Predefined number of points in single shape mode disabled by default

[bsekachev]

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 initialization of state properties in the SingleShapeSidebar component for better handling of default values.

• Chores

  • Refined state management logic without affecting existing functionality or user interactions.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the SingleShapeSidebar component within the single-shape-sidebar.tsx file. The modifications involve updating the initialization of the component's reducer state, specifically the pointsCountIsPredefined and pointsCount properties. The former now initializes based on the presence of defaultPointsCount, and the latter uses the nullish coalescing operator to ensure a default value of 1 if defaultPointsCount is null. The overall functionality and structure of the component remain unchanged.

Changes

File	Change Summary
cvat-ui/src/components/annotation-page/single-shape-workspace/...	Updated SingleShapeSidebar to initialize pointsCountIsPredefined based on defaultPointsCount and set pointsCount using nullish coalescing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Reducer

    User->>Sidebar: Interacts with component
    Sidebar->>Reducer: Initialize state
    Reducer-->>Sidebar: Return initial state
    Sidebar-->>User: Render updated UI

Loading

🐰 In the sidebar, a change took place,
Points now dance with a new embrace.
No more hardcoded, just look and see,
A dynamic start, as bright as can be!
With defaults set, the flow is clear,
Hopping along, we have no fear! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f0a578a and 12dab54.

📒 Files selected for processing (1)

• cvat-ui/src/components/annotation-page/single-shape-workspace/single-shape-sidebar/single-shape-sidebar.tsx (1 hunks)

🔇 Additional comments (1)

cvat-ui/src/components/annotation-page/single-shape-workspace/single-shape-sidebar/single-shape-sidebar.tsx (1)

240-241: LGTM! The changes align with the PR objective.

The modifications correctly implement the requirement to disable predefined points by default:

1. pointsCountIsPredefined is now initialized based on whether defaultPointsCount exists
2. pointsCount uses the nullish coalescing operator to default to 1 when defaultPointsCount is null

The implementation is clean and maintains backward compatibility while changing the default behavior.

Let's verify the usage of defaultPointsCount across the codebase:

✅ Verification successful

The changes are safe and correctly implemented

The codebase analysis shows that defaultPointsCount is used consistently across the application:

• It's properly typed as number | null in the Redux state and actions
• It's correctly parsed from URL parameters in annotation-page.tsx
• It's only used for initialization in the single shape sidebar component
• The test files demonstrate its usage with predefined values, which will continue to work
• The documentation accurately describes its purpose as an optional URL parameter

The changes maintain backward compatibility while implementing the new default behavior:

1. When defaultPointsCount is provided via URL, it works as before
2. When not provided, it defaults to null, disabling predefined points count
3. The nullish coalescing operator ensures a fallback to 1 point

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any other components that might be affected by defaultPointsCount
# Test: Search for defaultPointsCount usage. Expect: Only usage in query parameters and initialization.
rg "defaultPointsCount" -A 3

Length of output: 7189

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.29%. Comparing base (f0a578a) to head (12dab54).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8635      +/-   ##
===========================================
- Coverage    74.33%   74.29%   -0.04%     
===========================================
  Files          401      401              
  Lines        43395    43395              
  Branches      3945     3945              
===========================================
- Hits         32258    32241      -17     
- Misses       11137    11154      +17     

Components	Coverage Δ
cvat-ui	78.65% <ø> (ø)
cvat-server	70.56% <ø> (-0.08%)	⬇️