Skip retrieve application from external KM for MAPPED keys

[PasanT9]

$subject
Fix: wso2/api-manager#3821

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the updateApplicationOwner method in the APIConsumerImpl class by introducing a conditional check on the OAuth application creation mode. If the createMode is not MAPPED, the method retrieves the consumer key and OAuth application information, including the client name. The update proceeds only when a valid client name is found, otherwise an exception is thrown. This validation aims to prevent errors during application ownership transfer.

Changes

File(s) Changed	Change Summary
.../APIConsumerImpl.java	Modified updateApplicationOwner method to add a conditional check on the OAuth application's createMode. The method now retrieves the OAuth application information only when the mode is not MAPPED and validates the OAuth client name before proceeding with the update, throwing an exception if the client name is null.

Sequence Diagram(s)

sequenceDiagram
    participant U as User/Request
    participant AC as APIConsumerImpl
    participant OAu as OAuth Application Service

    U->>AC: updateApplicationOwner(userId, organization, application)
    alt createMode is not MAPPED
        AC->>OAu: Retrieve consumer key & client name
        alt OAuth client name exists
            AC->>OAu: Create OAuthAppRequest and update application owner
            OAu-->>AC: Success response
        else OAuth client name missing
            AC-->>U: Throw APIManagementException
        end
    else createMode is MAPPED
        AC-->>U: Skip OAuth application update
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Prevent errors in transferring application ownership when using third-party Key Manager [#3821]	✅

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 dcfc952 and 2b0d1f9.

📒 Files selected for processing (1)

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

🧰 Additional context used

🧬 Code Definitions (1)

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

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

• APIConstants (32-3337)

components/apimgt/org.wso2.carbon.apimgt.persistence/src/main/java/org/wso2/carbon/apimgt/persistence/APIConstants.java (1)

• APIConstants (21-416)

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

• GitHub Check: run-benchmark-test
• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (4, group4)

🔇 Additional comments (1)

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

2988-3009: Well-implemented check to skip OAuth application retrieval for MAPPED keys

The code now properly checks if the key's creation mode is "MAPPED" before attempting to retrieve and update OAuth application information. This prevents unnecessary API calls to external Key Managers when dealing with mapped applications, directly addressing the issue in the PR objective.

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