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

[draft] Update OAuthOpaqueAuthenticatorImpl.java #12989

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chamilaadhi
Copy link
Contributor

@chamilaadhi chamilaadhi commented Feb 23, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved tenant classification during organization data retrieval, ensuring tenant-specific information is now processed accurately.

Copy link

coderabbitai bot commented Feb 23, 2025

Walkthrough

This pull request changes the initialization of the isSuperTenant variable within the getOrganizationInfo method of the OAuthOpaqueAuthenticatorImpl class. The variable, which was previously hard-coded to true, is now set to false. This inversion affects the evaluation logic for tenant status while leaving the overall control flow unchanged. There are no changes to any publicly exported entities.

Changes

File Path Change Summary
components/apimgt/.../OAuthOpaqueAuthenticatorImpl.java Modified initialization of isSuperTenant in getOrganizationInfo() from true to false, affecting tenant evaluation.

Sequence Diagram(s)

sequenceDiagram
    participant API as API Request
    participant Auth as OAuthOpaqueAuthenticatorImpl

    API->>Auth: Invoke getOrganizationInfo()
    Note right of Auth: Initialize isSuperTenant = false
    Auth->>Auth: Evaluate tenant domain logic
    Auth-->>API: Return organization information based on tenant evaluation
Loading

Poem

I'm a rabbit coding under moonlit beams,
Tweaking booleans in my midnight dreams.
Once true, now false, a subtle little shift,
With each hop in code, my spirits lift.
Carrots and commits, in leaps of delight,
Celebrating changes that set things right!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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.

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.

Copy link

@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

🧹 Nitpick comments (2)
components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/java/org/wso2/carbon/apimgt/rest/api/util/impl/OAuthOpaqueAuthenticatorImpl.java (2)

264-264: Initial value of isSuperTenant is redundant.

The initial value of isSuperTenant is immediately overwritten at line 281 based on the tenant domain check. The initialization value doesn't affect the logic since it's not used before being overwritten.

Consider removing the initialization and declare the variable where it's first used:

-        Boolean isSuperTenant = false;
         int tenantId = MultitenantConstants.SUPER_TENANT_ID;
         APIManagerConfiguration config = ServiceReferenceHolder.getInstance().
                 getAPIManagerConfigurationService().getAPIManagerConfiguration();
         String orgNameClaim = config.getOrgAccessControl().getOrgNameLocalClaim();
         String orgIdClaim = config.getOrgAccessControl().getOrgIdLocalClaim();
+        boolean isSuperTenant = tenantDomain.equals(MultitenantConstants.SUPER_TENANT_DOMAIN_NAME);

Additionally:

  1. Use primitive boolean instead of Boolean since null values aren't needed here
  2. Move the declaration closer to where it's first used to improve code readability

256-333: Consider improving error handling and method organization.

The getOrganizationInfo method has multiple responsibilities and could benefit from the following improvements:

  1. The error message in the catch block could be more specific about which operation failed
  2. The method could be split into smaller, focused methods for better maintainability

Consider refactoring into smaller methods:

+ private String resolveUsername(String username, String tenantDomain) {
+     if (MultitenantConstants.SUPER_TENANT_DOMAIN_NAME.equals(tenantDomain)) {
+         long count = username.chars().filter(ch -> ch == '@').count();
+         boolean isEmailUsernameEnabled = Boolean.parseBoolean(
+             CarbonUtils.getServerConfiguration().getFirstProperty("EnableEmailUserName")
+         );
+         if (isEmailUsernameEnabled || (username.endsWith(SUPER_TENANT_SUFFIX) && count <= 1)) {
+             return MultitenantUtils.getTenantAwareUsername(username);
+         }
+     }
+     return username;
+ }

+ private String[] getOrganizationClaims(APIManagerConfiguration config) {
+     String orgNameClaim = config.getOrgAccessControl().getOrgNameLocalClaim();
+     String orgIdClaim = config.getOrgAccessControl().getOrgIdLocalClaim();
+     
+     if (StringUtils.isBlank(orgNameClaim)) {
+         orgNameClaim = "http://wso2.org/claims/organization";
+     }
+     if (StringUtils.isBlank(orgIdClaim)) {
+         orgIdClaim = "http://wso2.org/claims/organizationId";
+     }
+     return new String[]{orgNameClaim, orgIdClaim};
+ }

Also, improve the error message:

- String error = "Error while checking user existence for " + username;
+ String error = "Error while retrieving organization claims for user: " + username;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e8ec99d and eaf9d7e.

📒 Files selected for processing (1)
  • components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/java/org/wso2/carbon/apimgt/rest/api/util/impl/OAuthOpaqueAuthenticatorImpl.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-carbon
  • GitHub Check: build-product (2, group2)
  • GitHub Check: run-benchmark-test
  • GitHub Check: build-product (1, group1)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant