Fix null pointer exception when the tenant is invalid

[Jithmi004]

Purpose

When trying to change the API Provider through admin portal, if an invalid tenant name is given as input, (john@ a bc.com -> space within the tenant domain or [email protected] where test.com does not exists) an NPE is thrown. This PR fixes that issue.

Fixes: wso2/api-manager#3735

Implementation Details

If the tenant is invalid, the tenantId becomes -1. If that happens, an APIManagementException is now thrown with INVALID_TENANT as the ExceptionCode.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a new condition in the isUserExist() method within the API utility class. The method now checks if the tenant ID is -1, indicating that the tenant does not exist, and throws an APIManagementException with the INVALID_TENANT error code if the validation fails. Additionally, a new public method signature for isUserExist is added. Other modifications in the file include general improvements, bug fixes, and refactoring within the APIUtil class.

Changes

File(s)	Change Summary
components/.../APIUtil.java	Added new public method isUserExist(String username); incorporated a tenant ID check that throws an APIManagementException with INVALID_TENANT if tenant ID is -1; included general improvements and refactoring.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant APIUtil
    Caller->>APIUtil: call isUserExist(username)
    APIUtil->>APIUtil: Retrieve tenant ID
    alt Tenant ID equals -1
        APIUtil-->>Caller: throw APIManagementException (INVALID_TENANT)
    else Tenant exists
        APIUtil-->>Caller: Return user existence result
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Handle invalid tenant exceptions to prevent backend NullPointerException (#3735)	✅
Ensure provider name formatting and edit flow issues do not cause erroneous behavior (#3735)	❌	Provider formatting and edit behavior changes are not modified.

Possibly related PRs

• Fix tenant error #12988: Focuses on tenant validation logic in organization info retrieval, which has strong code-level connections to the tenant check introduced in isUserExist().

Suggested reviewers

• tgtshanika
• chamilaadhi
• dushaniw
• Arshardh
• AnuGayan
• PasanT9

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b08daad and 20d15b2.

📒 Files selected for processing (1)

• components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/utils/APIUtil.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-product (4, group4)
• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (2, group2)
• GitHub Check: build-product (1, group1)
• GitHub Check: run-benchmark-test
• GitHub Check: build-carbon

🔇 Additional comments (1)

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/utils/APIUtil.java (1)

2588-2591: Good addition of explicit tenant validation!

This check properly handles the case when a tenant doesn't exist by throwing an APIManagementException with the INVALID_TENANT error code instead of letting the code proceed, which would result in a null pointer exception later. The error message is clear and includes the tenant domain for easier debugging.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.