[improve][misc] Optimize TLS performance by omitting extra buffer copies

[lhotari]

Motivation

In Pulsar, there has been a long time workaround (#2464) for a Netty SslHandler issue where the input ByteBuf instances get mutated. After Netty 4.1.111.Final, it's no longer necessary to make buffer copies when TLS is enabled. This change on Netty side netty/netty#14086 contains the fix.

Modifications

Since the Pulsar client might get used with an older Netty version, it's necessary to detect that the Netty version contains the fix. The simplest way to detect Netty 4.1.111.Final is by checking for existence of the class io.netty.handler.ssl.SslHandlerCoalescingBufferQueue since that class was extracted from an inner class in 4.1.111.Final.

Instead of referencing ByteBufPair.ENCODER and ByteBufPair.COPYING_ENCODER directly, use ByteBufPair.getEncoder(tlsEnabled) to choose the correct encoder. The COPYING_ENCODER will only be used if an older Netty version is detected. This could be the case when a client application uses the pulsar-client-original maven dependency and the application uses an older Netty version.

Documentation

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

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.

Project coverage is 73.44%. Comparing base (bbc6224) to head (937b3e3).
Report is 1123 commits behind head on master.

Files with missing lines	Patch %	Lines
...org/apache/pulsar/common/protocol/ByteBufPair.java	57.14%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #23115      +/-   ##
============================================
- Coverage     73.57%   73.44%   -0.13%     
- Complexity    32624    33229     +605     
============================================
  Files          1877     1919      +42     
  Lines        139502   144113    +4611     
  Branches      15299    15746     +447     
============================================
+ Hits         102638   105844    +3206     
- Misses        28908    30158    +1250     
- Partials       7956     8111     +155     

Flag	Coverage Δ
inttests	27.83% <72.72%> (+3.24%)	⬆️
systests	24.73% <72.72%> (+0.40%)	⬆️
unittests	72.52% <72.72%> (-0.32%)	⬇️

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

Files with missing lines	Coverage Δ
...ulsar/broker/service/PulsarChannelInitializer.java	95.00% <100.00%> (ø)
...e/pulsar/client/impl/PulsarChannelInitializer.java	91.26% <100.00%> (+0.08%)	⬆️
...org/apache/pulsar/common/protocol/ByteBufPair.java	78.84% <57.14%> (-21.16%)	⬇️

... and 519 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.