Fix preprocessor parenthesis expression parse #2236

Sway007 · 2024-07-17T08:38:52Z

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)

Summary by CodeRabbit

Bug Fixes
- Improved parsing logic for constants in the shader preprocessor, enhancing the accuracy of shader code interpretation.

…t/shaderlab-relative-include

coderabbitai · 2024-07-17T08:38:58Z

Walkthrough

The PpParser class in the PpParser.ts file was updated to modify a method call within its parsing logic. Specifically, a call to _parseConstant was replaced with _parseConstantExpression when the current character is '('. This change impacts how constant expressions are parsed within the shader preprocessor.

Changes

Files	Change Summaries
`packages/.../PpParser.ts`	Changed the method call from `_parseConstant` to `_parseConstantExpression` within a conditional block checking for the current character `'('`.

Poem

In the land of Shader's might,
A parser took a subtle flight.
From constants to expressions grand,
With code in line, a change was planned.
Now shaders gleam with brighter hue,
Thanks to the parser’s code anew.
🎨✨

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.

codecov · 2024-07-17T08:41:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.31%. Comparing base (4cc191e) to head (3fefbe9).
Report is 9 commits behind head on dev/1.3.

Additional details and impacted files

@@             Coverage Diff             @@
##           dev/1.3    #2236      +/-   ##
===========================================
+ Coverage    68.27%   69.31%   +1.04%     
===========================================
  Files          468      523      +55     
  Lines        24353    27309    +2956     
  Branches      3632     4069     +437     
===========================================
+ Hits         16626    18929    +2303     
- Misses        6400     6899     +499     
- Partials      1327     1481     +154

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

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 921d3bc and 3fefbe9.

Files selected for processing (1)

packages/shader-lab/src/preprocessor/PpParser.ts (1 hunks)

coderabbitai · 2024-07-17T08:42:48Z

packages/shader-lab/src/preprocessor/PpParser.ts

@@ -382,7 +382,7 @@ export default class PpParser {
    if (scanner.getCurChar() === "(") {
      scanner.advance();
      scanner.skipSpace(false);
-      const ret = this._parseConstant(scanner);
+      const ret = this._parseConstantExpression(scanner);


Change from _parseConstant to _parseConstantExpression is appropriate for enhanced expression parsing.

The modification to use _parseConstantExpression instead of _parseConstant when parsing expressions within parenthesis is a logical enhancement. This change likely allows for more complex expressions to be correctly parsed, aligning with the intended improvements in the PR.

However, it is crucial to ensure that this change is thoroughly tested, especially since it affects the core functionality of the shader preprocessor.

Would you like me to help generate unit tests or update the documentation to reflect this change?

Sway007 added 9 commits July 16, 2024 14:03

fix: conditional compilation

94e30f5

fix: expand token

e3c7aa5

fix: expand token

36b77e0

feat: code opt

b2e07fc

fix: ci

93df92e

feat: cache error shader

8e0cc28

Merge branch 'dev/1.3' of https://github.com/galacean/engine into fea…

7652250

…t/shaderlab-relative-include

fix: preprocessor parse expression

c92e674

Merge branch 'dev/1.3' of https://github.com/galacean/engine into fea…

3fefbe9

…t/shaderlab-relative-include

Sway007 added bug Something isn't working shader Shader related functions high priority High priority issue labels Jul 17, 2024

Sway007 requested review from GuoLei1990 and zhuxudong July 17, 2024 08:38

Sway007 self-assigned this Jul 17, 2024

coderabbitai bot reviewed Jul 17, 2024

View reviewed changes

GuoLei1990 merged commit 99aaa89 into galacean:dev/1.3 Jul 17, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix preprocessor parenthesis expression parse #2236

Fix preprocessor parenthesis expression parse #2236

Sway007 commented Jul 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Jul 17, 2024

coderabbitai bot left a comment

coderabbitai bot Jul 17, 2024

Fix preprocessor parenthesis expression parse #2236

Fix preprocessor parenthesis expression parse #2236

Conversation

Sway007 commented Jul 17, 2024 • edited by coderabbitai bot Loading

Please check if the PR fulfills these requirements

Summary by CodeRabbit

coderabbitai bot commented Jul 17, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Jul 17, 2024

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jul 17, 2024

Choose a reason for hiding this comment

Sway007 commented Jul 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)