apolloconfig / apollo-java

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

perf: speed up the first loading of namespace when startup meet 404 #61

Closed Anilople closed 6 months ago

Anilople commented 6 months ago

What's the purpose of this PR

Speed up the user's startup time,

by decrease the number of http requests.

Which issue(s) this PR fixes:

Fixes https://github.com/apolloconfig/apollo-java/issues/60

Brief changelog

before change, it use 11494 ms to load 10 namespace when meet 404, before-change.log

after delete 2 http requests when context init, it use 1490 ms. after-change.log

i.e from 11494 ms to 1490 ms.

the code in https://github.com/apolloconfig/apollo-java/blob/bcc40531f32e74d0c639b5e5d2ab2995fd00c3d6/apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultConfig.java#L69 will ensure pull at least one time from remote when startup.

Follow this checklist to help us incorporate your contribution quickly and easily:

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent changes in the apollo-client module primarily focus on improving the initialization process to speed up the user's startup time. The changes include adding an initialize() method to various classes and interfaces, modifying constructors to avoid initial synchronization calls, and updating tests to reflect these changes.

Changes

File Path Change Summary
apollo-client/src/main/java/com/ctrip/framework/apollo/internals/AbstractConfigRepository.java Added initialize() method to call sync().
apollo-client/src/main/java/com/ctrip/framework/apollo/internals/ConfigRepository.java Added default initialize() method to the interface.
apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultConfig.java Added call to m_configRepository.initialize() in initialize() method.
apollo-client/src/main/java/com/ctrip/framework/apollo/internals/LocalFileConfigRepository.java Commented out trySync() call in the constructor.
apollo-client/src/main/java/com/ctrip/framework/apollo/internals/RemoteConfigRepository.java Commented out trySync() call in the constructor.
apollo-client/src/test/java/com/ctrip/framework/apollo/internals/LocalFileConfigRepositoryTest.java Added assertion to check source type before and after initialization in testOnRepositoryChange.

Assessment against linked issues

Objective (Issue #60) Addressed Explanation
Speed up user's startup time by reducing IO calls βœ…
Fast fail when encountering errors βœ…

In the land of code where rabbits play, Initialization now speeds the way. Sync calls deferred, constructors light, Users' startup times take flight. With tests to check, and code so bright, Apollo's changes feel just right. πŸ‡βœ¨


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.` 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](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.