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

Make transport cleanup configurable #13064

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

Conversation

PasanT9
Copy link
Contributor

@PasanT9 PasanT9 commented Apr 2, 2025

Fix: wso2/api-manager#3806

Make the auto-cleanup process configurable by introducing a system property, autoTransportOperationCleanUp. You can control whether to enable the auto-cleanup process when starting the API-M. Setting this property to false will disable the auto-cleanup mechanism.

ex. ./wso2server.sh -DautoTransportOperationCleanUp=false

Copy link

coderabbitai bot commented Apr 2, 2025

📝 Walkthrough

Walkthrough

This pull request adds a new constant to the API management gateway constants and modifies the BasicAuthCredentialValidator constructor. The new constant, AUTO_TRANSPORT_OPERATION_CLEANUP, allows external configuration of the service client’s auto cleanup behavior. In the validator, a conditional block checks for this system property and, if present, sets the corresponding property on the ServiceClient options. These changes enable dynamic configuration of auto cleanup operations in the API gateway.

Changes

File Path Change Summary
components/apimgt/.../APIMgtGatewayConstants.java Added new constant AUTO_TRANSPORT_OPERATION_CLEANUP to support configurable auto transport operation cleanup.
components/apimgt/.../BasicAuthCredentialValidator.java Inserted a conditional block in the constructor to check the system property and update the ServiceClient options accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant BA as BasicAuthCredentialValidator
    participant SP as System Properties
    participant SC as ServiceClient Options

    BA->>SP: Get property "autoTransportOperationCleanUp"
    alt Property exists
        BA->>SC: Set auto cleanup option based on property value
    else
        BA->>SC: Proceed with default configuration
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Provide configurable auto cleanup for the service client to mitigate intermittent 500 errors during Basic Auth API invocations (#3806)
✨ 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
🪧 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.

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 (1)
components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/basicauth/BasicAuthCredentialValidator.java (1)

98-102: Optimize the system property check by retrieving the value once.

The code makes two separate calls to retrieve the same system property. This is inefficient and could be optimized.

-if (System.getProperty(APIMgtGatewayConstants.AUTO_TRANSPORT_OPERATION_CLEANUP) != null) {
-    options.setProperty(ServiceClient.AUTO_OPERATION_CLEANUP,
-            Boolean.parseBoolean(
-                    System.getProperty(APIMgtGatewayConstants.AUTO_TRANSPORT_OPERATION_CLEANUP)));
+String autoCleanupPropertyValue = System.getProperty(APIMgtGatewayConstants.AUTO_TRANSPORT_OPERATION_CLEANUP);
+if (autoCleanupPropertyValue != null) {
+    boolean autoCleanup = Boolean.parseBoolean(autoCleanupPropertyValue);
+    options.setProperty(ServiceClient.AUTO_OPERATION_CLEANUP, autoCleanup);
+    if (log.isDebugEnabled()) {
+        log.debug("Setting ServiceClient.AUTO_OPERATION_CLEANUP to " + autoCleanup);
+    }
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac8150 and 8fdfe31.

📒 Files selected for processing (2)
  • components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/APIMgtGatewayConstants.java (1 hunks)
  • components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/basicauth/BasicAuthCredentialValidator.java (2 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/basicauth/BasicAuthCredentialValidator.java (1)
components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/APIMgtGatewayConstants.java (1)
  • APIMgtGatewayConstants (22-202)
🔇 Additional comments (1)
components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/APIMgtGatewayConstants.java (1)

183-183: Looks good - new constant for configurable transport cleanup.

This constant introduces the system property that allows users to configure the auto-cleanup process for transport operations, aligning with the PR objective.

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.

Intermittent 500 Errors During Basic Auth API Invocations Due to APIKeyMgtRemoteUserStoreMgtService Failures
1 participant