Skip to content

Conversation

@snakefoot
Copy link
Contributor

@snakefoot snakefoot commented Jul 16, 2025

Resolves #5932 - Fixing bug introduced with #5804

@snakefoot snakefoot added this to the 6.0.2 milestone Jul 16, 2025
@snakefoot snakefoot added the bug Bug report / Bug fix label Jul 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jul 16, 2025

Warning

Rate limit exceeded

@snakefoot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 74b5bbe and 1357bc9.

📒 Files selected for processing (2)
  • src/NLog/Logger.cs (2 hunks)
  • tests/NLog.UnitTests/LoggerTests.cs (1 hunks)

Walkthrough

The changes refactor message formatting logic in the Logger class by moving it into a new private method, enhancing exception handling during log event creation. Corresponding unit tests are updated to verify that invalid format strings do not throw exceptions and are logged as literal messages when exception suppression is enabled.

Changes

File(s) Change Summary
src/NLog/Logger.cs Refactored message formatting and log event creation into a new private method with improved exception handling.
tests/NLog.UnitTests/LoggerTests.cs Updated and expanded tests to assert that invalid format strings are handled gracefully and logged as literals.

Assessment against linked issues

Objective Addressed Explanation
Prevent System.FormatException when invalid format strings are used in log messages (#5932)
Log invalid format strings as literal messages without throwing exceptions (#5932)
Provide a mechanism to suppress exceptions during message formatting (#5932) Verified by usage of NoThrowNLogExceptions in tests.

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes detected.

Poem

In the code where loggers dwell,
Formatting now is handled well.
Errors caught and messages clear,
Even bad formats, there's nothing to fear!
Rabbits rejoice, with logs so bright—
All is tidy, all is right.
🐇✨


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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 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.

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Bug report / Bug fix size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

NLog 6.0: Logging Throws on Invalid Format Strings

1 participant