Fix `Color.toGamma` and `Color.toLinear` listener error #2389

cptbtptpbcptdtptp · 2024-09-25T10:12:23Z

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
- Adjusted callback invocation for color value updates to ensure correct execution context after transformations.

coderabbitai · 2024-09-25T10:12:36Z

Walkthrough

The changes in the Color.ts file involve modifying how the _onValueChanged callback is invoked within the Color class. The callback, which was previously called on the current instance (this._onValueChanged()), is now called on the out object (out._onValueChanged()). This adjustment alters the control flow regarding which object's callback is executed following color value transformations.

Changes

Files	Change Summary
packages/math/src/Color.ts	Modified the invocation of `_onValueChanged` from `this._onValueChanged()` to `out._onValueChanged()`.

Poem

In colors bright, a change took flight,
The rabbit hops with pure delight.
From this to out, the call now flows,
A dance of hues, as the callback glows.
With every shade, a joyful cheer,
For in this code, the magic's clear! 🐇✨

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.

codecov · 2024-09-25T10:14:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.91%. Comparing base (f3400c8) to head (1cff2d8).
Report is 40 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2389      +/-   ##
==========================================
+ Coverage   69.50%   74.91%   +5.40%     
==========================================
  Files         524      522       -2     
  Lines       27405    27355      -50     
  Branches     4100     4096       -4     
==========================================
+ Hits        19049    20493    +1444     
+ Misses       6852     6827      -25     
+ Partials     1504       35    -1469

Flag	Coverage Δ
unittests	`74.91% <100.00%> (?)`

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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

packages/math/src/Color.ts (2)
297-297: Approve change and suggest optional chaining

The addition of out._onValueChanged && out._onValueChanged(); correctly addresses the listener error in Color.toLinear. This ensures that any listeners are notified when the output color object is modified.

Consider using optional chaining for improved readability:
-out._onValueChanged && out._onValueChanged();
+out._onValueChanged?.();
This change maintains the same functionality while making the code more concise.

🧰 Tools

Biome

[error] 297-297: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

310-310: Approve change and suggest optional chaining

The addition of out._onValueChanged && out._onValueChanged(); correctly addresses the listener error in Color.toGamma. This ensures that any listeners are notified when the output color object is modified.

Consider using optional chaining for improved readability:
-out._onValueChanged && out._onValueChanged();
+out._onValueChanged?.();
This change maintains the same functionality while making the code more concise.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 214b8e6 and 1cff2d8.

📒 Files selected for processing (1)

packages/math/src/Color.ts (2 hunks)

🧰 Additional context used

Biome

packages/math/src/Color.ts

[error] 297-297: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments not posted (1)

packages/math/src/Color.ts (1)

297-297: Summary: Approve changes with minor refactor suggestions

The changes in both toLinear and toGamma methods successfully address the listener error mentioned in the PR objectives. The implementation is consistent and correctly notifies listeners when the output color object is modified.

These changes improve the functionality without introducing breaking changes. The suggested refactors to use optional chaining will further enhance code readability and maintainability.

Great job on fixing this issue! Once the optional chaining suggestions are addressed, this PR will be ready for merge.

Also applies to: 310-310

🧰 Tools

Biome

[error] 297-297: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

fix: color on value change error

1cff2d8

cptbtptpbcptdtptp requested a review from GuoLei1990 September 25, 2024 10:12

cptbtptpbcptdtptp requested a review from luzhuang September 25, 2024 10:12

cptbtptpbcptdtptp self-assigned this Sep 25, 2024

cptbtptpbcptdtptp added the bug Something isn't working label Sep 25, 2024

coderabbitai bot reviewed Sep 25, 2024

View reviewed changes

GuoLei1990 approved these changes Sep 26, 2024

View reviewed changes

GuoLei1990 merged commit 396cb8e into galacean:main Sep 26, 2024
9 checks passed

GuoLei1990 added the math Math library label Sep 26, 2024

coderabbitai bot mentioned this pull request Oct 25, 2024

refact: Color.gammaToLinearSpace to improve performance, speed increased by 7 times. #2406

Closed

3 tasks

coderabbitai bot mentioned this pull request Jan 9, 2025

Optimize the writing of function call _onValueChanged #2497

Merged

3 tasks

coderabbitai bot mentioned this pull request Apr 9, 2025

Color api rename #2607

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix `Color.toGamma` and `Color.toLinear` listener error #2389

Fix `Color.toGamma` and `Color.toLinear` listener error #2389

Uh oh!

Uh oh!

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fix Color.toGamma and Color.toLinear listener error #2389

Fix Color.toGamma and Color.toLinear listener error #2389

Uh oh!

Conversation

Uh oh!

Please check if the PR fulfills these requirements

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

Uh oh!

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Fix `Color.toGamma` and `Color.toLinear` listener error #2389

Fix `Color.toGamma` and `Color.toLinear` listener error #2389

CodeRabbit Configuration File (`.coderabbit.yaml`)