Shawyeok opened a new pull request, #20521:
URL: https://github.com/apache/pulsar/pull/20521
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see
*[Guideline - Pulsar PR Naming
Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
-->
### Motivation
Throws an exception from a async method generally a bad practice, for
example in `ProducerBuilderImpl#createAsync`, `checkArgument` may throws a
runtime exception directly:
https://github.com/apache/pulsar/blob/50b9a93e42e412d9f17b1637287d1a4c7c7ab148/pulsar-client/src/main/java/org/apache/pulsar/client/impl/ProducerBuilderImpl.java#L94-L97
If user call it in a async context, it may cause some unexpected behavior,
here is a case:
```java
CompletableFuture<xxx> future = new CompletableFuture<>();
xxx.whenComplete((v, ex) -> {
xxx.createAsync().whenComplete((v, ex) -> {
if (ex != null) {
future.completeExceptionally(ex);
} else {
future.complete(v);
}
});
})
```
If `createAsync()` throws an exception from inside, the `future` will never
get completed. This kind of problem is very hard to troubleshooting cause it
could haven’t any log.
So I wrote a PMD rule to examine the entire Pulsar codebase (current master
branch), aiming to identify similar kinds of problems. Here it is:
```
//MethodDeclaration[matches(@Name, "Async$")]
[.//PrimaryPrefix/Name[matches(@Image,
"(requireNonNull|checkNotNull|checkState|checkArgument)$")]]
```
Note: this rule may not be able to scan all similar code issues.
### Modifications
Return a failed future instead of throw exception directly, for the given
case above, it's will be change to:
```java
public CompletableFuture<Producer<T>> createAsync() {
// config validation
if (conf.isBatchingEnabled() && conf.isChunkingEnabled()) {
return FutureUtil.failedFuture(
new IllegalArgumentException("Batching and chunking of
messages can't be enabled together"));
}
```
### Verifying this change
- [x] Make sure that the change passes the CI checks.
### Does this pull request potentially affect one of the following parts:
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update
later -->
- [x] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions
will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since
the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed
in
a forked repository.
The tests will be run in the forked repository until all PR review comments
have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
