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 attributes update on cvat-canvas #8137

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Jul 8, 2024

Motivation and context

Resolved #8133

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

  • Improvement
    • Enhanced the clarity and accuracy of attribute names displayed within the canvas view by using a more precise mapping from attribute IDs to names.

Copy link
Contributor

coderabbitai bot commented Jul 8, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update to the CanvasViewImpl class in canvasView.ts optimizes the text display logic for attributes. By introducing a mapping from attribute IDs to names, the new approach enhances the clarity and accuracy of how attribute names are shown in the canvas view.

Changes

Files Change Summary
cvat-canvas/src/typescript/canvasView.ts Enhanced text content updating logic with a new constant attrNames mapping attribute IDs to names

Poem

In the canvas view where code is tight,
Attributes once vague now shine bright.
IDs to names, a mapping so clear,
Enhances our view with no fear.
Cheers to changes small yet grand,
A better canvas, a coder's wonderland 🐰✨


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 July 8, 2024 10:31
Copy link

sonarqubecloud bot commented Jul 8, 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 e76ccf8 and 7200f4b.

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

2401-2402: Improvement: Mapping of attribute IDs to names.

The introduction of the attrNames mapping improves readability and maintainability by making attribute name lookups more efficient.


2408-2408: Correctness: Ensure attribute name exists.

Before updating the text content, ensure that the attribute name exists in the attrNames mapping to avoid potential runtime errors.

- span.textContent = `${attrNames[attrID]}: ${state.attributes[attrID]}`;
+ if (attrNames[attrID]) {
+     span.textContent = `${attrNames[attrID]}: ${state.attributes[attrID]}`;
+ }

2986-2986: Improvement: Mapping of attribute IDs to names.

The introduction of the attrNames mapping improves readability and maintainability by making attribute name lookups more efficient.

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.27%. Comparing base (b17d293) to head (f3d2d4f).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8137      +/-   ##
===========================================
- Coverage    83.62%   83.27%   -0.35%     
===========================================
  Files          383      389       +6     
  Lines        40507    41272     +765     
  Branches      3830     3855      +25     
===========================================
+ Hits         33873    34369     +496     
- Misses        6634     6903     +269     
Components Coverage Δ
cvat-ui 79.39% <76.43%> (-0.25%) ⬇️
cvat-server 86.75% <75.90%> (-0.51%) ⬇️

@bsekachev bsekachev merged commit 13155bc into develop Jul 8, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/fixed_attr_update branch July 10, 2024 09:25
@cvat-bot cvat-bot bot mentioned this pull request Jul 15, 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.

Uninitialized text content.
2 participants