Merge branch 'main' into willhoy-patch-1

Signed-off-by: Will <2185386+willhoy@users.noreply.github.com>

Author: willhoy

.github/workflows/build.yml

@@ -28,6 +28,8 @@ jobs:
     #Only run for push to main
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # Needed to push to gh-pages
     steps:
       - uses: actions/checkout@v3
       - name: Doxygenize

CMakeLists.txt

@@ -1,6 +1,8 @@
-cmake_minimum_required(VERSION 3.25) 
+cmake_minimum_required(VERSION 3.25)
 project(rmq LANGUAGES C CXX)
 
+option(ENABLE_COMPRESSION "Enable zstd compression support" ON)
+
 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 enable_testing()
 

Makefile

@@ -32,15 +32,15 @@ clean:
 	rm -rf $(BUILD_FOLDER)
 
 docker-setup:
-	cd $(SRC_FOLDER)/dockerfiles && docker-compose build --pull 
+	cd $(SRC_FOLDER)/dockerfiles && docker compose build --pull 
 
 docker-build:
-	cd $(SRC_FOLDER)/dockerfiles && docker-compose run dev make full
+	cd $(SRC_FOLDER)/dockerfiles && docker compose run dev make full
 
 docker-test:
-	cd $(SRC_FOLDER)/dockerfiles && docker-compose run dev make full-test
+	cd $(SRC_FOLDER)/dockerfiles && docker compose run dev make full-test
 
 docker-shell:
-	cd $(SRC_FOLDER)/dockerfiles && docker-compose run dev
+	cd $(SRC_FOLDER)/dockerfiles && docker compose run dev
 
 .PHONY: build init unit integration clean full full-test

README.md

@@ -31,7 +31,7 @@ This library has been built from experience learned while supporting other Rabbi
     + `rmqcpp` always declares topology when creating consumers & producers, as per RabbitMQ best practices.
 4. ✉ Reliable Message Delivery 'on' by default
     + Publisher confirmations. This ensures clients are aware when messages are owned by RabbitMQ, and avoids messages being silently black holed.
-    + Consumer acknowledgements. Switching these on manually helps avoid messages being silently dropped during restart/outages, as would be the case with 'autoack'. 
+    + Consumer acknowledgements. Switching these on manually helps avoid messages being silently dropped during restart/outages, as would be the case with 'autoack'.
     + Durable queues and persistent delivery mode ensure messages always persist during broker restarts and total datacenter shutdowns.
     + [Mandatory flag](https://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.publish.mandatory) is defaulted to 'true' for all messages to ensure none are silently dropped due to missed bindings.
     + All of the above properties are used by default. Publisher confirms and consumer acknowledgements are required.
@@ -58,7 +58,7 @@ graph TD;
     rmqp-->rmqt;
 ```
 
-**Library** | **Purpose** | **Examples** 
+**Library** | **Purpose** | **Examples**
  :--- | :---- | :----
 [rmqp](src/rmq/rmqp) | RabbitMQ library interface (protocol) | Interfaces used to allow testing/mocking of `rmqcpp` applications
 [rmqa](src/rmq/rmqa) | RabbitMQ Library interface implementation | The main concrete objects used by applications
@@ -70,7 +70,7 @@ graph TD;
 
 ## Quick Start
 The quickest way to get started is to take a look at our integration tests and sample 'hello world' program, which is possible by following the Docker [Build](#building) steps and then: from the interactive shell window running `./build/examples/helloworld/rmqhelloworld_producer`
- 
+
 
 ## Usage
 
@@ -195,7 +195,7 @@ consumer->cancelAndDrain();
 
 ## Documentation
 Doxygen generated API documentation can be found [here](https://bloomberg.github.io/rmqcpp/index.html)
- 
+
 ## Building
 
 ### Prerequisites
@@ -206,6 +206,8 @@ Doxygen generated API documentation can be found [here](https://bloomberg.github
 
 There are build configuration options which can be specified using the environment variable `CMAKE_PRESET` (choose from configurations in `CMakePresets.json`) - eg. `export CMAKE_PRESET=macos-arm64-vcpkg`.
 
+`zstd` compression support is enabled by default, and requires the `zstd` library to be installed. To disable this, pass the `-DENABLE_COMPRESSION=OFF` option to cmake.
+
 ### Build Steps
 Once the prerequisites are configured:
 
@@ -221,8 +223,8 @@ We also provide Dockerfiles for building and running this in an isolated
 environment. If you don't wish to get vcpkg set up on your build machine, this can be an alternative
 quick way to get started.
 
-1. `make docker-setup` - Build required base images and setup vcpkg, prerequisite for running commands below 
-2. `make docker-build` - Build rmqcpp in the container using vcpkg 
+1. `make docker-setup` - Build required base images and setup vcpkg, prerequisite for running commands below
+2. `make docker-build` - Build rmqcpp in the container using vcpkg
 3. `make docker-unit`  - Build rmqcpp and run unit tests in the container
 4. `make docker-shell` - Get an interactive shell within the build environment container
 

dockerfiles/dev.Dockerfile

@@ -5,11 +5,12 @@ RUN apt-get update && apt-get install -y \
     clang-format \
     cmake \
     curl \
-    gcc \ 
+    gcc \
     gdb \
     git \
     libboost-dev \
     libssl-dev \
+    libzstd-dev \
     net-tools \
     netcat-traditional \
     ninja-build \
@@ -24,7 +25,7 @@ RUN apt-get update && apt-get install -y \
     zip \
     && rm -rf /var/lib/apt/lists/*
 
-ENV VCPKG_FORCE_SYSTEM_BINARIES=1 
+ENV VCPKG_FORCE_SYSTEM_BINARIES=1
 
 # clone and install vcpkg
 RUN git clone https://github.com/Microsoft/vcpkg.git /build/vcpkg && \

docs/doxygen.md

@@ -18,7 +18,7 @@ Metric publisher is used to publish internal library metrics. Users can provide
 
 Error callback is called when a connection or channel is closed by the RabbitMQ broker.
 
-Important -- `RabbitContext` object must outlive other library objects (`VHost`, `Producer`, `Consumer`).
+**Important** -- `RabbitContext` object **must outlive** other library objects (`VHost`, `Producer`, `Consumer`).
 
 ```cpp
 
@@ -51,6 +51,7 @@ bsl::shared_ptr<rmqa::VHost> vhost = context.createVHostConnection(
 
 Creating a `rmqa::VHost` instance **does not** immediately create a connection with the RabbitMQ broker. These connections are created lazily when calling `rmqa::VHost::createProducer` and `rmqa::VHost::createConsumer`.
 
+**Important** -- `VHost` object **must outlive** other library objects (`Producer`, `Consumer`).
 
 ## Topology
 

examples/rmqperftest/rmqperftest_runner.cpp

@@ -86,7 +86,7 @@ class ConfirmCallback {
 
     void operator()(const rmqt::Message&,
                     const bsl::string&,
-                    const rmqt::ConfirmResponse&){};
+                    const rmqt::ConfirmResponse&) {};
 };
 
 bsl::string_view queueNameOrRoutingKey(bsl::string_view routingKey,

licenses-binary/LICENSE-zstd.txt

@@ -0,0 +1,30 @@
+BSD License
+
+For Zstandard software
+
+Copyright (c) Meta Platforms, Inc. and affiliates. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook, nor Meta, nor the names of its contributors may
+   be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

licenses/LICENSE-zstd.txt

@@ -0,0 +1,30 @@
+BSD License
+
+For Zstandard software
+
+Copyright (c) Meta Platforms, Inc. and affiliates. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook, nor Meta, nor the names of its contributors may
+   be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/CMakeLists.txt

@@ -1,5 +1,8 @@
 find_package(Threads REQUIRED) # CMake 3.26-rc3 Bug https://gitlab.kitware.com/cmake/cmake/-/issues/24505
 find_package(ZLIB REQUIRED)
+if (ENABLE_COMPRESSION)
+    find_package(zstd CONFIG REQUIRED)
+endif()
 find_package(Boost REQUIRED)
 set(OPENSSL_USE_STATIC_LIBS TRUE)
 find_package(OpenSSL REQUIRED)