Skip to content

XmlParser - Fix handling of XML comment just before closing-tag#5895

Merged
snakefoot merged 1 commit intoNLog:devfrom
snakefoot:xml-parser-invalid
Jun 23, 2025
Merged

XmlParser - Fix handling of XML comment just before closing-tag#5895
snakefoot merged 1 commit intoNLog:devfrom
snakefoot:xml-parser-invalid

Conversation

@snakefoot
Copy link
Contributor

@snakefoot snakefoot commented Jun 23, 2025 •
edited
Loading

Followup to #5712

@snakefoot snakefoot added bug Bug report / Bug fix nlog-configuration labels Jun 23, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jun 23, 2025 •
edited
Loading

Walkthrough

The changes update the XML parser to correctly refresh the current character after advancing the enumerator when handling comments or CDATA sections. Additionally, new unit tests are added to verify parsing of empty elements with explicit closing tags and handling of comments inside such elements.

Changes

File(s) Change Summary
src/NLog/Internal/XmlParser.cs Updated TryReadInnerText to refresh currentChar after advancing the enumerator for comments/CDATA.
tests/NLog.UnitTests/Internal/XmlParserTests.cs Added two test cases to verify parsing of empty elements with explicit closing tags and comments.

Poem

In the warren where XML flows,
A parser hops and keenly knows:
When comments or CDATA appear,
It checks the next char, crystal clear.
With new tests to keep bugs at bay,
The code grows stronger every day!
🐇✨

📜 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 f9d5bf4 and 3a69d80.

📒 Files selected for processing (2)
  • src/NLog/Internal/XmlParser.cs (1 hunks)
  • tests/NLog.UnitTests/Internal/XmlParserTests.cs (1 hunks)
🔇 Additional comments (2)
src/NLog/Internal/XmlParser.cs (1)

252-253: LGTM! Critical bug fix for parser state synchronization.

The addition of currentChar = _xmlSource.Current; after advancing the enumerator is essential to maintain correct parser state. Without this update, the currentChar variable would be stale, potentially causing incorrect behavior in the return condition at line 274.

tests/NLog.UnitTests/Internal/XmlParserTests.cs (1)

298-299: Excellent test coverage for the parser fix.

These test cases provide comprehensive validation for the XML parser fix by testing:

  1. Empty elements with explicit closing tags instead of self-closing syntax
  2. Comments embedded within elements with explicit closing tags

Both scenarios directly exercise the code path that was fixed in the parser, ensuring the currentChar state synchronization works correctly.

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.

@snakefoot snakefoot enabled auto-merge (squash) June 23, 2025 18:05
@snakefoot snakefoot closed this Jun 23, 2025
auto-merge was automatically disabled June 23, 2025 18:39

Pull request was closed

@snakefoot snakefoot reopened this Jun 23, 2025
@snakefoot snakefoot closed this Jun 23, 2025
@snakefoot snakefoot reopened this Jun 23, 2025
@snakefoot snakefoot enabled auto-merge (squash) June 23, 2025 18:55
@snakefoot snakefoot closed this Jun 23, 2025
auto-merge was automatically disabled June 23, 2025 19:19

Pull request was closed

@snakefoot snakefoot reopened this Jun 23, 2025
@snakefoot snakefoot enabled auto-merge (squash) June 23, 2025 19:19
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 23, 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 merged commit 2d6cfb4 into NLog:dev Jun 23, 2025
6 checks passed
@snakefoot snakefoot added this to the 6.0.1 milestone Jun 29, 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

bug Bug report / Bug fix nlog-configuration size/XS

Projects

None yet

Milestone

6.0.1

Development

Successfully merging this pull request may close these issues.

1 participant

@snakefoot