Update to Mockttp v2.7.0 and avoid deprecated APIs to prepare for v3

We don't want to update to v3 immediately, since some edge cases mean
it's useful to roll out a widespread UI update first (and because
there's no urgent need for it) but this lays the groundwork so that it's
easy to do that update with no breakage later on.

Author: pimterry

pack.ts

@@ -51,7 +51,6 @@ const packageApp = async () => {
         // Add the fully bundled source (not normally packaged by npm):
         path.join('bundle', 'index.js'),
         path.join('bundle', 'error-tracking.js'),
-        path.join('bundle', 'schema.gql'),
         // Static resources normally stored in browser-launcher
         path.join('bundle', 'bl-resources')
     ].map((extraFile) =>

package-lock.json

@@ -65,7 +65,7 @@
     "lookpath": "^1.2.1",
     "mime-types": "^2.1.27",
     "mobx": "^6.3.5",
-    "mockttp": "^2.6.0",
+    "mockttp": "^2.7.0",
     "node-abort-controller": "^3.0.1",
     "node-fetch": "^2.6.1",
     "node-forge": "^1.3.0",

package.json

@@ -8,7 +8,7 @@ import { makeExecutableSchema } from '@graphql-tools/schema';
 import { GraphQLScalarType } from 'graphql';
 import { graphqlHTTP } from 'express-graphql';
 
-import { generateSPKIFingerprint, MockttpStandalone } from 'mockttp';
+import { generateSPKIFingerprint, MockttpAdminServer } from 'mockttp';
 import { getSystemProxy } from 'os-proxy-config';
 
 import { HtkConfig } from './config';
@@ -113,7 +113,7 @@ const INTERCEPTOR_TIMEOUT = 1000;
 const buildResolvers = (
     config: HtkConfig,
     interceptors: _.Dictionary<Interceptor>,
-    mockttpStandalone: MockttpStandalone,
+    mockttpAdminServer: MockttpAdminServer,
     eventEmitter: events.EventEmitter
 ) => {
     return {
@@ -139,7 +139,7 @@ const buildResolvers = (
                 return [`127.0.0.1:${dnsServer.address().port}`];
             },
             ruleParameterKeys: async (): Promise<String[]> => {
-                return mockttpStandalone.ruleParameterKeys;
+                return mockttpAdminServer.ruleParameterKeys;
             }
         },
 
@@ -275,14 +275,14 @@ export class HttpToolkitServerApi extends events.EventEmitter {
 
     private server: express.Application;
 
-    constructor(config: HtkConfig, mockttpStandalone: MockttpStandalone) {
+    constructor(config: HtkConfig, mockttpAdminServer: MockttpAdminServer) {
         super();
 
         let interceptors = buildInterceptors(config);
 
         const schema = makeExecutableSchema({
             typeDefs,
-            resolvers: buildResolvers(config, interceptors, mockttpStandalone, this)
+            resolvers: buildResolvers(config, interceptors, mockttpAdminServer, this)
         });
 
         this.server = express();

src/api-server.ts

@@ -38,12 +38,12 @@ export class CertCheckServer {
         await this.server.start(EPHEMERAL_PORT_RANGE);
 
         await Promise.all([
-            this.server.get('/test-https').thenCallback(() => {
+            this.server.forGet('/test-https').thenCallback(() => {
                 console.log('Request to /test-https successfully received');
                 this.certCheckedSuccessfully.resolve(true);
                 return { statusCode: 200 };
             }),
-            this.server.get('/check-cert').thenCallback(() => {
+            this.server.forGet('/check-cert').thenCallback(() => {
                 console.log('Request to /check-cert received');
 
                 return {
@@ -117,7 +117,7 @@ export class CertCheckServer {
                     `)
                 };
             }),
-            this.server.get('/failed-test').thenCallback(() => {
+            this.server.forGet('/failed-test').thenCallback(() => {
                 console.log('Request to /failed-test received');
                 this.certCheckedSuccessfully.resolve(false);
 

src/cert-check-server.ts

@@ -27,7 +27,7 @@ export class HideWarningServer {
     async start(targetUrl: string) {
         await this.server.start(EPHEMERAL_PORT_RANGE);
 
-        await this.server.get('/hide-warning').thenReply(200, `
+        await this.server.forGet('/hide-warning').thenReply(200, `
             <html>
                 <title>HTTP Toolkit Warning Fix</title>
                 <meta charset="UTF-8" />

src/hide-warning-server.ts

@@ -1,8 +1,8 @@
 import * as path from 'path';
 import * as fs from 'fs';
 import * as envPaths from 'env-paths';
-import { getStandalone, generateCACertificate } from 'mockttp';
-import { MockttpStandalone } from 'mockttp/dist/standalone/mockttp-standalone';
+import { getAdminServer, generateCACertificate } from 'mockttp';
+import { MockttpAdminServer } from 'mockttp';
 import { Mutex } from 'async-mutex';
 
 import updateCommand from '@oclif/plugin-update/lib/commands/update';
@@ -66,18 +66,18 @@ function checkCertExpiry(certContents: string): void {
 }
 
 function manageBackgroundServices(
-    standalone: MockttpStandalone,
+    standalone: MockttpAdminServer,
     httpsConfig: { certPath: string, certContent: string }
 ) {
-    standalone.on('mock-server-started', async (server) => {
-        startDockerInterceptionServices(server.port, httpsConfig, ruleParameters)
+    standalone.on('mock-session-started', async ({ http }) => {
+        startDockerInterceptionServices(http.getMockServer().port, httpsConfig, ruleParameters)
         .catch((error) => {
             console.log("Could not start Docker components:", error);
         });
     });
 
-    standalone.on('mock-server-stopping', (server) => {
-        stopDockerInterceptionServices(server.port, ruleParameters)
+    standalone.on('mock-session-stopping', ({ http }) => {
+        stopDockerInterceptionServices(http.getMockServer().port, ruleParameters)
         .catch((error) => {
             console.log("Could not stop Docker components:", error);
         });
@@ -112,7 +112,7 @@ export async function runHTK(options: {
     console.log('Certificates setup in', certSetupTime - configCheckTime, 'ms');
 
     // Start a Mockttp standalone server
-    const standalone = getStandalone({
+    const standalone = getAdminServer({
         serverDefaults: {
             cors: false, // Don't add mocked CORS responses to intercepted traffic
             recordTraffic: false, // Don't persist traffic here (keep it in the UI)

src/index.ts

@@ -19,7 +19,7 @@ export class MessageServer {
         this.server = getLocal({ https: this.config.https, cors: true });
         await this.server.start(EPHEMERAL_PORT_RANGE);
 
-        await this.server.get('/')
+        await this.server.forGet('/')
             .thenCallback(() => {
                 console.log('Request to message server received');
                 this.messageSeen.resolve();

src/message-server.ts

@@ -87,7 +87,6 @@ module.exports = {
         new webpack.IgnorePlugin(/^\.\/protocol.json$/, /chrome-remote-interface/),
         // Copy Mockttp's schema (read with readFile) into the output directory
         new CopyWebpackPlugin([
-            { from: path.join('node_modules', 'mockttp', 'dist', 'standalone', 'schema.gql') },
             { from: path.join('node_modules', '@httptoolkit', 'browser-launcher', 'res'), to: 'bl-resources' }
         ]),
         // If SENTRY_AUTH_TOKEN is set, upload this sourcemap to Sentry