feat: Reorganize code to better facilitate encapsulation. (#87)

* feat: Reorganize code to better facilitate encapsulation.

* Start scaffoling logging config.

* Building common/internal/sse

* Client builds.

* Hello app runs

* All runs.

* Everything builds.

* Attempt to appease GCC.

* Reformat code.

* Feedback, and make boost private.

* Run regex better.

* Lowercase w.

* Add missing newline to end of file.

* More Write casing.

* Fix header groupings for polling data source.

* Add missing headers.

* Remove code from bad merge.

* Update dependencies for release-please.

* Cleanup install deps.

* Format again.

* Format libs.

Author: kinyoklion

.release-please-manifest.json

@@ -1,5 +1,6 @@
 {
   "libs/client-sdk": "0.0.0",
   "libs/server-sent-events": "0.0.0",
-  "libs/common": "0.0.0"
+  "libs/common": "0.0.0",
+  "libs/internal": "0.0.0"
 }

CMakeLists.txt

@@ -49,8 +49,6 @@ if (BUILD_TESTING)
     enable_testing()
 endif ()
 
-add_subdirectory(libs/client-sdk)
-
 set(OPENSSL_USE_STATIC_LIBS ON)
 set(OPENSSL_ROOT_DIR "/opt/homebrew/opt/[email protected]")
 find_package(OpenSSL REQUIRED)
@@ -71,11 +69,14 @@ set(Boost_USE_STATIC_RUNTIME OFF)
 find_package(Boost 1.80 REQUIRED COMPONENTS json url coroutine)
 message(STATUS "LaunchDarkly: using Boost v${Boost_VERSION}")
 
+add_subdirectory(libs/client-sdk)
+
 set(ORIGINAL_BUILD_SHARED_LIBS "${BUILD_SHARED_LIBS}")
 set(BUILD_SHARED_LIBS OFF)
 
 # Always build the common libraries as shared libs.
 add_subdirectory(libs/common)
+add_subdirectory(libs/internal)
 add_subdirectory(libs/server-sent-events)
 add_subdirectory(bindings/c)
 

apps/hello-cpp/main.cpp

@@ -2,29 +2,24 @@
 
 #include <boost/asio/io_context.hpp>
 
-#include <launchdarkly/console_backend.hpp>
 #include <launchdarkly/context_builder.hpp>
 
 #include <iostream>
 
 namespace net = boost::asio;  // from <boost/asio.hpp>
 
-using launchdarkly::ConsoleBackend;
 using launchdarkly::ContextBuilder;
-using launchdarkly::Logger;
-using launchdarkly::LogLevel;
 using launchdarkly::client_side::Client;
 using launchdarkly::client_side::ConfigBuilder;
 using launchdarkly::client_side::DataSourceBuilder;
 
 int main() {
-    Logger logger(std::make_unique<ConsoleBackend>("Hello"));
-
     net::io_context ioc;
 
     char const* key = std::getenv("STG_SDK_KEY");
     if (!key) {
-        std::cout << "Set environment variable STG_SDK_KEY to the sdk key";
+        std::cout << "Set environment variable STG_SDK_KEY to the sdk key"
+                  << std::endl;
         return 1;
     }
 
@@ -47,27 +42,26 @@ int main() {
             .value(),
         ContextBuilder().kind("user", "ryan").build());
 
-    LD_LOG(logger, LogLevel::kInfo)
-        << "Initial Status: " << client.DataSourceStatus().Status();
+    std::cout << "Initial Status: " << client.DataSourceStatus().Status()
+              << std::endl;
 
-    client.DataSourceStatus().OnDataSourceStatusChange([&logger](auto status) {
-        LD_LOG(logger, LogLevel::kInfo) << "Got status: " << status;
+    client.DataSourceStatus().OnDataSourceStatusChange([](auto status) {
+        std::cout << "Got status: " << status << std::endl;
     });
 
-    client.FlagNotifier().OnFlagChange(
-        "my-boolean-flag", [&logger](auto event) {
-            LD_LOG(logger, LogLevel::kInfo) << "Got flag change: " << *event;
-        });
+    client.FlagNotifier().OnFlagChange("my-boolean-flag", [](auto event) {
+        std::cout << "Got flag change: " << *event << std::endl;
+    });
 
     client.WaitForReadySync(std::chrono::seconds(30));
 
     auto value = client.BoolVariationDetail("my-boolean-flag", false);
-    LD_LOG(logger, LogLevel::kInfo) << "Value was: " << *value;
+    std::cout << "Value was: " << *value << std::endl;
     if (auto reason = value.Reason()) {
-        LD_LOG(logger, LogLevel::kInfo) << "Reason was: " << *reason;
+        std::cout << "Reason was: " << *reason << std::endl;
     }
 
     // Sit around.
-    std::cout << "Press enter to exit" << std::endl;
+    std::cout << "Press enter to exit" << std::endl << std::endl;
     std::cin.get();
 }

apps/sdk-contract-tests/CMakeLists.txt

@@ -22,6 +22,7 @@ add_executable(sdk-tests
 
 target_link_libraries(sdk-tests PRIVATE
         launchdarkly::client
+        launchdarkly::internal
         foxy
         nlohmann_json::nlohmann_json
         Boost::coroutine

apps/sdk-contract-tests/include/entity_manager.hpp

@@ -3,7 +3,7 @@
 #include <boost/asio/any_io_executor.hpp>
 
 #include <launchdarkly/client_side/client.hpp>
-#include <launchdarkly/logger.hpp>
+#include <launchdarkly/logging/logger.hpp>
 
 #include "client_entity.hpp"
 #include "definitions.hpp"

apps/sdk-contract-tests/include/server.hpp

@@ -7,7 +7,7 @@
 
 #include "entity_manager.hpp"
 
-#include <launchdarkly/logger.hpp>
+#include <launchdarkly/logging/logger.hpp>
 
 #include <foxy/listener.hpp>
 

apps/sdk-contract-tests/include/session.hpp

@@ -1,7 +1,8 @@
 #pragma once
 
+#include <launchdarkly/logging/logger.hpp>
+
 #include "entity_manager.hpp"
-#include <launchdarkly/logger.hpp>
 
 #include <boost/beast.hpp>
 #include <boost/beast/http.hpp>

apps/sdk-contract-tests/src/main.cpp

@@ -1,6 +1,6 @@
 #include "server.hpp"
 
-#include <launchdarkly/console_backend.hpp>
+#include <launchdarkly/logging/console_backend.hpp>
 
 #include <boost/asio/io_context.hpp>
 #include <boost/asio/signal_set.hpp>
@@ -13,7 +13,7 @@
 namespace net = boost::asio;
 namespace beast = boost::beast;
 
-using launchdarkly::ConsoleBackend;
+using launchdarkly::logging::ConsoleBackend;
 
 using launchdarkly::LogLevel;
 

apps/sse-contract-tests/CMakeLists.txt

@@ -22,6 +22,7 @@ add_executable(sse-tests
 target_link_libraries(sse-tests PRIVATE
         launchdarkly::sse
         launchdarkly::common
+        launchdarkly::internal
         foxy
         nlohmann_json::nlohmann_json
         Boost::coroutine

apps/sse-contract-tests/include/entity_manager.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
+#include <launchdarkly/logging/logger.hpp>
 #include "definitions.hpp"
-#include <launchdarkly/logger.hpp>
 
 #include <launchdarkly/sse/client.hpp>
 

apps/sse-contract-tests/include/server.hpp

@@ -4,8 +4,8 @@
 #include <boost/asio/ip/tcp.hpp>
 #include <boost/asio/signal_set.hpp>
 #include <boost/beast.hpp>
+#include <launchdarkly/logging/logger.hpp>
 #include "entity_manager.hpp"
-#include <launchdarkly/logger.hpp>
 
 #include <foxy/listener.hpp>
 

apps/sse-contract-tests/include/session.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
+#include <launchdarkly/logging/logger.hpp>
 #include "entity_manager.hpp"
-#include <launchdarkly/logger.hpp>
 
 #include <boost/beast.hpp>
 #include <boost/beast/http.hpp>

apps/sse-contract-tests/src/main.cpp

@@ -1,6 +1,6 @@
 #include "server.hpp"
 
-#include <launchdarkly/console_backend.hpp>
+#include <launchdarkly/logging/console_backend.hpp>
 
 #include <boost/asio/io_context.hpp>
 #include <boost/asio/signal_set.hpp>
@@ -12,7 +12,7 @@
 namespace net = boost::asio;
 namespace beast = boost::beast;
 
-using launchdarkly::ConsoleBackend;
+using launchdarkly::logging::ConsoleBackend;
 
 using launchdarkly::LogLevel;
 

libs/client-sdk/docs/doc.md

@@ -5,5 +5,5 @@
 The following pages document the core of the API, every application will use these portions of the SDK:
 
 - [Client](@ref launchdarkly::client_side::Client)
-- [Config Builder](@ref launchdarkly::config::detail::builders::ConfigBuilder)
+- [Config Builder](@ref launchdarkly::config::shared::builders::ConfigBuilder)
 - [Context Builder](@ref launchdarkly::ContextBuilder)

libs/client-sdk/include/launchdarkly/client_side/client.hpp

@@ -8,8 +8,8 @@
 #include <launchdarkly/context.hpp>
 #include <launchdarkly/value.hpp>
 
-#include <launchdarkly/client_side/data_sources/data_source_status.hpp>
-#include <launchdarkly/client_side/flag_manager/flag_notifier.hpp>
+#include <launchdarkly/client_side/data_source_status.hpp>
+#include <launchdarkly/client_side/flag_notifier.hpp>
 #include <launchdarkly/config/client.hpp>
 #include <launchdarkly/data/evaluation_detail.hpp>
 
@@ -220,7 +220,7 @@ class IClient {
      * flag changes.
      * @return A flag notifier.
      */
-    virtual flag_manager::detail::IFlagNotifier& FlagNotifier() = 0;
+    virtual flag_manager::IFlagNotifier& FlagNotifier() = 0;
 
     /**
      * Wait for the client to be ready. A client will be ready when it either
@@ -299,7 +299,7 @@ class Client : public IClient {
 
     data_sources::IDataSourceStatusProvider& DataSourceStatus() override;
 
-    flag_manager::detail::IFlagNotifier& FlagNotifier() override;
+    flag_manager::IFlagNotifier& FlagNotifier() override;
 
     void WaitForReadySync(std::chrono::milliseconds timeout) override;
 

libs/client-sdk/include/launchdarkly/client_side/data_sources/data_source_status.hpp renamed to libs/client-sdk/include/launchdarkly/client_side/data_source_status.hpp

@@ -2,12 +2,13 @@
 
 #include <chrono>
 #include <cstddef>
+#include <functional>
+#include <memory>
 #include <optional>
 #include <ostream>
 #include <string>
 
-#include <launchdarkly/client_side/connection.hpp>
-#include <launchdarkly/network/detail/http_requester.hpp>
+#include <launchdarkly/connection.hpp>
 
 namespace launchdarkly::client_side::data_sources {
 
@@ -77,7 +78,7 @@ class DataSourceStatus {
      */
     class ErrorInfo {
        public:
-        using StatusCodeType = network::detail::HttpResult::StatusCode;
+        using StatusCodeType = uint64_t;
 
         /**
          * An enumeration describing the general type of an error.

libs/client-sdk/include/launchdarkly/client_side/export.hpp

@@ -2,7 +2,7 @@
 
 #include <launchdarkly/value.hpp>
 
-namespace launchdarkly::client_side::flag_manager::detail {
+namespace launchdarkly::client_side::flag_manager {
 /**
  * A notification, for the consumer of the SDK, that a flag value has
  * changed.
@@ -60,4 +60,4 @@ class FlagValueChangeEvent {
 
 std::ostream& operator<<(std::ostream& out, FlagValueChangeEvent const& event);
 
-}  // namespace launchdarkly::client_side::flag_manager::detail
+}  // namespace launchdarkly::client_side::flag_manager

libs/client-sdk/include/launchdarkly/client_side/flag_manager/flag_change_event.hpp renamed to libs/client-sdk/include/launchdarkly/client_side/flag_change_event.hpp

@@ -1,10 +1,13 @@
 #pragma once
 
-#include <launchdarkly/client_side/connection.hpp>
-#include <launchdarkly/client_side/flag_manager/flag_change_event.hpp>
+#include <launchdarkly/client_side/flag_change_event.hpp>
+#include <launchdarkly/connection.hpp>
 #include <launchdarkly/value.hpp>
 
-namespace launchdarkly::client_side::flag_manager::detail {
+#include <functional>
+#include <memory>
+
+namespace launchdarkly::client_side::flag_manager {
 
 /**
  * Interface to allow listening for flag changes. Notification events should
@@ -40,4 +43,4 @@ class IFlagNotifier {
     IFlagNotifier() = default;
 };
 
-}  // namespace launchdarkly::client_side::flag_manager::detail
+}  // namespace launchdarkly::client_side::flag_manager

libs/client-sdk/include/launchdarkly/client_side/flag_manager/flag_notifier.hpp renamed to libs/client-sdk/include/launchdarkly/client_side/flag_notifier.hpp

@@ -4,6 +4,7 @@
   "version": "0.0.0",
   "private": true,
   "dependencies": {
+    "launchdarkly-cpp-internal": "0.0.0",
     "launchdarkly-cpp-common": "0.0.0"
   }
 }

libs/client-sdk/package.json

@@ -1,13 +1,6 @@
 
 file(GLOB HEADER_LIST CONFIGURE_DEPENDS
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/*.hpp"
         "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/data_sources/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/data_sources/detail/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/flag_manager/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/flag_manager/detail/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/event_processor/*.hpp"
-        "${LaunchDarklyCPPClient_SOURCE_DIR}/include/launchdarkly/client_side/event_processor/detail/*.hpp"
         )
 
 # Automatic library: static or dynamic based on user config.
@@ -17,7 +10,7 @@ add_library(${LIBNAME}
         data_sources/streaming_data_source.cpp
         data_sources/base_64.cpp
         data_sources/data_source_event_handler.cpp
-        data_source_update_sink.cpp
+        data_sources/data_source_update_sink.cpp
         data_sources/polling_data_source.cpp
         flag_manager/flag_manager.cpp
         flag_manager/flag_updater.cpp
@@ -28,11 +21,25 @@ add_library(${LIBNAME}
         event_processor/null_event_processor.cpp
         boost_signal_connection.cpp
         client_impl.cpp
-        client.cpp)
+        client.cpp
+        data_sources/base_64.hpp
+        boost_signal_connection.hpp
+        client_impl.hpp
+        data_sources/data_source.hpp
+        data_sources/data_source_event_handler.hpp
+        data_sources/data_source_status_manager.hpp
+        data_sources/data_source_update_sink.hpp
+        data_sources/polling_data_source.hpp
+        data_sources/streaming_data_source.hpp
+        event_processor/event_processor.hpp
+        event_processor/null_event_processor.hpp
+        flag_manager/flag_manager.hpp
+        flag_manager/flag_updater.hpp
+        event_processor.hpp)
 
 target_link_libraries(${LIBNAME}
         PUBLIC launchdarkly::common
-        PRIVATE launchdarkly::sse)
+        PRIVATE Boost::headers launchdarkly::sse launchdarkly::internal)
 
 add_library(launchdarkly::client ALIAS ${LIBNAME})
 

libs/client-sdk/src/CMakeLists.txt

@@ -1,6 +1,6 @@
-#include <launchdarkly/client_side/detail/boost_signal_connection.hpp>
+#include "boost_signal_connection.hpp"
 
-namespace launchdarkly::client_side::detail {
+namespace launchdarkly::client_side {
 
 SignalConnection::SignalConnection(boost::signals2::connection connection)
     : connection_(std::move(connection)) {}
@@ -9,4 +9,4 @@ void SignalConnection::Disconnect() {
     connection_.disconnect();
 }
 
-}  // namespace launchdarkly::client_side::detail
+}  // namespace launchdarkly::client_side