perf: speed up when startup meet timeout
What's the purpose of this PR
Speed up when startup meet timeout, i.e when meet meta service and config service crash.
Which issue(s) this PR fixes:
Fixes #60
Brief changelog
There is a synchronized lock in
https://github.com/apolloconfig/apollo-java/blob/3f0979da3ea6478304719a71d4991fe4787558d1/apollo-client/src/main/java/com/ctrip/framework/apollo/internals/ConfigServiceLocator.java#L193
It will block even use multiple thread.
When try to getConfigServices, if cache is empty, method updateConfigServices will be invoke
https://github.com/apolloconfig/apollo-java/blob/3f0979da3ea6478304719a71d4991fe4787558d1/apollo-client/src/main/java/com/ctrip/framework/apollo/internals/ConfigServiceLocator.java#L162-L167
In this pr, the code change to fail quickly, so it can speed up when meta service and config service crash(that will cause timeout for client).
Maybe it better to let daemon thread to invoke method updateConfigServices,
another thread just use the result in memory cache,
If there is no available config service, throw exception quickly.
After change, load 10 namespaces timeusage from 65929 ms to 5150ms when all of them meet timeout
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the Contributing Guide before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [ ] Run
mvn clean testto make sure this pull request doesn't break anything. - [x] Update the
CHANGESlog.
Summary by CodeRabbit
-
New Features
- Enhanced timeout handling and recovery for configuration services, ensuring better reliability during network issues.
-
Improvements
- Improved initialization logic for configuration services, enhancing startup performance and stability.
-
Bug Fixes
- Added exception handling for unavailable configuration services, providing clearer error messages.
-
Tests
- Added comprehensive tests for timeout scenarios, ensuring robust handling of multiple namespaces and recovery mechanisms.
-
Refactor
- Updated access modifiers and logging levels for better code maintainability and readability.
Walkthrough
The updates enhance the Apollo Java client by optimizing the startup process, particularly when encountering timeouts. Key changes include improvements in HTTP request handling, task submission control, and configuration updates, significantly reducing the time taken to load namespaces under error conditions.
Changes
| Files/Modules | Change Summary |
|---|---|
ConfigServiceLocator.java |
Enhanced initialization, added timeout configuration, task submission control, and rate limiting. |
ConfigUtil.java |
Added new configuration fields and refactored methods to include timeout settings. |
BaseIntegrationTest.java |
Updated imports, logger declaration, and added methods for file operations and configuration assembly. |
MockedConfigService.java |
Added constant and method for simulating timeout. |
ConfigServiceLocatorTest.java |
Updated imports and test methods, added new test for exception handling. |
RemoteConfigRepositoryTest.java |
Removed calls to remoteConfigLongPollService.stopLongPollingRefresh() from various test methods. |
CHANGES.md |
Documented performance enhancement for handling timeouts during startup. |
Sequence Diagram(s) (Beta)
sequenceDiagram
participant Client
participant ConfigServiceLocator
participant ExecutorService
participant ConfigUtil
participant RemoteConfigService
Client->>ConfigServiceLocator: Initialize
ConfigServiceLocator->>ConfigUtil: Get timeout settings
ConfigServiceLocator->>ExecutorService: Submit update task
ExecutorService->>RemoteConfigService: Fetch config services
RemoteConfigService-->>ExecutorService: Response
ExecutorService-->>ConfigServiceLocator: Update config services
ConfigServiceLocator-->>Client: Return config services
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Speed up user's startup time (Issue #60) | ✅ |
Poem
In the land of Apollo, where configs flow, Startup's swift, no more slow. With timeouts tamed and tasks in line, Our client shines, truly divine. Fast and bright, like a comet's flight, Apollo's updates bring delight. 🌟
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?
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
@coderabbitaiin 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
@coderabbitaiin 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. -
@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 as PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto 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.yamlfile 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.