fix: NPE for policies when policyMap is not present

[abhvsn]

Description

/test all

🔍 Cypress test results

Tip

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

---

Mon, 16 Sep 2024 07:32:37 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

• Bug Fixes
  • Improved the reliability of policies retrieval methods to prevent null values, ensuring they always return a non-null result.
• New Features
  • Enhanced API design with safer handling of collections by returning an empty set when no policies are available.

[coderabbitai]

Walkthrough

The change involves modifying the getPolicies() method in the BaseDomain class to ensure it returns an empty set instead of null when the policyMap is null. Additionally, several methods across different classes have been updated to include null checks for user policies, creating empty sets when policies are absent. These adjustments enhance the reliability of the code by consistently providing non-null return values, thereby reducing the risk of NullPointerExceptions.

Changes

File	Change Summary
app/server/appsmith-interfaces/src/main/java/com/appsmith/external/models/BaseDomain.java	Modified getPolicies() to return an empty set using Set.of() instead of null when policyMap is null.
app/server/src/main/java/com/appsmith/server/migrations/db/ce/Migration028TagUserManagementRolesWithoutDefaultDomainTypeAndId.java	Added a null check for user policies, creating an empty Set if policies are null.
app/server/src/main/java/com/appsmith/server/migrations/db/ce/Migration025RemoveUnassignPermissionFromUnnecessaryRoles.java	Introduced a null check for policies, ensuring an empty set is created if getPolicies() returns null.
app/server/src/main/java/com/appsmith/server/migrations/db/ce/Migration029PopulateDefaultDomainIdInUserManagementRoles.java	Implemented a null check for user policies, initializing an empty set if policies are absent.
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/PermissionGroupServiceCEImpl.java	Added a null check for policies in the isEntityAccessible method, ensuring a valid set is used.
app/server/appsmith-server/src/main/java/com/appsmith/server/actioncollections/base/ActionCollectionServiceCEImpl.java	Modified createJsAction to check for null policies, initializing to an empty set if necessary.
app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/UserPermissionUtils.java	Added a null check for policies in the permission validation logic, ensuring a valid set is used.
app/server/appsmith-server/src/main/java/com/appsmith/server/acl/ce/PolicyGeneratorCE.java	Introduced a null check for the policySet parameter, returning an empty HashSet if it is null.

Possibly related PRs

• fix: NPE while creating a policies copy #36172: This PR modifies the setUserPermissionsInObject method to ensure that policies are initialized to an empty set if getPolicies() returns null, similar to the changes made in the getPolicies() method of the BaseDomain class in the main PR.
• fix: fixed page data DB call getting called twice #36247: The changes in this PR also involve handling null policies by ensuring that an empty set is created when policies are null, which aligns with the robustness improvements in the main PR.

Poem

In code we trust, with policies clear,
An empty set now brings us cheer.
No more nulls to cause dismay,
Robust and safe, we code away!
With every change, our code will sing,
A safer world, this fix will bring! 🎉

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 435c4e6 and 5bbb0ad.

Files selected for processing (1)

• app/server/appsmith-server/src/main/java/com/appsmith/server/acl/ce/PolicyGeneratorCE.java (1 hunks)

Additional comments not posted (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/acl/ce/PolicyGeneratorCE.java (1)

320-322: Excellent work on adding the null check, my dear student!

The null check for the policySet parameter is a splendid addition to the getAllChildPolicies method. It showcases your understanding of defensive programming practices and ensures that the method handles the case when no policies are provided gracefully. By returning an empty HashSet instead of proceeding with the existing logic, you prevent potential NullPointerException errors and maintain a consistent return type. This change enhances the robustness and reliability of the code. Well done!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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.

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.

[AnaghHegde]

Is this for the NPE we are seeing in 4517?