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

UI: don't send the cleanup parameter on interactive detector calls #8075

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Jun 24, 2024

Motivation and context

The server doesn't support it, and it wouldn't make sense anyway. Potentially it could be handled on the client side, but right now it isn't.

This should've been a part of #8074, but I didn't realize there was a similar issue with cleanup as with convMaskToPoly.

How has this been tested?

Manual testing.

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 cleanup parameter was not correctly deconstructed in the annotation tools control, improving the reliability of the convMaskToPoly feature.

The server doesn't support it, and it wouldn't make sense anyway.
Potentially it could be handled on the client side, but right now it isn't.
@SpecLad SpecLad requested a review from bsekachev as a code owner June 24, 2024 17:39
Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

A small adjustment was made to the ToolsControlComponent class in the file tools-control.tsx by modifying the deconstruction of the body object to include the cleanup parameter. This refactor is focused on improving code clarity and potentially preparing for future uses of the cleanup property.

Changes

File Path Change Summary
cvat-ui/src/components/annotation-page/standard-workspace/controls-side-bar/tools-control.tsx Addition of the cleanup parameter in the deconstruction of the body object within ToolsControlComponent.

Poem

In a realm of code, with keys and clicks,
A new tweak emerges, nifty and slick.
With a cleanup tag, now in the flow,
Our functions shine, and efficiency grows.
🐇✨🌟


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.

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 78fa7cf and 97936bf.

Files selected for processing (1)
  • cvat-ui/src/components/annotation-page/standard-workspace/controls-side-bar/tools-control.tsx (1 hunks)
Additional comments not posted (1)
cvat-ui/src/components/annotation-page/standard-workspace/controls-side-bar/tools-control.tsx (1)

1236-1236: Approved: Removal of unsupported parameters.

The exclusion of cleanup from the destructured body object aligns with the PR objective to prevent sending unsupported parameters to the server, enhancing the robustness and correctness of the API interaction.

However, ensure that the removal of convMaskToPoly does not affect other functionalities where this parameter might be expected.

@SpecLad SpecLad merged commit 25fc37b into cvat-ai:develop Jun 25, 2024
32 checks passed
@SpecLad SpecLad deleted the interactive-no-cleanup branch June 25, 2024 09:51
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.

None yet

2 participants