Make DPanic fatal in zaptest

[WGH-]

The intention of DPanic is to catch errors that should never happen. Unless you added zaptest.WrapOptions(zap.Development()), they were previously silently ignored.

This is a breaking change. But you can opt out of this using zaptest.Development(false) option.

Summary by CodeRabbit

• New Features
  • Added an option to disable development mode for the logger.
• Documentation
  • Updated logger documentation to reflect the new default behavior and the option to opt out of development mode.
• Tests
  • Added tests to verify logger behavior when development mode is enabled or disabled.

[CLAassistant]

All committers have signed the CLA.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.93%. Comparing base (845ca51) to head (377e39f).
Report is 82 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1274      +/-   ##
==========================================
- Coverage   98.08%   97.93%   -0.16%     
==========================================
  Files          50       50              
  Lines        3240     3242       +2     
==========================================
- Hits         3178     3175       -3     
- Misses         53       57       +4     
- Partials        9       10       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[abhinav]

Thanks! I agree that the zaptest logger should panic/run in development mode. This was an oversight. For opting out, we could maybe add a zaptest.LoggerOption that allows setting it to false?

zaptest.NewLogger(t) // will panic
zaptest.NewLogger(t, zaptest.Development(false)) // won't panic

There's a question of whether this is a breaking change, though.
Based on the intent of this API, I would consider this more a bugfix than a breaking change, but I'd like to hear thoughts on this from other maintainers.

CC @sywhang @mway @prashantv

[sywhang]

IMO this is a breaking change in behavior; but since this will only affect tests I think it might be worth considering.

Adding an option for opting out of the panic behavior would save many people from suddenly seeing a bunch of their tests break so I'm +1 on that suggestion.

[coderabbitai]

Walkthrough

A new configuration option was introduced to control whether the logger operates in zap's development mode. By default, the logger runs in development mode, but this can now be disabled using the newly added Development(enable bool) option. The logger's creation logic was updated to respect this setting. Corresponding documentation was revised to reflect the new behavior. A new test was added to verify that the logger's DPanic method behaves differently depending on whether development mode is enabled or not.

Changes

File(s)	Change Summary
zaptest/logger.go	Added a development boolean field to internal options, introduced Development(enable bool) LoggerOption, updated NewLogger logic and documentation to support toggling zap's development mode.
zaptest/logger_test.go	Added TestDPanic to verify DPanic panics in development mode and does not panic when development mode is disabled.

Poem

In the warren of logs, a new path appears,
With toggles for modes to calm all our fears.
"Development true or false," the bunny said,
Now panics behave as we carefully tread.
With tests that ensure our code hops just right,
The logger now shines, both day and night!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 800f9c8 and 0c822a5.

📒 Files selected for processing (2)

• zaptest/logger.go (4 hunks)
• zaptest/logger_test.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• zaptest/logger_test.go
• zaptest/logger.go

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[WGH-]

So I've just added zaptest.NoDevelopment() option to opt out of this.

(yeah, sorry, I kinda forgot for two years)

[WGH-]

...and changed to zaptest.Development(false), according to @abhinav's suggestion.

[prashantv]

Agree that this is worth changing as it only impacts tests, and it should have been this way from the start.