apolloconfig / apollo-java

Apollo Java Clients
Apache License 2.0
40 stars 72 forks source link

perf: speed up when startup meet timeout #64

Closed Anilople closed 5 months ago

Anilople commented 6 months ago

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:

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.