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

Fix: Gt annotations can be shown in standard mode #8675

Merged
merged 4 commits into from
Nov 13, 2024
Merged

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Nov 11, 2024

Motivation and context

Resolves #8627

To reproduce the issue:

  1. Create task with gt/honeypots
  2. Add annotations to gt job
  3. Go to normal job in review mode, enable show gt annotations
  4. Go back to the task open the same job/another job
  5. Gt annotations will be visible in standard mode

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

    • Resolved an issue preventing ground truth annotations from displaying in standard mode.
  • Improvements

    • Enhanced job closure functionality to reset ground truth visibility when a job is closed.
    • Improved handling of image filters to maintain the current processed image state upon successful job retrieval.

Copy link
Contributor

coderabbitai bot commented Nov 11, 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

This pull request introduces a fix for displaying ground truth (GT) annotations in standard mode, addressing an issue where these annotations were incorrectly shown. Additionally, it modifies the settings reducer to handle the closing of jobs, ensuring that the visibility of ground truth annotations is reset when a job is closed. The changes enhance the functionality related to annotation visibility and maintain the overall structure of the reducer.

Changes

File Change Summary
changelog.d/20241111_142755_klakhov_fix_show_gt.md Introduced a fix to display ground truth annotations in standard mode.
cvat-ui/src/reducers/settings-reducer.ts Added a new case for CLOSE_JOB to reset showGroundTruth to false; modified GET_JOB_SUCCESS to maintain processed image state for filters.

Assessment against linked issues

Objective Addressed Explanation
GT annotations can sometimes show up in the Standard mode (#8627)

🐰 In the meadow, bright and spry,
Ground truths now dance, oh my, oh my!
When jobs are closed, they fade from sight,
A fix so clever, it feels just right!
Hooray for changes, let’s hop and play,
Annotations clear, come what may! 🌼


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 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

🧹 Outside diff range and nitpick comments (1)
cvat-ui/src/reducers/settings-reducer.ts (1)

Line range hint 462-470: Consider adding documentation for GT visibility behavior.

The relationship between job/workspace changes and ground truth visibility might not be immediately obvious to future maintainers. Consider adding a comment explaining why showGroundTruth needs to be reset in these cases.

Example comment:

        case AnnotationActionTypes.CLOSE_JOB:
        case AnnotationActionTypes.CHANGE_WORKSPACE: {
+           // Reset ground truth visibility to prevent unintended GT annotation display
+           // when switching between jobs or workspaces
            return {
                ...state,
                shapes: {
                    ...state.shapes,
                    showGroundTruth: false,
                },
            };
        }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ed33852 and 45ec4b4.

📒 Files selected for processing (2)
  • changelog.d/20241111_142755_klakhov_fix_show_gt.md (1 hunks)
  • cvat-ui/src/reducers/settings-reducer.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • changelog.d/20241111_142755_klakhov_fix_show_gt.md
🔇 Additional comments (1)
cvat-ui/src/reducers/settings-reducer.ts (1)

Line range hint 462-470: LGTM! Implementation aligns with PR objectives.

The changes correctly reset ground truth annotation visibility when closing a job or changing workspace, which addresses the reported issue of GT annotations being unexpectedly visible in standard mode.

Let's verify all places where ground truth visibility is managed:

✅ Verification successful

Based on the search results, I can now verify the review comment comprehensively. Let me generate the final response:

Ground Truth visibility management is properly implemented across the codebase

The implementation correctly handles Ground Truth visibility state through:

  • Proper state initialization (showGroundTruth: false)
  • Consistent state updates via CHANGE_SHOW_GROUND_TRUTH action
  • Correct reset behavior on job close and workspace change
  • Complete UI integration in components:
    • Objects sidebar (objects-list.tsx, objects-list-header.tsx)
    • Canvas wrapper (canvas-wrapper.tsx)
    • Issues components (issues-list.tsx, issues-aggregator.tsx)

The changes align with the existing state management patterns and ensure Ground Truth annotations are properly hidden when expected.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find all code that manages ground truth visibility to ensure completeness of the fix

# Test 1: Search for direct state management of showGroundTruth
echo "=== Searching for showGroundTruth state management ==="
rg "showGroundTruth"

# Test 2: Search for related action types to ensure proper state transitions
echo "=== Searching for related action types ==="
rg "CHANGE_SHOW_GROUND_TRUTH|CLOSE_JOB|CHANGE_WORKSPACE"

# Test 3: Search for ground truth related UI components
echo "=== Searching for GT-related UI components ==="
rg -t tsx -t ts "groundTruth|GT"

Length of output: 6403

@codecov-commenter
Copy link

codecov-commenter commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.19%. Comparing base (5520212) to head (dc06dc2).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8675      +/-   ##
===========================================
- Coverage    74.19%   74.19%   -0.01%     
===========================================
  Files          401      401              
  Lines        43504    43496       -8     
  Branches      3950     3950              
===========================================
- Hits         32278    32272       -6     
+ Misses       11226    11224       -2     
Components Coverage Δ
cvat-ui 78.51% <ø> (+<0.01%) ⬆️
cvat-server 70.50% <100.00%> (-0.02%) ⬇️

@@ -460,6 +459,7 @@ export default (state = defaultState, action: AnyAction): SettingsState => {
},
};
}
case AnnotationActionTypes.CLOSE_JOB:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would propose to use GET_JOB_SUCCESS instead

Copy link

sonarcloud bot commented Nov 13, 2024

@klakhov klakhov merged commit 6d929fa into develop Nov 13, 2024
34 checks passed
@klakhov klakhov deleted the kl/fix-show-gt branch November 14, 2024 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GT annotations can sometimes show up in the Standard mode
3 participants