liangyepianzhou opened a new pull request, #24293:
URL: https://github.com/apache/pulsar/pull/24293
### Motivation
The current method `checkTopicExists` is an asynchronous method but follows
a synchronous naming convention (lacking the `Async` suffix). This naming
inconsistency can mislead developers into assuming it's a blocking operation,
potentially causing misuse in client code. Since this method is `public`, we
cannot remove it directly without breaking backward compatibility.
### Modifications
1. **Introduce a new asynchronous method**:
- Added `checkTopicExistsAsync()` with the correct asynchronous naming
convention.
- Internally delegates to the original `checkTopicExists()` method to
retain existing logic.
2. **Deprecate the original method**:
- Marked `checkTopicExists()` as `@Deprecated` with a note directing
users to the new `checkTopicExistsAsync()`.
3. **Refactor internal usages**:
- Updated all internal calls to use `checkTopicExistsAsync()` instead of
the deprecated method.
4. **Documentation updates**:
- Added Javadoc to `checkTopicExists()` clarifying its deprecated status
and replacement.
This approach maintains backward compatibility while aligning method names
with their asynchronous behavior.
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe
tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads
(10MB)*
- *Extended integration test for recovery after broker failure*
### 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]
