Fixed build problems with latest Boost library versions and workflow changes [DEX-431] [CTT-734][CTT-716] (#1322)

Fixed build problems with latest Boost library versions.

Verification pr build is
[HERE](https://github.com/hazelcast/hazelcast-cpp-client/actions/runs/18595861858).
I had to verify this PR on origin branch **new_boost_fixes** since we
also change the workflow, hence, please check this test run to see that
all tests in all environments actually passed and we can **actually
force merge** this PR.

Updated the project to use the minimum C++ standard to be the same as
the one required by the Boost library. This means if a user is using an
older Boost version we use C++11 but if newer Boost version is used we
change level to C++ 14 since the [Math library minimum requirement
became
C++14](https://github.com/boostorg/math/releases/tag/boost-1.82.0)
starting with Boost 1.82.0.

    # Check Boost version and set C++ standard accordingly
# Our library can not use a lower C++ standard than the one required by
Boost.
    if (Boost_VERSION VERSION_LESS 1.82.0)
        set(CMAKE_CXX_STANDARD 11)
message(STATUS "Boost version ${Boost_VERSION} < 1.82.0, setting C++
standard to 11.")
    else()
        set(CMAKE_CXX_STANDARD 14)
message(STATUS "Boost version ${Boost_VERSION} >= 1.82.0, setting C++
standard to 14. "
                "Boost.Math library requires minimum C++14 compiler.")
    endif()

Changed the PR builder boost version to latest version of Boost 1.89.0.

The lazy partition assignment is causing problem with partition updates.
Hence, I had to to port the following Java PR client related parts to
the C++ client as well:
hazelcast/hazelcast#16375

fixes #1253 
fixes https://hazelcast.atlassian.net/browse/DEX-431

I tried to separate the workflows changes from other changes but that
attempt failed at
[here](#1334). We
bump into a problem which is due to update of the new LLVM compiler
which does more strict checking of the template class methods. This
caused a bug in boost become apparent and it is only fixed at Boost
1.88.0. When I bump the Boost version, I also have to change the
workflow since the versions are [hard coded into the workflow
build-pr](https://github.com/hazelcast/hazelcast-cpp-client/blob/db3b3d83c70491d1e6905d220d96035de8350623/.github/workflows/build-pr.yml#L27).
Hence, separation attempt fails.

**Important Note:** There is a problem with Windows NO-SSL builds,
hence, I currently enable SSL even for no-ssl builds until this problem
is solved. The windows no-ssl builds fail with many errors like:

```
     5>C:\Boost\include\boost-1_89\boost\uuid\detail\chacha20.hpp(136,34): error C2059: syntax error: ')' [D:\a\hazelcast-cpp-client\hazelcast-cpp-client\build\hazelcast\test\src\client_test.vcxproj]
         (compiling source file '../../../../hazelcast/test/src/ClientTest.cpp')
         
     5>C:\Boost\include\boost-1_89\boost\uuid\detail\chacha20.hpp(136,34): error C2334: unexpected token(s) preceding ':'; skipping apparent function body [D:\a\hazelcast-cpp-client\hazelcast-cpp-client\build\hazelcast\test\src\client_test.vcxproj]
         (compiling source file '../../../../hazelcast/test/src/ClientTest.cpp')

```
[This](#1328)
windows build issue needs to be resolved before we do any releases but I
do not want it block this PR since I already spent good amount of time
without a solution.

Author: ihsandemir

.github/workflows/build-pr.yml

@@ -24,11 +24,11 @@ on:
         description: Enter guest PR verified HEAD commit SHA.
         required: true
 env:
-  boost_version: 1.78.0
-  boost_archive_name: 'boost_1_78_0.tar.gz'
-  boost_folder_name: 'boost_1_78_0'
-  boost_include_folder: 'C:\Boost\include\boost-1_78'
-  boost_url: 'https://archives.boost.io/release/1.78.0/source/boost_1_78_0.tar.gz'
+  boost_version: 1.89.0
+  boost_archive_name: 'boost_1_89_0.tar.gz'
+  boost_folder_name: 'boost_1_89_0'
+  boost_include_folder: 'C:\Boost\include\boost-1_89'
+  boost_url: 'https://archives.boost.io/release/1.89.0/source/boost_1_89_0.tar.gz'
   thrift_version: 0.13.0
   run_tests: false
 
@@ -207,16 +207,16 @@ jobs:
         with_openssl: ${{ fromJSON(needs.shared-matrix.outputs.openssl) }}
 
     runs-on: 'windows-latest'
-    env:
-      JOB_NAME: win_${{ matrix.options.address_model }}_${{ matrix.build_type.short }}_${{ matrix.shared_libs.name }}_${{ matrix.with_openssl.name }}
-    name: win-${{ matrix.options.address_model }}_${{ matrix.shared_libs.name }}_${{ matrix.with_openssl.name }}
+    name: windows-${{ matrix.options.address_model }}-(${{ matrix.build_type }}, ${{ matrix.shared_libs.name }}, ${{ matrix.with_openssl.name }})
     steps:
       - uses: actions/checkout@v5
+        if: ${{ matrix.with_openssl.toggle != 'OFF' }}
         with:
           ref: ${{ needs.get-refs.outputs.ref }}
           token: ${{ secrets.GH_TOKEN }}
 
       - uses: ./.github/actions/build-test/windows
+        if: ${{ matrix.with_openssl.toggle == 'ON' }}
         with:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
           BOOST_VERSION: ${{ env.boost_version }}

.github/workflows/coverage-report.yaml

@@ -17,7 +17,7 @@ jobs:
       - uses: ./.github/actions/coverage-report
         with:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          BOOST_VERSION: 1.78.0
+          BOOST_VERSION: 1.89.0
           THRIFT_VERSION: 0.13.0
           RUN_TESTS: true
           HAZELCAST_ENTERPRISE_KEY: ${{ secrets.HAZELCAST_ENTERPRISE_KEY }}

.github/workflows/get-shared-matrix.yml

@@ -19,6 +19,6 @@ jobs:
       build-type: "['Debug', 'Release']"
       shared-libs: "[{'toggle': 'OFF', 'name': 'Static'}, {'toggle': 'ON', 'name': 'Shared'}]"
       openssl: "[{'toggle': 'OFF', 'name': 'noSSL'}, {'toggle': 'ON', 'name': 'SSL'}]"
-      windows-options: "[{'cmake': 'Win32', 'choco_options': '--forceX86 --x86 --version 1.1.1.2100 -y', 'address_model': '32'}, {'cmake': 'x64', 'choco_options': '', 'address_model': '64'}]"
+      windows-options: "[{'cmake': 'Win32', 'choco_options': '--forceX86 --x86 --version 1.1.1.2100 --yes --no-progress', 'address_model': '32'}, {'cmake': 'x64', 'choco_options': '--no-progress --yes', 'address_model': '64'}]"
     steps:
       - run: exit 0

.github/workflows/nightly-macos-x86_64.yml

@@ -20,8 +20,8 @@ jobs:
       fail-fast: false
       matrix:
         boost:
-            - version: 1.71.0
-            - version: 1.76.0
+            - version: 1.73.0
+            - version: 1.89.0
         build_type: ${{ fromJSON(needs.shared-matrix.outputs.build-type) }}
         shared_libs: ${{ fromJSON(needs.shared-matrix.outputs.shared-libs) }}
         with_openssl: ${{ fromJSON(needs.shared-matrix.outputs.openssl) }}

.github/workflows/nightly-ubuntu-i386.yml

@@ -20,8 +20,8 @@ jobs:
       fail-fast: false
       matrix:
         boost:
-          - version: 1.71.0
-          - version: 1.76.0
+          - version: 1.73.0
+          - version: 1.89.0
         build_type: ${{ fromJSON(needs.shared-matrix.outputs.build-type) }}
         shared_libs: ${{ fromJSON(needs.shared-matrix.outputs.shared-libs) }}
         with_openssl: ${{ fromJSON(needs.shared-matrix.outputs.openssl) }}

.github/workflows/nightly-ubuntu-x86_64.yml

@@ -21,7 +21,7 @@ jobs:
       matrix:
         boost:
           - version: 1.73.0
-          - version: 1.76.0
+          - version: 1.89.0
 
         build_type:
           - Debug

.github/workflows/nightly-windows.yml

@@ -26,30 +26,24 @@ jobs:
             boost_archive_name: 'boost_1_73_0.tar.gz'
             boost_folder_name: 'boost_1_73_0'
             boost_include_folder: 'C:\Boost\include\boost-1_73'
-          - name: msvc-2019_boost_1800
+          - name: msvc-2019_boost_1890
             image: 'windows-2019'
-            boost_url: 'https://archives.boost.io/release/1.80.0/source/boost_1_80_0.tar.gz'
-            boost_archive_name: 'boost_1_80_0.tar.gz'
-            boost_folder_name: 'boost_1_80_0'
-            boost_include_folder: 'C:\Boost\include\boost-1_80'
-          - name: msvc-2022_boost_1780
+            boost_url: 'https://archives.boost.io/release/1.89.0/source/boost_1_89_0.tar.gz'
+            boost_archive_name: 'boost_1_89_0.tar.gz'
+            boost_folder_name: 'boost_1_89_0'
+            boost_include_folder: 'C:\Boost\include\boost-1_89'
+          - name: msvc-2022_boost_1890
             image: 'windows-2022'
-            boost_url: 'https://archives.boost.io/release/1.78.0/source/boost_1_78_0.tar.gz'
-            boost_archive_name: 'boost_1_78_0.tar.gz'
-            boost_folder_name: 'boost_1_78_0'
-            boost_include_folder: 'C:\Boost\include\boost-1_78'
-          - name: msvc-2022_boost_1800
-            image: 'windows-2022'
-            boost_url: 'https://archives.boost.io/release/1.80.0/source/boost_1_80_0.tar.gz'
-            boost_archive_name: 'boost_1_80_0.tar.gz'
-            boost_folder_name: 'boost_1_80_0'
-            boost_include_folder: 'C:\Boost\include\boost-1_80'
-          - name: msvc-latest_boost_1800
+            boost_url: 'https://archives.boost.io/release/1.89.0/source/boost_1_89_0.tar.gz'
+            boost_archive_name: 'boost_1_89_0.tar.gz'
+            boost_folder_name: 'boost_1_89_0'
+            boost_include_folder: 'C:\Boost\include\boost-1_89'
+          - name: msvc-latest_boost_1890
             image: 'windows-latest'
-            boost_url: 'https://archives.boost.io/release/1.80.0/source/boost_1_80_0.tar.gz'
-            boost_archive_name: 'boost_1_80_0.tar.gz'
-            boost_folder_name: 'boost_1_80_0'
-            boost_include_folder: 'C:\Boost\include\boost-1_80'
+            boost_url: 'https://archives.boost.io/release/1.89.0/source/boost_1_89_0.tar.gz'
+            boost_archive_name: 'boost_1_89_0.tar.gz'
+            boost_folder_name: 'boost_1_89_0'
+            boost_include_folder: 'C:\Boost\include\boost-1_89'
         options: ${{ fromJSON(needs.shared-matrix.outputs.windows-options) }}
         build_type: ${{ fromJSON(needs.shared-matrix.outputs.build-type) }}
         shared_libs: ${{ fromJSON(needs.shared-matrix.outputs.shared-libs) }}

CMakeLists.txt

@@ -21,8 +21,6 @@ project(hazelcast-cpp-client
         DESCRIPTION "Hazelcast C++ Client"
         LANGUAGES CXX)
 
-# Set the C++ standard
-set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # Generate the Reference_Manual.md file using the latest project version.
@@ -88,10 +86,26 @@ option(BUILD_EXAMPLES
 find_package(Threads REQUIRED)
 
 # find Boost
-if (WIN32)
-	find_package(Boost 1.73 REQUIRED COMPONENTS thread chrono)
+find_package(Boost 1.73 REQUIRED COMPONENTS thread chrono)
+
+if (Boost_FOUND)
+    message(STATUS "Boost version: ${Boost_VERSION}")
+    message(STATUS "Boost include directory: ${Boost_INCLUDE_DIRS}")
+    message(STATUS "Boost libraries: ${Boost_LIBRARIES}")
+
+    # Check Boost version and set C++ standard accordingly
+    # Our library can not use a lower C++ standard than the one required by Boost.
+    if (Boost_VERSION VERSION_LESS 1.82.0)
+        set(CMAKE_CXX_STANDARD 11)
+        message(STATUS "Boost version ${Boost_VERSION} < 1.82.0, setting C++ standard to 11.")
+    else()
+        set(CMAKE_CXX_STANDARD 14)
+        message(STATUS "Boost version ${Boost_VERSION} >= 1.82.0, setting C++ standard to 14. "
+                "Boost.Math library requires minimum C++14 compiler.")
+    endif()
+
 else()
-	find_package(Boost 1.71 REQUIRED COMPONENTS thread chrono)
+    message(FATAL_ERROR "Boost not found!")
 endif()
 
 # find OpenSSL if building WITH_OPENSSL
@@ -104,6 +118,10 @@ if (WITH_OPENSSL)
     endif ()
 
     find_package(OpenSSL REQUIRED)
+
+    message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
+    message(STATUS "OpenSSL include directory: ${OPENSSL_INCLUDE_DIR}")
+    message(STATUS "OpenSSL libraries: ${OPENSSL_LIBRARIES}")
 endif ()
 
 # add the library target
@@ -120,12 +138,6 @@ set_target_properties(
         SOVERSION ${PROJECT_VERSION}
 )
 
-# library requires c++11
-target_compile_features(
-        ${PROJECT_NAME}
-        PUBLIC cxx_std_11
-)
-
 # links the library against the system's thread library
 target_link_libraries(${PROJECT_NAME} PUBLIC Threads::Threads)
 
@@ -150,11 +162,18 @@ if (WITH_OPENSSL)
     target_link_libraries(${PROJECT_NAME} PUBLIC OpenSSL::SSL OpenSSL::Crypto)
 endif()
 
+message(STATUS "CMAKE_CXX_COMPILER_ID = ${CMAKE_CXX_COMPILER_ID}")
+
 # MSVC-specific compiler flags
 if (MSVC)
     target_compile_options(${PROJECT_NAME} PRIVATE /bigobj)
 endif ()
 
+# AppleClang-specific compiler flags, we set for all targets since we want these flags also for tests and examples
+if (CMAKE_CXX_STANDARD EQUAL 11 AND CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-enum-constexpr-conversion -Wno-deprecated-declarations -Wno-deprecated-builtins -Wno-unused-but-set-variable")
+endif ()
+
 # windows-specific compile flags
 if (WIN32)
     # speeds the build process
@@ -248,7 +267,9 @@ install(
 
 if (BUILD_TESTS)
     add_subdirectory(hazelcast/test)
-endif ()
+else()
+    message(STATUS "BUILD_TESTS is disabled.")
+endif()
 
 if (BUILD_EXAMPLES)
     add_subdirectory(examples)
@@ -264,3 +285,6 @@ message(STATUS "  DISABLE_LOGGING =       ${DISABLE_LOGGING}")
 message(STATUS "  CMAKE_INSTALL_PREFIX =  ${CMAKE_INSTALL_PREFIX}")
 message(STATUS "  BUILD_TESTS =           ${BUILD_TESTS}")
 message(STATUS "  BUILD_EXAMPLES =        ${BUILD_EXAMPLES}")
+message(STATUS "  CMAKE_CXX_FLAGS =       ${CMAKE_CXX_FLAGS}")
+message(STATUS "  CMAKE_CXX_FLAGS_DEBUG =       ${CMAKE_CXX_FLAGS_DEBUG}")
+message(STATUS "  CMAKE_CXX_FLAGS_RELEASE =       ${CMAKE_CXX_FLAGS_RELEASE}")

README.md

@@ -75,15 +75,15 @@ Please see [getting started](https://github.com/microsoft/vcpkg#getting-started)
 If you use Linux or Mac:
 
 ```sh
-git clone https://github.com/microsoft/vcpkg --branch 2025.02.14
+git clone https://github.com/microsoft/vcpkg
 ./vcpkg/bootstrap-vcpkg.sh
 ./vcpkg/vcpkg install "hazelcast-cpp-client[openssl]" --recurse
 ``` 
 
 If you use Windows:
 
 ```bat
-git clone https://github.com/microsoft/vcpkg --branch 2025.02.14
+git clone https://github.com/microsoft/vcpkg
 .\vcpkg\bootstrap-vcpkg.bat
 .\vcpkg\vcpkg install "hazelcast-cpp-client[openssl]:x64-windows" --recurse
 ``` 

Reference_Manual.md

@@ -199,15 +199,15 @@ Please see [getting started](https://github.com/microsoft/vcpkg#getting-started)
 If you use Linux or Mac:
 
 ```sh
-git clone https://github.com/microsoft/vcpkg --branch 2025.02.14
+git clone https://github.com/microsoft/vcpkg
 ./vcpkg/bootstrap-vcpkg.sh
 ./vcpkg/vcpkg install "hazelcast-cpp-client[openssl]" --recurse
 ``` 
 
 If you use Windows:
 
 ```bat
-git clone https://github.com/microsoft/vcpkg --branch 2025.02.14
+git clone https://github.com/microsoft/vcpkg
 .\vcpkg\bootstrap-vcpkg.bat
 .\vcpkg\vcpkg install "hazelcast-cpp-client[openssl]:x64-windows" --recurse
 ``` 
@@ -242,9 +242,22 @@ This generates the `conanbuildinfo.cmake` file to be included in your CMakeLists
 ### 1.1.3. Install From Source Code Using CMake
 #### 1.1.3.1. Requirements
 1. Linux, macOS or Windows
-2. A compiler that supports C++11
+2. A compiler that supports C++11 or above: The project detects the minimum C++ standard supported by the Boost library
+and uses the same language level for compilation. If you are using Boost 1.82.0 or higher version, the project requires
+C++14 or above since Boost.Math requires this language level as minimum starting 1.82.0 version.
+For lower Boost versions, C++11 or above support is sufficient.
 3. [CMake](https://cmake.org) 3.10 or above
-4. [Boost](https://www.boost.org) 1.71 or above. Minimum boost version is upgraded to 1.73 for Windows due to [this](https://github.com/chriskohlhoff/asio/issues/431) bug.
+4. [Boost](https://www.boost.org) 1.73 or above.
+   - The Boost libraries we use are:
+      - boost-thread
+      - boost-asio
+      - boost-chrono
+      - boost-format
+      - boost-optional
+      - boost-property-tree
+      - boost-system
+      - boost-uuid
+      - boost-multiprecision
 5. [OpenSSL](https://www.openssl.org) (optional)
 
 #### 1.1.3.2. Downloading Source Code
@@ -347,6 +360,28 @@ For example:
 g++ -DHZ_BUILD_WITH_SSL -DBOOST_CHRONO_DYN_LINK -DBOOST_CHRONO_NO_LIB -DBOOST_THREAD_DYN_LINK -DBOOST_THREAD_NO_LIB -DBOOST_THREAD_VERSION=5 -I/var/git/hazelcast-cpp-client/build/include -std=gnu++11 -c main.cpp
 ```
 
+##### 1.1.3.5.2. Building the hazelcast-cpp-client library with vcpkg toolchain
+If you want to build the `hazelcast-cpp-client` library with vcpkg toolchain, you can use the following command
+(For windows, please use `cmake.exe` instead of `cmake`):
+```sh
+cmake -B build -DCMAKE_TOOLCHAIN_FILE=<path to vcpkg folder>/scripts/buildsystems/vcpkg.cmake
+cmake --build build --config Release
+```
+
+if you want to build the project with tests and examples enabled, then you can use the following command:
+```sh
+cmake -b build \
+-DBUILD_TESTS=ON \
+-DBUILD_EXAMPLES=ON \
+-DWITH_OPENSSL=ON \
+-DCMAKE_VERBOSE_MAKEFILE=ON \
+-DCMAKE_TOOLCHAIN_FILE=<path to vcpkg folder>/scripts/buildsystems/vcpkg.cmake \
+-DVCPKG_MANIFEST_FEATURES='build-tests' \
+
+cmake --build build
+```
+
+
 ## 1.2. Starting a Hazelcast Cluster
 
 The Hazelcast C++ client requires a working Hazelcast cluster to run. This cluster handles storage and manipulation of the user data. Clients are a way to connect to the Hazelcast cluster and access such data.
@@ -3839,10 +3874,12 @@ In order to test Hazelcast C++ client locally, you will need the following:
 * Boost
 * thrift
 
-You need to enable the examples in the build with the cmake flag `-DBUILD_EXAMPLES=ON`. When you build, the result will
-produce the executable `client_test` on Linux/macOS and `client_test.exe` on Windows. You need to start the remote
-controller first before running this executable by executing `scripts/start-rc.sh` on Linux/macOS
-or `scripts/start-rc.bat` on Windows. Then you can run the test executable.
+When you compile with cmake, you need to use the flag `-DBUILD_TESTS=ON` to enable building the tests.
+When you build, the result will produce the executable `client_test` on Linux/macOS and `client_test.exe` on Windows.
+You need to start the remote controller first before running this executable by executing `scripts/start-rc.sh` on
+Linux/macOS or `scripts/start-rc.bat` on Windows. Then you can run the test executable.
+
+If you want to build the examples, you need to use the cmake flag `-DBUILD_EXAMPLES=ON`.
 
 # 9. Getting Help