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 ordering of frame intersection column on Quality page #8089

Merged
merged 2 commits into from
Jun 27, 2024

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Jun 26, 2024

Motivation and context

Resolved #8022

Before:
ordering-before
After:
ordering-updated

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

    • Corrected the ordering of the frame intersection column on the task quality page.
  • New Features

    • Enhanced filtering in job lists to accept additional types, improving flexibility.
  • Chores

    • Updated cvat-ui package version from 1.63.11 to 1.63.12.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

A fix has been applied to the task quality page in the CVAT project, addressing the sorting functionality for the frame intersection column. This fix updates the relevant onFilter and sorter functions to correctly handle different data types and use appropriate fields for ordering jobs.

Changes

File Change Summary
changelog.d/20240626_104311_klakhov_fix_frame_intersection_ordering.md Documented the fix for ordering of the frame intersection column on the task quality page.
cvat-ui/package.json Updated version from "1.63.11" to "1.63.12".
cvat-ui/src/components/analytics-page/task-quality/job-list.tsx Modified onFilter functions in JobListComponent to accept boolean or Key types and updated sorter function for frame_intersection column to reference frameCount within summary object.

Sequence Diagram(s)

No significant changes to the control flow, so sequence diagrams are not applicable.

Assessment against linked issues

Objective (from linked issue #8022) Addressed Explanation
Jobs are sorted according to the intersection instead of job ID

Poem

In CVAT's code, a fix was born,
To sort by frames where jobs adorn.
No more chaos, order leads,
As intersections now take heed.
Versioned up, the change is bright,
In tasks, all jobs aligned just right! 🌟


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 Jun 26, 2024

@klakhov klakhov marked this pull request as ready for review June 26, 2024 07:52
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 e8002b2 and 416910b.

Files selected for processing (3)
  • changelog.d/20240626_104311_klakhov_fix_frame_intersection_ordering.md (1 hunks)
  • cvat-ui/package.json (1 hunks)
  • cvat-ui/src/components/analytics-page/task-quality/job-list.tsx (4 hunks)
Files skipped from review due to trivial changes (2)
  • changelog.d/20240626_104311_klakhov_fix_frame_intersection_ordering.md
  • cvat-ui/package.json
Additional comments not posted (4)
cvat-ui/src/components/analytics-page/task-quality/job-list.tsx (4)

9-9: Import statement updated to include Key.

This change supports the new type requirements for the onFilter functions, ensuring they can accept a Key type, which is necessary for the improvements in sorting functionality.


123-123: Updated onFilter function for "Stage" column to accept boolean | Key.

This change ensures that the function can handle the appropriate data types for filtering, aligning with the updated import and improving the sorting functionality.


135-135: Updated onFilter function for "Assignee" column to accept boolean | Key.

Aligning with the changes in the "Stage" column, this update ensures consistent and correct data type handling for filtering by assignee.


144-144: Updated sorter function for "Frame intersection" column to use frameCount.

This change is crucial as it addresses the main issue reported in the PR by ensuring that jobs are sorted based on their frame intersection values rather than job IDs. This modification directly impacts the functionality and correctness of the sorting on the Quality page.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.61%. Comparing base (cdf50d3) to head (416910b).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8089      +/-   ##
===========================================
- Coverage    83.62%   83.61%   -0.02%     
===========================================
  Files          383      383              
  Lines        40450    40454       +4     
  Branches      3820     3821       +1     
===========================================
- Hits         33828    33826       -2     
- Misses        6622     6628       +6     
Components Coverage Δ
cvat-ui 79.60% <100.00%> (-0.03%) ⬇️
cvat-server 87.28% <ø> (ø)

@klakhov klakhov merged commit 79927bf into develop Jun 27, 2024
42 checks passed
@klakhov klakhov deleted the kl/fix-frame-intersection-ordering branch June 27, 2024 07:45
@cvat-bot cvat-bot bot mentioned this pull request Jul 2, 2024
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.

UI can't sort jobs by frame intersection with GT job on the task quality page
3 participants