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

[WIP] Support customer exception #1411

Conversation

wangchengming666
Copy link
Collaborator

@wangchengming666 wangchengming666 commented Apr 16, 2024

Motivation:

Explain the context, and why you're making that change.
To make others understand what is the problem you're trying to solve.

Modification:

Describe the idea and modifications you've done.

Result:

Fixes #.

If there is no issue then describe the changes introduced by this PR.

Summary by CodeRabbit

  • New Features
    • Enhanced retry logic to handle user-defined exceptions, allowing for more flexible and robust error recovery in RPC operations.
    • Introduced a new configuration option to specify user-defined exceptions for consumers, improving customization of error handling.
  • Refactor
    • Updated exception handling infrastructure to support new user-defined error types.
  • Documentation
    • Added new constants and configuration settings in the API documentation to assist developers in utilizing the new features effectively.

@sofastack-cla sofastack-cla bot added cla:yes CLA is ok size/M labels Apr 16, 2024
Copy link
Contributor

coderabbitai bot commented Apr 16, 2024

Walkthrough

The updates introduce handling and configuration for user-defined exceptions within the SOFARPC framework. This allows for custom exceptions to be specified for retry logic, enhancing flexibility for business applications to manage retries based on specific needs.

Changes

File Path Change Summary
.../client/FailoverCluster.java Added handling for user-defined exceptions in retry logic.
.../common/RpcOptions.java
.../config/ConsumerConfig.java
Introduced handling and configuration for a new field customerExceptions.
.../common/rpc-config-default.json Added new configuration for user-defined exception collection.
.../core/exception/RpcErrorType.java Added a new constant to represent user-defined exceptions.

Possibly related issues

  • Support custom exception retry #1362: The changes directly address the issue's request for support in retrying custom exceptions, allowing users to specify which exceptions can trigger retries.

🐇✨
A hop, a skip, in the code we weave,
Now custom troubles, you can relieve.
Retry, retry, with exceptions you choose,
SOFARPC adapts, you no longer lose.
🌟🐰


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f4a18df and 2812056.
Files selected for processing (5)
  • core-impl/client/src/main/java/com/alipay/sofa/rpc/client/FailoverCluster.java (2 hunks)
  • core/api/src/main/java/com/alipay/sofa/rpc/common/RpcOptions.java (1 hunks)
  • core/api/src/main/java/com/alipay/sofa/rpc/config/ConsumerConfig.java (3 hunks)
  • core/common/src/main/resources/com/alipay/sofa/rpc/common/rpc-config-default.json (1 hunks)
  • core/exception/src/main/java/com/alipay/sofa/rpc/core/exception/RpcErrorType.java (1 hunks)
Additional comments not posted (5)
core/exception/src/main/java/com/alipay/sofa/rpc/core/exception/RpcErrorType.java (1)

109-109: The addition of CUSTOMER_DESIGN_ERROR with value 310 is correctly implemented and follows the existing naming and coding conventions.

core-impl/client/src/main/java/com/alipay/sofa/rpc/client/FailoverCluster.java (1)

100-106: The implementation for retrying on user-defined exceptions is correctly placed and follows logical exception handling practices.

core/common/src/main/resources/com/alipay/sofa/rpc/common/rpc-config-default.json (1)

174-175: The addition of the consumer.exceptions configuration key is correctly implemented and allows for specifying user-defined exceptions as expected.

core/api/src/main/java/com/alipay/sofa/rpc/common/RpcOptions.java (1)

305-305: The addition of the CONSUMER_EXCEPTIONS constant is correctly implemented and follows the existing conventions for configuration keys.

core/api/src/main/java/com/alipay/sofa/rpc/config/ConsumerConfig.java (1)

40-40: The addition of the static import for getListValue is appropriate for handling list configurations.


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
Contributor

@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: 2

/**
* 用户自定义异常集合
*/
protected List<String> customerExceptions = getListValue(CONSUMER_EXCEPTIONS);
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider renaming customerExceptions to consumerExceptions to maintain naming consistency with the static import CONSUMER_EXCEPTIONS.

- protected List<String> customerExceptions = getListValue(CONSUMER_EXCEPTIONS);
+ protected List<String> consumerExceptions = getListValue(CONSUMER_EXCEPTIONS);

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
protected List<String> customerExceptions = getListValue(CONSUMER_EXCEPTIONS);
protected List<String> consumerExceptions = getListValue(CONSUMER_EXCEPTIONS);

Comment on lines +452 to +458
public List<String> getCustomerExceptions() {
return customerExceptions;
}

public void setCustomerExceptions(List<String> customerExceptions) {
this.customerExceptions = customerExceptions;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

The getter and setter methods for customerExceptions are correctly implemented. However, consider renaming them to align with the suggested field name change to consumerExceptions.

- public List<String> getCustomerExceptions() {
+ public List<String> getConsumerExceptions() {
      return consumerExceptions;
  }

- public void setCustomerExceptions(List<String> customerExceptions) {
+ public void setConsumerExceptions(List<String> consumerExceptions) {
      this.consumerExceptions = consumerExceptions;
  }

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
public List<String> getCustomerExceptions() {
return customerExceptions;
}
public void setCustomerExceptions(List<String> customerExceptions) {
this.customerExceptions = customerExceptions;
}
public List<String> getConsumerExceptions() {
return consumerExceptions;
}
public void setConsumerExceptions(List<String> consumerExceptions) {
this.consumerExceptions = consumerExceptions;
}

Copy link

stale bot commented Jun 16, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Jun 16, 2024
@stale stale bot closed this Jun 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes CLA is ok size/M wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant