I'm afraid it's very hard to avoid these API changes. Take the protocol handler as example, it could make use of nearly all modules via the `PulsarService` object. The cost to keep the compatibility might be high so that much legacy code could be left. For example, each time a new argument is added to a method, we have to add an overload to keep the compatibility. It could be confusing to people who don't know these extensions and they might wonder why an overload is needed that is never used in the Pulsar's main repo.
The root cause is that we don't have an API abstraction for the pulsar-broker module, like the pulsar-client-api module to the pulsar-client mode. But it could be a huge project to add something like pulsar-broker-api. Thanks, Yunze On Wed, Dec 7, 2022 at 1:21 PM <mattisonc...@gmail.com> wrote: > > > It would help me understand if you would explain how apis were changed in > > this PR > Sorry, I explained above. it's a small break, maybe it just breaks some unit > test mock, but it can be used as an example. > > We should be sure to track and then highlight API changes in release > > documents. > > API changes should be held until the next major version (now 2.12) and be > > documented with that release. > > I think we need to be explicit in our GitHub PR template. I don’t have a > > suggested edit yet, but the idea is to add text about > > 1. How the PR changes the API2. Which PIP authorizes it > +1 for an awesome idea. > > Am I just wondering if we can avoid breaking it? maybe we can give the old > method a @Deprecated? > > Best, > Mattison > On Dec 7, 2022, 12:56 +0800, Dave Fisher <wave4d...@comcast.net>, wrote: > > We should be sure to track and then highlight API changes in release > > documents. API changes should be held until the next major version (now > > 2.12) and be documented with that release. I think we need to be explicit > > in our GitHub PR template. I don’t have a suggested edit yet, but the idea > > is to add text about 1. How the PR changes the API 2. Which PIP authorizes > > it
