[fix] [client] Fix memory leak when publishing encountered a corner case error

[poorbarcode]

Motivation

Issue 1: memory leak if get errors when publishing
Conditions:

• Send queue is full
• Or reaches the limitation named max message size
• Or publishes after closing the producer
• Or encounters an error when calling ProducerInterceptor. eligible
• see testSendQueueIsFull, testSendMessageSizeExceeded, testSendAfterClosedProducer, and testInterceptorError

Modifications

• Fix issues

Documentation

• doc
• doc-required
• doc-not-needed
• doc-complete

Matching PR in forked repository

PR in forked repository: x

[poorbarcode]

/pulsarbot rerun-failure-checks

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.31%. Comparing base (bbc6224) to head (9f99fd2).
Report is 801 commits behind head on master.

Files with missing lines	Patch %	Lines
...va/org/apache/pulsar/client/impl/ProducerImpl.java	90.90%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #23738      +/-   ##
============================================
+ Coverage     73.57%   74.31%   +0.73%     
+ Complexity    32624     2374   -30250     
============================================
  Files          1877     1838      -39     
  Lines        139502   143053    +3551     
  Branches      15299    16232     +933     
============================================
+ Hits         102638   106304    +3666     
+ Misses        28908    28376     -532     
- Partials       7956     8373     +417     

Flag	Coverage Δ
inttests	26.75% <23.52%> (+2.17%)	⬆️
systests	23.71% <23.52%> (-0.62%)	⬇️
unittests	73.66% <94.11%> (+0.82%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
.../pulsar/client/impl/BatchMessageContainerImpl.java	85.79% <100.00%> (+4.89%)	⬆️
...pache/pulsar/client/impl/ProducerInterceptors.java	72.50% <100.00%> (ø)
...va/org/apache/pulsar/client/impl/ProducerImpl.java	84.00% <90.90%> (+0.40%)	⬆️

... and 1007 files with indirect coverage changes

[poorbarcode]

@codelipenghui

The fix looks good me, but when I try to run the newly added test on the master branch (without this fix). A lot of test cases can still get passed. Could you please help if this is expected?

• testSendMessageSizeExceeded: it should fail when the @param is larger than 1, I improved the test, and it is fine now.
• testBatchedSendMessageSizeExceeded: it is expected that the tests can pass because the batch message will only check the max message size that excludes message metadata
• testInterceptorError: only @param eligible has an issue, so it is expected.

[lhotari]

@poorbarcode @BewareMyPower Please review #23761, that addresses a long time issue where the completable futures of pending messages weren't completed when close was called. It's also a case which could result into a resource leak situation.