Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file #187

ESS-ENN · 2025-03-27T09:39:32Z

Summary by CodeRabbit

Refactor
- Enhanced the evaluation logic for developer exception triggers by refining the conditions and improving context sensitivity.
Tests
- Updated the formatting of test examples to include minor punctuation changes, ensuring consistent alignment in output snapshots.

…into main

CLAassistant · 2025-03-27T09:39:40Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ESS-ENN
❌ Sakshis

Sakshis seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

coderabbitai · 2025-03-27T09:39:40Z

Walkthrough

This PR revises the YAML rule for $APP.UseDeveloperExceptionPage() by restructuring its definition. The rule now classifies the invocation as a kind_invocation_expression with explicit checks for member_access_expression and argument_list, along with conditions to ensure it is not nested within a disallowed if_statement context. Additionally, a new rule for expression_statement has been added to avoid error outcomes. The associated snapshot file has been updated to include semicolons in the source entries, with corresponding adjustments to the end values.

Changes

File	Change Summary
rules/.../stacktrace-disclosure-csharp.yml	Restructured the `$APP.UseDeveloperExceptionPage()` utility to a `kind_invocation_expression` with new child node conditions and added an `expression_statement` rule.
tests/.../stacktrace-disclosure-csharp-snapshot.yml	Added semicolons to `app.UseDeveloperExceptionPage()` source entries and incremented end values to reflect the formatting change.

Sequence Diagram(s)

sequenceDiagram
    participant Code as Developer Code
    participant Rule as Rule Engine
    participant Matcher as Pattern Matcher
    Code->>Rule: Invoke $APP.UseDeveloperExceptionPage()
    Rule->>Matcher: Evaluate as kind_invocation_expression
    Matcher->>Rule: Confirm presence of member_access_expression & argument_list
    Rule->>Matcher: Verify not in disallowed if_statement context
    Matcher-->>Rule: Conditions met
    Rule->>Rule: Check expression_statement and error context
    Rule-->>Code: Return validation outcome

Possibly related PRs

Add YAML-based AST security rules and tests for C#, Java, Ruby #186: Introduces a rule to detect the usage of $APP.UseDeveloperExceptionPage() outside the development environment, directly relating to modifications made in this PR.

Suggested reviewers

ganeshpatro321

Poem

I'm a rabbit with code hops so light,
Revising rules that shine so bright,
Pattern checks and semicolons in line,
In YAML fields the changes align,
Hop along, fellow coders, with delight! 🐇

📜 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 d6616fc and 299b036.

📒 Files selected for processing (2)

rules/csharp/security/stacktrace-disclosure-csharp.yml (1 hunks)
tests/__snapshots__/stacktrace-disclosure-csharp-snapshot.yml (1 hunks)

🔇 Additional comments (9)

tests/__snapshots__/stacktrace-disclosure-csharp-snapshot.yml (6)

5-8: Semicolon Addition & End Value Update in First Snapshot Block

The source field now correctly ends with a semicolon, and the corresponding end value has been updated to reflect the additional character. This change ensures that the snapshot aligns with the updated coding standards and rule definitions.

11-14: Consistent Semicolon Application & End Value Adjustment in Second Snapshot Block

The changes on these lines add the semicolon to the app.UseDeveloperExceptionPage() statement and adjust the end value. This consistency is important for accurate snapshot comparisons against the live rules.

17-20: Uniform Source Formatting in Third Snapshot Block

The semicolon has been appended to the source entry and the end value updated accordingly. Maintaining uniform formatting across snapshot entries will help prevent false positives during test comparisons.

23-26: Updated Snapshot Entry: Semicolon Inclusion & End Value Revision

The addition of the semicolon in the source line, along with the revised end value, ensures that the snapshot precisely mirrors the intended real code output as per the updated rule.

29-32: Snapshot Entry Consistency: Semicolon & End Field Adjustment

These modifications continue the pattern of consistently appending a semicolon to the source field while adjusting the end value. This uniformity supports reliable snapshot testing.

39-42: Final Snapshot Block: Correct Semicolon and End Value

The changes here complete the snapshot updates by ensuring that the source field is formatted with a semicolon, and that the end value is recalibrated. This final update ties the snapshot changes neatly with the updated invocation rules.

rules/csharp/security/stacktrace-disclosure-csharp.yml (3)

17-27: Enhanced kind_invocation_expression Utility Definition

The new structure explicitly defines the invocation expression by requiring its first child to be a member_access_expression (with a check for $ENV.IsDevelopment) and its second child to be an argument_list. These explicit checks improve the precision of pattern matching for the $APP.UseDeveloperExceptionPage() usage.

28-41: Explicit Utility for $APP.UseDeveloperExceptionPage(...)

The updated utility now defines the invocation as an expression_statement with the pattern $APP.UseDeveloperExceptionPage($$$);. Moreover, it introduces constraints ensuring the expression is not nested within a disallowed if_statement that may incorporate an invocation expression. This clear structure aids in targeting only the appropriate contexts.

42-53: Layered Rule Checks to Avoid ERROR Contexts

The rule block now enforces additional validations by ensuring that the $APP.UseDeveloperExceptionPage(...) invocation is not situated in any context containing an ERROR. This layered approach is a robust safeguard against unintentional exposure of detailed stacktrace information in non-development environments.

🪧 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.
- 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 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 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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

Sakshis and others added 30 commits December 16, 2024 13:09

removed missing-secure-java

bb7b8e1

Merge branch 'coderabbitai:main' into main

308e947

Merge branch 'coderabbitai:main' into main

46efd55

Merge branch 'coderabbitai:main' into main

3ac0204

Merge branch 'coderabbitai:main' into main

7caba92

Merge branch 'coderabbitai:main' into main

d3a2776

Merge branch 'coderabbitai:main' into main

2e86380

Merge branch 'coderabbitai:main' into main

b072db7

Merge branch 'coderabbitai:main' into main

65dce29

httponly-false-csharp

12bb3aa

use-of-md5-digest-utils-java

2c5ea88

removing use-of-md5-digest-utils and httponly-false-csharp

d3067f1

Merge branch 'coderabbitai:main' into main

56d4011

Merge branch 'coderabbitai:main' into main

f7f1d72

Merge branch 'coderabbitai:main' into main

0d53f8e

Merge branch 'coderabbitai:main' into main

b622bca

Merge branch 'coderabbitai:main' into main

67459bf

Merge branch 'coderabbitai:main' into main

b8b2adb

Merge branch 'coderabbitai:main' into main

9b29d0a

Merge branch 'coderabbitai:main' into main

24510d4

Merge remote-tracking branch 'upstream/main' into main

6c6d229

Merge branch 'main' of https://github.com/ESS-ENN/ast-grep-essentials …

c5f0d85

…into main

Merge branch 'coderabbitai:main' into main

4104e61

Merge remote-tracking branch 'upstream/main' into main

36b1114

Merge branch 'main' of https://github.com/ESS-ENN/ast-grep-essentials …

befc6b0

…into main

Merge branch 'coderabbitai:main' into main

7bc886d

Merge remote-tracking branch 'upstream/main' into main

fc13546

Merge branch 'main' of https://github.com/ESS-ENN/ast-grep-essentials …

e4a1853

…into main

Merge branch 'coderabbitai:main' into main

b6203b0

Merge remote-tracking branch 'upstream/main' into main

5327545

ESS-ENN added 5 commits March 25, 2025 12:50

Merge remote-tracking branch 'upstream/main' into main

f59e083

Merge branch 'coderabbitai:main' into main

e0d7253

Merge remote-tracking branch 'upstream/main' into main

a545c52

Merge branch 'main' of https://github.com/ESS-ENN/ast-grep-essentials …

a6d049d

…into main

Updated stacktrace-disclosure-csharp rule file

299b036

coderabbitai bot changed the title ~~@coderabbitai~~ Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file Mar 27, 2025

coderabbitai bot approved these changes Mar 27, 2025

View reviewed changes

petrisorcoderabbit approved these changes Mar 27, 2025

View reviewed changes

petrisorcoderabbit merged commit cc2e5aa into coderabbitai:main Mar 27, 2025
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file #187

Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file #187

Uh oh!

ESS-ENN commented Mar 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

CLAassistant commented Mar 27, 2025

Uh oh!

coderabbitai bot commented Mar 27, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file #187

Update YAML rule for $APP.UseDeveloperExceptionPage and snapshot file #187

Uh oh!

Conversation

ESS-ENN commented Mar 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

CLAassistant commented Mar 27, 2025

Uh oh!

coderabbitai bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

ESS-ENN commented Mar 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)