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 in node environment #2362

Merged
merged 4 commits into from
Aug 27, 2024
Merged

Conversation

zhuxudong
Copy link
Member

@zhuxudong zhuxudong commented Aug 27, 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 for WebP support detection, preventing application crashes in environments without canvas support. This ensures a more robust user experience.
  • New Features
    • Introduced a new property to determine if the code is running in a browser environment, allowing for enhanced functionality based on the execution context.

@zhuxudong zhuxudong self-assigned this Aug 27, 2024
Copy link

coderabbitai bot commented Aug 27, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes made to the EXT_texture_webp class improve error handling during WebP support initialization by introducing a check for the browser environment before creating a canvas. Additionally, the SystemInfo class now features a static property, _isBrowser, which identifies whether the code is executing in a browser context based on the presence of the navigator object.

Changes

Files Change Summary
packages/loader/src/gltf/extensions/EXT_texture_webp.ts Enhanced error handling for WebP support initialization by conditionally checking the browser environment.
packages/core/src/SystemInfo.ts Introduced static property _isBrowser to indicate if the execution context is a browser.

Poem

In a world of pixels bright,
A canvas danced with pure delight.
With WebP's charm, we take our stance,
No more crashes, give it a chance!
So hop along, dear friends, we say,
For smoother paths await today! 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@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, codebase verification and nitpick comments (1)
packages/loader/src/gltf/extensions/EXT_texture_webp.ts (1)

19-25: Consider logging the error in the catch block.

The try-catch block is a good addition for robustness. However, logging the error can help with debugging if the WebP support detection fails.

try {
  const testCanvas = document.createElement("canvas");
  testCanvas.width = testCanvas.height = 1;
  this._supportWebP = testCanvas.toDataURL("image/webp").indexOf("data:image/webp") == 0;
} catch (e) {
+  console.error("Error detecting WebP support:", e);
  this._supportWebP = false;
}
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fec392e and cb1f88a.

Files selected for processing (1)
  • packages/loader/src/gltf/extensions/EXT_texture_webp.ts (1 hunks)

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cb1f88a and 1ca67fc.

Files selected for processing (2)
  • packages/core/src/SystemInfo.ts (2 hunks)
  • packages/loader/src/gltf/extensions/EXT_texture_webp.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/loader/src/gltf/extensions/EXT_texture_webp.ts
Additional comments not posted (3)
packages/core/src/SystemInfo.ts (3)

9-10: LGTM!

The isBrowser property is correctly added and initialized to true.

The code changes are approved.


28-29: LGTM!

The conditional check for navigator correctly sets isBrowser to false if navigator is undefined.

The code changes are approved.


Line range hint 15-54: LGTM!

The _initialize method is correctly implemented and the changes do not introduce any issues.

The code changes are approved.

@GuoLei1990 GuoLei1990 added the bug Something isn't working label Aug 27, 2024
@zhuxudong zhuxudong changed the title Detect node environment Adapter browser environment Aug 27, 2024
@GuoLei1990 GuoLei1990 changed the title Adapter browser environment Fix error in no-browser environment Aug 27, 2024
@GuoLei1990 GuoLei1990 changed the title Fix error in no-browser environment Fix error in node environment Aug 27, 2024
@GuoLei1990 GuoLei1990 merged commit 337ba2e into galacean:main Aug 27, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants