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: add check to avoid NPE when binding value is null #38104

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

subrata71
Copy link
Contributor

@subrata71 subrata71 commented Dec 11, 2024

Description

Slack thread: https://theappsmith.slack.com/archives/C04GRCN4CS3/p1733907474929399

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12277298947
Commit: 71ba98b
Cypress dashboard.
Tags: @tag.All
Spec:


Wed, 11 Dec 2024 15:39:23 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for dynamic bindings by validating empty or null values.
  • Bug Fixes

    • Improved test coverage for handling null binding values in dynamic bindings.
  • Tests

    • Added a new test for verifying behavior with null binding values.
    • Updated existing tests to ensure they accurately reflect the expected outcomes.

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request involve updates to the AstServiceCEImpl class and its corresponding test class, ASTServiceCETest. A new import for StringUtils has been added, and the method refactorNameInDynamicBindings now includes validation for empty or null binding values, returning an empty Mono when such values are encountered. Additionally, the test class has been enhanced with a new test case to verify the handling of null binding values, ensuring comprehensive coverage of the method's behavior.

Changes

File Change Summary
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/AstServiceCEImpl.java Added import for StringUtils, updated refactorNameInDynamicBindings to handle empty/null values.
app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ASTServiceCETest.java Added test for null binding values and modified existing tests to enhance coverage.

Possibly related PRs

  • chore: Skip unnecessary RTS calls to optimise performance #37949: This PR modifies the refactorNameInDynamicBindings method in the AstServiceCEImpl class, introducing a new check to optimize performance by skipping unnecessary RTS calls, which is directly related to the changes made in the main PR that also focuses on the refactorNameInDynamicBindings method.

Suggested labels

Bug, Task, ok-to-test, AST-backend, Javascript Product

Suggested reviewers

  • nidhi-nair

In the realm of code, where logic flows,
A check for nulls, like a garden grows.
With tests that ensure, all values align,
Refactoring names, oh how they shine!
So here's to the changes, both clever and bright,
In the world of Appsmith, we code with delight! 🌟


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

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.

@subrata71 subrata71 added the ok-to-test Required label for CI label Dec 11, 2024
@subrata71 subrata71 self-assigned this Dec 11, 2024
@github-actions github-actions bot added the Bug Something isn't working label Dec 11, 2024
@subrata71 subrata71 added Backend This marks the issue or pull request to reference server code Packages Pod issues that belong to the packages pod Packages & Git Pod All issues belonging to Packages and Git ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Dec 11, 2024
@subrata71 subrata71 requested a review from nidhi-nair December 11, 2024 11:40
Copy link
Contributor

@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 (2)
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/AstServiceCEImpl.java (1)

148-155: Consider adding debug logging for discarded bindings.

The null check implementation is correct, but adding debug logging would help track discarded bindings during troubleshooting.

 if (!StringUtils.hasText(bindingValue.getValue())) {
+    log.debug("Discarding invalid binding during refactoring: {}", bindingValue);
     return Mono.empty();
 }
app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ASTServiceCETest.java (1)

90-105: Consider expanding test coverage for empty string cases.

While the test correctly verifies null handling, consider adding explicit cases for empty string and whitespace-only values.

 @Test
 void refactorNameInDynamicBindings_nullBindingValue_returnsEmptyMap() {
     MustacheBindingToken token1 = new MustacheBindingToken();
+    MustacheBindingToken token2 = new MustacheBindingToken();
+    token2.setValue("");
+    MustacheBindingToken token3 = new MustacheBindingToken();
+    token3.setValue("   ");
 
     Set<MustacheBindingToken> bindings = new HashSet<>();
     bindings.add(token1);
+    bindings.add(token2);
+    bindings.add(token3);
 
     Mono<Map<MustacheBindingToken, String>> result =
             astService.refactorNameInDynamicBindings(bindings, "abc", "xyz", 2, false);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 61c90ce and 71ba98b.

📒 Files selected for processing (2)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/AstServiceCEImpl.java (2 hunks)
  • app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ASTServiceCETest.java (4 hunks)
🔇 Additional comments (3)
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/AstServiceCEImpl.java (1)

18-18: LGTM!

The StringUtils import is appropriate for null/empty string validation.

app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ASTServiceCETest.java (2)

13-13: LGTM!

The HashSet import is necessary for the new test implementation.


Line range hint 64-76: LGTM!

The test modifications properly verify that invalid tokens are handled correctly.

@subrata71 subrata71 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Dec 11, 2024
@subrata71 subrata71 merged commit 493dba0 into release Dec 11, 2024
169 of 179 checks passed
@subrata71 subrata71 deleted the fix/handle-npe-in-ast-service branch December 11, 2024 19:25
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Dec 12, 2024
…8104)

## Description
Slack thread:
https://theappsmith.slack.com/archives/C04GRCN4CS3/p1733907474929399

Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12277298947>
> Commit: 71ba98b
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12277298947&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Wed, 11 Dec 2024 15:39:23 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced error handling for dynamic bindings by validating empty or
null values.
  
- **Bug Fixes**
- Improved test coverage for handling null binding values in dynamic
bindings.

- **Tests**
  - Added a new test for verifying behavior with null binding values.
- Updated existing tests to ensure they accurately reflect the expected
outcomes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend This marks the issue or pull request to reference server code Bug Something isn't working ok-to-test Required label for CI Packages & Git Pod All issues belonging to Packages and Git Packages Pod issues that belong to the packages pod
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants