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 shaderlab loader in NPM mode #2427

Merged
merged 53 commits into from
Nov 7, 2024
Merged

Conversation

Sway007
Copy link
Member

@Sway007 Sway007 commented Nov 7, 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

  • New Features

    • Improved shader retrieval process for enhanced performance and clarity.
  • Bug Fixes

    • Removed outdated logic for shader and shader reference handling, streamlining material loading.
  • Refactor

    • Renamed method for better visibility and consistency in naming conventions.

@Sway007 Sway007 requested a review from GuoLei1990 November 7, 2024 07:16
@Sway007 Sway007 self-assigned this Nov 7, 2024
Copy link

coderabbitai bot commented Nov 7, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the MaterialLoader class in MaterialLoader.ts, specifically the load method and the private method _getMaterialByShader. The load method now directly looks up shaders using Shader.find(shaderName), streamlining the shader retrieval process. If the shader is not found, it retrieves it using resourceManager.getResourceByRef<Shader>(<IAssetRef>shaderRef). The private method has been renamed from getMaterialByShader to _getMaterialByShader, reflecting a change in visibility while maintaining its functionality.

Changes

File Change Summary
packages/loader/src/MaterialLoader.ts - Updated load method to directly lookup shaders using Shader.find(shaderName).
- Removed previous logic for handling cases where neither shader nor shaderRef was found.
- Renamed getMaterialByShader to _getMaterialByShader to indicate visibility change.

Possibly related PRs

  • Fix shaderlab loader in NPM mode #2427: The changes in this PR directly modify the MaterialLoader class, specifically the load method and the _getMaterialByShader method, which are also the focus of the main PR.

Suggested labels

shader, enhancement

Suggested reviewers

  • zhuxudong

🐰 In the land of code, where shaders gleam,
A loader hops forth, fulfilling the dream.
With a flick of its method, it finds with ease,
Materials dance like leaves in the breeze.
So let’s celebrate changes, both swift and bright,
In the world of the loader, all is 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.

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 Nov 7, 2024

Codecov Report

Attention: Patch coverage is 16.66667% with 5 lines in your changes missing coverage. Please review.

Project coverage is 69.38%. Comparing base (4c0cfd0) to head (81cfca6).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
packages/loader/src/MaterialLoader.ts 16.66% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2427      +/-   ##
==========================================
+ Coverage   69.11%   69.38%   +0.26%     
==========================================
  Files         524      524              
  Lines       27411    27412       +1     
  Branches     4108     4109       +1     
==========================================
+ Hits        18946    19019      +73     
+ Misses       6968     6887      -81     
- Partials     1497     1506       +9     
Flag Coverage Δ
unittests 69.38% <16.66%> (+0.26%) ⬆️

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.

@GuoLei1990 GuoLei1990 changed the title Fix shaderlab loader Fix shaderlab loader in NPM mode Nov 7, 2024
@GuoLei1990 GuoLei1990 merged commit 65594f0 into galacean:main Nov 7, 2024
8 of 9 checks passed
@GuoLei1990 GuoLei1990 added bug Something isn't working ignore for release ignore for release labels Nov 7, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 18, 2024
3 tasks
This was referenced Dec 9, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 19, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ignore for release ignore for release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants