make tracking for better error details optional (fixes #1009)

[tomtau]

2.7.8 cargo bench:

http parser             time:   [321.39 µs 321.54 µs 321.70 µs]
json parser             time:   [20.382 µs 20.425 µs 20.484 µs]

2.7.9 cargo bench (baseline 2.7.8):

http parser             time:   [2.1007 ms 2.1013 ms 2.1020 ms]
                        change: [+552.62% +553.14% +553.59%] (p = 0.00 < 0.05)
                        Performance has regressed.
Found 7 outliers among 100 measurements (7.00%)
  1 (1.00%) high mild
  6 (6.00%) high severe

json parser             time:   [124.16 µs 124.19 µs 124.23 µs]
                        change: [+506.35% +507.34% +508.18%] (p = 0.00 < 0.05)
                        Performance has regressed.
Found 10 outliers among 100 measurements (10.00%)
  1 (1.00%) low mild
  6 (6.00%) high mild
  3 (3.00%) high severe

this PR fix when disabled (baseline 2.7.9):

http parser             time:   [378.87 µs 379.17 µs 379.72 µs]
                        change: [-81.966% -81.952% -81.929%] (p = 0.00 < 0.05)
                        Performance has improved.
Found 10 outliers among 100 measurements (10.00%)
  5 (5.00%) high mild
  5 (5.00%) high severe

json parser             time:   [25.925 µs 25.935 µs 25.946 µs]
                        change: [-79.118% -79.105% -79.093%] (p = 0.00 < 0.05)
                        Performance has improved.
Found 15 outliers among 100 measurements (15.00%)
  3 (3.00%) low severe
  4 (4.00%) low mild
  5 (5.00%) high mild
  3 (3.00%) high severe

[coderabbitai]

Warning

Rate Limit Exceeded

@tomtau has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 6 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

Files that changed from the base of the PR and between 23f6082 and a9e08b6.

Walkthrough

The changes across various files focus on introducing the set_error_detail function to manage error details in parsing, impacting error handling and token matching based on error detail settings, enhancing debugging capabilities.

Changes

Files	Change Summary
pest/src/parser_state.rs	Added set_error_detail function for error detail control, enabled field in ParseAttempts, and logic based on parse_attempts.enabled.
pest/src/parser_state.rs	Modified error handling and token matching functions based on parse_attempts.enabled.

🐰✨ A whimsical verse from a rabbit's burrow,
To celebrate the code that we now follow.
With a hop and a skip, errors we'll detail,
In the land of code, we shall never fail.
Toggle on, toggle off, with ease we sail,
Through bugs and features, we prevail! 🌟📜

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[tomtau]

@EmirVildanov FYI this disables tracking for detailed errors to reduce the performance overhead, but it can still be optionally enabled via set_error_detail

[coderabbitai]

Actionable comments posted: 1

[NoahTheDuke]

I think this looks good. My only thought is: should these checks be in the impacting functions instead of at the call-sites? Seeing if new_state.parse_attempts.enabled { try_add_rule_to_stack(&mut new_state); } multiple times (along with the others) gives me pause.

I don't know the performance implications of unnecessary function calls, so I'll trust your judgement here, given that we're trying to fix a performance issue. This isn't such a big deal that we should worsen performance more for a little more clarity.

[tomtau]

@NoahTheDuke yeah, I was thinking that; I went for checking at call-sites, because 1) it was easier to cross-check against the original PR's modifications in the parser state, 2) some of those calls had a String allocation before that guarded call (maybe the compiler could inline functions there and optimize away those allocations, maybe not).
Anyway, this is open to potential follow-up PRs with more refactoring and optimization work.

[klensy]

With a release of 2.7.10, can 2.7.9 be yanked? Regression was quite big to actually prevent users to use it.

[tomtau]

@klensy that makes sense, so 2.7.9 should be yanked now