imavid: return 0 instead of NaN if total frames is 1 or 0

[sashankaryal]

minor bugfix to prevent cases where NaN might be returned as a result of division by zero

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of edge cases in timeline visualization calculations to prevent potential division by zero errors
  • Enhanced robustness of percentage conversion function when dealing with minimal frame counts

[coderabbitai]

Walkthrough

The pull request modifies the convertFrameNumberToPercentage function in the timeline visualization utilities. A new guard clause is introduced to handle edge cases where the total number of frames is 1 or less. This change prevents potential division by zero errors by immediately returning 0 when the denominator would be zero or negative. The modification ensures more robust handling of frame percentage calculations in boundary scenarios.

Changes

File	Change Summary
app/packages/playback/src/lib/use-timeline-viz-utils.ts	Added guard clause in convertFrameNumberToPercentage to handle cases with 1 or fewer total frames

Possibly related PRs

• Prevent video time from getting assigned NaN when frame rate is undefined #5155: Similar error handling for frame calculations, addressing potential undefined value issues

Suggested reviewers

• benjaminpkane

Poem

🐰 A rabbit's tale of frames so rare,
Where zero lurks with mathematical flair,
One line of code, a guardian's might,
Preventing errors with algorithmic light,
Smooth playback dancing without a care! 🎬

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

app/packages/playback/src/lib/use-timeline-viz-utils.ts (1)

Line range hint 52-62: Consider adding JSDoc comments to document the edge cases.

While the implementation is correct, it would be helpful to document the behavior for edge cases in the function's JSDoc comments.

Add documentation like this:

+/**
+ * Converts a frame number to a percentage (0-100) based on total frames.
+ * @param frameNumber - The current frame number (1-based indexing)
+ * @param totalFrames - The total number of frames
+ * @returns The percentage (0-100) or 0 if total frames is 1 or less
+ */
 export const convertFrameNumberToPercentage = (
   frameNumber: number,
   totalFrames: number
 ) => {

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d87fae5 and 6134aba.

📒 Files selected for processing (1)

• app/packages/playback/src/lib/use-timeline-viz-utils.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

app/packages/playback/src/lib/use-timeline-viz-utils.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: lint / eslint
• GitHub Check: e2e / test-e2e
• GitHub Check: test / test-python (ubuntu-latest-m, 3.10)
• GitHub Check: test / test-app
• GitHub Check: build / build

🔇 Additional comments (1)

app/packages/playback/src/lib/use-timeline-viz-utils.ts (1)

55-59: LGTM! Good handling of edge cases.

The guard clause effectively prevents division by zero when total frames is 1 or 0, returning 0 instead of NaN. This is a robust solution that maintains type safety.

[benjaminpkane]

LGTM. convertFrameNumberToPercentage is an easy function to add unit tests for 😄