chore: Add support for persistent store contract tests.

.github/actions/ci/action.yml

@@ -37,6 +37,14 @@ inputs:
     description: 'Whether to install CURL development libraries. Required for OpenTelemetry builds (server-sdk-otel), but does not enable CURL networking for the SDK itself.'
     required: false
     default: 'false'
+  use_redis:
+    description: 'Whether to enable Redis support (LD_BUILD_REDIS_SUPPORT=ON). Leave unset to preserve automatic detection for Redis targets.'
+    required: false
+    default: ''
+  use_dynamodb:
+    description: 'Whether to enable DynamoDB support (LD_BUILD_DYNAMODB_SUPPORT=ON). Leave unset to preserve automatic detection for DynamoDB targets.'
+    required: false
+    default: ''
 
 runs:
   using: composite
@@ -58,7 +66,7 @@ runs:
       id: install-curl
     - name: Build Library
       shell: bash
-      run: ./scripts/build.sh ${{ inputs.cmake_target }} ON ${{ inputs.use_curl }}
+      run: ./scripts/build.sh ${{ inputs.cmake_target }} ON "${{ inputs.use_curl }}" "${{ inputs.use_redis }}" "${{ inputs.use_dynamodb }}"
       env:
         BOOST_ROOT: ${{ steps.install-boost.outputs.BOOST_ROOT }}
         Boost_DIR: ${{ steps.install-boost.outputs.Boost_DIR }}
@@ -69,7 +77,7 @@ runs:
       id: build-tests
       if: inputs.run_tests == 'true'
       shell: bash
-      run: ./scripts/build.sh gtest_${{ inputs.cmake_target }} ON ${{ inputs.use_curl }}
+      run: ./scripts/build.sh gtest_${{ inputs.cmake_target }} ON "${{ inputs.use_curl }}" "${{ inputs.use_redis }}" "${{ inputs.use_dynamodb }}"
       env:
         BOOST_ROOT: ${{ steps.install-boost.outputs.BOOST_ROOT }}
         Boost_DIR: ${{ steps.install-boost.outputs.Boost_DIR }}

.github/workflows/server-dynamodb.yml

@@ -14,6 +14,47 @@ on:
     - cron: '0 8 * * *'
 
 jobs:
+  contract-tests-dynamodb:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - harness: v2
+            suppressions: contract-tests/server-contract-tests/persistence-suppressions.txt
+          - harness: v3
+            suppressions: contract-tests/server-contract-tests/persistence-suppressions-fdv2.txt
+    services:
+      dynamodb:
+        image: amazon/dynamodb-local
+        ports:
+          - 8000:8000
+    env:
+      TEST_SERVICE_PORT: 8123
+      TEST_SERVICE_BINARY: ./build/contract-tests/server-contract-tests/server-tests
+    steps:
+      # https://github.com/actions/checkout/releases/tag/v4.3.0
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0
+      - uses: ./.github/actions/ci
+        with:
+          cmake_target: server-tests
+          run_tests: false
+          # AWS C++ SDK requires libcurl at link time on Linux/macOS.
+          install_curl: true
+          use_dynamodb: true
+      - name: 'Launch test service as background task'
+        run: $TEST_SERVICE_BINARY $TEST_SERVICE_PORT 2>&1 &
+      # https://github.com/launchdarkly/gh-actions/releases/tag/contract-tests-v1.3.0
+      - uses: launchdarkly/gh-actions/actions/contract-tests@5adb11fd6953e1bc35d9cf1fc1b4374c464e3a8b
+        with:
+          test_service_port: ${{ env.TEST_SERVICE_PORT }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          enable_persistence_tests: true
+          version: ${{ matrix.harness }}
+          branch: ${{ matrix.harness }}
+          # The other suites are covered by libs/server-sdk's workflow.
+          extra_params: -run=persistent.data.store -skip-from=${{ matrix.suppressions }}
+
   build-test-dynamodb:
     runs-on: ubuntu-22.04
     services:

.github/workflows/server-redis.yml

@@ -14,6 +14,45 @@ on:
     - cron: '0 8 * * *'
 
 jobs:
+  contract-tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - harness: v2
+            suppressions: contract-tests/server-contract-tests/persistence-suppressions.txt
+          - harness: v3
+            suppressions: contract-tests/server-contract-tests/persistence-suppressions-fdv2.txt
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    env:
+      TEST_SERVICE_PORT: 8123
+      TEST_SERVICE_BINARY: ./build/contract-tests/server-contract-tests/server-tests
+    steps:
+      # https://github.com/actions/checkout/releases/tag/v4.3.0
+      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955
+      - uses: ./.github/actions/ci
+        with:
+          cmake_target: server-tests
+          run_tests: false
+          use_redis: true
+      - name: 'Launch test service as background task'
+        run: $TEST_SERVICE_BINARY $TEST_SERVICE_PORT 2>&1 &
+      # https://github.com/launchdarkly/gh-actions/releases/tag/contract-tests-v1.3.0
+      - uses: launchdarkly/gh-actions/actions/contract-tests@5adb11fd6953e1bc35d9cf1fc1b4374c464e3a8b
+        with:
+          test_service_port: ${{ env.TEST_SERVICE_PORT }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          enable_persistence_tests: true
+          version: ${{ matrix.harness }}
+          branch: ${{ matrix.harness }}
+          # The other suites are covered by libs/server-sdk's workflow.
+          extra_params: -run=persistent.data.store -skip-from=${{ matrix.suppressions }}
+
   build-test-redis:
     runs-on: ubuntu-22.04
     services:
@@ -28,6 +67,7 @@ jobs:
         with:
           cmake_target: launchdarkly-cpp-server-redis-source
           simulate_release: true
+          use_redis: true
   build-redis-mac:
     runs-on: macos-15
     steps:
@@ -39,6 +79,7 @@ jobs:
           platform_version: 12
           run_tests: false # TODO: figure out how to run Redis service on Mac
           simulate_release: true
+          use_redis: true
   build-test-redis-windows:
     runs-on: windows-2022
     steps:
@@ -57,3 +98,4 @@ jobs:
           toolset: msvc
           run_tests: false # TODO: figure out how to run Redis service on Windows
           simulate_windows_release: true
+          use_redis: true

contract-tests/data-model/include/data_model/data_model.hpp

@@ -3,7 +3,7 @@
 #include <optional>
 #include <string>
 #include <unordered_map>
 #include "nlohmann/json.hpp"
 
 namespace nlohmann {
 template <typename T>
@@ -65,7 +65,7 @@
                                                 pollIntervalMs,
                                                 filter);
 
 struct ConfigEventParams {
     std::optional<std::string> baseUri;
     std::optional<uint32_t> capacity;
     std::optional<bool> enableDiagnostics;
@@ -93,7 +93,7 @@
                                                 polling,
                                                 events);
 
 struct ConfigClientSideParams {
     nlohmann::json initialContext;
     std::optional<bool> evaluationReasons;
     std::optional<bool> useReport;
@@ -136,7 +136,7 @@
                                                 data,
                                                 errors);
 
 struct ConfigHooksParams {
     std::vector<ConfigHookInstance> hooks;
 };
 
@@ -149,6 +149,42 @@
 
 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigWrapper, name, version);
 
+struct ConfigPersistentCache {
+    std::string mode;        // "off", "ttl", "infinite"
+    std::optional<int> ttl;  // TTL in seconds (sent by test harness as "ttl")
+};
+
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigPersistentCache,
+                                                mode,
+                                                ttl);
+
+struct ConfigPersistentStore {
+    std::string type;  // "redis", "consul", "dynamodb"
+    std::string dsn;
+    std::optional<std::string> prefix;
+};
+
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigPersistentStore,
+                                                type,
+                                                dsn,
+                                                prefix);
+
+struct ConfigPersistentDataStore {
+    ConfigPersistentStore store;
+    ConfigPersistentCache cache;
+};
+
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigPersistentDataStore,
+                                                store,
+                                                cache);
+
+struct ConfigDataSystemStore {
+    std::optional<ConfigPersistentDataStore> persistentDataStore;
+};
+
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigDataSystemStore,
+                                                persistentDataStore);
+
 struct ConfigDataSynchronizerParams {
     std::optional<ConfigStreamingParams> streaming;
     std::optional<ConfigPollingParams> polling;
@@ -170,13 +206,15 @@
     std::optional<std::vector<ConfigDataSynchronizerParams>> synchronizers;
     std::optional<ConfigPollingParams> fdv1Fallback;
     std::optional<std::string> payloadFilter;
+    std::optional<ConfigDataSystemStore> store;
 };
 
 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ConfigDataSystemParams,
                                                 initializers,
                                                 synchronizers,
                                                 fdv1Fallback,
-                                                payloadFilter);
+                                                payloadFilter,
+                                                store);
 
 struct ConfigBigSegmentsParams {
     std::string callbackUri;
@@ -208,6 +246,7 @@
     std::optional<ConfigProxyParams> proxy;
     std::optional<ConfigHooksParams> hooks;
     std::optional<ConfigWrapper> wrapper;
+    std::optional<ConfigPersistentDataStore> persistentDataStore;
     std::optional<ConfigBigSegmentsParams> bigSegments;
 };
 
@@ -226,9 +265,10 @@
                                                 proxy,
                                                 hooks,
                                                 wrapper,
+                                                persistentDataStore,
                                                 bigSegments);
 
 struct ContextSingleParams {
     std::optional<std::string> kind;
     std::string key;
     std::optional<std::string> name;
@@ -323,7 +363,7 @@
                                                 defaultValue,
                                                 detail);
 
 struct EvaluateFlagResponse {
     nlohmann::json value;
     std::optional<uint32_t> variationIndex;
     std::optional<nlohmann::json> reason;
@@ -334,7 +374,7 @@
                                                 variationIndex,
                                                 reason);
 
 struct EvaluateAllFlagParams {
     std::optional<nlohmann::json> context;
     std::optional<bool> withReasons;
     std::optional<bool> clientSideOnly;
@@ -347,7 +387,7 @@
                                                 clientSideOnly,
                                                 detailsOnlyForTrackedFlags);
 
 struct EvaluateAllFlagsResponse {
     nlohmann::json state;
 };
 
@@ -369,7 +409,7 @@
                                                 omitNullData,
                                                 metricValue);
 
 struct IdentifyEventParams {
     nlohmann::json context;
 };
 

contract-tests/server-contract-tests/CMakeLists.txt

@@ -29,4 +29,14 @@ target_link_libraries(server-tests PRIVATE
         contract-test-data-model
         )
 
+if (LD_BUILD_REDIS_SUPPORT)
+    target_link_libraries(server-tests PRIVATE launchdarkly::server_redis_source)
+    target_compile_definitions(server-tests PRIVATE LD_REDIS_SUPPORT_ENABLED)
+endif ()
+
+if (LD_BUILD_DYNAMODB_SUPPORT)
+    target_link_libraries(server-tests PRIVATE launchdarkly::server_dynamodb_source)
+    target_compile_definitions(server-tests PRIVATE LD_DYNAMODB_SUPPORT_ENABLED)
+endif ()
+
 target_include_directories(server-tests PUBLIC include)

contract-tests/server-contract-tests/persistence-suppressions-fdv2.txt

@@ -0,0 +1,44 @@
+# The SDK's store integrations are read-only sources for the Lazy Load data
+# system, so it can't write data it receives, and a store can't be combined
+# with a data source (the data system method is one of Lazy Load, Background
+# Sync, or FDv2).
+
+persistent data store/redis/read-write/initializes store when data received
+persistent data store/redis/read-write/applies updates to store
+persistent data store/redis/read-write/evaluation reflects streaming updates
+persistent data store/redis/read-write/data source updates respect versioning
+persistent data store/redis/read-write/data source deletions respect versioning
+persistent data store/redis/read-write/ignores direct database modifications
+persistent data store/redis/read-write/ignores dropped flags
+persistent data store/redis/store mode read-write - with data source/no cache - ignores database until init key is set
+persistent data store/redis/store mode read-write - with data source/no cache - ignores database when ds sends data
+persistent data store/redis/store mode read-write - with data source/infinite cache - ignores database until init key is set
+persistent data store/redis/store mode read-write - with data source/infinite cache - ignores database when ds sends data
+persistent data store/redis/store mode read-write - with data source/ttl cache - ignores database until init key is set
+persistent data store/redis/store mode read-write - with data source/ttl cache - ignores database when ds sends data
+persistent data store/redis/store mode read - with data source/no cache - ignores database until init key is set
+persistent data store/redis/store mode read - with data source/no cache - ignores database when ds sends data
+persistent data store/redis/store mode read - with data source/infinite cache - ignores database until init key is set
+persistent data store/redis/store mode read - with data source/infinite cache - ignores database when ds sends data
+persistent data store/redis/store mode read - with data source/ttl cache - ignores database until init key is set
+persistent data store/redis/store mode read - with data source/ttl cache - ignores database when ds sends data
+
+persistent data store/dynamodb/read-write/initializes store when data received
+persistent data store/dynamodb/read-write/applies updates to store
+persistent data store/dynamodb/read-write/evaluation reflects streaming updates
+persistent data store/dynamodb/read-write/data source updates respect versioning
+persistent data store/dynamodb/read-write/data source deletions respect versioning
+persistent data store/dynamodb/read-write/ignores direct database modifications
+persistent data store/dynamodb/read-write/ignores dropped flags
+persistent data store/dynamodb/store mode read-write - with data source/no cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read-write - with data source/no cache - ignores database when ds sends data
+persistent data store/dynamodb/store mode read-write - with data source/infinite cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read-write - with data source/infinite cache - ignores database when ds sends data
+persistent data store/dynamodb/store mode read-write - with data source/ttl cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read-write - with data source/ttl cache - ignores database when ds sends data
+persistent data store/dynamodb/store mode read - with data source/no cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read - with data source/no cache - ignores database when ds sends data
+persistent data store/dynamodb/store mode read - with data source/infinite cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read - with data source/infinite cache - ignores database when ds sends data
+persistent data store/dynamodb/store mode read - with data source/ttl cache - ignores database until init key is set
+persistent data store/dynamodb/store mode read - with data source/ttl cache - ignores database when ds sends data

contract-tests/server-contract-tests/persistence-suppressions.txt

@@ -0,0 +1,26 @@
+# The SDK's store integrations are read-only sources for the Lazy Load data
+# system, so it can't write data it receives back to the store.
+persistent data store/redis/read-write/initializes store when data received
+persistent data store/redis/read-write/applies updates to store
+persistent data store/redis/read-write/data source updates respect versioning
+persistent data store/redis/read-write/data source deletions respect versioning
+persistent data store/redis/read-write/cache mode infinite/does not cache flag miss
+persistent data store/redis/read-write/cache mode infinite/sdk reflects data source updates even with cache
+persistent data store/redis/read-write/cache mode infinite/ignores direct database modifications
+persistent data store/redis/read-write/cache mode infinite/ignores dropped flags
+persistent data store/redis/read-write/cache mode ttl/does not cache flag miss
+persistent data store/redis/read-write/cache mode ttl/sdk reflects data source updates even with cache
+persistent data store/redis/read-write/cache mode ttl/ignores direct database modifications
+persistent data store/redis/read-write/cache mode ttl/ignores dropped flags
+persistent data store/dynamodb/read-write/initializes store when data received
+persistent data store/dynamodb/read-write/applies updates to store
+persistent data store/dynamodb/read-write/data source updates respect versioning
+persistent data store/dynamodb/read-write/data source deletions respect versioning
+persistent data store/dynamodb/read-write/cache mode infinite/does not cache flag miss
+persistent data store/dynamodb/read-write/cache mode infinite/sdk reflects data source updates even with cache
+persistent data store/dynamodb/read-write/cache mode infinite/ignores direct database modifications
+persistent data store/dynamodb/read-write/cache mode infinite/ignores dropped flags
+persistent data store/dynamodb/read-write/cache mode ttl/does not cache flag miss
+persistent data store/dynamodb/read-write/cache mode ttl/sdk reflects data source updates even with cache
+persistent data store/dynamodb/read-write/cache mode ttl/ignores direct database modifications
+persistent data store/dynamodb/read-write/cache mode ttl/ignores dropped flags