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

Added support for boolean parameters in annotations actions #8798

Merged
merged 3 commits into from
Dec 10, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Dec 9, 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

  • New Features

    • Introduced support for boolean parameters in annotation actions.
    • Added a new CHECKBOX option to action parameters, enhancing flexibility in parameter types.
  • Improvements

    • Updated the annotations actions modal to handle both select and checkbox types, improving user interface interactions and type safety.

@bsekachev bsekachev requested a review from nmanovic as a code owner December 9, 2024 09:22
Copy link
Contributor

coderabbitai bot commented Dec 9, 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

This update introduces support for boolean parameters in annotation actions, enhancing the system's flexibility. Key changes include the addition of a CHECKBOX enumeration value to the ActionParameterType enum, allowing for checkbox options in action parameters. Additionally, the annotations-actions-modal.tsx file has been modified to utilize this new enum, replacing string literals with enumerated types for improved type safety and clarity. The modal's rendering logic has been updated to handle both select and checkbox types, refining the overall action parameter management.

Changes

File Path Change Summary
changelog.d/20241209_110126_sekachev.bs_support_boolean.md Added support for boolean parameters in annotation actions.
cvat-core/src/annotations-actions/base-action.ts Added CHECKBOX value to ActionParameterType enum.
cvat-ui/src/components/annotation-page/annotations-actions/annotations-actions-modal.tsx Updated to import ActionParameterType and modify rendering logic to handle select and checkbox types.

Poem

In the fields where annotations play,
A checkbox joins the fun today! 🐇
With types so clear, no strings to fear,
Our actions dance, oh what a cheer!
Flexibility blooms, as we hop and zoom! 🌼


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 (1)
cvat-ui/src/components/annotation-page/annotations-actions/annotations-actions-modal.tsx (1)

263-272: Consider improving boolean value handling

The current implementation could be more robust in handling boolean values:

  1. The string-to-boolean conversion could handle more cases
  2. The default value handling could be more explicit

Consider this improved implementation:

 if (type === ActionParameterType.CHECKBOX) {
     return (
         <Switch
-            checked={value.toLowerCase() === 'true'}
+            checked={['true', '1', 'yes'].includes(value.toLowerCase())}
             onChange={(val: boolean) => {
-                setValue(String(val));
+                setValue(val ? 'true' : 'false');
             }}
+            defaultChecked={['true', '1', 'yes'].includes(computedDefaultValue.toLowerCase())}
         />
     );
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 61c6a01 and bb9d477.

📒 Files selected for processing (3)
  • changelog.d/20241209_110126_sekachev.bs_support_boolean.md (1 hunks)
  • cvat-core/src/annotations-actions/base-action.ts (1 hunks)
  • cvat-ui/src/components/annotation-page/annotations-actions/annotations-actions-modal.tsx (3 hunks)
🔇 Additional comments (4)
changelog.d/20241209_110126_sekachev.bs_support_boolean.md (1)

1-4: LGTM!

The changelog entry is well-formatted and properly documents the feature addition with a reference to the PR.

cvat-core/src/annotations-actions/base-action.ts (1)

12-12: LGTM!

The addition of CHECKBOX type to ActionParameterType enum is clean and consistent with the existing pattern.

cvat-ui/src/components/annotation-page/annotations-actions/annotations-actions-modal.tsx (2)

28-28: LGTM!

The imports are properly organized and the components are imported from the correct packages.

Also applies to: 33-33


Line range hint 253-272: Verify error handling for invalid boolean values

The current implementation might not handle invalid string values gracefully.

Copy link

sonarqubecloud bot commented Dec 9, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.95%. Comparing base (094c62d) to head (e070721).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8798      +/-   ##
===========================================
+ Coverage    73.92%   73.95%   +0.02%     
===========================================
  Files          409      409              
  Lines        43957    43957              
  Branches      3986     3986              
===========================================
+ Hits         32497    32508      +11     
+ Misses       11460    11449      -11     
Components Coverage Δ
cvat-ui 78.41% <ø> (+0.05%) ⬆️
cvat-server 70.13% <ø> (ø)

@bsekachev bsekachev merged commit 17016de into develop Dec 10, 2024
35 checks passed
@bsekachev bsekachev deleted the bs/support_boolean branch December 11, 2024 08:07
@cvat-bot cvat-bot bot mentioned this pull request Dec 20, 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