Get CI building again (#103)

BrennanConroy · web-flow · commit 547d71920491 · 2025-07-03T16:34:19.000-07:00
diff --git a/.azure/default-build.yml b/.azure/default-build.yml
@@ -23,11 +23,11 @@ jobs:
       enableTelemetry: true
       pool:
         ${{ if eq(parameters.agentOs, 'macOS') }}:
-          vmImage: macOS-12
+          vmImage: macOS-latest
         ${{ if eq(parameters.agentOs, 'Linux') }}:
-          vmImage: ubuntu-20.04
+          vmImage: ubuntu-latest
         ${{ if eq(parameters.agentOs, 'Windows') }}:
-          vmImage: windows.vs2019.amd64
+          vmImage: windows-latest
       steps:
       - checkout: self
         clean: true
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -16,6 +16,8 @@ if(NOT WIN32)
   set(EXTRA_FLAGS "-std=c++11 -fPIC -DNO_SIGNALRCLIENT_EXPORTS")
 else()
   set(EXTRA_FLAGS "-DSIGNALRCLIENT_EXPORTS")
+  # cpprestsdk hasn't updated to fix these warnings
+  string(APPEND EXTRA_FLAGS " -D_SILENCE_STDEXT_ARR_ITERS_DEPRECATION_WARNING")
 endif()
 
 if(USE_MSGPACK)
@@ -45,8 +47,8 @@ set(JSONCPP_LIB "jsoncpp_static" CACHE STRING "jsoncpp target name")
 endif()
 
 if(USE_MSGPACK)
-  find_package(msgpack CONFIG REQUIRED)
-  set(MSGPACK_LIB "msgpackc-cxx")
+  find_package(msgpack-cxx CONFIG REQUIRED)
+  set(MSGPACK_LIB "msgpack-cxx")
 endif()
 
 include_directories (include)
diff --git a/README.md b/README.md
@@ -6,9 +6,14 @@ Use https://github.com/aspnet/AspNetCore/issues for issues with this project.
 
 ## Install this library
 
+> [!WARNING]
+> Websockets are currently disabled which means the client will fail to connect to a SignalR server.
+> Workaround by providing a custom websocket client implementation and using it via `builder.with_websocket_factory(...)`.
+> A new websocket implementation will be provided in-box in a future commit.
+
 There are multiple ways to build this library
 
-* Use [vcpkg](https://github.com/microsoft/vcpkg) and install the library with `vcpkg install microsoft-signalr`
+* **Currently missing due to websocket issues.** ~~Use [vcpkg](https://github.com/microsoft/vcpkg) and install the library with `vcpkg install microsoft-signalr`~~
 * Build from [command line](#command-line-build)
 * Build in Visual Studio (must have the "Desktop Development with C++" workload) by selecting the "Open a local folder" option and selecting the repository root folder
 
@@ -21,7 +26,7 @@ Below are instructions to build on different OS's. You can also use the followin
 | -DBUILD_SAMPLES | Build the included sample project | false |
 | -DBUILD_TESTING | Builds the test project | true |
 | -DUSE_CPPRESTSDK | Includes the CppRestSDK (default http stack) (requires cpprestsdk to be installed) | false |
-| -DUSE_MSGPACK | Adds an option to use the MessagePack Hub Protocol (requires msgpack-c to be installed) | false |
+| -DUSE_MSGPACK | Adds an option to use the MessagePack Hub Protocol (requires msgpack to be installed, e.g. `vcpkg install msgpack:x64-windows`) | false |
 | -DWERROR | Enables warnings as errors | true |
 | -DWALL | Enables all warnings | true |
 | -DINJECT_HEADER_AFTER_STDAFX=`<header path>` | Adds the provided header to the library compilation in stdafx.cpp, intended to allow "new" and "delete" to be replaced. | `<none>` |
@@ -30,7 +35,7 @@ Below are instructions to build on different OS's. You can also use the followin
 ```powershell
 PS> git submodule update --init
 PS> .\submodules\vcpkg\bootstrap-vcpkg.bat
-PS> .\submodules\vcpkg\vcpkg.exe install cpprestsdk[websockets]:x64-windows jsoncpp:x64-windows
+PS> .\submodules\vcpkg\vcpkg.exe install cpprestsdk:x64-windows jsoncpp:x64-windows
 PS> mkdir build.release
 PS> cd build.release
 PS> cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE="..\submodules\vcpkg\scripts\buildsystems\vcpkg.cmake" -DCMAKE_BUILD_TYPE=Release -DUSE_CPPRESTSDK=true
@@ -43,7 +48,7 @@ Output will be in `build.release\bin\Release\`
 $ git submodule update --init
 $ brew install gcc6
 $ ./submodules/vcpkg/bootstrap-vcpkg.sh
-$ ./submodules/vcpkg/vcpkg install cpprestsdk[websockets] jsoncpp
+$ ./submodules/vcpkg/vcpkg install cpprestsdk jsoncpp
 $ mkdir build.release
 $ cd build.release
 $ cmake .. -DCMAKE_TOOLCHAIN_FILE=../submodules/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -DUSE_CPPRESTSDK=true
@@ -56,7 +61,7 @@ Output will be in `build.release/bin/`
 ```bash
 $ git submodule update --init
 $ ./submodules/vcpkg/bootstrap-vcpkg.sh
-$ ./submodules/vcpkg/vcpkg install cpprestsdk[websockets] boost-system boost-chrono boost-thread jsoncpp
+$ ./submodules/vcpkg/vcpkg install cpprestsdk boost-system boost-chrono boost-thread jsoncpp
 $ mkdir build.release
 $ cd build.release
 $ cmake .. -DCMAKE_TOOLCHAIN_FILE=../submodules/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -DUSE_CPPRESTSDK=true
@@ -74,7 +79,11 @@ Output will be in `build.release/bin/`
 #include "signalrclient/signalr_value.h"
 
 std::promise<void> start_task;
-signalr::hub_connection connection = signalr::hub_connection_builder::create("http://localhost:5000/hub").build();
+signalr::hub_connection connection = signalr::hub_connection_builder::create("http://localhost:5000/hub")
+    //.with_messagepack_hub_protocol()
+    //.with_websocket_factory(...)
+    //.with_http_client_factory(...)
+    .build();
 
 connection.on("Echo", [](const std::vector<signalr::value>& m)
 {
diff --git a/azure-pipelines-public.yml b/azure-pipelines-public.yml
@@ -34,7 +34,7 @@ stages:
       - powershell: "& ./submodules/vcpkg/bootstrap-vcpkg.bat"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk[websockets]:x64-windows msgpack:x64-windows jsoncpp:x64-windows --vcpkg-root ./submodules/vcpkg"
+      - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk:x64-windows msgpack:x64-windows jsoncpp:x64-windows --vcpkg-root ./submodules/vcpkg"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
 
@@ -47,7 +47,7 @@ stages:
       - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh --allowAppleClang"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk[websockets] msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
+      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
 
@@ -60,7 +60,7 @@ stages:
       - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk[websockets] boost-system boost-chrono boost-thread msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
+      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk boost-system boost-chrono boost-thread msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
       - bash: "sudo apt-get update && sudo apt install valgrind"
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -56,7 +56,7 @@ extends:
           - powershell: "& ./submodules/vcpkg/bootstrap-vcpkg.bat"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: Bootstrap vcpkg
-          - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk[websockets]:x64-windows msgpack:x64-windows jsoncpp:x64-windows --vcpkg-root ./submodules/vcpkg"
+          - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk:x64-windows msgpack:x64-windows jsoncpp:x64-windows --vcpkg-root ./submodules/vcpkg"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: vcpkg install dependencies
 
@@ -69,7 +69,7 @@ extends:
           - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh --allowAppleClang"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: Bootstrap vcpkg
-          - bash: "./submodules/vcpkg/vcpkg install cpprestsdk[websockets] msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
+          - bash: "./submodules/vcpkg/vcpkg install cpprestsdk msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: vcpkg install dependencies
 
@@ -82,7 +82,7 @@ extends:
           - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: Bootstrap vcpkg
-          - bash: "./submodules/vcpkg/vcpkg install cpprestsdk[websockets] boost-system boost-chrono boost-thread msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
+          - bash: "./submodules/vcpkg/vcpkg install cpprestsdk boost-system boost-chrono boost-thread msgpack jsoncpp --vcpkg-root ./submodules/vcpkg"
             condition: ne(variables.CACHE_RESTORED, 'true')
             displayName: vcpkg install dependencies
           - bash: "sudo apt-get update && sudo apt install valgrind"
diff --git a/include/signalrclient/signalr_client_config.h b/include/signalrclient/signalr_client_config.h
@@ -34,8 +34,10 @@ namespace signalr
         SIGNALRCLIENT_API web::http::client::http_client_config __cdecl get_http_client_config() const;
         SIGNALRCLIENT_API void __cdecl set_http_client_config(const web::http::client::http_client_config& http_client_config);
 
+#if false
         SIGNALRCLIENT_API web::websockets::client::websocket_client_config __cdecl get_websocket_client_config() const noexcept;
         SIGNALRCLIENT_API void __cdecl set_websocket_client_config(const web::websockets::client::websocket_client_config& websocket_client_config);
+#endif
 #endif
 
         SIGNALRCLIENT_API signalr_client_config();
@@ -55,7 +57,9 @@ namespace signalr
     private:
 #ifdef USE_CPPRESTSDK
         web::http::client::http_client_config m_http_client_config;
+#if false
         web::websockets::client::websocket_client_config m_websocket_client_config;
+#endif
 #endif
         std::map<std::string, std::string> m_http_headers;
         std::shared_ptr<scheduler> m_scheduler;
diff --git a/include/signalrclient/signalr_value.h b/include/signalrclient/signalr_value.h
@@ -208,6 +208,8 @@ namespace signalr
 
         union storage
         {
+#pragma warning (push)
+#pragma warning (disable: 4582)
             bool boolean;
             std::string string;
             std::vector<value> array;
@@ -218,8 +220,7 @@ namespace signalr
             // constructor of types in union are not implicitly called
             // this is expected as we only construct a single type in the union once we know
             // what that type is when constructing the signalr_value type.
-#pragma warning (push)
-#pragma warning (disable: 4582)
+
             storage() {}
 #pragma warning (pop)
 
diff --git a/src/signalrclient/connection_impl.cpp b/src/signalrclient/connection_impl.cpp
@@ -46,7 +46,9 @@ namespace signalr
         if (websocket_factory == nullptr)
         {
 #ifdef USE_CPPRESTSDK
+#if false
             websocket_factory = [](const signalr_client_config& signalr_client_config) { return std::make_shared<default_websocket_client>(signalr_client_config); };
+#endif
 #endif
         }
 
diff --git a/src/signalrclient/default_websocket_client.cpp b/src/signalrclient/default_websocket_client.cpp
@@ -4,6 +4,7 @@
 
 #include "stdafx.h"
 
+#if false
 #ifdef USE_CPPRESTSDK
 #include "default_websocket_client.h"
 #include <cpprest/producerconsumerstream.h>
@@ -122,4 +123,5 @@ namespace signalr
             });
     }
 }
+#endif
 #endif
diff --git a/src/signalrclient/default_websocket_client.h b/src/signalrclient/default_websocket_client.h
@@ -4,6 +4,7 @@
 
 #pragma once
 
+#if false
 #ifdef USE_CPPRESTSDK
 
 #pragma warning (push)
@@ -29,4 +30,5 @@ namespace signalr
     };
 }
 
+#endif
 #endif
diff --git a/src/signalrclient/signalr_client_config.cpp b/src/signalrclient/signalr_client_config.cpp
@@ -13,13 +13,17 @@ namespace signalr
     void signalr_client_config::set_proxy(const web::web_proxy &proxy)
     {
         m_http_client_config.set_proxy(proxy);
+#if false
         m_websocket_client_config.set_proxy(proxy);
+#endif
     }
 
     void signalr_client_config::set_credentials(const web::credentials &credentials)
     {
         m_http_client_config.set_credentials(credentials);
+#if false
         m_websocket_client_config.set_credentials(credentials);
+#endif
     }
 
     web::http::client::http_client_config signalr_client_config::get_http_client_config() const
@@ -32,6 +36,7 @@ namespace signalr
         m_http_client_config = http_client_config;
     }
 
+#if false
     web::websockets::client::websocket_client_config signalr_client_config::get_websocket_client_config() const noexcept
     {
         return m_websocket_client_config;
@@ -41,6 +46,7 @@ namespace signalr
     {
         m_websocket_client_config = websocket_client_config;
     }
+#endif
 #endif
 
     signalr_client_config::signalr_client_config()
diff --git a/submodules/googletest b/submodules/googletest
@@ -1 +1 @@
-Subproject commit 703bd9caab50b139428cea1aaff9974ebee5742e
+Subproject commit 662fe38e44900c007eccb65a5d2ea19df7bd520e
diff --git a/submodules/vcpkg b/submodules/vcpkg
@@ -1 +1 @@
-Subproject commit 934a99dc13cabb330824ae1a5ab4a53a9acc5a49
+Subproject commit 031ad89ce6c575df35a8e58707ad2c898446c63e
diff --git a/test/signalrclienttests/connection_tests.cpp b/test/signalrclienttests/connection_tests.cpp
@@ -1501,8 +1501,10 @@ TEST(connection_impl_stop, dtor_stops_the_connection)
 {
     auto writer = std::shared_ptr<log_writer>{ std::make_shared<memory_log_writer>() };
 
+    // in the outer scope so we know the connection_impl dtor is what caused the connection to stop
+    auto websocket_client = create_test_websocket_client();
+
     {
-        auto websocket_client = create_test_websocket_client();
         auto connection = create_connection(websocket_client, writer, trace_level::verbose);
 
         auto mre = manual_reset_event<void>();
@@ -1519,7 +1521,7 @@ TEST(connection_impl_stop, dtor_stops_the_connection)
     // The connection_impl will be destroyed when the last reference to shared_ptr holding is released. This can happen
     // on a different thread in which case the dtor will be invoked on a different thread so we need to wait for this
     // to happen and if it does not the test will fail
-    for (int wait_time_ms = 5; wait_time_ms < 6000 && memory_writer->get_log_entries().size() < 6; wait_time_ms <<= 1)
+    for (int wait_time_ms = 5; wait_time_ms < 6000 && memory_writer->get_log_entries().size() < 13; wait_time_ms <<= 1)
     {
         std::this_thread::sleep_for(std::chrono::milliseconds(wait_time_ms));
     }
diff --git a/test/signalrclienttests/test_utils.cpp b/test/signalrclienttests/test_utils.cpp
@@ -6,6 +6,7 @@
 #include "test_utils.h"
 #include "test_http_client.h"
 #include "signalrclient/signalr_client_config.h"
+#include <algorithm>
 
 using namespace signalr;
 
diff --git a/test/signalrclienttests/websocket_transport_tests.cpp b/test/signalrclienttests/websocket_transport_tests.cpp
@@ -11,6 +11,7 @@
 #include "memory_log_writer.h"
 #include <future>
 #include <atomic>
+#include <algorithm>
 
 using namespace signalr;
 

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,9 @@ namespace signalr`
`46`	`46`	`if (websocket_factory == nullptr)`
`47`	`47`	`{`
`48`	`48`	`#ifdef USE_CPPRESTSDK`
	`49`	`+#if false`
`49`	`50`	`websocket_factory = [](const signalr_client_config& signalr_client_config) { return std::make_shared<default_websocket_client>(signalr_client_config); };`
	`51`	`+#endif`
`50`	`52`	`#endif`
`51`	`53`	`}`
`52`	`54`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`#include "stdafx.h"`
`6`	`6`
	`7`	`+#if false`
`7`	`8`	`#ifdef USE_CPPRESTSDK`
`8`	`9`	`#include "default_websocket_client.h"`
`9`	`10`	`#include <cpprest/producerconsumerstream.h>`
`@@ -122,4 +123,5 @@ namespace signalr`
`122`	`123`	`});`
`123`	`124`	`}`
`124`	`125`	`}`
	`126`	`+#endif`
`125`	`127`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`#pragma once`
`6`	`6`
	`7`	`+#if false`
`7`	`8`	`#ifdef USE_CPPRESTSDK`
`8`	`9`
`9`	`10`	`#pragma warning (push)`
`@@ -29,4 +30,5 @@ namespace signalr`
`29`	`30`	`};`
`30`	`31`	`}`
`31`	`32`
	`33`	`+#endif`
`32`	`34`	`#endif`