ci: adding Oxygen contract tests to CI

Author: joker23

.github/workflows/shopify-oxygen.yml

@@ -26,3 +26,15 @@ jobs:
         with:
           workspace_name: '@launchdarkly/shopify-oxygen-sdk'
           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 the test service
+        run: yarn workspace @launchdarkly/shopify-oxygen-contract-tests build
+      - name: Launch the test service in the background
+        run: yarn workspace @launchdarkly/shopify-oxygen-contract-tests start &> /dev/null &
+      - uses: launchdarkly/gh-actions/actions/contract-tests@61ea6c63de800b495a2fe40c0d4e4ba2a2833ee6
+        with:
+          test_service_port: 8000
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Based on run-test-harness.sh from the sdk package
+          extra_params: '--url http://localhost:8000 --skip "streaming.*" --skip "evaluation.*" --skip "event.*" --skip "service.*" --stop-service-at-end'

packages/sdk/shopify-oxygen/contract-tests/src/index.ts

@@ -50,19 +50,16 @@ app.delete('/', (req: Request, res: Response) => {
 
 app.post('/', async (req: Request, res: Response) => {
   await clientPool.createClient(req.body, res);
-  res.send();
 });
 
 app.post('/clients/:id', async (req: Request, res: Response) => {
   await clientPool.runCommand(req.params.id, req.body, res);
-  res.send();
 });
 
 app.delete('/clients/:id', async (req: Request, res: Response) => {
   console.debug('DELETE request received /clients/:id');
   console.debug(req.params.id);
   await clientPool.deleteClient(req.params.id, res);
-  res.send();
 });
 
 server = app.listen(port, () => {

packages/sdk/shopify-oxygen/contract-tests/src/utils/clientPool.ts

@@ -10,6 +10,10 @@ import { init } from '@launchdarkly/shopify-oxygen-sdk';
 // general purpose in the future and maybe even come up with some shared ts interface
 // to facilitate future contract testing.
 
+// TODO: currently this class will handle the response sending as well, which may technically
+// sit outside the scope of what it SHOULD be doing. We should refactor this to be more
+// general purpose and allow the caller to handle the response sending.
+
 /**
  * ClientPool is a singleton that manages a pool of LDClient instances. Currently there is
  * no separation between a managed client and this pool. Which means all of the client specs
@@ -56,9 +60,11 @@ export default class ClientPool {
       } catch (err) {
         console.error(`Error running command: ${err}`);
         res.status(500);
+        res.send();
       }
     } else {
       res.status(404);
+      res.send();
     }
   }
 
@@ -68,8 +74,10 @@ export default class ClientPool {
       client.close();
       delete this._clients[id];
       res.status(204);
+      res.send();
     } else {
       res.status(404);
+      res.send();
     }
   }
 
@@ -83,6 +91,7 @@ export default class ClientPool {
       if (!polling) {
         // We do not support non-polling clients yet
         res.status(400);
+        res.send();
         return;
       }
       const client = await init(credential, {
@@ -98,12 +107,15 @@ export default class ClientPool {
       if (!client.initialized()) {
         res.status(500);
         client.close();
+        res.send();
+        return;
       }
-      this._clients[id] = client;
       console.debug(`Creating client with configuration: ${JSON.stringify(options.configuration)}`);
+      res.send();
     } catch (err) {
       console.error(`Error creating client: ${err}`);
       res.status(500);
+      res.send();
     }
   }
 }