chore: prep SDK relay runners for running on github (#82)

fix: dotnet build
fix: testing-api, allow duplicate /api in URL
tweaks: baseUrl, allow relay to specify a `build-and-run` file, longer wait for relay apps to boot

Author: typotter

package-testing/dotnet-sdk-relay/build-and-run.sh

@@ -1,9 +1,7 @@
 #!/usr/bin/env bash
 
-: "${SDK_VERSION:=3.4.0}"
-
-DOTNET_VERSION="8.0.10"
-DOTNET_SDK_VERSION="8.0"
+# default version of the SDK to use.
+: "${SDK_VERSION:=3.5.1}"
 
 SDK="https://github.com/Eppo-exp/dot-net-server-sdk.git"
 
@@ -12,33 +10,9 @@ if [ -e .env ]; then
   source .env
 fi
 
-
-# Configure environment to **build** the app
-echo "Configuring for build"
-
-# Github runners use the package managers below
-# https://github.com/actions/runner-images
-case "${EPPO_SDK_PLATFORM}" in
-    "windows")
-        choco install dotnet-sdk -v ${DOTNET_SDK_VERSION}
-        ;;
-    "macos")
-        brew install dotnet-sdk@${DOTNET_SDK_VERSION}
-        ;;
-    "linux")
-        sudo apt update
-        sudo apt install dotnet-sdk-${DOTNET_SDK_VERSION}
-        ;;
-    *)
-        echo "Unsupported platform: ${EPPO_SDK_PLATFORM}"
-        exit 1
-        ;;
-esac
-
-
+# No need to configure the environment; GH Runners all have .NET installed.
 
 # Inject desired SDK version
- 
 dotnet remove EppoSDKRelay package Eppo.Sdk
 
 if [[ -n "$SDK_REF" ]]; then
@@ -57,53 +31,35 @@ if [[ -n "$SDK_REF" ]]; then
   pushd tmp
   echo "Building SDK"
   dotnet pack
-
-  echo "Moving build artifact"
-  mv dot-net-sdk/bin/Release/*.nupkg ./
   popd
 
-  echo "Adding local dep"
-  dotnet add EppoSDKRelay package Eppo.Sdk --source tmp/
+  echo "Adding local dependency"
+  pushd EppoSDKRelay
+  dotnet restore
+  dotnet add package Eppo.Sdk --source ../tmp/dot-net-sdk/bin/Release/
+  popd
 else
+  pushd EppoSDKRelay
   # Use the provided SDK_VERSION (or the default)
   echo "Using Eppo.sdk@${SDK_VERSION}"
-  dotnet add EppoSDKRelay package Eppo.Sdk --version $SDK_VERSION 
+  dotnet add package Eppo.Sdk --version $SDK_VERSION 
   if [ $? -ne 0 ]; then
     echo "Adding versioned package failed";
     exit 1
   fi
+  popd
 fi
 
 # Build project
 echo "Building project"
-dotnet build EppoSDKRelay
+
+cd EppoSDKRelay
+dotnet build
 
 echo "Publishing project"
 dotnet publish
 
-
-# Configure environment to **run** the app
-echo "Configuring for run"
-
-case "${EPPO_SDK_PLATFORM}" in
-    "windows")
-        choco install dotnet-runtime -v ${DOTNET_VERSION}
-        ;;
-    "macos")
-        brew install dotnet@${DOTNET_VERSION}
-        ;;
-    "linux")
-        sudo apt update
-        sudo apt install dotnet-${DOTNET_VERSION}
-        ;;
-    *)
-        echo "Unsupported platform: ${EPPO_SDK_PLATFORM}"
-        exit 1
-        ;;
-esac
-
-
 echo "Running Eppo SDK Relay"
 
 # Pipe in parameters.
-dotnet run --project EppoSDKRelay
+dotnet run

package-testing/php-sdk-relay/docker-run.sh

@@ -9,8 +9,13 @@ fi
 
 docker stop php-relay
 docker remove php-relay
+
+docker build . -t Eppo-exp/php-sdk-relay:$VERSION
+
 docker run  -p $SDK_RELAY_PORT:$SDK_RELAY_PORT \
+  --add-host host.docker.internal:host-gateway \
   -e SDK_REF \
+  -e EPPO_BASE_URL \
   -e SDK_RELAY_PORT \
   --name php-relay \
   -d --rm \

package-testing/sdk-test-runner/test-sdk.sh

@@ -39,7 +39,7 @@ function wait_for_url() {
   while [[ $attempt -le $max_attempts ]]; do
     curl --silent --output /dev/null --fail "$url" && { return 1; }
     echo "Waiting attempt number ${attempt}"
-    sleep 1
+    sleep 5
     ((attempt++))
   done
 
@@ -137,13 +137,19 @@ case "$command" in
 
         BUILD_AND_RUN_PLATFORM=build-and-run-${EPPO_SDK_PLATFORM}.sh
         if [ -f docker-run.sh ]; then
-           echo "    ... Starting SDK Relay via docker launch script"
+          echo "    ... Starting SDK Relay via docker launch script"
 
           # Docker containers need to point at host.docker.internal instead of localhost
-          EPPO_BASE_URL=host.docker.internal:${EPPO_API_PORT} EPPO_API_HOST=host.docker.internal ./docker-run.sh >> ${RUNNER_DIR}/logs/sdk.log 2>&1 &
+          EPPO_BASE_URL=http://host.docker.internal:${EPPO_API_PORT}/api EPPO_API_HOST=host.docker.internal ./docker-run.sh > ${RUNNER_DIR}/logs/sdk.log 2>&1 &
+
         elif [ -f ${BUILD_AND_RUN_PLATFORM} ]; then
-           echo "    ... Starting SDK Relay via platform build-and-run script"
-          ./${BUILD_AND_RUN_PLATFORM} >> ${RUNNER_DIR}/logs/sdk.log 2>&1 &
+          echo "    ... Starting SDK Relay via platform build-and-run script"
+          ./${BUILD_AND_RUN_PLATFORM} > ${RUNNER_DIR}/logs/sdk.log 2>&1 &
+
+        elif [ -f build-and-run.sh ]; then
+          echo "    ... Starting SDK Relay via build-and-run script"
+          ./build-and-run.sh > ${RUNNER_DIR}/logs/sdk.log 2>&1 &
+
         else
           exit_with_message "SDK Relay does not have a launch script in $SDK_DIR"
         fi

package-testing/testing-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eppo-testing-api",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "UFC server for SDK integration testing",
   "main": "src/server.ts",
   "repository": "github.com/Eppo-exp/sdk-test-data",

package-testing/testing-api/src/routes.ts

@@ -1,4 +1,4 @@
-import { Router } from 'express';
+import { RequestHandler, Router } from 'express';
 import { getDataForRequest, isObfuscatedSdk, updateClientDataMap } from './ufc/data';
 
 const routes = Router();
@@ -9,7 +9,7 @@ routes.get('/', (req, res) => {
 });
 
 // Serve Unified Flag Config
-routes.get('/api/flag-config/v1/config', (req, res) => {
+const serveUFC: RequestHandler = (req, res) => {
   const sdk: string = req.query.sdkName as string;
 
   const data = getDataForRequest(sdk);
@@ -37,10 +37,10 @@ routes.get('/api/flag-config/v1/config', (req, res) => {
   }
 
   return res.status(404).json({ message: 'No data for specified SDK' });
-});
+};
 
-// Serve bandit models
-routes.get('/api/flag-config/v1/bandits', (req, res) => {
+// Serve bandit params
+const serveBanditParams: RequestHandler =(req, res) => {
   const sdk: string = req.query.sdkName as string;
 
   const data = getDataForRequest(sdk);
@@ -51,7 +51,15 @@ routes.get('/api/flag-config/v1/bandits', (req, res) => {
   }
 
   return res.status(404).json({ message: 'No data for specified SDK' });
-});
+};
+
+// Serve with and without the /api prefix to accomodate SDKs in transition.
+routes.get('/api/flag-config/v1/config', serveUFC);
+routes.get('/api/flag-config/v1/bandits', serveBanditParams);
+
+// For SDKs which in transition; they're passed a baseUrl including `/api` and are using endpoint constants which start with `api/`
+routes.get('/api/api/flag-config/v1/config', serveUFC);
+routes.get('/api/api/flag-config/v1/bandits', serveBanditParams);
 
 // Allow a test runner to change the scenario for an SDK
 routes.post('/sdk/:sdk/scenario', (req, res) => {