michaeljmarshall opened a new issue #10046:
URL: https://github.com/apache/pulsar/issues/10046


   ## Observation of Typo
   Based on looking through the results of a topic stats call, I noticed that 
there appears to be a typo in one of the keys. Producers use the key 
`chunkedMessageRate` while consumers use `chuckedMessageRate`. 
[Here](https://github.com/apache/pulsar/blob/c754f9e90c4ec08a1be744d497ce81fa3dcfd568/site2/docs/admin-api-topics.md#stats-1)
 is an example result from topic stats. Notice that the first uses `chunk` and 
the second uses `chuck`.
   
   It looks like the first possible typo was introduced in June, 2020 by 
https://github.com/apache/pulsar/pull/4400, and it also looks like the PIP has 
a single typo where it refers to `maxPendingChuckedMessage`: 
https://github.com/apache/pulsar/wiki/PIP-37:-Large-message-size-handling-in-Pulsar#client-changes.
 Otherwise, the PIP only uses `chunk`.
   
   After digging into this, I am pretty sure that `chucked` is a typo, but I 
think I might also be wrong about that. Please let me know if `chucked` was 
intentionally used.
   
   ## Examples
   
   Here are two examples where `chuck` and `chunk` are used in close proximity, 
as if they are interchangeable.
   
   
https://github.com/apache/pulsar/blob/3988f9ff369b42066cdf6ccaf451fda6dc46eede/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdConsume.java#L110-L111
   
   
https://github.com/apache/pulsar/blob/85b1c7ef8a37e0bc06052f04ecd5da076804e8cb/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java#L664-L698
   
   ## Proposal
   If `chucked` is confirmed to be a typo, which I think it is, I am wondering 
what the right path forward is for fixing a typo that is in the public api. I 
believe a simple update would count as a breaking change, so I am thinking we 
should add a `@deprecated` flag where possible as well as add the correctly 
spelled method/variable to whatever classes. In the JSON, is it worth supplying 
it under both the correct and the typo'ed name? I am definitely open to 
suggestions.
   
   I'm happy to help work this issue, if we confirm that it is in fact a typo.


-- 
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.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to