(WIP) Add performance check

Author: BewareMyPower

.clang-tidy

@@ -16,77 +16,25 @@
 # under the License.
 
 ---
-#bugprone-*,
-#google-*,
-#misc-*,
-#modernize-*,
-#performance-*,
-#portability-*,
-#readability-*,
-#-google-readability-braces-around-statements,
-#-google-readability-namespace-comments,
-#-google-runtime-references,
-#-misc-non-private-member-variables-in-classes,
-#-misc-const-correctness,
-#-misc-include-cleaner,
-#-modernize-return-braced-init-list,
-#-modernize-use-trailing-return-type,
-#-modernize-concat-nested-namespaces,
-#-modernize-use-nodiscard,
-#-modernize-avoid-c-arrays,
-#-modernize-type-traits,
-#-modernize-unary-static-assert,
-#-performance-move-const-arg,
-#-performance-avoid-endl,
-#-performance-enum-size,
-#-readability-braces-around-statements,
-#-readability-identifier-length,
-#-readability-magic-numbers,
-#-readability-named-parameter,
-#-readability-redundant-declaration,
-#-readability-avoid-return-with-void-value,
-#-readability-function-cognitive-complexity,
-#-bugprone-narrowing-conversions,
-#-bugprone-easily-swappable-parameters,
-#-bugprone-inc-dec-in-conditions,
-#-bugprone-implicit-widening-of-multiplication-result,
-#-bugprone-unchecked-optional-access,
-#-bugprone-unused-local-non-trivial-variable,
-#-bugprone-unused-return-value,
-#-bugprone-reserved-identifier,
-#-google-build-using-namespace,
-#-misc-unused-parameters,
-#-modernize-deprecated-headers,
-#-modernize-use-equals-default,
-#-modernize-use-using,
-#-readability-enum-initial-value,
+# TODO: add more checks
+# - bugprone
+# - cppcoreguidelines
+# - portability
+# - readability
 Checks: >
   -*,
   clang-analyzer-*,
   -clang-analyzer-security.insecureAPI.rand,
+  performance-*,
+  -performance-inefficient-string-concatenation
 WarningsAsErrors: '*'
 HeaderFileExtensions:
   - ''
   - h
 ImplementationFileExtensions:
   - cc
-HeaderFilterRegex: '.*'
+HeaderFilterRegex: '^(?!.*PulsarApi\.pb\.h$).*$'
 FormatStyle:     none
 CheckOptions:
-  cert-err33-c.CheckedFunctions: '^::aligned_alloc;^::asctime_s;^::at_quick_exit;^::atexit;^::bsearch;^::bsearch_s;^::btowc;^::c16rtomb;^::c32rtomb;^::calloc;^::clock;^::cnd_broadcast;^::cnd_init;^::cnd_signal;^::cnd_timedwait;^::cnd_wait;^::ctime_s;^::fclose;^::fflush;^::fgetc;^::fgetpos;^::fgets;^::fgetwc;^::fopen;^::fopen_s;^::fprintf;^::fprintf_s;^::fputc;^::fputs;^::fputwc;^::fputws;^::fread;^::freopen;^::freopen_s;^::fscanf;^::fscanf_s;^::fseek;^::fsetpos;^::ftell;^::fwprintf;^::fwprintf_s;^::fwrite;^::fwscanf;^::fwscanf_s;^::getc;^::getchar;^::getenv;^::getenv_s;^::gets_s;^::getwc;^::getwchar;^::gmtime;^::gmtime_s;^::localtime;^::localtime_s;^::malloc;^::mbrtoc16;^::mbrtoc32;^::mbsrtowcs;^::mbsrtowcs_s;^::mbstowcs;^::mbstowcs_s;^::memchr;^::mktime;^::mtx_init;^::mtx_lock;^::mtx_timedlock;^::mtx_trylock;^::mtx_unlock;^::printf_s;^::putc;^::putwc;^::raise;^::realloc;^::remove;^::rename;^::scanf;^::scanf_s;^::setlocale;^::setvbuf;^::signal;^::snprintf;^::snprintf_s;^::sprintf;^::sprintf_s;^::sscanf;^::sscanf_s;^::strchr;^::strerror_s;^::strftime;^::strpbrk;^::strrchr;^::strstr;^::strtod;^::strtof;^::strtoimax;^::strtok;^::strtok_s;^::strtol;^::strtold;^::strtoll;^::strtoul;^::strtoull;^::strtoumax;^::strxfrm;^::swprintf;^::swprintf_s;^::swscanf;^::swscanf_s;^::thrd_create;^::thrd_detach;^::thrd_join;^::thrd_sleep;^::time;^::timespec_get;^::tmpfile;^::tmpfile_s;^::tmpnam;^::tmpnam_s;^::tss_create;^::tss_get;^::tss_set;^::ungetc;^::ungetwc;^::vfprintf;^::vfprintf_s;^::vfscanf;^::vfscanf_s;^::vfwprintf;^::vfwprintf_s;^::vfwscanf;^::vfwscanf_s;^::vprintf_s;^::vscanf;^::vscanf_s;^::vsnprintf;^::vsnprintf_s;^::vsprintf;^::vsprintf_s;^::vsscanf;^::vsscanf_s;^::vswprintf;^::vswprintf_s;^::vswscanf;^::vswscanf_s;^::vwprintf_s;^::vwscanf;^::vwscanf_s;^::wcrtomb;^::wcschr;^::wcsftime;^::wcspbrk;^::wcsrchr;^::wcsrtombs;^::wcsrtombs_s;^::wcsstr;^::wcstod;^::wcstof;^::wcstoimax;^::wcstok;^::wcstok_s;^::wcstol;^::wcstold;^::wcstoll;^::wcstombs;^::wcstombs_s;^::wcstoul;^::wcstoull;^::wcstoumax;^::wcsxfrm;^::wctob;^::wctrans;^::wctype;^::wmemchr;^::wprintf_s;^::wscanf;^::wscanf_s;'
-  cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor: 'true'
-  cppcoreguidelines-special-member-functions.AllowMissingMoveFunctionsWhenCopyIsDeleted: 'true'
   performance-move-const-arg.CheckTriviallyCopyableMove: 'false'
-  readability-identifier-naming.LocalVariableCase: 'camelBack'
-  readability-identifier-naming.LocalConstantCase: 'camelBack'
-  readability-identifier-naming.StructCase: 'CamelCase'
-  readability-identifier-naming.ClassCase: 'CamelCase'
-  readability-identifier-naming.ParameterCase: 'camelBack'
-  readability-identifier-naming.MethodCase: 'camelBack'
-  readability-identifier-naming.EnumCase: 'CamelCase'
-  readability-identifier-naming.FunctionCase: 'camelBack'
-  readability-identifier-naming.MemberCase: 'camelBack'
-  readability-identifier-naming.PrivateMemberSuffix: '_'
-  readability-identifier-naming.ProtectedMemberSuffix: '_'
-  readability-identifier-naming.PublicMemberSuffix: ''
 SystemHeaders: false

CMakeLists.txt

@@ -97,8 +97,6 @@ else() # GCC or Clang are mostly compatible:
     # Options unique to Clang or GCC:
     if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
         add_compile_options(-Qunused-arguments) 
-    elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 8.1))
-        add_compile_options(-Wno-stringop-truncation)
     endif()
 endif()
 

include/pulsar/Authentication.h

@@ -394,10 +394,7 @@ class PULSAR_PUBLIC AuthAthenz : public Authentication {
 // currently mainly works for access token
 class Oauth2TokenResult {
    public:
-    enum
-    {
-        undefined_expiration = -1
-    };
+    static constexpr int undefined_expiration = -1;
 
     Oauth2TokenResult();
     ~Oauth2TokenResult();

include/pulsar/Client.h

@@ -110,7 +110,7 @@ class PULSAR_PUBLIC Client {
      * @param topic the name of the topic where to produce
      * @param conf the customized ProducerConfiguration
      */
-    void createProducerAsync(const std::string& topic, ProducerConfiguration conf,
+    void createProducerAsync(const std::string& topic, const ProducerConfiguration& conf,
                              CreateProducerCallback callback);
 
     /**
@@ -331,7 +331,7 @@ class PULSAR_PUBLIC Client {
      * built from a message that already exists
      */
     void createTableViewAsync(const std::string& topic, const TableViewConfiguration& conf,
-                              TableViewCallback callBack);
+                              const TableViewCallback& callBack);
 
     /**
      * Get the list of partitions for a given topic.
@@ -415,7 +415,7 @@ class PULSAR_PUBLIC Client {
                             std::function<void(Result, const SchemaInfo&)> callback);
 
    private:
-    Client(const std::shared_ptr<ClientImpl>);
+    Client(const std::shared_ptr<ClientImpl>&);
 
     friend class PulsarFriend;
     friend class PulsarWrapper;

include/pulsar/ClientConfiguration.h

@@ -23,6 +23,8 @@
 #include <pulsar/Logger.h>
 #include <pulsar/defines.h>
 
+#include <cstdint>
+
 namespace pulsar {
 class PulsarWrapper;
 struct ClientConfigurationImpl;
@@ -32,7 +34,7 @@ class PULSAR_PUBLIC ClientConfiguration {
     ~ClientConfiguration();
     ClientConfiguration(const ClientConfiguration&);
     ClientConfiguration& operator=(const ClientConfiguration&);
-    enum ProxyProtocol
+    enum ProxyProtocol : uint8_t
     {
         SNI = 0
     };

include/pulsar/CompressionType.h

@@ -19,8 +19,10 @@
 #ifndef PULSAR_COMPRESSIONTYPE_H_
 #define PULSAR_COMPRESSIONTYPE_H_
 
+#include <cstdint>
+
 namespace pulsar {
-enum CompressionType
+enum CompressionType : std::uint8_t
 {
     CompressionNone = 0,
     CompressionLZ4 = 1,

include/pulsar/Consumer.h

@@ -83,7 +83,7 @@ class PULSAR_PUBLIC Consumer {
      *
      * @param callback the callback to get notified when the operation is complete
      */
-    void unsubscribeAsync(ResultCallback callback);
+    void unsubscribeAsync(const ResultCallback& callback);
 
     /**
      * Receive a single message.
@@ -134,10 +134,10 @@ class PULSAR_PUBLIC Consumer {
      * </p>
      * @param ReceiveCallback will be completed when message is available
      */
-    void receiveAsync(ReceiveCallback callback);
+    void receiveAsync(const ReceiveCallback& callback);
 
     template <typename T>
-    void receiveAsync(std::function<void(Result result, const TypedMessage<T>&)> callback,
+    void receiveAsync(const std::function<void(Result result, const TypedMessage<T>&)>& callback,
                       typename TypedMessage<T>::Decoder decoder) {
         receiveAsync([callback, decoder](Result result, const Message& msg) {
             callback(result, TypedMessage<T>{msg, decoder});
@@ -167,7 +167,7 @@ class PULSAR_PUBLIC Consumer {
      * </p>
      * @param BatchReceiveCallback will be completed when messages are available.
      */
-    void batchReceiveAsync(BatchReceiveCallback callback);
+    void batchReceiveAsync(const BatchReceiveCallback& callback);
 
     /**
      * Acknowledge the reception of a single message.
@@ -209,7 +209,7 @@ class PULSAR_PUBLIC Consumer {
      * @param message the message to acknowledge
      * @param callback callback that will be triggered when the message has been acknowledged
      */
-    void acknowledgeAsync(const Message& message, ResultCallback callback);
+    void acknowledgeAsync(const Message& message, const ResultCallback& callback);
 
     /**
      * Asynchronously acknowledge the reception of a single message.
@@ -220,15 +220,15 @@ class PULSAR_PUBLIC Consumer {
      * @param messageId the messageId to acknowledge
      * @param callback the callback that is triggered when the message has been acknowledged or not
      */
-    void acknowledgeAsync(const MessageId& messageId, ResultCallback callback);
+    void acknowledgeAsync(const MessageId& messageId, const ResultCallback& callback);
 
     /**
      * Asynchronously acknowledge the consumption of a list of message.
      * @param messageIdList
      * @param callback the callback that is triggered when the message has been acknowledged or not
      * @return
      */
-    void acknowledgeAsync(const MessageIdList& messageIdList, ResultCallback callback);
+    void acknowledgeAsync(const MessageIdList& messageIdList, const ResultCallback& callback);
 
     /**
      * Acknowledge the reception of all the messages in the stream up to (and including)
@@ -239,7 +239,7 @@ class PULSAR_PUBLIC Consumer {
      *
      * Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.
      *
-     * It's equivalent to calling asyncAcknowledgeCumulative(const Message&, ResultCallback) and
+     * It's equivalent to calling asyncAcknowledgeCumulative(const Message&, const ResultCallback&) and
      * waiting for the callback to be triggered.
      *
      * @param message the last message in the stream to acknowledge
@@ -258,8 +258,8 @@ class PULSAR_PUBLIC Consumer {
      *
      * Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.
      *
-     * It is equivalent to calling the asyncAcknowledgeCumulative(const Message&, ResultCallback) method and
-     * waiting for the callback to be triggered.
+     * It is equivalent to calling the asyncAcknowledgeCumulative(const Message&, const ResultCallback&)
+     * method and waiting for the callback to be triggered.
      *
      * @param messageId the last messageId in the stream to acknowledge
      * @return ResultOk if the message is successfully acknowledged. All previously delivered messages for
@@ -277,7 +277,7 @@ class PULSAR_PUBLIC Consumer {
      * @param message the message to acknowledge
      * @param callback callback that will be triggered when the message has been acknowledged
      */
-    void acknowledgeCumulativeAsync(const Message& message, ResultCallback callback);
+    void acknowledgeCumulativeAsync(const Message& message, const ResultCallback& callback);
 
     /**
      * Asynchronously acknowledge the reception of all the messages in the stream up to (and
@@ -289,7 +289,7 @@ class PULSAR_PUBLIC Consumer {
      * @param messageId the messageId to acknowledge
      * @param callback the callback that is triggered when the message has been acknowledged or not
      */
-    void acknowledgeCumulativeAsync(const MessageId& messageId, ResultCallback callback);
+    void acknowledgeCumulativeAsync(const MessageId& messageId, const ResultCallback& callback);
 
     /**
      * Acknowledge the failure to process a single message.
@@ -364,7 +364,7 @@ class PULSAR_PUBLIC Consumer {
      * Asynchronously close the consumer and stop the broker to push more messages
      *
      */
-    void closeAsync(ResultCallback callback);
+    void closeAsync(const ResultCallback& callback);
 
     /**
      * Pause receiving messages via the messageListener, till resumeMessageListener() is called.
@@ -413,7 +413,7 @@ class PULSAR_PUBLIC Consumer {
      * @param callback - callback function to get the brokerConsumerStats,
      *                   if result is ResultOk then the brokerConsumerStats will be populated
      */
-    void getBrokerConsumerStatsAsync(BrokerConsumerStatsCallback callback);
+    void getBrokerConsumerStatsAsync(const BrokerConsumerStatsCallback& callback);
 
     /**
      * Reset the subscription associated with this consumer to a specific message id.
@@ -445,15 +445,15 @@ class PULSAR_PUBLIC Consumer {
      * @param messageId
      *            the message id where to reposition the subscription
      */
-    virtual void seekAsync(const MessageId& messageId, ResultCallback callback);
+    virtual void seekAsync(const MessageId& messageId, const ResultCallback& callback);
 
     /**
      * Asynchronously reset the subscription associated with this consumer to a specific message publish time.
      *
      * @param timestamp
      *            the message publish time where to reposition the subscription
      */
-    virtual void seekAsync(uint64_t timestamp, ResultCallback callback);
+    virtual void seekAsync(uint64_t timestamp, const ResultCallback& callback);
 
     /**
      * @return Whether the consumer is currently connected to the broker
@@ -464,7 +464,7 @@ class PULSAR_PUBLIC Consumer {
      * Asynchronously get an ID of the last available message or a message ID with -1 as an entryId if the
      * topic is empty.
      */
-    void getLastMessageIdAsync(GetLastMessageIdCallback callback);
+    void getLastMessageIdAsync(const GetLastMessageIdCallback& callback);
 
     /**
      * Get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty.

include/pulsar/ConsumerConfiguration.h

@@ -117,7 +117,7 @@ class PULSAR_PUBLIC ConsumerConfiguration {
      *
      * @param keySharedPolicy The {@link KeySharedPolicy} want to specify
      */
-    ConsumerConfiguration& setKeySharedPolicy(KeySharedPolicy keySharedPolicy);
+    ConsumerConfiguration& setKeySharedPolicy(const KeySharedPolicy& keySharedPolicy);
 
     /**
      * @return the KeyShared subscription policy

include/pulsar/ConsumerType.h

@@ -19,8 +19,10 @@
 #ifndef PULSAR_CPP_CONSUMERTYPE_H
 #define PULSAR_CPP_CONSUMERTYPE_H
 
+#include <cstdint>
+
 namespace pulsar {
-enum ConsumerType
+enum ConsumerType : uint8_t
 {
     /**
      * There can be only 1 consumer on the same topic with the same consumerName

include/pulsar/CryptoKeyReader.h

@@ -71,7 +71,7 @@ class PULSAR_PUBLIC DefaultCryptoKeyReader : public CryptoKeyReader {
    private:
     std::string publicKeyPath_;
     std::string privateKeyPath_;
-    void readFile(std::string fileName, std::string& fileContents) const;
+    void readFile(const std::string& fileName, std::string& fileContents) const;
 
    public:
     /**