RCPP-6 Improve networking (#216)

Author: leemaguire

CHANGELOG.md

@@ -11,12 +11,30 @@ NEXT-RELEASE Release notes (YYYY-MM-DD)
   Supported operators are `==`, `!=`, `>`, `<`, `>=`, `<=` and `contains(const std::string&)`.
 * Add `managed<std::map<std::string, T>>::contains_key` for conveniently checking if a managed map
   contains a given key. Use this method in the Type Safe Query API instead of `managed<std::map<std::string, T>>::find`.
+* Add `realm::networking` namespace which contains interfaces for providing your own custom network transport
+  implementations. The following interfaces are exposed:
+  * `websocket_interface`
+  * `websocket_observer`
+  * `sync_socket_provider`
+  * `sync_socket_provider::timer`
+  * `http_transport_client`
+* Add `default_http_transport` for built-in HTTP transport.
+* Add `default_socket_provider` a built-in class for providing the components necessary for transport via WebSocket.
+* A custom WebSocket & HTTP transport implementation can be used by passing 
+  the instance via `realm::app::App::configuration.http_transport_client` & `realm::app::App::configuration.sync_socket_provider`.
+* Network configuration for the built-in http transport must be supplied via it's constructor using the
+  `realm::networking::default_http_transport::configuration` struct.
+* Network configuration for the built-in websocket provider must be supplied via it's constructor using the
+  `realm::networking::default_socket_provider::configuration` struct.
+
+### Deprecations
+* Proxy and custom http headers should no longer be set via `realm::app::App::configuration`.
 
 ### Compatibility
 * Fileformat: Generates files with format v24. Reads and automatically upgrade from fileformat v10.
 
 ### Internals
-* None
+* Upgraded to Core v14.10.4
 
 2.1.0 Release notes (2024-06-27)
 =============================================================

CMakeLists.txt

@@ -122,24 +122,8 @@ if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang"
     target_compile_options(cpprealm PRIVATE -Wall -Wextra -pedantic -Werror)
 endif()
 
-if(APPLE OR MSVC)
-    target_sources(cpprealm PRIVATE src/cpprealm/internal/network/network_transport.cpp)
-elseif(ANDROID)
-    set(REALM_ANDROID)
-    target_sources(cpprealm PRIVATE src/cpprealm/internal/network/network_transport.cpp)
-else()
-    find_package(CURL)
-    if(NOT CURL_FOUND)
-        message(WARNING "CURL not found. Realm C++ will use internal networking components instead.")
-        target_sources(cpprealm PRIVATE src/cpprealm/internal/network/network_transport.cpp)
-    else()
-        target_link_libraries(cpprealm PUBLIC CURL::libcurl)
-        target_sources(cpprealm PRIVATE src/cpprealm/internal/curl/network_transport.cpp)
-    endif()
-
-    if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9.0)
-        target_link_libraries(cpprealm PRIVATE stdc++fs)
-    endif()
+if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9.0)
+    target_link_libraries(cpprealm PRIVATE stdc++fs)
 endif()
 
 if(MSVC AND NOT DEFINED CMAKE_MSVC_RUNTIME_LIBRARY)

Package.swift

@@ -3,7 +3,7 @@
 import PackageDescription
 
 let sdkVersion = Version("2.1.0")
-let coreVersion = Version("14.9.0")
+let coreVersion = Version("14.10.4")
 
 var cxxSettings: [CXXSetting] = [
     .define("REALM_ENABLE_SYNC", to: "1"),
@@ -41,8 +41,6 @@ let cppSdkTarget: Target = .target(
     ],
     path: ".",
     exclude: [
-        "src/cpprealm/internal/curl",
-        "src/cpprealm/internal/network",
         "src/cpprealm/util/config.in.h",
         "realm-core"
     ],

include/cpprealm/app.hpp

@@ -27,11 +27,14 @@
 #include <cpprealm/internal/bridge/sync_manager.hpp>
 #include <cpprealm/internal/bridge/sync_session.hpp>
 #include <cpprealm/internal/bridge/utils.hpp>
+#include <cpprealm/networking/http.hpp>
+#include <cpprealm/networking/websocket.hpp>
 
 #include <future>
 #include <utility>
 
 namespace realm {
+
     using proxy_config = sync_config::proxy_config;
     using sync_session = internal::bridge::sync_session;
 
@@ -222,20 +225,43 @@ namespace app {
 
 class App {
 public:
+    /**
+     * Properties representing the configuration of a client
+     * that communicate with a particular Realm application.
+     *
+     * `App::configuration` options cannot be modified once the `App` using it
+     *  is created. App's configuration values are cached when the App is created so any modifications after it
+     *  will not have any effect.
+     */
     struct configuration {
+        /// The App ID for your Atlas Device Sync Application.
         std::string app_id;
+        /// A custom base URL to request against. If not set or set to nil, the default base url for app services will be returned.
         std::optional<std::string> base_url;
+        /// Custom location for Realm files.
         std::optional<std::string> path;
+        [[deprecated("Network options must be supplied via custom network implementations.")]]
         std::optional<std::map<std::string, std::string>> custom_http_headers;
+        /// Custom encryption key for the metadata Realm.
         std::optional<std::array<char, 64>> metadata_encryption_key;
+        /// Caches an App and its configuration for a given App ID. On by default.
+        bool enable_caching = true;
+        [[deprecated("Network options must be supplied via custom network implementations.")]]
         std::optional<sync_config::proxy_config> proxy_configuration;
+        /**
+         * Optionally provide a custom HTTP transport for network calls to the server.
+         *
+         * Alternatively use `realm::networking::set_http_client_factory` to globally set
+         * the default HTTP transport client.
+         */
+        std::shared_ptr<networking::http_transport_client> http_transport_client;
+        /**
+         * Optionally provide a custom WebSocket interface for sync.
+         */
+        std::shared_ptr<networking::sync_socket_provider> sync_socket_provider;
+
     };
 
-    [[deprecated("Use App(const configuration&) instead.")]]
-    explicit App(const std::string& app_id,
-                 const std::optional<std::string>& base_url = {},
-                 const std::optional<std::string>& path = {},
-                 const std::optional<std::map<std::string, std::string>>& custom_http_headers = {});
 
     App(const configuration&);
 

include/cpprealm/db.hpp

@@ -20,19 +20,16 @@
 #define CPPREALM_DB_HPP
 
 #include <cpprealm/accessors.hpp>
-
+#include <cpprealm/macros.hpp>
+#include <cpprealm/results.hpp>
+#include <cpprealm/scheduler.hpp>
 #include <cpprealm/schema.hpp>
+#include <cpprealm/types.hpp>
 
 #include <cpprealm/internal/bridge/sync_session.hpp>
 #include <cpprealm/internal/bridge/thread_safe_reference.hpp>
 #include <cpprealm/internal/bridge/sync_session.hpp>
 
-#include <cpprealm/scheduler.hpp>
-
-#include <cpprealm/macros.hpp>
-#include <cpprealm/results.hpp>
-#include <cpprealm/types.hpp>
-
 #include <filesystem>
 #include <optional>
 #include <string>

include/cpprealm/internal/bridge/status.hpp

@@ -61,7 +61,7 @@ namespace realm::internal::bridge {
     };
 
     struct status {
-
+        static status ok();
         status(const ::realm::Status&);
         status(::realm::Status&&);
         status(const status&);
@@ -73,7 +73,7 @@ namespace realm::internal::bridge {
         bool is_ok() const noexcept;
         const std::string& reason() const noexcept;
         std::string_view code_string() const noexcept;
-
+        operator ::realm::Status() const noexcept;
     private:
 #ifdef CPPREALM_HAVE_GENERATED_BRIDGE_TYPES
         storage::Status m_status[1];

include/cpprealm/internal/generic_network_transport.hpp

@@ -0,0 +1,39 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2024 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+#ifndef CPPREALM_SHIMS_HPP
+#define CPPREALM_SHIMS_HPP
+
+#include <cpprealm/networking/http.hpp>
+#include <cpprealm/networking/websocket.hpp>
+
+namespace realm {
+    namespace sync {
+        class SyncSocketProvider;
+    }
+    namespace app {
+        struct GenericNetworkTransport;
+    }
+}
+
+namespace realm::internal::networking {
+    std::shared_ptr<app::GenericNetworkTransport> create_http_client_shim(const std::shared_ptr<::realm::networking::http_transport_client>&);
+    std::unique_ptr<::realm::sync::SyncSocketProvider> create_sync_socket_provider_shim(const std::shared_ptr<::realm::networking::sync_socket_provider>& provider);
+}
+
+#endif //CPPREALM_SHIMS_HPP

include/cpprealm/internal/networking/shims.hpp

@@ -0,0 +1,50 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2024 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+#ifndef CPPREALM_NETWORKING_UTILS_HPP
+#define CPPREALM_NETWORKING_UTILS_HPP
+
+#include <cpprealm/networking/websocket.hpp>
+
+#include <optional>
+
+namespace realm {
+    namespace app {
+        struct Request;
+        struct Response;
+    }
+    namespace sync {
+        struct WebSocketEndpoint;
+    }
+
+    namespace networking {
+        struct request;
+        struct response;
+    }
+}
+
+namespace realm::internal::networking {
+    ::realm::networking::request to_request(const ::realm::app::Request&);
+    ::realm::app::Response to_core_response(const ::realm::networking::response&);
+
+    ::realm::sync::WebSocketEndpoint to_core_websocket_endpoint(const ::realm::networking::websocket_endpoint& ep,
+                                                                const std::optional<::realm::networking::default_socket_provider::configuration>& config);
+    ::realm::networking::websocket_endpoint to_websocket_endpoint(const ::realm::sync::WebSocketEndpoint& ep);
+} //namespace realm::internal::networking
+
+#endif //CPPREALM_NETWORKING_UTILS_HPP