chore: Migrate contract tests to typescript. (#820)

Convert the contract tests to TypeScript. This is just a straight
conversion without any structural improvements.

Add the contract tests to the workspace. This allows everything to be
linked locally by default.

Author: kinyoklion

Diff for: .github/workflows/server-node.yml

@@ -31,8 +31,12 @@ jobs:
         with:
           workspace_name: '@launchdarkly/node-server-sdk'
           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 the test service
+        run: yarn contract-test-service-build
       - name: Launch the test service in the background
-        run: yarn run contract-test-service 2>&1 &
+        run: yarn contract-test-service 2>&1 &
       - uses: launchdarkly/gh-actions/actions/[email protected]
         with:
           test_service_port: 8000

Diff for: contract-tests/BigSegmentTestStore.js

@@ -1,17 +1,26 @@
 {
   "name": "node-server-sdk-contract-tests",
   "version": "0.0.0",
-  "main": "index.js",
+  "main": "dist/src/index.js",
   "scripts": {
-    "start": "node --inspect index.js"
+    "start": "node --inspect dist/src/index.js",
+    "build": "tsc",
+    "dev": "tsc --watch"
   },
   "type": "module",
   "author": "",
   "license": "Apache-2.0",
+  "private": true,
   "dependencies": {
+    "@launchdarkly/node-server-sdk": "9.8.0",
     "body-parser": "^1.19.0",
     "express": "^4.17.1",
-    "node-server-sdk": "file:../packages/sdk/server-node",
-    "got": "13.0.0"
+    "got": "14.4.7"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.19.2",
+    "@types/express": "^4.17.13",
+    "@types/node": "^18.11.9",
+    "typescript": "^4.9.0"
   }
 }

Diff for: contract-tests/TestHook.js

@@ -0,0 +1,40 @@
+import got from 'got';
+
+interface BigSegmentMetadata {
+  lastUpToDate?: number;
+}
+
+interface BigSegmentMembership {
+  values?: Record<string, boolean>;
+}
+
+export default class BigSegmentTestStore {
+  private _callbackUri: string;
+
+  /**
+   * Create a big segment test store suitable for use with the contract tests.
+   * @param callbackUri Uri on the test service to direct big segments calls to.
+   */
+  constructor(callbackUri: string) {
+    this._callbackUri = callbackUri;
+  }
+
+  async getMetadata(): Promise<BigSegmentMetadata> {
+    const data = await got.get(`${this._callbackUri}/getMetadata`, { retry: { limit: 0 } }).json();
+    return data as BigSegmentMetadata;
+  }
+
+  async getUserMembership(contextHash: string): Promise<Record<string, boolean> | undefined> {
+    const data = await got
+      .post(`${this._callbackUri}/getMembership`, {
+        retry: { limit: 0 },
+        json: {
+          contextHash,
+        },
+      })
+      .json();
+    return (data as BigSegmentMembership)?.values;
+  }
+
+  close(): void {}
+}

Diff for: contract-tests/log.js

@@ -0,0 +1,75 @@
+import got from 'got';
+
+import { integrations, LDEvaluationDetail } from '@launchdarkly/node-server-sdk';
+
+export interface HookData {
+  beforeEvaluation?: Record<string, unknown>;
+  afterEvaluation?: Record<string, unknown>;
+}
+
+export interface HookErrors {
+  beforeEvaluation?: string;
+  afterEvaluation?: string;
+}
+
+export default class TestHook implements integrations.Hook {
+  private _name: string;
+  private _endpoint: string;
+  private _data?: HookData;
+  private _errors?: HookErrors;
+
+  constructor(name: string, endpoint: string, data?: HookData, errors?: HookErrors) {
+    this._name = name;
+    this._endpoint = endpoint;
+    this._data = data;
+    this._errors = errors;
+  }
+
+  private async _safePost(body: unknown): Promise<void> {
+    try {
+      await got.post(this._endpoint, { json: body });
+    } catch {
+      // The test could move on before the post, so we are ignoring
+      // failed posts.
+    }
+  }
+
+  getMetadata(): integrations.HookMetadata {
+    return {
+      name: this._name,
+    };
+  }
+
+  beforeEvaluation(
+    hookContext: integrations.EvaluationSeriesContext,
+    data: integrations.EvaluationSeriesData,
+  ): integrations.EvaluationSeriesData {
+    if (this._errors?.beforeEvaluation) {
+      throw new Error(this._errors.beforeEvaluation);
+    }
+    this._safePost({
+      evaluationSeriesContext: hookContext,
+      evaluationSeriesData: data,
+      stage: 'beforeEvaluation',
+    });
+    return { ...data, ...(this._data?.beforeEvaluation || {}) };
+  }
+
+  afterEvaluation(
+    hookContext: integrations.EvaluationSeriesContext,
+    data: integrations.EvaluationSeriesData,
+    detail: LDEvaluationDetail,
+  ): integrations.EvaluationSeriesData {
+    if (this._errors?.afterEvaluation) {
+      throw new Error(this._errors.afterEvaluation);
+    }
+    this._safePost({
+      evaluationSeriesContext: hookContext,
+      evaluationSeriesData: data,
+      stage: 'afterEvaluation',
+      evaluationDetail: detail,
+    });
+
+    return { ...data, ...(this._data?.afterEvaluation || {}) };
+  }
+}

Diff for: contract-tests/package.json

@@ -1,22 +1,23 @@
 import bodyParser from 'body-parser';
-import express from 'express';
+import express, { Request, Response } from 'express';
+import { Server } from 'http';
 
 import { Log } from './log.js';
-import { badCommandError, newSdkClientEntity } from './sdkClientEntity.js';
+import { badCommandError, newSdkClientEntity, SdkClientEntity } from './sdkClientEntity.js';
 
 const app = express();
-let server = null;
+let server: Server | null = null;
 
 const port = 8000;
 
 let clientCounter = 0;
-const clients = {};
+const clients: Record<string, SdkClientEntity> = {};
 
 const mainLog = Log('service');
 
 app.use(bodyParser.json());
 
-app.get('/', (req, res) => {
+app.get('/', (req: Request, res: Response) => {
   res.header('Content-Type', 'application/json');
   res.json({
     capabilities: [
@@ -45,21 +46,23 @@ app.get('/', (req, res) => {
   });
 });
 
-app.delete('/', (req, res) => {
+app.delete('/', (req: Request, res: Response) => {
   mainLog.info('Test service has told us to exit');
   res.status(204);
   res.send();
 
   // Defer the following actions till after the response has been sent
   setTimeout(() => {
-    server.close(() => process.exit());
+    if (server) {
+      server.close(() => process.exit());
+    }
     // We force-quit with process.exit because, even after closing the server, there could be some
     // scheduled tasks lingering if an SDK instance didn't get cleaned up properly, and we don't want
     // that to prevent us from quitting.
   }, 1);
 });
 
-app.post('/', async (req, res) => {
+app.post('/', async (req: Request, res: Response) => {
   const options = req.body;
 
   clientCounter += 1;
@@ -74,14 +77,14 @@ app.post('/', async (req, res) => {
     res.set('Location', resourceUrl);
   } catch (e) {
     res.status(500);
-    const message = e.message || JSON.stringify(e);
-    mainLog.error('Error creating client: ' + message);
+    const message = e instanceof Error ? e.message : JSON.stringify(e);
+    mainLog.error(`Error creating client: ${message}`);
     res.write(message);
   }
   res.send();
 });
 
-app.post('/clients/:id', async (req, res) => {
+app.post('/clients/:id', async (req: Request, res: Response) => {
   const client = clients[req.params.id];
   if (!client) {
     res.status(404);
@@ -97,16 +100,18 @@ app.post('/clients/:id', async (req, res) => {
     } catch (e) {
       const isBadRequest = e === badCommandError;
       res.status(isBadRequest ? 400 : 500);
-      res.write(e.message || JSON.stringify(e));
-      if (!isBadRequest && e.stack) {
+      const message = e instanceof Error ? e.message : JSON.stringify(e);
+      res.write(message);
+      if (!isBadRequest && e instanceof Error && e.stack) {
+        // eslint-disable-next-line no-console
         console.log(e.stack);
       }
     }
   }
   res.send();
 });
 
-app.delete('/clients/:id', async (req, res) => {
+app.delete('/clients/:id', async (req: Request, res: Response) => {
   const client = clients[req.params.id];
   if (!client) {
     res.status(404);
@@ -120,5 +125,6 @@ app.delete('/clients/:id', async (req, res) => {
 });
 
 server = app.listen(port, () => {
+  // eslint-disable-next-line no-console
   console.log('Listening on port %d', port);
 });

Diff for: contract-tests/src/BigSegmentTestStore.ts

@@ -0,0 +1,27 @@
+import ld from '@launchdarkly/node-server-sdk';
+
+export interface Logger {
+  info: (message: string) => void;
+  error: (message: string) => void;
+}
+
+export function Log(tag: string): Logger {
+  function doLog(level: string, message: string): void {
+    // eslint-disable-next-line no-console
+    console.log(`${new Date().toISOString()} [${tag}] ${level}: ${message}`);
+  }
+  return {
+    info: (message: string) => doLog('info', message),
+    error: (message: string) => doLog('error', message),
+  };
+}
+
+export function sdkLogger(tag: string): ld.LDLogger {
+  return ld.basicLogger({
+    level: 'debug',
+    destination: (line: string) => {
+      // eslint-disable-next-line no-console
+      console.log(`${new Date().toISOString()} [${tag}.sdk] ${line}`);
+    },
+  });
+}