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

feat: Portal 模块 RestTemplate 支持配置 ConnectionTimeToLive #5121

Merged
merged 1 commit into from
Apr 9, 2024

Conversation

larry4xie
Copy link
Contributor

@larry4xie larry4xie commented Apr 7, 2024

希望 Portal 模块 RestTemplateFactory 支持配置 ConnectionTimeToLive,详见 #5120

Summary by CodeRabbit

  • New Features
    • Enhanced network connection stability by configuring the connection time to live.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Apr 7, 2024
Copy link

coderabbitai bot commented Apr 7, 2024

Walkthrough

The changes involve enhancing the Apollo Portal's RestTemplate component to support configurable connection lifetimes. This is achieved by adding a new configuration option in PortalConfig and utilizing it to set the ConnectionTimeToLive for the CloseableHttpClient used by the RestTemplateFactory. This update aims to improve the resilience of the service discovery mechanism under network fault conditions.

Changes

File Path Change Summary
.../apollo/portal/component/RestTemplateFactory.java Added TimeUnit import; modified CloseableHttpClient creation to use connectionTimeToLive from PortalConfig.
.../apollo/portal/component/config/PortalConfig.java Added connectionTimeToLive() method to return api.connectionTimeToLive property value.

Possibly related issues

  • apolloconfig/apollo#5120: The issue requests for ConnectionTimeToLive configurability in the Portal module to address network fault scenarios. This PR directly implements the requested feature, suggesting a solution to the problem outlined.

Poem

As the moon whispers to the night, a change takes flight,
In the land of Apollo, where configurations shine bright.
🐇 A rabbit hopped, code in paw, setting connections to renew,
🌌 Under starlit skies, a resilience grew.
Through the network's weave, they dance and weave,
A tale of connections, in which we believe.
So here's to changes, both big and small, a toast,
For every packet lost, may resilience be our boast.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

github-actions bot commented Apr 7, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

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

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c884de5 and 632d4b7.
Files selected for processing (2)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/component/RestTemplateFactory.java (2 hunks)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/component/config/PortalConfig.java (1 hunks)
Additional comments not posted (3)
apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/component/RestTemplateFactory.java (2)

31-31: The import of TimeUnit is correctly added to support specifying the time unit for connection TTL.


62-64: The implementation correctly sets the connection TTL for CloseableHttpClient. Ensure that the default TTL value of -1 behaves as expected (e.g., connections do not expire prematurely).

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/component/config/PortalConfig.java (1)

172-174: The connectionTimeToLive() method is correctly implemented to fetch the TTL configuration. Consider documenting the default behavior when the TTL is set to -1.

@shoothzj
Copy link
Member

shoothzj commented Apr 7, 2024

Thanks for your contribution. I have a question. Is there any mechanism like RestTemplate timeout reconnect?

@larry4xie
Copy link
Contributor Author

@shoothzj 丢包会产生 read timeout, 但是不同于 TCP FIN or RST, RestTemplate 不会重建连接,还是使用的被故障注入的 IP

Copy link
Member

@shoothzj shoothzj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense if ClosableHttpClient will not reconnect after rw timeout

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 8, 2024
@larry4xie
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@nobodyiam nobodyiam merged commit 287ec50 into apolloconfig:master Apr 9, 2024
10 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants