Skip to content

Conversation

@Shane32
Copy link
Owner

@Shane32 Shane32 commented Jun 12, 2025

This allows bypassing parent type's authorization while defining new requirements on the field. Previously any requirements on the field were ignored.

Summary by CodeRabbit

  • Bug Fixes

    • Improved authorization validation to ensure all fields are consistently validated, regardless of anonymous access settings.
  • Tests

    • Added comprehensive tests to verify authorization behavior when both parent and child fields have role-based requirements and varying anonymous access configurations.
  • Documentation

    • Clarified authorization attribute descriptions to specify that they bypass type-level requirements rather than simply allowing unauthenticated access.

@Shane32 Shane32 self-assigned this Jun 12, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

Warning

Rate limit exceeded

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

Reviewing files that changed from the base of the PR and between 475c150 and b5f2ce4.

📒 Files selected for processing (1)
  • src/Tests/AuthorizationTests.cs (1 hunks)
📝 Walkthrough

Walkthrough

The conditional logic in the authorization visitor was updated so that validation is now performed on all fields, regardless of anonymous access settings. Additionally, a new parameterized test was introduced to verify authorization behavior when both parent and child fields have role requirements, with the child optionally allowing anonymous access. The README was updated to clarify the meaning of .AllowAnonymous() and [AllowAnonymous] attributes in GraphQL authorization.

Changes

File(s) Change Summary
src/GraphQL.AspNetCore3/AuthorizationVisitorBase.cs Removed conditional check; always calls ValidateAsync for every field, regardless of anonymous access.
src/Tests/AuthorizationTests.cs Added parameterized test BothAnonymousAndRequirements to cover role and anonymous access combinations.
README.md Clarified documentation on .AllowAnonymous() and [AllowAnonymous] attributes regarding authorization bypass.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AuthorizationVisitor
    participant Field
    participant Validator

    User->>AuthorizationVisitor: Request query execution
    loop For each field in query
        AuthorizationVisitor->>Validator: ValidateAsync(field)
        Validator-->>AuthorizationVisitor: Validation result
    end
    AuthorizationVisitor-->>User: Authorization result
Loading
sequenceDiagram
    participant Test
    participant AuthorizationVisitor
    participant ParentField
    participant ChildField
    participant Validator

    Test->>AuthorizationVisitor: Validate query { parent { child } }
    AuthorizationVisitor->>Validator: ValidateAsync(ParentField)
    Validator-->>AuthorizationVisitor: Parent field validation result
    AuthorizationVisitor->>Validator: ValidateAsync(ChildField)
    Validator-->>AuthorizationVisitor: Child field validation result
    AuthorizationVisitor-->>Test: Combined authorization result
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings

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 docstrings to generate docstrings for this 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.

Copy link
Contributor

@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/Tests/AuthorizationTests.cs (2)

765-772: Comment does not match the code – clarify to avoid confusion

The code applies the Role 2 requirement and (optionally) AllowAnonymous() to _field (the parent field), not to the child field as the comment states. This works, but the mismatch will trip readers up.

-        // Set up child field to require Role2 and optionally be anonymous
+        // Set up the 'parent' field to require Role2 and, optionally, allow anonymous access

774-779: Minor robustness: trim split roles

When splitting the comma-separated role list, any accidental spaces (e.g. "Role1, Role2") will become part of the role string. A small trim keeps the helper resilient:

-            var roles = userRoles.Split(',');
-            var claims = roles.Select(role => new Claim(ClaimTypes.Role, role)).ToArray();
+            var claims = userRoles.Split(',')
+                                  .Select(r => r.Trim())
+                                  .Where(r => r.Length > 0)
+                                  .Select(r => new Claim(ClaimTypes.Role, r))
+                                  .ToArray();
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e04baf0 and 557614b.

📒 Files selected for processing (2)
  • src/GraphQL.AspNetCore3/AuthorizationVisitorBase.cs (1 hunks)
  • src/Tests/AuthorizationTests.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test (windows-latest)
  • GitHub Check: test (ubuntu-latest)
  • GitHub Check: format
🔇 Additional comments (1)
src/GraphQL.AspNetCore3/AuthorizationVisitorBase.cs (1)

60-60: ValidateAsync now always runs – double-check perf & duplicate-error impact

With the conditional check removed, ValidateAsync is awaited for every field, even when fieldAnonymousAllowed is true.
That is the intended functional change, but please confirm:

  1. ValidateAsync is inexpensive when early-exiting on anonymous fields, otherwise a hot query could see noticeable overhead.
  2. Fields that are both [AllowAnonymous] and [Authorize] will now receive two validation passes (type + field). Ensure this cannot surface two identical AccessDeniedErrors for the same location.

If either risk materialises, consider adding an inexpensive short-circuit inside ValidateAsync for anonymous-only paths.

@github-actions
Copy link

Coverage Report

Totals Coverage
Statements: 93.76% ( 2060 / 2197 )
Methods: 80.88% ( 313 / 387 )

@Shane32 Shane32 merged commit dd56890 into master Jun 12, 2025
6 checks passed
@Shane32 Shane32 deleted the role_and_anonymous branch June 12, 2025 03:28
@coveralls
Copy link

coveralls commented Jun 12, 2025

Pull Request Test Coverage Report for Build 15600772670

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.009%) to 91.672%

Totals Coverage Status
Change from base Build 14895471409: -0.009%
Covered Lines: 2059
Relevant Lines: 2197

💛 - Coveralls

@Shane32 Shane32 added this to the 7.2.0 milestone Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants