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

Improved types corresponding to export actions #8122

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Jul 5, 2024

Motivation and context

Changed some any to correct types, removed unused file

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

  • Improvements

    • Enhanced modal functions to accept more specific parameter types, improving clarity and reducing errors.
    • Added a safety check in the Export Dataset Modal to prevent issues when closing the modal.
  • Refactor

    • Renamed Task to Project in various parts of the codebase for better alignment with updated data models.

Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The changes encompass updating type definitions and enhancing type safety across various parts of the CVAT-UI codebase. The ProjectOrTaskOrJob type replaces any in several functions. Additionally, the Task type has been renamed to Project in multiple locations to improve code clarity. These updates enhance type safety, maintainability, and readability of the code.

Changes

File Change Summary
cvat-ui/src/actions/export-actions.ts Updated function parameters to use ProjectOrTaskOrJob type instead of any.
.../export-dataset/export-dataset-modal.tsx Added a conditional check for instance before dispatching an action.
cvat-ui/src/reducers/index.ts Renamed Task entity to Project and updated type definitions accordingly.

Poem

A rabbit swift in code did hop,
With types and tasks, it made a swap.
From any to specific, it did decide,
And clarity now stands by its side.
The code now gleams, so neat, so clear,
Hurray for changes, let’s all cheer!
🐇✨


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

sonarcloud bot commented Jul 5, 2024

@klakhov klakhov marked this pull request as ready for review July 5, 2024 08:45
@klakhov klakhov requested a review from bsekachev as a code owner July 5, 2024 08:45
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 c9f1cff and e09f0bd.

Files selected for processing (3)
  • cvat-ui/src/actions/export-actions.ts (2 hunks)
  • cvat-ui/src/components/export-dataset/export-dataset-modal.tsx (1 hunks)
  • cvat-ui/src/reducers/index.ts (7 hunks)
Additional comments not posted (7)
cvat-ui/src/actions/export-actions.ts (4)

28-28: Improved Type Safety

The parameter type has been updated to ProjectOrTaskOrJob, enhancing type safety and clarity.


31-31: Improved Type Safety

The parameter type has been updated to ProjectOrTaskOrJob, enhancing type safety and clarity.


64-64: Improved Type Safety

The parameter type has been updated to ProjectOrTaskOrJob, enhancing type safety and clarity.


67-67: Improved Type Safety

The parameter type has been updated to ProjectOrTaskOrJob, enhancing type safety and clarity.

cvat-ui/src/components/export-dataset/export-dataset-modal.tsx (1)

96-97: Prevent Potential Errors

The conditional check for instance before dispatching the closeExportDatasetModal action prevents potential errors when instance is not defined.

cvat-ui/src/reducers/index.ts (2)

115-131: Improved Type Safety

The modalInstance type has been updated from any | null to Project | Task | Job | null, enhancing type safety and clarity.


Line range hint 140-164:
Improved Type Safety

The modalInstance type has been updated from any | null to Project | Task | Job | null, enhancing type safety and clarity.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.27%. Comparing base (b17d293) to head (e09f0bd).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8122      +/-   ##
===========================================
- Coverage    83.62%   83.27%   -0.35%     
===========================================
  Files          383      389       +6     
  Lines        40507    41274     +767     
  Branches      3830     3855      +25     
===========================================
+ Hits         33873    34370     +497     
- Misses        6634     6904     +270     
Components Coverage Δ
cvat-ui 79.39% <76.49%> (-0.25%) ⬇️
cvat-server 86.75% <75.90%> (-0.51%) ⬇️

@bsekachev bsekachev merged commit e76ccf8 into develop Jul 8, 2024
42 checks passed
@bsekachev bsekachev deleted the kl/improve-actions-types branch July 8, 2024 11:05
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.

3 participants