Refactored updating a job instance on client side

bsekachev commented 2 weeks ago

Motivation and context

Resolved #7241

How has this been tested?

Checklist

[x] 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)
[x] I have increased versions of npm packages if it is necessary (cvat-canvas, cvat-core, cvat-data and cvat-ui)

License

[x] 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
- Added new functionality to support detailed job state updates and transitions.
- Introduced a new component, RemoveConfirmComponent, in the Single Shape Workspace.
- Enhanced the Single Shape Workspace UI to support skipping or submitting results based on the next frame status.
Bug Fixes
- Updated various dispatch functions to improve async action handling and error management.
- Corrected the condition for workspace inclusion in the CanvasWrapperComponent.
Documentation
- Added user guidance to the Single Shape annotation mode documentation.
Tests
- Added new Cypress test cases for single object annotation mode, including drawing with disabled "autoNext," object activation, and object removal shortcuts.
Style
- Renamed CSS class .cvat-single-shape-annotation-sidebar-skip-wrapper to .cvat-single-shape-annotation-sidebar-finish-frame-wrapper.

coderabbitai[bot] commented 2 weeks ago

[!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 changes enhance the handling of job states, transitions specific actions to utilize ThunkDispatch, and introduce new UI features. Key improvements include better type usage in asynchronous actions, updated UI handling for single shape annotation, and fixes for handling job state transitions. The changes aim to streamline the annotation process and ensure smoother interaction across the CVAT UI.

Changes

File(s)	Summary
`cvat-ui/src/actions/annotation-actions.ts`	Updated annotation actions to use `ThunkDispatch` and added job state transition handling.
`cvat-ui/src/actions/cloud-storage-actions.ts`	Modified type declarations for dispatch functions to use `ThunkDispatch`.
`cvat-ui/src/actions/projects-actions.ts`	Updated function signatures to use `ThunkDispatch`.
`cvat-ui/src/actions/tasks-actions.ts`	Streamlined type definitions for asynchronous actions using `ThunkDispatch`.
`cvat-ui/src/actions/webhooks-actions.ts`	Adjusted `getWebhooksAsync` to use `ThunkDispatch`.
`cvat-ui/src/components/annotation-page/canvas/.../canvas-wrapper.tsx`	Included `Workspace.SINGLE_SHAPE` in workspace condition.
`cvat-ui/src/components/annotation-page/.../single-shape-sidebar.tsx`	Added new actions like `nextFrame` and updated UI elements for frame handling.
`cvat-ui/src/components/annotation-page/.../single-shape-workspace.tsx`	Integrated `RemoveConfirmComponent` for removing shapes.
`cvat-ui/src/components/annotation-page/.../styles.scss`	Renamed `.cvat-single-shape-annotation-sidebar-skip-wrapper` to `.cvat-single-shape-annotation-sidebar-finish-frame-wrapper`.
`cvat-ui/src/components/annotation-page/.../remove-confirm.tsx`	Enhanced `useSelector` hook and updated `removeObjectAsync` function.
`cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx`	Refactored to dispatch actions using `useDispatch`.
`cvat-ui/src/components/annotation-page/top-bar/left-group.tsx`	Replaced `AnnotationMenuContainer` with `AnnotationMenuComponent`.
`cvat-ui/src/containers/.../canvas-context-menu.tsx`	Changed `readonly` property in `OwnProps` interface to an optional boolean.
`cvat-ui/src/reducers/index.ts`	Added `jobUpdating` property to `NotificationsState` interface.
`cvat-ui/src/reducers/notifications-reducer.ts`	Included `jobUpdating` handling for `UPDATE_CURRENT_JOB_FAILED` action.
`site/content/en/docs/manual/advanced/single-shape.md`	Updated hints for Single Shape annotation mode.
`tests/cypress/e2e/features/single_object_annotation.js`	Added new test cases, removed `submitJob()` function, and updated handling for PATCH requests.

Sequence Diagram(s)

No diagrams needed as changes revolve around type updates and UI adjustments, which are too specific and varied.

Assessment against linked issues

Objective	Addressed	Explanation
Workers should be able to update job status (#7241)	✅

Poem

In code so sleek, the changes flow, Dispatch with Thunk, actions in tow. Transition jobs with ease anew, Single shapes in frames pursue. A worker's task made clearer now, A bunny's hop, take a bow! 🐰🎉

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.