feat!: use C++ Server-side SDK 3.0 bindings [v2]

.github/actions/ci/action.yml

@@ -8,35 +8,70 @@ inputs:
 runs:
   using: composite
   steps:
-    - uses: leafo/gh-actions-lua@35bcb06abec04ec87df82e08caa84d545348536e
+    - name: Install Lua
+      uses: leafo/gh-actions-lua@35bcb06abec04ec87df82e08caa84d545348536e
       with:
         luaVersion: ${{ inputs.lua-version }}
-    - uses: leafo/gh-actions-luarocks@e65774a6386cb4f24e293dca7fc4ff89165b64c5
-    - name: Install C Server-side SDK Dependencies
-      shell: bash
-      run: |
-        sudo apt-get update -y
-        sudo apt-get install -y libcurl4-openssl-dev
-        sudo apt-get install -y libhiredis-dev
-
-    - name: Setup C Server-side SDK
-      shell: bash
-      run: ./scripts/build-c-server.sh
+    - name: Install LuaRocks
+      uses: leafo/gh-actions-luarocks@e65774a6386cb4f24e293dca7fc4ff89165b64c5
+    - name: Install Boost
+      id: install-boost
+      uses: MarkusJx/install-boost@v2.4.4
+      with:
+        boost_version: 1.81.0
+        platform_version: "22.04"
+    - name: Install CPP SDK
+      uses: ./.github/actions/install-cpp-sdk-redis
+      with:
+          version: launchdarkly-cpp-server-redis-source-v2.1.0
+          path: cpp-sdk
 
     - name: Build Lua Server-side SDK
       shell: bash
-      run:  luarocks make launchdarkly-server-sdk-1.0-0.rockspec
+      run:  |
+        luarocks make launchdarkly-server-sdk-1.0-0.rockspec \
+        LD_DIR=./cpp-sdk/build-dynamic/release
 
     - name: Build Lua Server-side SDK with Redis
       shell: bash
-      run: luarocks make launchdarkly-server-sdk-redis-1.0-0.rockspec
+      run: |
+        luarocks make launchdarkly-server-sdk-redis-1.0-0.rockspec \
+        LDREDIS_DIR=./cpp-sdk/build-dynamic/release
 
-    - name: Run tests
+    - name: Run Lua Server-side SDK Tests
       shell: bash
       if: ${{ ! contains(inputs.lua-version, 'jit') }}
-      run: lua test.lua
+      run: luarocks test launchdarkly-server-sdk-1.0-0.rockspec
+      env:
+        # Needed because boost isn't installed in default system paths, which is
+        # what the C++ Server-side SDK shared object expects.
+        LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib
 
-    - name: Run tests (JIT)
+    - name: Run Lua Server-side SDK Tests (JIT)
       shell: bash
       if: ${{ contains(inputs.lua-version, 'jit') }}
       run: luajit test.lua
+      env:
+        # Needed because boost isn't installed in default system paths, which is
+        # what the C++ Server-side SDK shared object expects.
+        LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib
+
+    - name: Run Lua Server-side SDK with Redis Tests
+      shell: bash
+      if: ${{ ! contains(inputs.lua-version, 'jit') }}
+      run: luarocks test launchdarkly-server-sdk-redis-1.0-0.rockspec
+      env:
+        # Needed because boost isn't installed in default system paths, which is
+        # what the C++ Server-side SDK shared object expects. Same for hiredis which is bundled
+        # with the SDK release.
+        LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib;./cpp-sdk/build-dynamic/release/lib
+
+    - name: Run Lua Server-side SDK with Redis Tests (JIT)
+      shell: bash
+      if: ${{ contains(inputs.lua-version, 'jit') }}
+      run: luajit test-redis.lua
+      env:
+        # Needed because boost isn't installed in default system paths, which is
+        # what the C++ Server-side SDK shared object expects. Same for hiredis which is bundled
+        # with the SDK release.
+        LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib;./cpp-sdk/build-dynamic/release/lib

.github/actions/install-cpp-sdk-redis/action.yml

@@ -0,0 +1,27 @@
+# This custom action is used because the MarkusJx/install-boost does
+# not include all built libraries for mac or windows builds.
+# Specifically, it was missing boost_json.
+name: Install C++ Server-side SDK with Redis Source
+description: 'Obtain prebuilt libraries for the Launchdarkly C++ server-side SDK with Redis Source.'
+inputs:
+    version:
+        required: true
+        description: "Version of the C++ SDK with Redis Source."
+        default: "v1.0.1"
+    path:
+      description: "Where to download the SDK."
+      default: "cpp-sdk"
+
+runs:
+  using: composite
+  steps:
+    - name: Download C++ Server-side SDK with Redis Source
+      uses: robinraju/release-downloader@efa4cd07bd0195e6cc65e9e30c251b49ce4d3e51
+      id: download-cpp-sdk
+      with:
+          repository: "launchdarkly/cpp-sdks"
+          latest: false
+          tag: ${{ inputs.version }}
+          fileName: linux-gcc-x64-dynamic.zip
+          out-file-path: ${{ inputs.path }}
+          extract: true

.gitignore

@@ -1 +1,4 @@
 .idea
+cpp-sdks
+*.o
+*.so

README.md

@@ -14,18 +14,57 @@ LaunchDarkly overview
 Supported Lua versions
 -----------
 
-This version of the LaunchDarkly SDK is compatible with the Lua 5.1-5.3 interpreter, and LuaJIT.
+This version of the LaunchDarkly SDK is known to be compatible with the Lua 5.1-5.3 interpreter, and LuaJIT 2.0.5.
 
-Supported C server-side SDK versions
+Supported C++ server-side SDK versions
 -----------
 
-This version of the Lua server-side SDK depends on the C server-side SDK. The minimum required version is `2.1.0`, and under `3.0.0`.
+This version of the Lua server-side SDK depends on the LaunchDarkly C++ Server-side SDK.
+
+If Redis support is desired, then it optionally depends on the C++ server-side SDK's Redis Source. 
+
+| Dependency                     | Minimum Version                                                                                            | Notes                                      |
+|--------------------------------|------------------------------------------------------------------------------------------------------------|--------------------------------------------|
+| C++ Server-Side SDK            | [3.3.0](https://github.com/launchdarkly/cpp-sdks/releases/tag/launchdarkly-cpp-server-v3.3.0)              | Required dependency.                       |
+| C++ Server-Side SDK with Redis | [2.1.0](https://github.com/launchdarkly/cpp-sdks/releases/tag/launchdarkly-cpp-server-redis-source-v2.1.0) | Optional, if using Redis as a data source. |
+
+
+3rd Party Dependencies
+------------
+Depending on how the C++ server-side SDK was built, the Lua SDK may require additional runtime dependencies to work properly.
+
+
+| Dependency | If C++ SDK compiled with..   | Notes                                                                  |
+|------------|------------------------------|------------------------------------------------------------------------|
+| OpenSSL    | `LD_DYNAMIC_LINK_OPENSSL=ON` | If linking OpenSSL dynamically, it must be present on target system.   |
+| Boost      | `LD_DYNAMIC_LINK_BOOST=ON`   | If linking Boost dynamically, it must be present on the target system. |
+
+_Note: The CI process builds against the C++ Server-side SDK's Linux shared libraries, which were compiled with `LD_DYNAMIC_LINK_BOOST=ON` so
+Boost is fetched as part of the build process._
+
 
 Getting started
 -----------
 
 Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/server-side/lua#getting-started) for instructions on getting started with using the SDK.
 
+To compile the LuaRock modules:
+1. Install [LuaRocks](https://github.com/luarocks/luarocks/wiki/Download)
+2. Build the [C++ Server-side SDK](https://github.com/launchdarkly/cpp-sdks) from source using CMake, or obtain pre-built artifacts from the [releases page](https://github.com/launchdarkly/cpp-sdks/releases?q=%22launchdarkly-cpp-server%22)
+3. Run `luarocks make`:
+    ```bash
+    # Base SDK
+    luarocks make launchdarkly-server-sdk-1.0-0.rockspec \
+    LD_DIR=./path-to-installed-cpp-sdk
+
+    # SDK with Redis
+    luarocks make launchdarkly-server-sdk-redis-1.0-0.rockspec \
+    LDREDIS_DIR=./path-to-installed-cpp-sdk
+    ```
+
+Please note that the Lua SDK uses the C++ server-side SDK's C bindings, so if you're using prebuilt artifacts
+then only a C99 compiler is necessary.
+
 Learn more
 -----------
 

launchdarkly-server-sdk-1.0-0.rockspec

@@ -1,5 +1,7 @@
 package = "launchdarkly-server-sdk"
 
+rockspec_format = "3.0"
+
 version = "1.0-0"
 
 source = {
@@ -13,18 +15,27 @@ dependencies = {
 
 external_dependencies = {
     LD = {
-        header = "launchdarkly/api.h"
-    }
+        header = "launchdarkly/server_side/bindings/c/sdk.h",
+        library = "launchdarkly-cpp-server"
+    },
+}
+
+test = {
+    type = "command",
+    script = "test.lua"
 }
 
 build = {
    type = "builtin",
    modules = {
       ["launchdarkly_server_sdk"] = {
           sources = { "launchdarkly-server-sdk.c" },
+          -- Uncomment to compile with debug messages, mainly to help debug parsing configuration/context
+          -- builders.
+          -- defines = {"DEBUG=1"},
           incdirs = {"$(LD_INCDIR)"},
           libdirs = {"$(LD_LIBDIR)"},
-          libraries = {"ldserverapi"}
+          libraries = {"launchdarkly-cpp-server"},
       }
    }
 }

launchdarkly-server-sdk-redis-1.0-0.rockspec

@@ -1,5 +1,7 @@
 package = "launchdarkly-server-sdk-redis"
 
+rockspec_format = "3.0"
+
 version = "1.0-0"
 
 source = {
@@ -12,18 +14,24 @@ dependencies = {
 
 external_dependencies = {
     LDREDIS = {
-        header = "launchdarkly/store/redis.h"
+        header = "launchdarkly/server_side/bindings/c/integrations/redis/redis_source.h",
+        library = "launchdarkly-cpp-server-redis-source"
     }
 }
 
+test = {
+    type = "command",
+    script = "test-redis.lua"
+}
+
 build = {
    type = "builtin",
    modules = {
       ["launchdarkly_server_sdk_redis"] = {
           sources = { "launchdarkly-server-sdk-redis.c" },
           incdirs = {"$(LDREDIS_INCDIR)"},
           libdirs = {"$(LDREDIS_LIBDIR)"},
-          libraries = {"ldserverapi-redis"}
+          libraries = {"launchdarkly-cpp-server-redis-source"}
       }
    }
 }

launchdarkly-server-sdk-redis.c

@@ -9,73 +9,51 @@ Server-side SDK for LaunchDarkly Redis store.
 #include <stdbool.h>
 #include <string.h>
 
-#include <launchdarkly/api.h>
-#include <launchdarkly/store/redis.h>
+#include <launchdarkly/server_side/bindings/c/integrations/redis/redis_source.h>
+
+
 
 /***
-Initialize a store backend
-@function makeStore
-@tparam table fields list of configuration options
-@tparam[opt] string fields.host Hostname for Redis.
-@tparam[opt] int fields.port Port for Redis.
-@tparam[opt] string fields.prefix Redis key prefix for SDK values.
-@tparam[opt] int fields.poolSize Number of Redis connections to maintain.
-@return A fresh Redis store backend.
+Create a Redis data source, which can be used instead
+of a LaunchDarkly Streaming or Polling data source. This should be configured
+in the SDK's configuration table, under the dataSystem.lazyLoad.source property.
+@function makeRedisSource
+@tparam string uri Redis URI. Example: 'redis://localhost:6379'.
+@tparam string prefix Prefix to use when reading SDK data from Redis. This is prefixed to all
+Redis keys used by this SDK. Example: 'my-environment'.
+@return A new Redis data source.
 */
 static int
-LuaLDRedisMakeStore(lua_State *const l)
+LuaLDRedisMakeSource(lua_State *const l)
 {
-    struct LDRedisConfig *config;
-    struct LDStoreInterface *storeInterface;
-
-    if (lua_gettop(l) != 1) {
-        return luaL_error(l, "expecting exactly 1 argument");
-    }
-
-    luaL_checktype(l, 1, LUA_TTABLE);
-
-    config = LDRedisConfigNew();
-
-    lua_getfield(l, 1, "host");
-
-    if (lua_isstring(l, -1)) {
-        LDRedisConfigSetHost(config, luaL_checkstring(l, -1));
+    if (lua_gettop(l) != 2) {
+        return luaL_error(l, "expecting exactly 2 arguments");
     }
 
-    lua_getfield(l, 1, "prefix");
-
-    if (lua_isstring(l, -1)) {
-        LDRedisConfigSetPrefix(config, luaL_checkstring(l, -1));
-    }
 
-    lua_getfield(l, 1, "port");
+	const char* uri = luaL_checkstring(l, 1);
+	const char* prefix = luaL_checkstring(l, 2);
 
-    if (lua_isnumber(l, -1)) {
-        LDRedisConfigSetPort(config, luaL_checkinteger(l, -1));
+    struct LDServerLazyLoadRedisResult out_result;
+   	bool success = LDServerLazyLoadRedisSource_New(uri, prefix, &out_result);
+    if (!success) {
+        return luaL_error(l, "failed to create Redis source: %s", out_result.error_message);
     }
 
-    lua_getfield(l, 1, "poolSize");
-
-    if (lua_isnumber(l, -1)) {
-        LDRedisConfigSetPoolSize(config, luaL_checkinteger(l, -1));
-    }
-
-    storeInterface = LDStoreInterfaceRedisNew(config);
-
-    struct LDStoreInterface **i =
-        (struct LDStoreInterface **)lua_newuserdata(l, sizeof(storeInterface));
+    LDServerLazyLoadRedisSource *i =
+        (LDServerLazyLoadRedisSource *) lua_newuserdata(l, sizeof(out_result.source));
 
-    *i = storeInterface;
+    *i = out_result.source;
 
-    luaL_getmetatable(l, "LaunchDarklyStoreInterface");
+    luaL_getmetatable(l, "LaunchDarklySourceInterface");
     lua_setmetatable(l, -2);
 
     return 1;
 }
 
 static const struct luaL_Reg launchdarkly_functions[] = {
-    { "makeStore", LuaLDRedisMakeStore },
-    { NULL,        NULL                }
+    { "makeRedisSource", LuaLDRedisMakeSource },
+    { NULL, NULL}
 };
 
 #if !defined LUA_VERSION_NUM || LUA_VERSION_NUM==501
@@ -99,7 +77,7 @@ static void luaL_setfuncs (lua_State *L, const luaL_Reg *l, int nup) {
 int
 luaopen_launchdarkly_server_sdk_redis(lua_State *const l)
 {
-    #if LUA_VERSION_NUM == 503 || LUA_VERSION_NUM == 502
+    #if LUA_VERSION_NUM >= 502
         luaL_newlib(l, launchdarkly_functions);
     #else
         luaL_register(l, "launchdarkly-server-sdk-redis",