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

Fixed couple of issues with copy/paste a mask #8728

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

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 20, 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

    • Resolved issues with copying and pasting masks, ensuring all relevant attributes are transferred correctly.
    • Fixed an error occurring when copying and pasting a mask after opening a job.
  • Improvements

    • Enhanced the mask drawing and editing functionality, allowing for more detailed state management and improved data integrity.
    • Improved clarity in assigning object types during the drawing process for mask shapes.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes introduced in this pull request focus on fixing issues related to the copy and paste functionality of masks within a video annotation application. The updates ensure that attributes associated with masks are correctly copied during paste operations. Additionally, modifications were made to the MasksHandlerImpl class to enhance mask drawing and editing capabilities, including the handling of various properties. The CanvasWrapperComponent class was also updated to refine how object types are assigned during shape drawing, particularly for masks.

Changes

File Path Change Summary
changelog.d/20241121_013447_sekachev.bs.md Fix for error when copying and pasting a mask after opening a job.
changelog.d/20241121_013934_sekachev.bs.md Bug fix for mask attributes not being copied during paste operations.
cvat-canvas/src/typescript/masksHandler.ts Updated MasksHandlerImpl class to include additional properties in onDrawDone and modified edit method for brush tool updates.
cvat-ui/src/components/annotation-page/canvas/views/canvas2d/canvas-wrapper.tsx Modified onCanvasShapeDrawn method to improve object type assignment based on shape type and updated state handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Canvas
    participant MasksHandler
    participant State

    User->>Canvas: Draw Mask
    Canvas->>MasksHandler: onDrawDone
    MasksHandler->>State: Update with attributes (occluded, color, etc.)
    State-->>Canvas: Reflect changes
    User->>Canvas: Copy Mask
    Canvas->>MasksHandler: Copy attributes
    MasksHandler-->>Canvas: Paste Mask with attributes
    Canvas->>User: Display pasted Mask
Loading

🐇 "In the canvas where masks do play,
Attributes now copy, hooray!
With colors and shapes, oh what a sight,
Drawing and pasting, all feels just right.
A hop and a skip, we celebrate,
For every mask, we elevate!" 🐇


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>, please review it.
    • 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 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 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 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 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

sonarcloud bot commented Nov 20, 2024

Please retry analysis of this Pull-Request directly on SonarQube Cloud

Copy link

sonarcloud bot commented Nov 20, 2024

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

🧹 Outside diff range and nitpick comments (2)
cvat-canvas/src/typescript/masksHandler.ts (1)

407-410: LGTM! Consider adding type safety.

The changes correctly implement the copying of mask properties during paste operations, ensuring that attributes, occluded state, color, and object type are preserved from the initial state.

Consider adding type safety by explicitly defining the interface for initialState:

interface MaskInitialState {
    occluded: boolean;
    attributes: Record<string, unknown>;
    color: string;
    objectType: string;
    label: unknown;
}

This would help catch potential type-related issues early in development.

cvat-ui/src/components/annotation-page/canvas/views/canvas2d/canvas-wrapper.tsx (1)

656-657: LGTM! Consider improving readability.

The logic for assigning objectType is correct - forcing ObjectType.SHAPE for masks while falling back to activeObjectType for other shapes.

Consider improving readability by extracting the condition into a more descriptive variable:

-state.objectType = state.shapeType === ShapeType.MASK ?
-  ObjectType.SHAPE : state.objectType ?? activeObjectType;
+const isMaskShape = state.shapeType === ShapeType.MASK;
+state.objectType = isMaskShape ? ObjectType.SHAPE : state.objectType ?? activeObjectType;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 228b676 and a1c6690.

📒 Files selected for processing (4)
  • changelog.d/20241121_013447_sekachev.bs.md (1 hunks)
  • changelog.d/20241121_013934_sekachev.bs.md (1 hunks)
  • cvat-canvas/src/typescript/masksHandler.ts (1 hunks)
  • cvat-ui/src/components/annotation-page/canvas/views/canvas2d/canvas-wrapper.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • changelog.d/20241121_013447_sekachev.bs.md
  • changelog.d/20241121_013934_sekachev.bs.md

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.18%. Comparing base (3eec9fe) to head (a1c6690).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8728   +/-   ##
========================================
  Coverage    74.18%   74.18%           
========================================
  Files          401      401           
  Lines        43510    43513    +3     
  Branches      3950     3953    +3     
========================================
+ Hits         32278    32281    +3     
  Misses       11232    11232           
Components Coverage Δ
cvat-ui 78.50% <ø> (+<0.01%) ⬆️
cvat-server 70.49% <ø> (ø)
---- 🚨 Try these New Features:

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