apolloconfig / apollo-java

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

fix the npe issue when @ApolloJsonValue is annotated on methods #67

Closed nobodyiam closed 5 months ago

nobodyiam commented 5 months ago

What's the purpose of this PR

53 introduced a feature that parses time based on a pattern for @ApolloJsonValue. However, it caused an issue with NullPointerException (NPE) when @ApolloJsonValue is used as a method annotation. This pull request aims to resolve that issue.

Which issue(s) this PR fixes:

Fixes #53

Brief changelog

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

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

In AutoUpdateConfigChangeListener.java within the apollo-client module, the resolvePropertyValue method has been updated to enhance its functionality. The method now checks if springValue is a field or a method parameter before retrieving the ApolloJsonValue annotation. This change ensures more precise handling of JSON values and their associated date patterns, refining the way date and time strings are parsed based on custom patterns specified in @ApolloJsonValue.

Changes

File Path Change Summary
.../apollo/spring/property/AutoUpdateConfigChangeListener.java Updated resolvePropertyValue method to check if springValue is a field or a method parameter before retrieving ApolloJsonValue annotation.

Sequence Diagram(s)

sequenceDiagram
    participant Application
    participant AutoUpdateConfigChangeListener
    participant SpringValue
    participant ApolloJsonValue

    Application->>AutoUpdateConfigChangeListener: Initiates property value resolution
    AutoUpdateConfigChangeListener->>SpringValue: Check if field or method parameter
    SpringValue-->>AutoUpdateConfigChangeListener: Return type (field/parameter)
    AutoUpdateConfigChangeListener->>ApolloJsonValue: Retrieve annotation (if available)
    ApolloJsonValue-->>AutoUpdateConfigChangeListener: Return annotation details
    AutoUpdateConfigChangeListener->>Application: Return resolved value considering date pattern

Assessment against linked issues

Objective Addressed Explanation
Implement parsing time based on pattern for @ApolloJsonValue (Issues #49, #53) ✅
Make use of Gson's way to turn a string into a date to handle time strings according to a given pattern (Issues #49, #53) ✅

Poem

In code's quiet dance, a change we spell,
To parse the dates and parse them well.
With ApolloJsonValue, new patterns we find,
Resolving fields and parameters, intricately defined.
🌟 Code evolves, as stars align,
✨ Making JSON dates truly shine.


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.