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-#8709 #8840

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Conversation

rnkp755
Copy link

@rnkp755 rnkp755 commented Dec 18, 2024

Motivation and context

The change is required to provide a consistent UI. There's some flaws in UI. After the current job is switched to the completed state automatically, it still shows the previous state in UI.

How has this been tested?

Only a single react state has been set.

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 Issue #8709 )
  • 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

    • Enhanced user feedback with a success message upon job completion.
  • Bug Fixes

    • Improved layout of the modal confirmation for removing annotations.
  • Refactor

    • Reformatted functions and structures for better readability and consistency.

@rnkp755 rnkp755 requested a review from bsekachev as a code owner December 18, 2024 13:47
Copy link
Contributor

coderabbitai bot commented Dec 18, 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 pull request introduces modifications to the AnnotationMenuComponent in the annotation-menu.tsx file. The changes primarily focus on improving code readability and consistency within the component. The finishJob function has been updated to set the job state to JobState.COMPLETED, and various formatting improvements have been made to the component's structure, including menu items, modal confirmations, and job state submenu.

Changes

File Change Summary
cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx - Updated finishJob function to set job state to JobState.COMPLETED
- Reformatted changeState and changeJobState functions
- Adjusted items array formatting in menuItems
- Improved modal confirmation layout
- Reformatted job state submenu children

Poem

🐰 A rabbit's code review delight,
Formatting clean, each line just right
Menus aligned with careful grace
Consistency finds its perfect place
Annotations dance with newfound might! 🖥️


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

🧹 Nitpick comments (2)
cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx (2)

74-82: Consider enhancing error handling and user feedback

While the implementation is correct, consider these improvements:

  1. Add error handling for failed state updates
  2. Make the success message more specific to the state being updated
 const changeState = useCallback(
     (state: JobState) => {
-        dispatch(updateCurrentJobAsync({ state })).then(() => {
-            message.info('Job state updated', 2);
-            setJobState(jobInstance.state);
-        });
+        dispatch(updateCurrentJobAsync({ state }))
+            .then(() => {
+                message.success(`Job state updated to ${state}`, 2);
+                setJobState(jobInstance.state);
+            })
+            .catch((error) => {
+                message.error(`Failed to update job state: ${error.message}`, 3);
+            });
     },
     [jobInstance],
 );

205-230: Consider adding loading states for better UX

While the menu structure is good, consider adding loading indicators during state transitions to prevent multiple clicks and provide better user feedback.

 const changeJobState = useCallback(
     (state: JobState) => () => {
+        const [isLoading, setIsLoading] = useState(false);
         Modal.confirm({
             title: 'Would you like to update current job state?',
             content: `Job state will be switched to "${state}"`,
             okText: 'Continue',
             cancelText: 'Cancel',
             className: 'cvat-modal-content-change-job-state',
-            onOk: () => changeState(state),
+            onOk: async () => {
+                setIsLoading(true);
+                try {
+                    await changeState(state);
+                } finally {
+                    setIsLoading(false);
+                }
+            },
+            okButtonProps: {
+                loading: isLoading,
+            },
         });
     },
     [changeState],
 );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 851fb7d and e799d22.

📒 Files selected for processing (1)
  • cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx (5 hunks)
🔇 Additional comments (3)
cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx (3)

27-28: LGTM: Import statements are correctly added

The new imports align with the PR's objective to handle job state updates.


Line range hint 56-62: Perfect fix for the UI inconsistency issue

This change directly addresses the reported issue (#8709) by ensuring the UI state is updated immediately when a job is completed. The addition of a success message provides good user feedback.


134-170: LGTM: Modal UI structure improved

The restructuring of the Collapse component using the items prop improves code readability while maintaining the same functionality.

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.

1 participant