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

Prevent video time from getting assigned NaN when frame rate is undefined #5155

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

tom-vx51
Copy link
Contributor

@tom-vx51 tom-vx51 commented Nov 19, 2024

What changes are proposed in this pull request?

Prevent video time from getting assigned NaN when frame rate is undefined. This currently causes a crash during playback; with this change, playback will be disabled if the frame rate is undefined, but will not crash.

How is this patch tested? If it is not, please explain why.

local app

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling in the time calculation function to prevent non-finite values from being returned, enhancing application stability.

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes involve an update to the getTime function in the app/packages/looker/src/elements/util.ts file. The implementation now includes a new variable time, which calculates a value based on the input parameters. The function checks if time is finite before returning it; if not, it returns 0.0. This modification improves the function's error handling by preventing the return of non-finite values.

Changes

File Path Change Summary
app/packages/looker/src/elements/util.ts Updated getTime function to include a new variable time and modified return statement for error handling.

Suggested reviewers

  • sashankaryal

Poem

In the land of code where rabbits play,
A function grew wiser, come what may.
With checks for the finite, it hops with glee,
No more strange values, just smooth as can be!
So let’s celebrate this change, oh so bright,
In the world of Looker, all feels 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>, 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.

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)
app/packages/looker/src/elements/util.ts (1)

108-109: Approve with suggestion: Use Number.isFinite for stricter type checking

The change successfully prevents NaN values from being returned when frame rate is undefined, which aligns with the PR objective. However, we should use Number.isFinite() instead of isFinite() for stricter type checking.

Apply this change for better type safety:

  const time = (frameNumber - 1 + 0.01) / frameRate;
- return isFinite(time) ? time : 0.0;
+ return Number.isFinite(time) ? time : 0.0;

Rationale: Number.isFinite() is preferred over isFinite() because:

  1. It doesn't attempt type coercion
  2. It strictly checks if the value is a finite number
  3. It's more predictable and safer
🧰 Tools
🪛 Biome

[error] 109-109: isFinite is unsafe. It attempts a type coercion. Use Number.isFinite instead.

See the MDN documentation for more details.
Unsafe fix: Use Number.isFinite instead.

(lint/suspicious/noGlobalIsFinite)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 01ea636 and 90c4838.

📒 Files selected for processing (1)
  • app/packages/looker/src/elements/util.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/looker/src/elements/util.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.

🪛 Biome
app/packages/looker/src/elements/util.ts

[error] 109-109: isFinite is unsafe. It attempts a type coercion. Use Number.isFinite instead.

See the MDN documentation for more details.
Unsafe fix: Use Number.isFinite instead.

(lint/suspicious/noGlobalIsFinite)

Copy link
Contributor

@benjaminpkane benjaminpkane left a comment

Choose a reason for hiding this comment

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

🚀

@tom-vx51 tom-vx51 merged commit 9967d21 into release/v1.1.0 Nov 19, 2024
11 checks passed
@tom-vx51 tom-vx51 deleted the bugfix/prevent-nan-video-time branch November 19, 2024 22:17
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.

2 participants