feat: add server-side TestHook and migrate server-node/shopify-oxygen to shared utils [SDK-2009]

.github/workflows/browser.yml

@@ -50,6 +50,9 @@ jobs:
       - name: Install Playwright browsers
         run: yarn workspace browser-contract-test-service install-playwright-browsers
 
+      - name: Build shared contract test utils
+        run: yarn workspace @launchdarkly/js-contract-test-utils build:client
+
       - name: Build contract test adapter
         run: yarn workspace browser-contract-test-adapter run build
 

.github/workflows/electron.yaml

@@ -40,6 +40,7 @@ jobs:
           ELECTRON_DISABLE_SANDBOX: '1'
         run: |
           yarn workspaces focus @internal/electron-contract-tests-entity
+          yarn workspace @launchdarkly/js-contract-test-utils build:client
           yarn workspace @internal/electron-contract-tests-entity build
           sudo apt-get install -y xvfb
           Xvfb :99 -screen 0 1024x768x24 > /tmp/xvfb.log 2>&1 &

.github/workflows/react-native-contract-tests.yml

@@ -33,6 +33,9 @@ jobs:
       - name: Build SDK and dependencies
         run: yarn workspaces foreach -pR --topological-dev --from '@launchdarkly/react-native-client-sdk' run build
 
+      - name: Build shared contract test utils
+        run: yarn workspace @launchdarkly/js-contract-test-utils build:client
+
       - name: Build contract test adapter
         run: yarn workspace react-native-contract-test-adapter run build
 

.github/workflows/react.yaml

@@ -39,8 +39,7 @@ jobs:
           yarn workspaces foreach -pR --topological-dev --from "@launchdarkly/react-sdk-contract-tests" install
           yarn workspaces foreach -pR --topological-dev --from 'browser-contract-test-adapter' run build
           yarn workspaces foreach -pR --topological-dev --from "@launchdarkly/react-sdk-contract-tests" run build
-      - name: Install Playwright browsers
-        run: yarn workspace @launchdarkly/react-sdk-contract-tests install-playwright-browsers
+          yarn workspace @launchdarkly/react-sdk-contract-tests install-playwright-browsers
       - name: Run test adapter
         run: |
           yarn workspace @launchdarkly/react-sdk-contract-tests run start:adapter > /tmp/adapter.log 2>&1 &

.github/workflows/server-node.yml

@@ -33,6 +33,8 @@ jobs:
           workspace_path: packages/sdk/server-node
       - name: Install contract test service dependencies
         run: yarn workspace node-server-sdk-contract-tests install --no-immutable
+      - name: Build shared contract test utils (server)
+        run: yarn workspace @launchdarkly/js-contract-test-utils build:server
       - name: Build the test service
         run: yarn workspace node-server-sdk-contract-tests build
       - name: Launch the test service in the background

.github/workflows/shopify-oxygen.yml

@@ -28,6 +28,8 @@ jobs:
           workspace_path: packages/sdk/shopify-oxygen
       - name: Install contract test service dependencies
         run: yarn workspace @launchdarkly/shopify-oxygen-contract-tests install --no-immutable
+      - name: Build shared contract test utils
+        run: yarn workspace @launchdarkly/js-contract-test-utils build:server
       - name: Build the test service
         run: yarn workspace @launchdarkly/shopify-oxygen-contract-tests build
       - name: Launch the test service in the background

packages/sdk/server-node/contract-tests/package.json

@@ -12,6 +12,7 @@
   "license": "Apache-2.0",
   "private": true,
   "dependencies": {
+    "@launchdarkly/js-contract-test-utils": "workspace:^",
     "@launchdarkly/node-server-sdk": "workspace:^",
     "body-parser": "^1.19.0",
     "express": "^4.17.1",

packages/sdk/server-node/contract-tests/src/index.ts

@@ -2,6 +2,8 @@ import bodyParser from 'body-parser';
 import express, { Request, Response } from 'express';
 import { Server } from 'http';
 
+import { ClientPool } from '@launchdarkly/js-contract-test-utils/server';
+
 import { Log } from './log.js';
 import { badCommandError, newSdkClientEntity, SdkClientEntity } from './sdkClientEntity.js';
 
@@ -10,8 +12,7 @@ let server: Server | null = null;
 
 const port = 8000;
 
-let clientCounter = 0;
-const clients: Record<string, SdkClientEntity> = {};
+const clients = new ClientPool<SdkClientEntity>();
 
 const mainLog = Log('service');
 
@@ -66,16 +67,12 @@ app.delete('/', (req: Request, res: Response) => {
 app.post('/', async (req: Request, res: Response) => {
   const options = req.body;
 
-  clientCounter += 1;
-  const clientId = clientCounter.toString();
-  const resourceUrl = `/clients/${clientId}`;
-
   try {
     const client = await newSdkClientEntity(options);
-    clients[clientId] = client;
+    const clientId = clients.add(client);
 
     res.status(201);
-    res.set('Location', resourceUrl);
+    res.set('Location', `/clients/${clientId}`);
   } catch (e) {
     res.status(500);
     const message = e instanceof Error ? e.message : JSON.stringify(e);
@@ -86,7 +83,7 @@ app.post('/', async (req: Request, res: Response) => {
 });
 
 app.post('/clients/:id', async (req: Request, res: Response) => {
-  const client = clients[req.params.id];
+  const client = clients.get(req.params.id);
   if (!client) {
     res.status(404);
   } else {
@@ -113,13 +110,13 @@ app.post('/clients/:id', async (req: Request, res: Response) => {
 });
 
 app.delete('/clients/:id', async (req: Request, res: Response) => {
-  const client = clients[req.params.id];
+  const client = clients.get(req.params.id);
   if (!client) {
     res.status(404);
     res.send();
   } else {
     client.close();
-    delete clients[req.params.id];
+    clients.remove(req.params.id);
     res.status(204);
     res.send();
   }