Skip to content

Change gate for attach mutation #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

15g-lucas
Copy link
Member

@15g-lucas 15g-lucas commented Jun 5, 2025

close #162

I've added the possibility of using the attachModel gate when attaching to the PerformMutate, as indicated in the documentation.

I've left the possibility of using view so as not to create a breaking change.

Summary by CodeRabbit

  • Bug Fixes
    • Improved authorization checks for certain mutation operations, ensuring more specific permissions are verified before falling back to general permissions.

Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

Walkthrough

The authorization logic within the applyMutation method was updated to introduce a conditional check for mutation operations other than 'create' and 'update'. Now, the method first attempts to authorize using a dynamically constructed 'attach' operation before defaulting to the existing 'view' authorization. Additionally, the mutate method's loop was simplified by consolidating the assignment of mutation results.

Changes

File Change Summary
src/Query/Traits/PerformMutation.php Simplified array assignment in mutate; updated authorization logic in applyMutation for non-create/update mutations; minor docblock formatting adjustments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PerformMutation
    participant Resource

    User->>PerformMutation: applyMutation(mutation, attributes)
    PerformMutation->>Resource: authorizeTo('attach' + model, model)
    alt attach authorization passes
        PerformMutation-->>User: Proceed with mutation
    else attach authorization fails
        PerformMutation->>Resource: authorizeTo('view', model)
        alt view authorization passes
            PerformMutation-->>User: Proceed with mutation
        else view authorization fails
            PerformMutation-->>User: Authorization denied
        end
    end
Loading

Poem

A bunny with code on its mind,
Tweaked permissions, now more refined.
First, try to attach—if that’s not the match,
Then view is the fallback we find.
With hops through the logic, it’s never a chore—
Secure little changes, who could ask for more?
🐇✨


📜 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 090e201 and 70f68d5.

📒 Files selected for processing (1)
  • src/Query/Traits/PerformMutation.php (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/Query/Traits/PerformMutation.php
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: Tests on PHP 8.4 with Laravel ^12.0 and mysql
  • GitHub Check: Tests on PHP 8.4 with Laravel ^12.0 and pgsql
  • GitHub Check: Tests on PHP 8.4 with Laravel ^11.0 and pgsql
  • GitHub Check: Tests on PHP 8.4 with Laravel ^11.0 and sqlite
  • GitHub Check: Tests on PHP 8.4 with Laravel ^12.0 and sqlite
  • GitHub Check: Tests on PHP 8.3 with Laravel ^12.0 and mysql
  • GitHub Check: Tests on PHP 8.4 with Laravel ^11.0 and mysql
  • GitHub Check: Tests on PHP 8.3 with Laravel ^11.0 and mysql
  • GitHub Check: Tests on PHP 8.3 with Laravel ^12.0 and sqlite
  • GitHub Check: Tests on PHP 8.3 with Laravel ^12.0 and pgsql
  • GitHub Check: Tests on PHP 8.2 with Laravel ^12.0 and mysql
  • GitHub Check: Tests on PHP 8.3 with Laravel ^11.0 and pgsql
  • GitHub Check: Tests on PHP 8.3 with Laravel ^11.0 and sqlite
  • GitHub Check: Tests on PHP 8.2 with Laravel ^12.0 and sqlite
  • GitHub Check: Tests on PHP 8.2 with Laravel ^12.0 and pgsql
  • GitHub Check: Tests on PHP 8.2 with Laravel ^11.0 and pgsql
  • GitHub Check: Tests on PHP 8.2 with Laravel ^11.0 and mysql
  • GitHub Check: Tests on PHP 8.2 with Laravel ^11.0 and sqlite
✨ 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 56fbd7e and 3b5c192.

📒 Files selected for processing (1)
  • src/Query/Traits/PerformMutation.php (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/Query/Traits/PerformMutation.php (1)
src/Concerns/Authorizable.php (1)
  • authorizeTo (24-53)

Comment on lines 67 to 69
if (!$this->resource->authorizeTo('attach' . $model, $model)) {
$this->resource->authorizeTo('view', $model);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the authorization logic - authorizeTo doesn't return a boolean.

The conditional check if (!$this->resource->authorizeTo(...)) is incorrect because the authorizeTo method doesn't return a boolean. Based on the relevant code snippet from src/Concerns/Authorizable.php, this method either:

  • Succeeds and returns void (which is falsy)
  • Fails and calls Response::deny()->authorize() (presumably throwing an exception)

This means the code will always execute the fallback $this->resource->authorizeTo('view', $model) when the first authorization succeeds, which defeats the purpose.

Additionally, 'attach' . $model will likely produce an unintended ability name since $model is a Model instance, not a string.

Consider this approach using a try-catch pattern:

-            if (!$this->resource->authorizeTo('attach' . $model, $model)) {
-                $this->resource->authorizeTo('view', $model);
-            }
+            try {
+                $this->resource->authorizeTo('attach' . class_basename($model), $model);
+            } catch (\Exception $e) {
+                $this->resource->authorizeTo('view', $model);
+            }

Or modify the authorizeTo method to return a boolean if this pattern is needed elsewhere.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (!$this->resource->authorizeTo('attach' . $model, $model)) {
$this->resource->authorizeTo('view', $model);
}
try {
$this->resource->authorizeTo('attach' . class_basename($model), $model);
} catch (\Exception $e) {
$this->resource->authorizeTo('view', $model);
}
🤖 Prompt for AI Agents
In src/Query/Traits/PerformMutation.php around lines 67 to 69, the current
authorization check incorrectly treats authorizeTo as returning a boolean, but
it actually throws an exception on failure and returns void on success. To fix
this, replace the if condition with a try-catch block: try calling
authorizeTo('attach' . AbilityName, $model) where AbilityName is a string
representing the ability (not the model object), and if it throws an exception,
catch it and then call authorizeTo('view', $model). This ensures proper
authorization flow without misusing the return value or concatenating the model
object to the ability string.

@GautierDele
Copy link
Member

GautierDele commented Jun 6, 2025

Oh ! but there are no unit tests on this ? I'll add some with it

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.

Attachment problem from a BelongTo relationship
2 participants