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 exception 'this.el.node.getScreenCTM() is null' when cancel drawing shape for any tracker #8080

Merged
merged 2 commits 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
    • Addressed an exception that occurred when canceling the drawing of shapes in the application.

Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

The latest update introduces a fix for an exception related to canceling the drawing of shapes within trackers in the application. This is achieved by adding a new cancelled boolean property to the InteractionHandlerImpl class, which is used to manage and halt ongoing drawing operations effectively.

Changes

Files/Modules Change Summary
cvat-canvas/src/typescript/interactionHandler.ts Introduced a cancelled boolean property in the InteractionHandlerImpl class to handle drawing cancellations.
changelog.d/20240625_125241_boris.md Added a changelog entry corresponding to the introduction of the new cancellation fix for drawing shapes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InteractionHandlerImpl
    participant Canvas
    
    User->>InteractionHandlerImpl: Start drawing shape
    InteractionHandlerImpl->>Canvas: Initialize drawing shape
    User->>InteractionHandlerImpl: Cancel drawing shape
    InteractionHandlerImpl->>InteractionHandlerImpl: Set cancelled to true
    Canvas-->>InteractionHandlerImpl: Acknowledge cancellation
    InteractionHandlerImpl-->>User: Drawing operation cancelled
Loading

Poem

In the land of code, new features unveiled,
A bug was squashed, we prevailed. 🚀
With a boolean switch, cessation’s our friend,
Drawing shapes, now easy to end.
Hooray, for the canvas is now free,
To start, to stop, as we decree. 🎨


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.

@bsekachev bsekachev requested a review from nmanovic as a code owner June 25, 2024 09:55
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 25fc37b and afcaf68.

Files selected for processing (2)
  • changelog.d/20240625_125241_boris.md (1 hunks)
  • cvat-canvas/src/typescript/interactionHandler.ts (5 hunks)
Files skipped from review due to trivial changes (1)
  • changelog.d/20240625_125241_boris.md
Additional comments not posted (4)
cvat-canvas/src/typescript/interactionHandler.ts (4)

42-42: Addition of cancelled property to manage interaction flow

The addition of the cancelled boolean property is a good approach to manage the state of drawing operations, especially to handle cancellations effectively. This change aligns with the PR's objective to fix the exception during shape drawing cancellation.


197-199: Proper handling of the cancelled state during rectangle interaction

This code ensures that if the interaction has been cancelled, no further processing occurs, which is crucial for avoiding unwanted side-effects after a cancellation event. This is a good use of the cancelled property to control the flow in the interactRectangle method.


542-563: Management of interaction state based on enabled property

The management of the cancelled state in response to the enabled property of interactionData is well-implemented. It ensures that when interaction is enabled, the cancelled flag is reset, and the interaction setup is correctly initialized or continued based on the state of interactionData.


592-592: Effective use of the cancelled property in the cancel method

Setting the cancelled property to true in the cancel method is straightforward and effectively communicates the intent to stop any ongoing interactions. This change supports the overall goal of managing drawing cancellations properly.

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 83.66%. Comparing base (a53e2bf) to head (afcaf68).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8080      +/-   ##
===========================================
+ Coverage    83.64%   83.66%   +0.02%     
===========================================
  Files          383      383              
  Lines        40439    40448       +9     
  Branches      3815     3819       +4     
===========================================
+ Hits         33825    33841      +16     
+ Misses        6614     6607       -7     
Components Coverage Δ
cvat-ui 79.68% <80.95%> (+0.05%) ⬆️
cvat-server 87.29% <ø> (-0.01%) ⬇️

@bsekachev bsekachev merged commit ef0b366 into develop Jun 25, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/fixed_exception branch June 26, 2024 06:15
@cvat-bot cvat-bot bot mentioned this pull request Jul 2, 2024
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