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: player navigates to removed frames when playing #8747

Merged
merged 6 commits into from
Dec 2, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 27, 2024

Motivation and context

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 navigation to removed frames during playback, enhancing playback functionality.
  • New Features

    • Improved playback control by preventing concurrent executions of the play function.
    • Streamlined frame transition logic for simplified playback experience.

@bsekachev bsekachev requested a review from nmanovic as a code owner November 27, 2024 12:58
Copy link
Contributor

coderabbitai bot commented Nov 27, 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 update addresses a bug in the playback feature, preventing navigation to non-existent frames. It also modifies the AnnotationTopBarContainer component by removing unnecessary imports and refactoring the play method to enhance playback control. The method now includes a lockedPlayTimeout property to prevent concurrent playback executions and simplifies frame transition logic by removing checks for playback speeds.

Changes

File Path Change Summary
changelog.d/20241127_145739_sekachev.bs_simplified_navigation.md Fixes a bug preventing navigation to removed frames during playback.
cvat-ui/src/containers/annotation-page/top-bar/top-bar.tsx Refactors AnnotationTopBarContainer: removes imports for JobType and DimensionType, adds lockedPlayTimeout to prevent concurrent playback, and simplifies the play method by removing frame speed checks. Constructor updated to initialize lockedPlayTimeout.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AnnotationTopBarContainer
    participant PlaybackLogic

    User->>AnnotationTopBarContainer: Start Playback
    AnnotationTopBarContainer->>PlaybackLogic: Check Frame Validity
    alt Frame Valid
        PlaybackLogic->>AnnotationTopBarContainer: Update Frame
    else Frame Invalid
        PlaybackLogic->>AnnotationTopBarContainer: Stop Playback
    end
Loading

Poem

🐇 In the meadow, hops a little hare,
With a twitching nose and fluffy hair.
"Playback's smooth, no frames to lose,
Simplified paths, oh what a muse!
Let's dance through frames, hop with glee,
A joyful playback, just you and me!" 🌼


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

🧹 Outside diff range and nitpick comments (1)
cvat-ui/src/containers/annotation-page/top-bar/top-bar.tsx (1)

228-228: Consider using a more descriptive property name

The property name lockedPlayTimeout could be more descriptive of its purpose. Consider renaming it to isPlaybackInProgress or isFrameTransitionLocked to better convey its role in preventing concurrent frame transitions during playback.

-    private lockedPlayTimeout: boolean;
+    private isPlaybackInProgress: boolean;

     constructor(props: Props) {
         super(props);
-        this.lockedPlayTimeout = false;
+        this.isPlaybackInProgress = false;

Also applies to: 233-233

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4f7391d and c17eb35.

📒 Files selected for processing (2)
  • changelog.d/20241127_145739_sekachev.bs_simplified_navigation.md (1 hunks)
  • cvat-ui/src/containers/annotation-page/top-bar/top-bar.tsx (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • changelog.d/20241127_145739_sekachev.bs_simplified_navigation.md
🔇 Additional comments (1)
cvat-ui/src/containers/annotation-page/top-bar/top-bar.tsx (1)

586-605: Overall implementation effectively addresses the playback issue

The changes successfully prevent navigation to removed frames during playback by:

  1. Adding a lock mechanism to prevent concurrent frame transitions
  2. Using frames.search with notDeleted: true to find valid frames
  3. Properly handling the case when no valid next frame is found

The implementation is sound and effectively fixes the reported issue.

Comment on lines 586 to 605
if (playing && canvasIsReady && !frameFetching && !this.lockedPlayTimeout) {
this.lockedPlayTimeout = true;
setTimeout(async () => {
const { playing: stillPlaying } = this.props;
this.lockedPlayTimeout = false;

if (stillPlaying) {
const newFrame = await jobInstance.frames.search(
{ notDeleted: true },
frameNumber + 1,
jobInstance.stopFrame,
);

if (newFrame !== null && isAbleToChangeFrame(newFrame)) {
onChangeFrame(newFrame, stillPlaying);
} else {
onSwitchPlay(false);
}
}, frameDelay);
} else {
onSwitchPlay(false);
}
}
}, frameDelay);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance error handling and maintainability of the play method

The play method implementation could be improved in several ways:

  1. Add error handling for the async frame search operation
  2. Extract frame search logic into a separate method
  3. Add TypeScript return type annotation
  4. Consider removing redundant playing check

Consider refactoring the method like this:

-    private play(): void {
+    private async play(): Promise<void> {
         const {
             jobInstance,
             frameNumber,
             frameDelay,
             frameFetching,
             playing,
             canvasIsReady,
             onSwitchPlay,
             onChangeFrame,
         } = this.props;

-        if (playing && canvasIsReady && !frameFetching && !this.lockedPlayTimeout) {
-            this.lockedPlayTimeout = true;
-            setTimeout(async () => {
-                const { playing: stillPlaying } = this.props;
-                this.lockedPlayTimeout = false;
+        if (playing && canvasIsReady && !frameFetching && !this.isPlaybackInProgress) {
+            this.isPlaybackInProgress = true;
+            try {
+                await new Promise((resolve) => setTimeout(resolve, frameDelay));
+                const newFrame = await this.findNextPlayableFrame(frameNumber);
+                if (newFrame !== null && isAbleToChangeFrame(newFrame)) {
+                    onChangeFrame(newFrame, playing);
+                } else {
+                    onSwitchPlay(false);
+                }
+            } catch (error) {
+                console.error('Failed to advance frame during playback:', error);
+                onSwitchPlay(false);
+            } finally {
+                this.isPlaybackInProgress = false;
+            }
+        }
+    }

-                if (stillPlaying) {
-                    const newFrame = await jobInstance.frames.search(
-                        { notDeleted: true },
-                        frameNumber + 1,
-                        jobInstance.stopFrame,
-                    );
-
-                    if (newFrame !== null && isAbleToChangeFrame(newFrame)) {
-                        onChangeFrame(newFrame, stillPlaying);
-                    } else {
-                        onSwitchPlay(false);
-                    }
-                }
-            }, frameDelay);
-        }
+    private async findNextPlayableFrame(currentFrame: number): Promise<number | null> {
+        const { jobInstance } = this.props;
+        return jobInstance.frames.search(
+            { notDeleted: true },
+            currentFrame + 1,
+            jobInstance.stopFrame,
+        );
     }

This refactoring:

  1. Adds proper error handling with try/catch
  2. Extracts frame search logic into a separate method
  3. Uses async/await consistently
  4. Removes the redundant playing check
  5. Adds TypeScript return type annotations
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (playing && canvasIsReady && !frameFetching && !this.lockedPlayTimeout) {
this.lockedPlayTimeout = true;
setTimeout(async () => {
const { playing: stillPlaying } = this.props;
this.lockedPlayTimeout = false;
if (stillPlaying) {
const newFrame = await jobInstance.frames.search(
{ notDeleted: true },
frameNumber + 1,
jobInstance.stopFrame,
);
if (newFrame !== null && isAbleToChangeFrame(newFrame)) {
onChangeFrame(newFrame, stillPlaying);
} else {
onSwitchPlay(false);
}
}, frameDelay);
} else {
onSwitchPlay(false);
}
}
}, frameDelay);
private async play(): Promise<void> {
const {
jobInstance,
frameNumber,
frameDelay,
frameFetching,
playing,
canvasIsReady,
onSwitchPlay,
onChangeFrame,
} = this.props;
if (playing && canvasIsReady && !frameFetching && !this.isPlaybackInProgress) {
this.isPlaybackInProgress = true;
try {
await new Promise((resolve) => setTimeout(resolve, frameDelay));
const newFrame = await this.findNextPlayableFrame(frameNumber);
if (newFrame !== null && isAbleToChangeFrame(newFrame)) {
onChangeFrame(newFrame, playing);
} else {
onSwitchPlay(false);
}
} catch (error) {
console.error('Failed to advance frame during playback:', error);
onSwitchPlay(false);
} finally {
this.isPlaybackInProgress = false;
}
}
}
private async findNextPlayableFrame(currentFrame: number): Promise<number | null> {
const { jobInstance } = this.props;
return jobInstance.frames.search(
{ notDeleted: true },
currentFrame + 1,
jobInstance.stopFrame,
);
}

@codecov-commenter
Copy link

codecov-commenter commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.05%. Comparing base (e97ace2) to head (baac19d).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8747      +/-   ##
===========================================
+ Coverage    74.04%   74.05%   +0.01%     
===========================================
  Files          409      409              
  Lines        43786    43784       -2     
  Branches      3984     3984              
===========================================
+ Hits         32420    32423       +3     
+ Misses       11366    11361       -5     
Components Coverage Δ
cvat-ui 78.35% <ø> (-0.01%) ⬇️
cvat-server 70.34% <ø> (+0.02%) ⬆️

@bsekachev bsekachev merged commit fc37eb3 into develop Dec 2, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/simplified_navigation branch December 3, 2024 06:25
@cvat-bot cvat-bot bot mentioned this pull request Dec 9, 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.

3 participants