Skip to content
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

Don't check permissions for the target resource when canceling requests #8369

Merged
merged 1 commit into from
Aug 30, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Aug 28, 2024

Motivation and context

IMO, these checks are not very useful. The permission logic for requests already checks that the request is being canceled by the same user that created it. Therefore, these additional checks can only fail if a user creates a request for some action, loses the permissions to do the same action again, and then tries to cancel the request. But cancelling a request does not do anything to the target resource (in fact, it prevents some future actions from taking place), so I really don't see why this shouldn't be allowed.

In addition, these checks create some problems:

  • If the creator of the request is no longer able to cancel it, we now have a request that nobody is allowed to cancel. That seems wrong.

  • To implement these checks, RequestPermission has to know which actions require which permissions. This creates code duplication between it and the other permission classes. It also causes a dependency on those classes, which could create problems if we want to use the request API for actions from the Enterprise version.

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Users can now cancel requests without needing specific permissions, enhancing flexibility and streamlining workflows.
  • Bug Fixes

    • Simplified permission handling may improve overall user experience, though it raises concerns about permission validation robustness.
  • Chores

    • Code simplification for permission handling has been implemented for better maintainability.

…quests

IMO, these checks are not very useful. The permission logic for requests
already checks that the request is being canceled by the same user that
created it. Therefore, these additional checks can only fail if a user
creates a request for some action, loses the permissions to do the same
action again, and then tries to cancel the request. But cancelling a request
does not do anything to the target resource (in fact, it _prevents_ some
future actions from taking place), so I really don't see why this shouldn't
be allowed.

In addition, these checks create some problems:

* If the creator of the request is no longer able to cancel it, we now have
  a request that _nobody_ is allowed to cancel. That seems wrong.

* To implement these checks, `RequestPermission` has to know which actions
  require which permissions. This creates code duplication between it and
  the other permission classes. It also causes a dependency on those
  classes, which could create problems if we want to use the request API for
  actions from the Enterprise version.
Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update modifies the request cancellation process by changing the permission requirements for users. Users can now cancel requests without needing specific permissions tied to the original action. Additionally, the permission handling logic within the create method has been simplified, removing detailed checks and resource retrieval related to various actions and permissions.

Changes

File Path Change Summary
changelog.d/20240828_053041_roman_rm_extra_checks.md, cvat/apps/engine/permissions.py Updated request cancellation process to allow users to cancel without specific permissions. Simplified permission handling logic in the create method, removing detailed checks and resource retrieval.

Poem

🐇 In fields of code where bunnies play,
Permissions light the user’s way.
With simpler paths, we hop along,
Cancelling requests, where we belong.
A joyful leap, a happy cheer,
For changes bright, we hold so dear! 🌼


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
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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fe3f79f and 4e33b4b.

Files selected for processing (2)
  • changelog.d/20240828_053041_roman_rm_extra_checks.md (1 hunks)
  • cvat/apps/engine/permissions.py (1 hunks)
Additional comments not posted (2)
changelog.d/20240828_053041_roman_rm_extra_checks.md (1)

1-5: LGTM!

The changelog entry is clear and concise.

The code changes are approved.

cvat/apps/engine/permissions.py (1)

Line range hint 1-1: Verify the impact on security and functionality.

The changes simplify the permission checks, but the removal of detailed checks might impact security and functionality. Ensure that the new implementation does not introduce security vulnerabilities or functional issues.

Run the following script to verify the impact of the changes:

Also applies to: 32-36

Copy link

sonarcloud bot commented Aug 28, 2024

@SpecLad SpecLad changed the title Don't check permissions for the underlying resource when canceling requests Don't check permissions for the target resource when canceling requests Aug 29, 2024
@SpecLad SpecLad merged commit 2d6ac62 into cvat-ai:develop Aug 30, 2024
33 checks passed
@SpecLad SpecLad deleted the rm-extra-checks branch August 30, 2024 09:36
This was referenced Sep 9, 2024
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 2024
…ts (cvat-ai#8369)

IMO, these checks are not very useful. The permission logic for requests
already checks that the request is being canceled by the same user that
created it. Therefore, these additional checks can only fail if a user
creates a request for some action, loses the permissions to do the same
action again, and then tries to cancel the request. But cancelling a
request does not do anything to the target resource (in fact, it
_prevents_ some future actions from taking place), so I really don't see
why this shouldn't be allowed.

In addition, these checks create some problems:

* If the creator of the request is no longer able to cancel it, we now
  have a request that _nobody_ is allowed to cancel. That seems wrong.

* To implement these checks, `RequestPermission` has to know which
  actions require which permissions. This creates code duplication between
  it and the other permission classes. It also causes a dependency on
  those classes, which could create problems if we want to use the request
  API for actions from the Enterprise version.
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.

2 participants