Fix role cache issue when CaseInsensitiveUsername is enabled in userstores

[npamudika]

Fixes wso2/api-manager#3569

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces new utility methods in the API utility class. In particular, it adds a method to obtain API complexity details and two methods to determine whether an API (or API Product) is a streaming API based on its type attribute. Additionally, the PR enhances test coverage by adding static mocks for the IdentityUtil class in the API utility tests to control the behavior of username case sensitivity checks.

Changes

File(s)	Change Summary
components/apimgt/.../APIUtil.java	Added new methods: getComplexityDetails(API api), isStreamingApi(API api), and isStreamingApi(APIProduct apiProduct).
components/apimgt/.../APIUtilTest.java	Added import for IdentityUtil and static mocking for its method isUserStoreInUsernameCaseSensitive in multiple test methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant APIUtil
    Client->>APIUtil: getComplexityDetails(API)
    APIUtil->>APIUtil: Compute complexity details
    APIUtil-->>Client: Return GraphqlComplexityInfo

Loading

sequenceDiagram
    participant Client
    participant APIUtil
    participant API
    Client->>APIUtil: isStreamingApi(API)
    APIUtil->>API: Retrieve type attribute
    API-->>APIUtil: Return type value
    APIUtil-->>Client: Return streaming flag

Loading

Assessment against linked issues

Objective	Addressed	Explanation
API Visibility Issue in DevPortal for Case Sensitive UserNames (#3569)	✅

Possibly related PRs

• Add publisher and creator permissions to the cache #13019: Contains modifications in the APIUtil class related to permissions and caching logic, which are closely connected to the changes introduced in this PR.

Suggested reviewers

• tgtshanika
• chamilaadhi
• tharindu1st
• dushaniw
• Arshardh
• AnuGayan

---

📜 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 5ee9d1e and 65ae863.

📒 Files selected for processing (2)

• components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/utils/APIUtil.java (3 hunks)
• components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/utils/APIUtilTest.java (6 hunks)

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

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

🔇 Additional comments (8)

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

2459-2461: LGTM! Proper case sensitivity handling added for usernames

The addition of case sensitivity check using IdentityUtil.isUserStoreInUsernameCaseSensitive() ensures correct username handling based on the userstore configuration.

---

2554-2556: LGTM! Consistent case sensitivity handling in getListOfRoles

The case sensitivity check is consistently implemented across methods, ensuring proper role management based on userstore configuration.

components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/utils/APIUtilTest.java (6)

70-70: Added import for IdentityUtil is appropriate.

This is needed to support the case-sensitive username handling in the test methods.

---

117-118: Good addition of IdentityUtil to @PrepareForTest annotation.

Adding IdentityUtil.class to the PowerMock's @PrepareForTest annotation is necessary to support static mocking of this class in the test methods.

---

1760-1761: Well-implemented static mocking for username case sensitivity check.

The static mocking for the IdentityUtil.isUserStoreInUsernameCaseSensitive method properly addresses the role cache issue when CaseInsensitiveUsername is enabled in user stores.

---

1934-1935: Good implementation of case sensitivity check in testGetListOfRoles.

This correctly adds the username case sensitivity verification to ensure the test properly handles usernames with the CaseInsensitiveUsername feature enabled.

---

1972-1973: Proper handling of non-super tenant case sensitivity check.

The addition of IdentityUtil mocking for the non-super tenant test case ensures consistent username case sensitivity handling across tenant types.

---

2005-2006: Correctly implemented case sensitivity check for super tenant.

This mock configuration properly handles username case sensitivity for super tenant scenarios, completing the implementation across all test cases.

✨ 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 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.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

Naduni Pamudika seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}