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

Upgrade netty version #12953

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

YasasRangika
Copy link
Contributor

@YasasRangika YasasRangika commented Feb 18, 2025

io.netty Upgrade

Purpose

Upgrades carbon mediation and synapse versions to bump the io.netty version from 4.1.117.Final to non-vulnerable 4.1.118.Final.

Related PRs:

transport-http: wso2/transport-http#475
synapse: wso2/wso2-synapse#2333
carbon-mediation: wso2/carbon-mediation#1763
product-apim: wso2/product-apim#13688

Json-smart Upgrade

Purpose

To upgrade json-smart version from 2.5.0 to the non-vulnerable 2.5.2 version.

Related PRs:

Identity-inbound-auth-oauth: wso2-extensions/identity-inbound-auth-oauth#2730
Carbon-identity-framework: wso2/carbon-identity-framework#6543
Identity-inbound-auth-openid: wso2-extensions/identity-inbound-auth-openid#109
Identity-outbound-auth-oidc: wso2-extensions/identity-outbound-auth-oidc#199
Carbon-mediation: wso2/carbon-mediation#1767
Carbon-analytics-common: wso2/carbon-analytics-common#862
Product-apim: wso2/product-apim#13688

Summary by CodeRabbit

  • New Features
    • Introduced an enhanced API throttling setting that refines the failover behavior, offering more controlled performance during high-load scenarios.
  • Chores
    • Updated dependency versioning to dynamically incorporate the latest stable releases, enhancing overall system security and reliability.
    • Added a new configuration entry for throttling settings to improve application performance.

Copy link

coderabbitai bot commented Feb 21, 2025

Walkthrough

This pull request updates dependency version management in the pom.xml file. Fixed version numbers for carbon.analytics.common.version, carbon.mediation.version, carbon.identity.version, and synapse.version have been replaced with the <LATEST_RELEASE_VERSION> placeholder to enable dynamic versioning. Additionally, the version for json-smart has been incremented from 2.5.0 to 2.5.2. New configuration entries have been added to support throttling settings in the API management configuration files, enhancing the existing configuration structure.

Changes

File Change Summary
pom.xml Replaced fixed version numbers for carbon.analytics.common.version, carbon.mediation.version, carbon.identity.version, and synapse.version with <LATEST_RELEASE_VERSION>. Updated json-smart.version from 2.5.0 to 2.5.2.
features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/org.wso2.carbon.apimgt.core.default.json Added new configuration entry: "apim.throttling.sequential_failover_from_beginning": "false".
features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2 Added new element <SequentialFailoverFromBeginning>{{apim.throttling.sequential_failover_from_beginning}}</SequentialFailoverFromBeginning> in <JMSConnectionParameters> and <EventReceiverConfiguration>.

Poem

Hop, hop, hooray for versions anew,
I, a little rabbit, dance with code so true.
Fixed numbers hop aside for dynamic delight,
Each dependency now glowing with a fresher light.
Bound through the branches of our code, we delight!
🐇💻


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ae5f0c1 and 38f094e.

📒 Files selected for processing (3)
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/org.wso2.carbon.apimgt.core.default.json (1 hunks)
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2 (2 hunks)
  • pom.xml (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/org.wso2.carbon.apimgt.core.default.json
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2
🔇 Additional comments (6)
pom.xml (6)

2050-2050: Dynamic Versioning for Carbon Analytics Common
The fixed version for carbon.analytics.common.version is replaced with <LATEST_RELEASE_VERSION>, enabling dynamic version management. Please verify that your build and dependency resolution processes are fully compatible with this placeholder and that downstream modules relying on this version can correctly resolve the intended release.


2060-2060: Dynamic Versioning for Carbon Mediation
Replacing the explicit version for carbon.mediation.version with <LATEST_RELEASE_VERSION> makes the dependency management more flexible. Ensure that any adjustments in related components (for example, the netty upgrade and mediation-specific functionality) are thoroughly tested to prevent compatibility issues.


2065-2065: Dynamic Versioning for Carbon Identity
Changing carbon.identity.version to <LATEST_RELEASE_VERSION> aligns with the new dynamic versioning strategy. Please confirm that all dependent modules (and any external integration points) have been updated to use this new placeholder range to avoid inadvertent version mismatches.


2140-2140: Dynamic Versioning for Synapse
The change from a fixed synapse version to <LATEST_RELEASE_VERSION> should help maintain compatibility with related updates. It is recommended to run a full integration test suite to ensure that Synapse-specific APIs and behaviors remain consistent once the dynamic version is resolved at build time.


2177-2177: json-smart.version Update
The update from version 2.5.0 to 2.5.2 for json-smart addresses the known vulnerabilities. Verify that there are no breaking changes introduced by this upgrade and that all functionality interacting with json-smart remains intact.


2178-2178: Addition of org.apache.velocity.version Property
Introducing the property <org.apache.velocity.version>2.3</org.apache.velocity.version> adds explicit control over the Velocity dependency. Ensure that this version is compatible with other modules that leverage Apache Velocity. Document the rationale for this update if not already present to aid future maintainers.


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 (1)
features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/org.wso2.carbon.apimgt.core.default.json (1)

143-143: LGTM! Consider adding documentation for the new throttling configuration.

The new configuration property sequential_failover_from_beginning with a default value of "false" is a good addition. This helps control failover behavior in throttling.

Consider adding a comment above this line to document:

  • The purpose of this configuration
  • The impact of setting it to true/false
  • Any prerequisites or related configurations
+ // Controls whether throttling failover should restart from the beginning
+ // Set to true to restart from the first endpoint on failover
+ // Set to false to continue with the next available endpoint
  "apim.throttling.sequential_failover_from_beginning": "false",
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a3371f8 and ae5f0c1.

📒 Files selected for processing (3)
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/org.wso2.carbon.apimgt.core.default.json (1 hunks)
  • features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2 (2 hunks)
  • pom.xml (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pom.xml
🔇 Additional comments (1)
features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2 (1)

1166-1166: LGTM! The XML template changes are consistent with the JSON configuration.

The addition of <SequentialFailoverFromBeginning> elements in both JMS connection parameters and event receiver configuration sections is correct and properly references the new configuration value.

Also applies to: 1623-1623

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