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 error when the animationEvent loses the callback function with the given name #2394

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

luzhuang
Copy link
Contributor

@luzhuang luzhuang commented Oct 14, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in the animation event system to prevent runtime errors when binding functions.
  • Refactor

    • Enhanced the robustness of the Animator class without altering its fundamental behavior.

@luzhuang luzhuang added bug Something isn't working animation Built-in animation system related functions labels Oct 14, 2024
@luzhuang luzhuang requested a review from GuoLei1990 October 14, 2024 10:36
Copy link

coderabbitai bot commented Oct 14, 2024

Walkthrough

The changes in this pull request focus on the Animator class within the Animator.ts file, specifically enhancing the handling of animation events and state transitions. The primary modification involves adding a conditional check to ensure that event handler functions exist before binding them, thereby improving error handling and preventing runtime errors. The overall structure and functionality of the Animator class remain unchanged, with the modifications localized to the event handling mechanism.

Changes

File Change Summary
packages/core/src/animation/Animator.ts Refined event handler binding with a conditional check for function existence to prevent runtime errors.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • GuoLei1990

Poem

In the world of hops and bounds,
An animator's grace astounds.
With checks in place, no errors found,
Our animations dance around!
So let us cheer, with joy profound,
For smoother flows in leaps unbound! 🐇✨


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

codecov bot commented Oct 14, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 69.48%. Comparing base (396cb8e) to head (3066272).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
packages/core/src/animation/Animator.ts 0.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2394      +/-   ##
==========================================
- Coverage   74.88%   69.48%   -5.41%     
==========================================
  Files         522      522              
  Lines       27355    27355              
  Branches     4096     4097       +1     
==========================================
- Hits        20486    19007    -1479     
- Misses       6834     6846      +12     
- Partials       35     1502    +1467     
Flag Coverage Δ
unittests 69.48% <0.00%> (-5.41%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@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)
packages/core/src/animation/Animator.ts (1)

409-409: Approve change and suggest type improvement

The modification improves fault tolerance by checking if the handler exists before binding, which aligns with the PR objective. This change prevents potential runtime errors when a callback function is not provided.

However, there's an opportunity to improve type safety:

Consider replacing the Function type with a more specific function signature. This will enhance type safety and make the code more robust. Here's a suggested improvement:

const handler = script[funcName] as ((parameter: any) => void) | undefined;
handler && handlers.push(handler);

This change specifies that the handler is a function that takes any parameter and returns void, which is likely the expected signature for event handlers in this context.

🧰 Tools
🪛 Biome

[error] 409-409: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 396cb8e and 3066272.

📒 Files selected for processing (1)
  • packages/core/src/animation/Animator.ts (1 hunks)
🧰 Additional context used
🪛 Biome
packages/core/src/animation/Animator.ts

[error] 409-409: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

@GuoLei1990 GuoLei1990 changed the title fix: fault tolerance in the absence of a callback function Fix fault tolerance in the absence of a callback function Oct 30, 2024
@GuoLei1990 GuoLei1990 changed the title Fix fault tolerance in the absence of a callback function Fix fault tolerance in the absence of the animationEvent callback function Oct 30, 2024
@GuoLei1990 GuoLei1990 changed the title Fix fault tolerance in the absence of the animationEvent callback function Fix error when the animationEvent miss the callback function Oct 30, 2024
@GuoLei1990 GuoLei1990 changed the title Fix error when the animationEvent miss the callback function Fix error when the animationEvent loses the callback function Oct 30, 2024
@GuoLei1990 GuoLei1990 changed the title Fix error when the animationEvent loses the callback function Fix error when the animationEvent loses the callback function with the given name Oct 30, 2024
@GuoLei1990 GuoLei1990 merged commit aefd944 into galacean:main Oct 30, 2024
7 of 9 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 31, 2024
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 12, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
animation Built-in animation system related functions bug Something isn't working
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants