feat: redis data source

.github/ISSUE_TEMPLATE/server-sdk-redis-source--bug-report.md

@@ -0,0 +1,50 @@
+---
+name: 'C++ Server SDK / Redis Source Bug Report'
+about: Create a report to help us improve
+title: ''
+labels: 'package: sdk/server-redis, bug'
+assignees: ''
+
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this
+library. If you're not sure whether the problem you are having is specifically related to this library, or to the
+LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to
+investigate the problem and will consult the SDK team if necessary. You can submit a support request by
+going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing
+support@launchdarkly.com.
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on
+your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+To get more logs from the SDK, change the log level using environment variable `LD_LOG_LEVEL`. For example:
+
+  ```
+   LD_LOG_LEVEL=debug ./your-application
+  ```
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, C++17 or C11. If you are using a language that requires a separate compiler, such as C, please include the
+name and version of the compiler too.
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the
+browser type and version.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/server-sdk-redis-source--feature-request.md

@@ -0,0 +1,20 @@
+---
+name: 'C++ Server SDK / Redis Source Feature Request'
+about: Create a report to help us improve
+title: ''
+labels: 'package: sdk/server-redis, feature'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/workflows/manual-publish-doc.yml

@@ -9,6 +9,7 @@ on:
         options:
           - libs/client-sdk
           - libs/server-sdk
+          - libs/server-sdk-redis-source
 name: Publish Documentation
 jobs:
   build-publish:

.github/workflows/manual-sdk-release-artifacts.yml

@@ -15,6 +15,7 @@ on:
         options:
           - libs/client-sdk:launchdarkly-cpp-client
           - libs/server-sdk:launchdarkly-cpp-server
+          - libs/server-sdk-redis-source:launchdarkly-cpp-server-redis-source
 
 name: Publish SDK Artifacts
 

.github/workflows/server-redis.yml

@@ -0,0 +1,49 @@
+name: libs/server-sdk-redis-source
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [ "main", "feat/**" ]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-redis:
+    runs-on: ubuntu-22.04
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/ci
+        with:
+          cmake_target: launchdarkly-cpp-server-redis-source
+          simulate_release: true
+  build-redis-mac:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/ci
+        with:
+          cmake_target: launchdarkly-cpp-server-redis-source
+          platform_version: 12
+          run_tests: false # TODO: figure out how to run Redis service on Mac
+  build-test-redis-windows:
+    runs-on: windows-2022
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ilammy/msvc-dev-cmd@v1
+      - uses: ./.github/actions/ci
+        env:
+          BOOST_LIBRARY_DIR: 'C:\local\boost_1_81_0\lib64-msvc-14.3'
+          BOOST_LIBRARYDIR: 'C:\local\boost_1_81_0\lib64-msvc-14.3'
+        with:
+          cmake_target: launchdarkly-cpp-server-redis-source
+          platform_version: 2022
+          toolset: msvc
+          run_tests: false # TODO: figure out how to run Redis service on Windows

CMakeLists.txt

@@ -61,6 +61,8 @@ option(LD_DYNAMIC_LINK_OPENSSL
 
 option(LD_BUILD_EXAMPLES "Build hello-world examples." ON)
 
+option(LD_BUILD_REDIS_SUPPORT "Build redis support." OFF)
+
 # If using 'make' as the build system, CMake causes the 'install' target to have a dependency on 'all', meaning
 # it will cause a full build. This disables that, allowing us to build piecemeal instead. This is useful
 # so that we only need to build the client or server for a given release (if only the client or server were affected.)
@@ -142,6 +144,11 @@ add_subdirectory(libs/common)
 add_subdirectory(libs/internal)
 add_subdirectory(libs/server-sent-events)
 
+if (LD_BUILD_REDIS_SUPPORT)
+    message("LaunchDarkly: building server-side redis support")
+    add_subdirectory(libs/server-sdk-redis-source)
+endif ()
+
 # Built as static or shared depending on LD_BUILD_SHARED_LIBS variable.
 # This target "links" in common, internal, and sse as object libraries.
 add_subdirectory(libs/client-sdk)

cmake/redis-plus-plus.cmake

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 3.11)
+
+include(FetchContent)
+
+
+FetchContent_Declare(hiredis
+        GIT_REPOSITORY https://github.com/redis/hiredis.git
+        GIT_TAG 60e5075d4ac77424809f855ba3e398df7aacefe8
+        GIT_SHALLOW TRUE
+        SOURCE_DIR _deps/hiredis
+        OVERRIDE_FIND_PACKAGE
+)
+
+
+FetchContent_MakeAvailable(hiredis)
+
+include_directories(${CMAKE_CURRENT_BINARY_DIR}/_deps)
+
+set(REDIS_PLUS_PLUS_BUILD_TEST OFF CACHE BOOL "" FORCE)
+
+# 1.3.7 is the last release that works with FetchContent, due to a problem with CheckSymbolExists
+# when it tries to do feature detection on hiredis.
+FetchContent_Declare(redis-plus-plus
+        GIT_REPOSITORY https://github.com/sewenew/redis-plus-plus.git
+        GIT_TAG 1.3.7
+        GIT_SHALLOW TRUE
+)
+
+FetchContent_MakeAvailable(redis-plus-plus)

examples/CMakeLists.txt

@@ -3,3 +3,7 @@ add_subdirectory(hello-cpp-client)
 add_subdirectory(hello-cpp-server)
 add_subdirectory(hello-c-server)
 add_subdirectory(client-and-server-coexistence)
+
+if (LD_BUILD_REDIS_SUPPORT)
+    add_subdirectory(hello-cpp-server-redis)
+endif ()

examples/hello-c-server/main.c

@@ -53,7 +53,7 @@ int main() {
             return 1;
         }
     } else {
-        printf("SDK initialization didn't complete in %dms\n",
+        printf("*** SDK initialization didn't complete in %dms\n",
                INIT_TIMEOUT_MILLISECONDS);
         return 1;
     }

examples/hello-cpp-server-redis/CMakeLists.txt

@@ -0,0 +1,15 @@
+# Required for Apple Silicon support.
+cmake_minimum_required(VERSION 3.19)
+
+project(
+        LaunchDarklyHelloCPPServerRedisSource
+        VERSION 0.1
+        DESCRIPTION "LaunchDarkly Hello CPP Server-side SDK with Redis source"
+        LANGUAGES CXX
+)
+
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+find_package(Threads REQUIRED)
+
+add_executable(hello-cpp-server-redis-source main.cpp)
+target_link_libraries(hello-cpp-server-redis-source PRIVATE launchdarkly::server_redis_source Threads::Threads)

examples/hello-cpp-server-redis/main.cpp

@@ -0,0 +1,108 @@
+#include <launchdarkly/context_builder.hpp>
+#include <launchdarkly/server_side/client.hpp>
+#include <launchdarkly/server_side/config/config_builder.hpp>
+
+#include <launchdarkly/server_side/integrations/redis/redis_source.hpp>
+
+#include <cstring>
+#include <iostream>
+
+// Set SDK_KEY to your LaunchDarkly SDK key.
+#define SDK_KEY ""
+
+// Set FEATURE_FLAG_KEY to the feature flag key you want to evaluate.
+#define FEATURE_FLAG_KEY "my-boolean-flag"
+
+// Set INIT_TIMEOUT_MILLISECONDS to the amount of time you will wait for
+// the client to become initialized.
+#define INIT_TIMEOUT_MILLISECONDS 3000
+
+// Set REDIS_URI to your own Redis instance's URI.
+#define REDIS_URI "redis://localhost:6379"
+
+// Set REDIS_PREFIX to the prefix containing the launchdarkly
+// environment data in Redis.
+#define REDIS_PREFIX "launchdarkly"
+
+char const* get_with_env_fallback(char const* source_val,
+                                  char const* env_variable,
+                                  char const* error_msg);
+using namespace launchdarkly;
+using namespace launchdarkly::server_side;
+
+int main() {
+    char const* sdk_key = get_with_env_fallback(
+        SDK_KEY, "LD_SDK_KEY",
+        "Please edit main.cpp to set SDK_KEY to your LaunchDarkly server-side "
+        "SDK key "
+        "first.\n\nAlternatively, set the LD_SDK_KEY environment "
+        "variable.\n"
+        "The value of SDK_KEY in main.c takes priority over LD_SDK_KEY.");
+
+    auto config_builder = ConfigBuilder(sdk_key);
+
+    using LazyLoad = server_side::config::builders::LazyLoadBuilder;
+
+    auto redis = integrations::RedisDataSource::Create(REDIS_URI, REDIS_PREFIX);
+
+    if (!redis) {
+        std::cout << "error: redis config is invalid: " << redis.error()
+                  << '\n';
+        return 1;
+    }
+
+    config_builder.DataSystem().Method(
+        LazyLoad().Source(*redis).CacheRefresh(std::chrono::seconds(30)));
+
+    auto config = config_builder.Build();
+    if (!config) {
+        std::cout << "error: config is invalid: " << config.error() << '\n';
+        return 1;
+    }
+
+    auto client = Client(std::move(*config));
+
+    auto start_result = client.StartAsync();
+
+    if (auto const status = start_result.wait_for(
+            std::chrono::milliseconds(INIT_TIMEOUT_MILLISECONDS));
+        status == std::future_status::ready) {
+        if (start_result.get()) {
+            std::cout << "*** SDK successfully initialized!\n\n";
+        } else {
+            std::cout << "*** SDK failed to initialize\n";
+            return 1;
+        }
+    } else {
+        std::cout << "*** SDK initialization didn't complete in "
+                  << INIT_TIMEOUT_MILLISECONDS << "ms\n";
+        return 1;
+    }
+
+    auto const context =
+        ContextBuilder().Kind("user", "example-user-key").Name("Sandy").Build();
+
+    bool const flag_value =
+        client.BoolVariation(context, FEATURE_FLAG_KEY, false);
+
+    std::cout << "*** Feature flag '" << FEATURE_FLAG_KEY << "' is "
+              << (flag_value ? "true" : "false") << " for this user\n\n";
+
+    return 0;
+}
+
+char const* get_with_env_fallback(char const* source_val,
+                                  char const* env_variable,
+                                  char const* error_msg) {
+    if (strlen(source_val)) {
+        return source_val;
+    }
+
+    if (char const* from_env = std::getenv(env_variable);
+        from_env && strlen(from_env)) {
+        return from_env;
+    }
+
+    std::cout << "*** " << error_msg << std::endl;
+    std::exit(1);
+}

libs/client-sdk/tests/CMakeLists.txt

@@ -9,8 +9,10 @@ file(GLOB tests "${PROJECT_SOURCE_DIR}/tests/*.cpp")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 
 # Get things in the same directory on windows.
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+if (WIN32)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+endif ()
 
 add_executable(gtest_${LIBNAME}
         ${tests})

libs/client-sdk/tests/data_source_status_manager_test.cpp

@@ -2,6 +2,8 @@
 
 #include "data_sources/data_source_status_manager.hpp"
 
+#include <thread>
+
 using launchdarkly::client_side::data_sources::DataSourceStatus;
 using launchdarkly::client_side::data_sources::DataSourceStatusManager;
 using launchdarkly::client_side::data_sources::IDataSourceStatusProvider;
@@ -145,6 +147,8 @@ TEST(DataSourceStatusManagerTests, TimeIsUpdatedOnStateChange) {
     status_manager.SetState(DataSourceStatus::DataSourceState::kValid);
 
     auto initial = status_manager.Status().StateSince();
+
+    std::this_thread::sleep_for(std::chrono::milliseconds(1));
     status_manager.SetState(DataSourceStatus::DataSourceState::kInterrupted);
 
     EXPECT_NE(initial.time_since_epoch().count(),

libs/common/tests/CMakeLists.txt

@@ -11,8 +11,10 @@ file(GLOB tests "${PROJECT_SOURCE_DIR}/tests/*.cpp"
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 
 # Get things in the same directory on windows.
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+if (WIN32)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+endif ()
 
 add_executable(gtest_${LIBNAME}
         ${tests})

libs/common/tests/data_source_status_test.cpp

@@ -2,6 +2,8 @@
 
 #include <launchdarkly/data_sources/data_source_status_base.hpp>
 
+#include <iomanip>
+
 namespace test_things {
 enum class TestDataSourceStates { kStateA = 0, kStateB = 1, kStateC = 2 };
 

libs/internal/tests/CMakeLists.txt

@@ -9,8 +9,10 @@ file(GLOB tests "${PROJECT_SOURCE_DIR}/tests/*.cpp")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 
 # Get things in the same directory on windows.
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+if (WIN32)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}../")
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}../")
+endif ()
 
 add_executable(gtest_${LIBNAME}
         ${tests})