Skip to content

Conversation

@snakefoot
Copy link
Contributor

No description provided.

@coderabbitai
Copy link

coderabbitai bot commented Aug 21, 2025

Walkthrough

Adds a new bool-predicate overload for creating parameterless condition methods and updates WithAutoFlush to use it instead of boxing booleans. No other behavior changes.

Changes

Cohort / File(s) Summary
Condition method overload
src/NLog/Conditions/ConditionMethodExpression.cs
Adds CreateMethodNoParameters(string, Func<LogEventInfo, bool>) that wraps the bool into boxed true/false and delegates to the existing object-returning overload.
Setup auto-flush integration
src/NLog/SetupLoadConfigurationExtensions.cs
Refactors WithAutoFlush to call the new bool-predicate overload directly, removing explicit boxing logic; no public API changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor App
  participant Setup as SetupLoadConfigurationExtensions
  participant Cond as ConditionMethodExpression
  participant Wrapper as AutoFlushTargetWrapper
  participant Logger as Logger Pipeline

  App->>Setup: WithAutoFlush(conditionMethod)
  Setup->>Cond: CreateMethodNoParameters("AutoFlush", Func<LogEventInfo,bool>)
  Cond-->>Setup: ConditionMethodExpression (no-params)
  Setup->>Wrapper: Configure AutoFlush(condition)
  note right of Wrapper: Uses condition to decide when to Flush

  Logger->>Wrapper: Process(LogEventInfo)
  Wrapper->>Cond: Evaluate condition(LogEventInfo)
  alt condition true
    Wrapper->>Wrapper: Flush()
  else condition false
    Wrapper-->>Logger: Continue without flush
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nudge the logs with whiskered cheer,
A tidy bool now guides us here—
No boxing burrows left to dig,
Just hop to flush when events grow big.
Thump-thump, code’s clean and bright—
A rabbit’s fix, swift as night. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/NLog/Conditions/ConditionMethodExpression.cs (2)

90-93: Add null-guard for the bool predicate to keep early validation consistent.

Currently a null method would defer failure to evaluation time (NullReferenceException) instead of failing fast like the object-returning overload. Guard it up-front.

Apply this diff:

-        public static ConditionMethodExpression CreateMethodNoParameters(string conditionMethodName, Func<LogEventInfo, bool> method)
-        {
-            return CreateMethodNoParameters(conditionMethodName, (evt) => method(evt) ? BoxedTrue : BoxedFalse);
-        }
+        public static ConditionMethodExpression CreateMethodNoParameters(string conditionMethodName, Func<LogEventInfo, bool> method)
+        {
+            var predicate = Guard.ThrowIfNull(method);
+            return CreateMethodNoParameters(conditionMethodName, evt => predicate(evt) ? BoxedTrue : BoxedFalse);
+        }

90-93: Optional: document intent and perf characteristics of the new overload.

A short XML doc helps discoverability and clarifies that it maps to BoxedTrue/BoxedFalse to avoid per-call boxing.

For example (outside the selected lines, above the method):

/// <summary>
/// Convenience overload for parameterless predicates that return bool.
/// Returns cached BoxedTrue/BoxedFalse to avoid per-evaluation boxing.
/// </summary>
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0de74a0 and be58977.

📒 Files selected for processing (2)
  • src/NLog/Conditions/ConditionMethodExpression.cs (1 hunks)
  • src/NLog/SetupLoadConfigurationExtensions.cs (1 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
src/NLog/SetupLoadConfigurationExtensions.cs (1)
src/NLog/Conditions/ConditionMethodExpression.cs (8)
  • ConditionMethodExpression (41-232)
  • ConditionMethodExpression (52-57)
  • ConditionMethodExpression (85-88)
  • ConditionMethodExpression (90-93)
  • ConditionMethodExpression (95-99)
  • ConditionMethodExpression (101-106)
  • ConditionMethodExpression (108-114)
  • ConditionMethodExpression (116-119)
src/NLog/Conditions/ConditionMethodExpression.cs (2)
src/NLog/Conditions/ConditionParser.cs (2)
  • ConditionMethodExpression (113-145)
  • ConditionMethodExpression (147-183)
src/NLog/Config/MethodFactory.cs (5)
  • Func (352-361)
  • Func (363-372)
  • Func (374-383)
  • Func (385-394)
  • Func (396-443)
🔇 Additional comments (1)
src/NLog/SetupLoadConfigurationExtensions.cs (1)

677-681: All CreateMethodNoParameters usages already leverage the bool–predicate overload—no further boxing candidates found

I’ve verified across the src folder that:

  • Every ConditionMethodExpression.CreateMethodNoParameters(…) invocation accepts a Func<LogEventInfo, bool>, so it already returns the cached BoxedTrue/BoxedFalse.
  • There are no direct call sites producing a boxed result that could be switched to the bool overload.
  • All remaining ConditionExpression.BoxedTrue/BoxedFalse usages reside within the core condition‐evaluation engine and wrapper filters (e.g. AutoFlushTargetWrapper, PostFilteringTargetWrapper, logical expressions), where they’re used for compare/evaluate logic—not method binding.

No additional manual conversions are required.

@sonarqubecloud
Copy link

@snakefoot snakefoot merged commit 234eca2 into NLog:dev Aug 22, 2025
6 checks passed
@snakefoot snakefoot added this to the 6.0.4 milestone Aug 30, 2025
@snakefoot snakefoot changed the title ColoredConsoleTarget - Fix boxing issue in ConsoleRowHighlightingRule Simplify WithAutoFlush-method for fluent config API Aug 30, 2025
This was referenced Sep 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant