Skip to content

ConsoleTarget - ForceWriteLine = false by default #5849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
snakefoot merged 1 commit into from
May 29, 2025
Merged

ConsoleTarget - ForceWriteLine = false by default #5849

snakefoot merged 1 commit into from
May 29, 2025

Conversation

@snakefoot
Copy link
Contributor

@snakefoot snakefoot commented May 29, 2025 •
edited
Loading

Replacing #5847

@snakefoot snakefoot added this to the 6.0 milestone May 29, 2025
@snakefoot snakefoot added console-target new default (breaking) Kind of Breaking behavior change labels May 29, 2025
@coderabbitai
Copy link

coderabbitai bot commented May 29, 2025 •
edited
Loading

Walkthrough

The changes rename and invert the semantics of a property and related parameters controlling console output buffering in the logging system. The EnableBatchWrite property is replaced by ForceWriteLine, reversing its default and logic. All method signatures, documentation, and test references are updated to match the new naming and behavior.

Changes

File(s) Change Summary
src/NLog/SetupLoadConfigurationExtensions.cs Updated WriteToConsole method: replaced enableBatchWrite (default true) with forceWriteLine (default false), updated XML docs and property assignment.
src/NLog/Targets/ConsoleTarget.cs Renamed property EnableBatchWrite to ForceWriteLine, reversed logic, updated obsolete property mapping, and inverted conditional logic in output methods.
tests/NLog.UnitTests/Targets/ConsoleTargetTests.cs Renamed test method parameter from writeBuffer to forceWriteLine, updated property assignment accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant Setup as SetupLoadConfigurationExtensions
    participant ConsoleTarget

    App->>Setup: WriteToConsole(..., forceWriteLine)
    Setup->>ConsoleTarget: set ForceWriteLine
    App->>ConsoleTarget: Log Event(s)
    alt forceWriteLine = true
        ConsoleTarget->>Console: WriteLine (no buffering)
    else forceWriteLine = false
        ConsoleTarget->>Console: Buffered Write
    end
Loading

Poem

In the warren of code, a flag did flip,
From batch to force, we made the trip.
Now logs may hop or take their time,
With WriteLine’s force or buffer’s rhyme.
A bunny cheers this tidy feat—
Console output, now so neat!
🐇✨

📜 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 95df2ed and 1f7cb99.

📒 Files selected for processing (3)
  • src/NLog/SetupLoadConfigurationExtensions.cs (2 hunks)
  • src/NLog/Targets/ConsoleTarget.cs (3 hunks)
  • tests/NLog.UnitTests/Targets/ConsoleTargetTests.cs (1 hunks)
🔇 Additional comments (8)
tests/NLog.UnitTests/Targets/ConsoleTargetTests.cs (2)

58-58: LGTM: Test parameter correctly renamed.

The parameter name change from writeBuffer to forceWriteLine aligns with the new property naming convention and maintains test readability.

65-65: LGTM: Property assignment updated correctly.

The property assignment change from WriteBuffer to ForceWriteLine correctly reflects the new API while maintaining the same test behavior through the property's semantic inversion.

src/NLog/SetupLoadConfigurationExtensions.cs (2)

449-450: LGTM: Extension method correctly updated with semantic inversion.

The parameter rename from enableBatchWrite to forceWriteLine with the default value change from true to false correctly maintains the same default behavior (batch writing enabled) while using the new inverted semantics.

460-460: LGTM: Property assignment correctly updated.

The property assignment change from EnableBatchWrite to ForceWriteLine aligns with the new property API and maintains correct functionality through the semantic inversion.

src/NLog/Targets/ConsoleTarget.cs (4)

134-137: LGTM: Property correctly renamed with semantic inversion.

The property rename from EnableBatchWrite to ForceWriteLine with updated documentation clearly explains the new semantics. The property controls whether to force slower Console.WriteLine() instead of faster internal buffering.

143-144: LGTM: Obsolete property correctly maintains backward compatibility.

The obsolete WriteBuffer property correctly maps to the inverse of ForceWriteLine, ensuring existing code continues to work while guiding users toward the new API.

258-265: LGTM: Conditional logic correctly inverted.

The logic correctly implements the semantic inversion - when ForceWriteLine is true, it calls base.Write() for Console.WriteLine() behavior, when false it uses the faster buffering approach via WriteBufferToOutput().

277-284: LGTM: Conditional logic correctly inverted in RenderToOutput.

The logic inversion is consistent with the batch write method - ForceWriteLine true forces WriteLineToOutput(), false uses WriteBufferToOutput() for better performance.

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

sonarqubecloud bot commented May 29, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@snakefoot snakefoot enabled auto-merge (squash) May 29, 2025 12:01
@snakefoot snakefoot merged commit 5ace9a3 into NLog:dev May 29, 2025
6 checks passed
@snakefoot snakefoot mentioned this pull request Jun 1, 2025
Merged
@snakefoot
Copy link
Contributor Author

snakefoot commented Jun 21, 2025

Updated wiki: https://github.com/NLog/NLog/wiki/Console-target

@snakefoot snakefoot added the documentation done all docs done (wiki, api docs, lists on nlog-project.org, xmldocs) label Jun 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

breaking behavior change Same API, different result console-target documentation done all docs done (wiki, api docs, lists on nlog-project.org, xmldocs) needs documentation on wiki new default (breaking) Kind of Breaking behavior change size/M

Projects

None yet

Milestone

6.0

Development

Successfully merging this pull request may close these issues.

1 participant

@snakefoot