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 missing lock logic when dragging skeleton points #8084

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Jun 25, 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
    • Improved drag behavior by adding a condition to respect the lock property of elements.

Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

The change introduced a conditional check to control the drag behavior in the draggable method of the CanvasViewImpl class, based on the lock property of elementState. This ensures elements are only draggable if they are not locked, enhancing the interactivity and functionality of the canvas.

Changes

File Change Summary
cvat-canvas/src/typescript/canvasView.ts Added a conditional check for elementState.lock in the draggable method call within the CanvasViewImpl class.

Poem

In the canvas world of CodeRabbit's realm,
Elements lock, in order to helm.
The drag now dances, only when free,
A change so small, yet filled with glee.
Code rides swift, through logic's air,
Ensuring our canvas is handled with care. 🐇🎨


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 Configration 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 Jun 25, 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7aa699d and c4a972e.

Files selected for processing (1)
  • cvat-canvas/src/typescript/canvasView.ts (1 hunks)
Additional comments not posted (1)
cvat-canvas/src/typescript/canvasView.ts (1)

1226-1236: Review of the draggable function logic for skeleton points

The implementation of the draggable function for skeleton points now checks the lock property before enabling drag functionality. This is a crucial fix as it ensures that locked elements are not draggable, which maintains the integrity of the data and prevents accidental modifications.

  • Correctness: The use of the lock property to conditionally enable dragging is correct and aligns with typical UI behavior in similar applications.
  • Performance: The changes should not negatively impact performance as they introduce a simple conditional check.
  • Security: No security concerns with this change.
  • Maintainability: The change is localized and does not introduce any complex dependencies, making it easy to maintain.

Overall, this change effectively addresses the issue of missing lock logic when dragging skeleton points and should be included in the final merge.

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 20.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 83.61%. Comparing base (7aa699d) to head (c4a972e).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8084      +/-   ##
===========================================
- Coverage    83.61%   83.61%   -0.01%     
===========================================
  Files          383      383              
  Lines        40449    40450       +1     
  Branches      3819     3820       +1     
===========================================
- Hits         33822    33821       -1     
- Misses        6627     6629       +2     
Components Coverage Δ
cvat-ui 79.59% <20.00%> (-0.01%) ⬇️
cvat-server 87.28% <ø> (-0.01%) ⬇️

@bsekachev bsekachev merged commit 8c4fc83 into develop Jun 25, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/fixed_lock branch June 26, 2024 06:15
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.

None yet

2 participants