Add a separate test-run to cover client backward compatibility

Author: pimterry

.github/workflows/ci.yml

@@ -23,9 +23,12 @@ jobs:
           node-version: ${{ matrix.node-version }}
           check-latest: true
           cache: 'npm'
-          cache-dependency-path: 'package.json'
+          cache-dependency-path: |
+            package.json
+            test/backward-compat-fixtures/package.json
 
       - run: npm install
+      - run: npm install --prefix test/backward-compat-fixtures
 
       - run: npm run ci-tests
         env:

karma.conf.js

@@ -12,7 +12,7 @@ module.exports = function(config) {
     config.set({
         frameworks: ['mocha', 'chai', 'webpack'],
         files: [
-            'test/**/*.spec.ts',
+            'test/{unit,integration}/**/*.spec.ts',
             // Required for wasm due to https://github.com/ryanclark/karma-webpack/issues/498. Results
             // in an annoying warning before the webpack build, but then it works fine.
             { pattern: `${outputDir}/**/*`, included: false, served: true }
@@ -76,6 +76,11 @@ module.exports = function(config) {
                 new webpack.ProvidePlugin({
                     process: 'process/browser',
                     Buffer: ['buffer', 'Buffer'],
+                }),
+                new webpack.DefinePlugin({
+                    'process.env.MOCKTTP_BACKWARD_COMPAT_TEST': JSON.stringify(
+                        process.env.MOCKTTP_BACKWARD_COMPAT_TEST || ''
+                    )
                 })
             ],
             output: {

package.json

@@ -64,9 +64,10 @@
     "build:src": "tsc && chmod +x ./dist/admin/admin-bin.js",
     "build:doc": "typedoc src/main.ts",
     "postbuild:doc": "touch ./typedoc/.nojekyll",
-    "test": "npm run build && npm run test:node && npm run test:browser && npm run test:perf",
-    "test:node": "NODE_EXTRA_CA_CERTS=./test/fixtures/test-ca.pem TS_NODE_FILES=true mocha -r ts-node/register 'test/**/*.spec.ts'",
+    "test": "npm run build && npm run test:node && npm run test:browser && npm run test:browser:backward-compat && npm run test:perf",
+    "test:node": "NODE_EXTRA_CA_CERTS=./test/fixtures/test-ca.pem TS_NODE_FILES=true mocha -r ts-node/register 'test/{unit,integration}/**/*.spec.ts'",
     "test:browser": "npm run with-admin -- karma start",
+    "test:browser:backward-compat": "MOCKTTP_BACKWARD_COMPAT_TEST=true node test/backward-compat-fixtures/node_modules/mockttp/dist/admin/admin-bin.js -c 'npx karma start --single-run'",
     "test:browser:debug": "npm run with-admin -- karma start --single-run=false --browsers ChromeWithCert",
     "test:perf": "NODE_EXTRA_CA_CERTS=./test/fixtures/test-ca.pem TS_NODE_FILES=true mocha -r ts-node/register 'test/performance/*.perf.ts'",
     "admin": "TS_NODE_FILES=true ts-node -e 'require(\"./src/main\").getAdminServer({ debug: true }).start()'",

test/backward-compat-fixtures/.gitignore

@@ -0,0 +1 @@
+node_modules/