[COL-56] Add integration tests

.github/workflows/dev-ci.yml

@@ -38,6 +38,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: true
       - uses: actions/setup-node@v1
         with:
           node-version: 18

CONTRIBUTING.md

@@ -29,6 +29,16 @@
 
 ## Test suite
 
+### Setup
+
+Before running the tests, you first need to initialize the repository’s submodules:
+
+```
+git submodule update --init
+```
+
+### Running the tests
+
 To run the Jest tests, simply run the following command:
 
 ```bash
@@ -39,7 +49,6 @@ npm test
 
 To test the bundle that we upload to the CDN:
 
-1. Initialize submodules: `git submodule update --init`
-2. Install browser for Playwright to use: `npx run playwright install chromium`
-3. Build the bundle: `npm run build`
-4. Run the test: `npm run test:cdn-bundle`
+1. Install browser for Playwright to use: `npx run playwright install chromium`
+2. Build the bundle: `npm run build`
+3. Run the test: `npm run test:cdn-bundle`

test/cdn-bundle/test/cdnBundle.test.ts

@@ -1,5 +1,5 @@
 import { test, expect } from '@playwright/test';
-import { createSandboxAblyAPIKey } from '../lib/ablySandbox.js';
+import { createSandboxAblyAPIKey } from '../../lib/ablySandbox.js';
 
 test.describe('CDN bundle', () => {
   /**

test/integration/utilities/setup.ts

@@ -0,0 +1,36 @@
+import { Realtime } from 'ably';
+import { nanoid } from 'nanoid';
+import { createSandboxAblyAPIKey } from '../../lib/ablySandbox.js';
+import Spaces from '../../../src/Spaces.js';
+
+/**
+ * Fetches a key for the Ably sandbox environment. This key is shared between all callers of this function.
+ */
+const fetchSharedSandboxKey = (() => {
+  const sandboxKeyPromise = createSandboxAblyAPIKey();
+
+  return async () => {
+    return await sandboxKeyPromise;
+  };
+})();
+
+/**
+ * Performs the following part of a test setup:
+ *
+ * > Given $count Spaces clients, all configured to use the same API key, and each configured to use a different randomly-generated client ID...
+ */
+export async function createClients({ count }: { count: number }) {
+  const sandboxKey = await fetchSharedSandboxKey();
+
+  return Array.from({ length: count }, () => {
+    const clientId = nanoid();
+    const realtime = new Realtime.Promise({
+      environment: 'sandbox',
+      key: sandboxKey,
+      clientId: clientId,
+    });
+    const spaces = new Spaces(realtime);
+
+    return { spaces: spaces, clientId: clientId };
+  });
+}

test/cdn-bundle/lib/ablySandbox.ts → test/lib/ablySandbox.ts

@@ -1,5 +1,5 @@
 import https from 'node:https';
-import testAppSetup from '../../ably-common/test-resources/test-app-setup.json';
+import testAppSetup from '../ably-common/test-resources/test-app-setup.json';
 
 export interface TestApp {
   keys: TestAppKey[];

test/lib/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "resolveJsonModule": true
+  }
+}