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

[Hotfix] Fix scope defining #8185

Merged
merged 2 commits into from
Jul 18, 2024
Merged

[Hotfix] Fix scope defining #8185

merged 2 commits into from
Jul 18, 2024

Conversation

Marishka17
Copy link
Contributor

@Marishka17 Marishka17 commented Jul 17, 2024

Motivation and context

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

  • Bug Fixes

    • Changed export_dataset_v2 and export_backup_v2 endpoints to use POST instead of GET for improved security and functionality.
  • Improvements

    • Adjusted access scopes for various exporting actions to align with the new HTTP methods and enhance security.

@Marishka17 Marishka17 requested a review from azhavoro July 17, 2024 21:40
Copy link
Contributor

coderabbitai bot commented Jul 17, 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

The recent changes in permissions.py within the cvat/apps/engine directory involve switching the HTTP methods for export_dataset_v2 and export_backup_v2 endpoints from GET to POST. This update impacts the scopes associated with these actions, ensuring that the appropriate permissions are enforced based on the new HTTP method and the type of request.

Changes

Files/Paths Change Summary
cvat/apps/engine/permissions.py Updated export_dataset_v2 and export_backup_v2 endpoints to use POST instead of GET methods. Adjusted scopes accordingly.

Poem

In the realm of CVAT's code,
Permissions shift, a new method showed,
From GET to POST, they now align,
Scopes updated, working fine.
Export tasks with ease, we cheer,
Progress made, the path is clear. 🚀


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 2490153 and 4330a58.

Files selected for processing (1)
  • cvat/apps/engine/permissions.py (4 hunks)
Additional comments not posted (4)
cvat/apps/engine/permissions.py (4)

482-482: Verify the change of HTTP method for export_dataset_v2.

The HTTP method for export_dataset_v2 has been changed from GET to POST. Ensure that all calls to this endpoint are updated accordingly in the codebase and that the change aligns with the expected behavior.

Verification successful

Verification successful for the change of HTTP method for export_dataset_v2.

The HTTP method for export_dataset_v2 has been correctly updated to POST in the codebase. No instances of other HTTP methods were found for this endpoint.

  • cvat/apps/engine/permissions.py: The export_dataset_v2 endpoint is mapped to the POST method.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `export_dataset_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type python -A 5 $'export_dataset_v2'

Length of output: 72


Script:

#!/bin/bash
# Description: Verify all function calls to `export_dataset_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg -A 5 'export_dataset_v2'

Length of output: 2152


Script:

#!/bin/bash
# Description: Verify that all calls to the `export_dataset_v2` endpoint use the `POST` method.

# Test: Search for HTTP method usage of `export_dataset_v2`. Expect: Only occurrences of `POST`.
rg -A 5 'export_dataset_v2' | grep -E 'GET|POST|PUT|DELETE|PATCH'

Length of output: 1435


279-279: Verify the change of HTTP method for export_backup_v2.

The HTTP method for export_backup_v2 has been changed from GET to POST. Ensure that all calls to this endpoint are updated accordingly in the codebase and that the change aligns with the expected behavior.

Verification successful

Verification successful: The HTTP method for export_backup_v2 has been correctly updated to POST in all relevant parts of the codebase.

  • cvat/apps/engine/permissions.py correctly maps export_backup_v2 to POST.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `export_backup_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type python -A 5 $'export_backup_v2'

Length of output: 71


Script:

#!/bin/bash
# Description: Verify all function calls to `export_backup_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg -A 5 'export_backup_v2'

Length of output: 1411


Script:

#!/bin/bash
# Description: Verify all HTTP method usages for `export_backup_v2` are using POST.

# Test: Search for HTTP method usages. Expect: Only occurrences of POST.
rg -A 5 'export_backup_v2' | grep -i 'post'

Length of output: 326


277-277: Verify the change of HTTP method for export_dataset_v2.

The HTTP method for export_dataset_v2 has been changed from GET to POST. Ensure that all calls to this endpoint are updated accordingly in the codebase and that the change aligns with the expected behavior.

Verification successful

Verification successful for the HTTP method change for export_dataset_v2.

The HTTP method for export_dataset_v2 has been changed from GET to POST. The method implementation in mixins.py is compatible with this change and does not explicitly depend on the HTTP method. Ensure that any external calls to this endpoint are updated accordingly.

  • cvat/apps/engine/permissions.py: Line 277
  • cvat/apps/engine/mixins.py: Lines 466-473
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `export_dataset_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type python -A 5 $'export_dataset_v2'

Length of output: 72


Script:

#!/bin/bash
# Description: Verify all function calls to `export_dataset_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type py -A 5 $'export_dataset_v2'

Length of output: 2162


Script:

#!/bin/bash
# Description: Extract the implementation of the `export_dataset_v2` method from `mixins.py`.

# Test: Retrieve the method implementation. Expect: Full method definition for review.
ast-grep --lang python --pattern $'def export_dataset_v2(self, $_, $_):\n    $$$' cvat/apps/engine/mixins.py

Length of output: 782


494-494: Verify the change of HTTP method for export_backup_v2.

The HTTP method for export_backup_v2 has been changed from GET to POST. Ensure that all calls to this endpoint are updated accordingly in the codebase and that the change aligns with the expected behavior.

Verification successful

Verified the change of HTTP method for export_backup_v2.

The HTTP method for export_backup_v2 has been correctly updated to POST in the permissions file. No direct HTTP calls or URL patterns were found referencing this endpoint, indicating it is likely called internally within the application.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `export_backup_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type python -A 5 $'export_backup_v2'

Length of output: 71


Script:

#!/bin/bash
# Description: Verify all function calls to `export_backup_v2` match the new HTTP method.

# Test: Search for the function usage. Expect: Only occurrences of the new HTTP method.
rg --type py -A 5 $'export_backup_v2'

Length of output: 1421


Script:

#!/bin/bash
# Description: Verify all HTTP method calls to `export_backup_v2` match the new POST method.

# Test: Search for HTTP method usage. Expect: Only occurrences of the new POST method.
rg --type py -A 5 'export_backup_v2'

Length of output: 1421


Script:

#!/bin/bash
# Description: Verify all HTTP calls to `export_backup_v2` match the new POST method.

# Test: Search for HTTP calls to `export_backup_v2`. Expect: Only occurrences of the new POST method.
rg --type py -A 5 'export_backup_v2' | grep -E 'requests\.post|requests\.get|requests\.put|requests\.delete|requests\.patch'

Length of output: 124


Script:

#!/bin/bash
# Description: Verify all URL patterns and API routes that reference `export_backup_v2`.

# Test: Search for URL patterns and API routes. Expect: Only occurrences referencing `export_backup_v2`.
rg --type py 'export_backup_v2'

Length of output: 313

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.37%. Comparing base (2490153) to head (4330a58).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8185      +/-   ##
===========================================
+ Coverage    83.35%   83.37%   +0.01%     
===========================================
  Files          388      388              
  Lines        41306    41306              
  Branches      3854     3854              
===========================================
+ Hits         34432    34439       +7     
+ Misses        6874     6867       -7     
Components Coverage Δ
cvat-ui 79.67% <ø> (+0.03%) ⬆️
cvat-server 86.69% <ø> (+<0.01%) ⬆️

@azhavoro
Copy link
Contributor

LGTM, but need to add a test, probably in a separate PR

@azhavoro
Copy link
Contributor

Also please add a changelog entry

Copy link

sonarcloud bot commented Jul 18, 2024

@Marishka17
Copy link
Contributor Author

LGTM, but need to add a test, probably in a separate PR

I was sure that we have such tests, probably the previous version of API was used there, I'll check

@bsekachev bsekachev merged commit b6228da into develop Jul 18, 2024
17 checks passed
@cvat-bot cvat-bot bot mentioned this pull request Jul 18, 2024
@bsekachev bsekachev mentioned this pull request Jul 18, 2024
2 tasks
@bsekachev bsekachev deleted the mk/fix-permissions branch August 13, 2024 09:28
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.

4 participants