cvat
cvat copied to clipboard
Added ability to copy/paste annotation guide with assets
Motivation and context
Related #6536
How has this been tested?
Checklist
- [x] I submit my changes into the
developbranch - [x] 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
- [x] 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
- Resolved an issue where copying/pasting annotation guides with assets between different resources failed due to an error message.
-
Refactor
- Renamed
GuidePagecomponent toAnnotationGuidePageand refactored logic for fetching and saving guides. - Updated component structure and behavior in the annotation guide editor.
- Renamed
-
Style
- Adjusted the height property in the annotation guide editor for better layout consistency.
-
New Features
- Added a method to handle updating related assets in the annotation guides.
[!IMPORTANT]
Review skipped
Auto incremental reviews are disabled on this repository.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
The recent changes address a bug related to copying/pasting annotation guides with assets, refine the GuidePage component by renaming it to AnnotationGuidePage and adjusting its logic, and modify asset handling in the backend by introducing a new method to update related assets. These updates aim to improve the user experience and streamline the backend processes for managing annotation guides and their associated assets.
Changes
| File(s) | Change Summary |
|---|---|
changelog.d/20240605_154324_boris_fix_anno_guide.md |
Added a new changelog entry detailing the fix for the annotation guide asset issue. |
cvat-ui/src/components/md-guide/guide-page.tsx |
Renamed GuidePage to AnnotationGuidePage, refactored guide fetching/saving logic, updated file insertion handling, and adjusted component structure. |
cvat-ui/src/components/md-guide/styles.scss |
Updated .cvat-guide-page-editor-wrapper to set height to calc(100% - $grid-unit-size * 16). |
cvat/apps/engine/permissions.py |
Simplified the create method in the Scopes class by removing unnecessary reassignment and logic. |
cvat/apps/engine/serializers.py |
Removed the _update_assets call from the save method in the create method. |
cvat/apps/engine/views.py |
Added _update_related_assets method to AnnotationGuidesViewSet and modified perform_create, perform_update, and perform_destroy methods to call _update_related_assets. Added imports for re, shutil, and contextlib.suppress. |
Poem
In fields where code and bugs reside,
A rabbit hops with joy and pride.
Guides now copy, assets stay,
No more errors in our way.
With pages named and styles set,
Our work improved, no more regret.
So cheers to code both swift and bright,
We hop ahead, our future's light! πβ¨
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto 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.yamlfile 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.
Codecov Report
Attention: Patch coverage is 9.61538% with 47 lines in your changes missing coverage. Please review.
Project coverage is 83.33%. Comparing base (
b4cc2ff) to head (3102a29).
Additional details and impacted files
@@ Coverage Diff @@
## develop #7989 +/- ##
===========================================
- Coverage 83.36% 83.33% -0.04%
===========================================
Files 388 388
Lines 41315 41339 +24
Branches 3855 3855
===========================================
+ Hits 34443 34450 +7
- Misses 6872 6889 +17
| Components | Coverage Ξ | |
|---|---|---|
| cvat-ui | 79.67% <ΓΈ> (+0.03%) |
:arrow_up: |
| cvat-server | 86.61% <9.61%> (-0.10%) |
:arrow_down: |
Quality Gate passed
Issues
1 New issue
0 Accepted issues
Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code
Quality Gate passed
Issues
2 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code