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 issue: fit:canvas may not generate in some cases #8750

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 28, 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 an issue where the canvas fitting event was not triggered correctly from the controls sidebar.
  • Improvements

    • Enhanced the logic for canvas scaling and positioning, reducing unnecessary updates and notifications.
    • Streamlined event handling for canvas interactions, ensuring consistent behavior during user actions.
  • Refactor

    • Updated comments and structure for better clarity and maintainability in canvas fitting logic and event dispatching.

@bsekachev bsekachev requested a review from nmanovic as a code owner November 28, 2024 09:29
Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

This update addresses issues related to the fit:canvas event handling and refactors the fit method within the CanvasModelImpl class. The changes ensure that the fit event is triggered correctly when fitting the canvas from the controls sidebar. Additionally, the logic for calculating canvas scale and position has been improved for clarity and maintainability. The event handling in the CanvasViewImpl class has also been streamlined, enhancing the overall responsiveness of the canvas to user interactions.

Changes

File Path Change Summary
changelog.d/20241128_112750_sekachev.bs_fixed_fit.md Fixed an issue where the fit:canvas event was not generated when fitting the canvas from the controls sidebar.
cvat-canvas/src/typescript/canvasModel.ts Refactored the fit method in CanvasModelImpl to improve clarity and maintainability. Introduced temporary variables for scale and position calculations, and streamlined the conditions for updating these properties to reduce unnecessary updates and notifications. Comments were updated to reflect the new logic.
cvat-canvas/src/typescript/canvasView.ts Modified the CanvasViewImpl class to centralize canvas.fit event dispatching within the notify method based on the UpdateReasons.IMAGE_FITTED condition. Updated the onMouseUp method to disable drag actions for left and middle mouse buttons. Adjusted event handling logic for better clarity and consistency in response to user interactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CanvasView
    participant CanvasModel

    User->>CanvasView: Trigger fit action
    CanvasView->>CanvasModel: Call fit method
    CanvasModel->>CanvasModel: Calculate updatedScale, updatedTop, updatedLeft
    CanvasModel->>CanvasView: Notify changes if necessary
    CanvasView->>User: Update canvas view
Loading

🐰 "In the canvas realm, where colors blend,
A fit event now finds its perfect end.
With logic refined, and clarity bright,
Our canvas dances, a joyful sight!
So hop along, dear friends, rejoice,
For every change, we cheer and voice!" 🎨✨


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
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 (3)
changelog.d/20241128_112750_sekachev.bs_fixed_fit.md (1)

1-4: Consider enhancing the changelog entry with additional details.

While the current entry correctly describes the fix, consider adding more context to help users understand:

  • What causes this issue (e.g., specific user actions or conditions)
  • The impact on users (e.g., visual or functional consequences)
  • The technical solution implemented (e.g., event handling improvements)

Here's a suggested enhancement:

 ### Fixed

-fit:canvas event is not generated if to fit it from the controls sidebar
-(<https://github.com/cvat-ai/cvat/pull/8750>)
+- Fixed an issue where the fit:canvas event was not being generated when using the fit
+  operation from the controls sidebar. This could prevent proper canvas fitting and
+  affect the viewport adjustment. The fix improves event handling to ensure consistent
+  behavior across all canvas fitting operations.
+  (<https://github.com/cvat-ai/cvat/pull/8750>)
cvat-canvas/src/typescript/canvasModel.ts (1)

708-717: Good optimization! Added check before updating values

The new condition prevents unnecessary updates and notifications by checking if values have actually changed. The added comment about fittedScale helps explain its relationship with zooming.

Consider adding type annotations to the temporary variables for better type safety:

-const updatedScale = Math.min(Math.max(updatedScale, FrameZoom.MIN), FrameZoom.MAX);
-const updatedTop = this.data.canvasSize.height / 2 - this.data.imageSize.height / 2;
-const updatedLeft = this.data.canvasSize.width / 2 - this.data.imageSize.width / 2;
+const updatedScale: number = Math.min(Math.max(updatedScale, FrameZoom.MIN), FrameZoom.MAX);
+const updatedTop: number = this.data.canvasSize.height / 2 - this.data.imageSize.height / 2;
+const updatedLeft: number = this.data.canvasSize.width / 2 - this.data.imageSize.width / 2;
cvat-canvas/src/typescript/canvasView.ts (1)

1893-1901: Dispatch 'canvas.fit' event when image is fitted

This change correctly ensures the canvas.fit event is dispatched when the image is fitted, addressing the issue where the event was not generated in some cases.

Consider adding unit tests to verify the canvas.fit event dispatch to prevent future regressions.

Would you like assistance in creating the unit tests or opening a GitHub issue to track this task?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4f7391d and e613c70.

📒 Files selected for processing (3)
  • changelog.d/20241128_112750_sekachev.bs_fixed_fit.md (1 hunks)
  • cvat-canvas/src/typescript/canvasModel.ts (1 hunks)
  • cvat-canvas/src/typescript/canvasView.ts (1 hunks)
🔇 Additional comments (1)
cvat-canvas/src/typescript/canvasModel.ts (1)

690-706: LGTM! Improved readability with temporary variables

The refactoring improves code clarity by:

  • Using descriptive temporary variables for scale and position calculations
  • Maintaining clear separation between angle-dependent scale calculations

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.06%. Comparing base (7d0205b) to head (e613c70).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8750   +/-   ##
========================================
  Coverage    74.05%   74.06%           
========================================
  Files          409      409           
  Lines        43783    43790    +7     
  Branches      3984     3986    +2     
========================================
+ Hits         32425    32433    +8     
+ Misses       11358    11357    -1     
Components Coverage Δ
cvat-ui 78.38% <100.00%> (+0.01%) ⬆️
cvat-server 70.34% <100.00%> (+<0.01%) ⬆️

@bsekachev bsekachev merged commit 86bd1f1 into develop Dec 2, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/fixed_fit branch December 3, 2024 06:25
@cvat-bot cvat-bot bot mentioned this pull request Dec 9, 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