Start moving to @httptoolkit/util for utilities

pimterry · pimterry · commit 7371ec27328a · 2024-06-10T17:07:12.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
     "@graphql-tools/utils": "^8.8.0",
     "@httptoolkit/browser-launcher": "^2.3.0",
     "@httptoolkit/osx-find-executable": "^2.0.1",
+    "@httptoolkit/util": "^0.1.5",
     "@oclif/command": "^1.5.4",
     "@oclif/config": "^1.13.3",
     "@oclif/plugin-help": "^2.2.3",
diff --git a/src/api/api-model.ts b/src/api/api-model.ts
@@ -1,11 +1,11 @@
 import * as _ from 'lodash';
 import * as os from 'os';
 
+import { delay } from '@httptoolkit/util';
 import { generateSPKIFingerprint } from 'mockttp';
 import { getSystemProxy } from 'os-proxy-config';
 
 import { SERVER_VERSION } from "../constants";
-import { delay } from '../util/promise';
 import { logError, addBreadcrumb } from '../error-tracking';
 
 import { HtkConfig } from "../config";
diff --git a/src/browsers.ts b/src/browsers.ts
@@ -1,6 +1,7 @@
 import * as path from 'path';
 import { promisify } from 'util';
 
+import { delay } from '@httptoolkit/util';
 import getBrowserLauncherCb from '@httptoolkit/browser-launcher';
 import {
     LaunchOptions,
@@ -11,7 +12,6 @@ import {
 } from '@httptoolkit/browser-launcher';
 
 import { logError } from './error-tracking';
-import { delay } from './util/promise';
 import { isErrorLike } from './util/error';
 import { readFile, deleteFile } from './util/fs';
 
diff --git a/src/cert-check-server.ts b/src/cert-check-server.ts
@@ -1,8 +1,8 @@
 import { getLocal, Mockttp } from 'mockttp';
+import { getDeferred } from '@httptoolkit/util';
 
 import { HtkConfig } from './config';
 import { EPHEMERAL_PORT_RANGE } from './constants';
-import { getDeferred } from './util/promise';
 
 const buildPage = (style: string, script?: string, body?: string) =>
     `<html>
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,7 @@ import * as fs from 'fs';
 import envPaths from 'env-paths';
 import { Mutex } from 'async-mutex';
 
+import { delay } from '@httptoolkit/util';
 import {
     PluggableAdmin,
     generateCACertificate
@@ -21,7 +22,6 @@ import { checkBrowserConfig } from './browsers';
 import { logError } from './error-tracking';
 import { IS_PROD_BUILD, MOCKTTP_ALLOWED_ORIGINS } from './constants';
 
-import { delay } from './util/promise';
 import { isErrorLike } from './util/error';
 import { readFile, checkAccess, writeFile, ensureDirectoryExists } from './util/fs';
 
diff --git a/src/interceptors/android/adb-commands.ts b/src/interceptors/android/adb-commands.ts
@@ -1,9 +1,12 @@
 import * as stream from 'stream';
 import * as path from 'path';
+
 import adb, * as Adb from '@devicefarmer/adbkit';
+import { delay } from '@httptoolkit/util';
+
 import { logError } from '../../error-tracking';
 import { isErrorLike } from '../../util/error';
-import { delay, waitUntil } from '../../util/promise';
+import { waitUntil } from '../../util/promise';
 import { getCertificateFingerprint, parseCert } from '../../certificates';
 import { streamToBuffer } from '../../util/stream';
 
diff --git a/src/interceptors/android/android-adb-interceptor.ts b/src/interceptors/android/android-adb-interceptor.ts
@@ -1,13 +1,12 @@
 import _ from 'lodash';
 import { DeviceClient } from '@devicefarmer/adbkit';
+import { delay } from '@httptoolkit/util';
 
 import { Interceptor } from '..';
 import { HtkConfig } from '../../config';
 import { generateSPKIFingerprint } from 'mockttp';
 
 import { logError } from '../../error-tracking';
-import { delay } from '../../util/promise';
-import { isErrorLike } from '../../util/error';
 import {
     ANDROID_TEMP,
     createAdbClient,
diff --git a/src/interceptors/chromium-based-interceptors.ts b/src/interceptors/chromium-based-interceptors.ts
@@ -1,10 +1,10 @@
 import _ from 'lodash';
 import * as path from 'path';
+import { delay } from '@httptoolkit/util';
 import { generateSPKIFingerprint } from 'mockttp';
 
 import { HtkConfig } from '../config';
 
-import { delay } from '../util/promise';
 import { readFile, deleteFolder } from '../util/fs';
 import { listRunningProcesses, windowsClose, waitForExit } from '../util/process-management';
 import { getSnapConfigPath, isSnap } from '../util/snap';
diff --git a/src/interceptors/docker/docker-build-injection.ts b/src/interceptors/docker/docker-build-injection.ts
@@ -1,14 +1,15 @@
 import _ from 'lodash';
 import * as path from 'path';
 import * as stream from 'stream';
+
 import * as EventStream from 'event-stream';
 import getRawBody from 'raw-body';
 import maybeGunzip = require('gunzip-maybe');
 import * as tarStream from 'tar-stream';
 import { parse as parseDockerfile, CommandEntry } from 'docker-file-parser';
+import { getDeferred } from '@httptoolkit/util';
 
 import { getTerminalEnvVars } from '../terminal/terminal-env-overrides';
-import { getDeferred } from '../../util/promise';
 import { getDockerHostAddress } from './docker-commands';
 import { packOverrideFiles } from './docker-data-injection';
 
diff --git a/src/interceptors/docker/docker-commands.ts b/src/interceptors/docker/docker-commands.ts
@@ -2,7 +2,7 @@ import _ from 'lodash';
 import Docker from 'dockerode';
 import * as path from 'path';
 
-import { delay } from '../../util/promise';
+import { delay } from '@httptoolkit/util';
 
 import { getTerminalEnvVars } from '../terminal/terminal-env-overrides';
 import { transformComposeCreationLabels } from './docker-compose';
diff --git a/src/interceptors/docker/docker-tunnel-proxy.ts b/src/interceptors/docker/docker-tunnel-proxy.ts
@@ -1,10 +1,10 @@
 import _ = require('lodash');
 import Docker from 'dockerode';
 import { Mutex } from 'async-mutex';
+import { delay } from '@httptoolkit/util';
 
 import { isImageAvailable } from './docker-commands';
 import { isDockerAvailable } from './docker-interception-services';
-import { delay } from '../../util/promise';
 import { logError } from '../../error-tracking';
 import { waitForDockerStream } from './docker-utils';
 
diff --git a/src/interceptors/electron.ts b/src/interceptors/electron.ts
@@ -2,14 +2,14 @@ import _ from 'lodash';
 import { spawn } from 'child_process';
 import * as path from 'path';
 
+import { delay } from '@httptoolkit/util';
 import { getPortPromise as getPort } from 'portfinder';
 import { generateSPKIFingerprint } from 'mockttp';
 import ChromeRemoteInterface = require('chrome-remote-interface');
 
 import { Interceptor } from '.';
 
 import { HtkConfig } from '../config';
-import { delay } from '../util/promise';
 import { ErrorLike, isErrorLike } from '../util/error';
 import { canAccess, readFile } from '../util/fs';
 import { windowsClose } from '../util/process-management';
diff --git a/src/interceptors/fresh-firefox.ts b/src/interceptors/fresh-firefox.ts
@@ -2,11 +2,12 @@ import _ from 'lodash';
 import * as path from 'path';
 import { SpawnOptions } from 'child_process';
 
+import { delay } from '@httptoolkit/util';
+
 import { APP_ROOT } from '../constants';
 import { HtkConfig } from '../config';
 import { logError } from '../error-tracking';
 
-import { delay } from '../util/promise';
 import { isErrorLike } from '../util/error';
 import { isSnap, getSnapConfigPath } from '../util/snap';
 
diff --git a/src/interceptors/jvm.ts b/src/interceptors/jvm.ts
@@ -1,13 +1,14 @@
 import _ from 'lodash';
 import * as path from 'path';
 
+import { delay } from '@httptoolkit/util';
+
 import { Interceptor } from '.';
 
 import { HtkConfig } from '../config';
 import { spawnToResult, waitForExit } from '../util/process-management';
 import { OVERRIDE_JAVA_AGENT } from './terminal/terminal-env-overrides';
 import { logError } from '../error-tracking';
-import { delay } from '../util/promise';
 import { commandExists, canAccess } from '../util/fs';
 import { ErrorLike } from '../util/error';
 
diff --git a/src/message-server.ts b/src/message-server.ts
@@ -1,8 +1,8 @@
 import { getLocal, Mockttp } from 'mockttp';
+import { getDeferred } from '@httptoolkit/util';
 
 import { HtkConfig } from './config';
 import { EPHEMERAL_PORT_RANGE } from './constants';
-import { getDeferred } from './util/promise';
 
 export class MessageServer {
 
diff --git a/src/shutdown.ts b/src/shutdown.ts
@@ -1,5 +1,5 @@
+import { delay } from '@httptoolkit/util';
 import { logError } from './error-tracking';
-import { delay } from './util/promise';
 
 type ShutdownHandler = () => Promise<unknown>;
 const shutdownHandlers: Array<ShutdownHandler> = [];
diff --git a/src/util/process-management.ts b/src/util/process-management.ts
@@ -2,7 +2,7 @@ import _ from 'lodash';
 import * as path from 'path';
 import { spawn } from 'child_process';
 
-import { delay } from './promise';
+import { delay } from '@httptoolkit/util';
 
 // Spawn a command, and resolve with all output as strings when it terminates
 export function spawnToResult(command: string, args: string[] = [], options = {}, inheritOutput = false): Promise<{
diff --git a/src/util/promise.ts b/src/util/promise.ts
@@ -1,9 +1,4 @@
-export function delay(durationMs: number, options: { unref?: boolean } = {}): Promise<void> {
-    return new Promise((resolve) => {
-        const timer = setTimeout(resolve, durationMs);
-        if (options.unref) timer.unref();
-    });
-}
+import { delay } from '@httptoolkit/util';
 
 export async function waitUntil<T extends unknown>(
     delayMs: number,
@@ -21,23 +16,3 @@ export async function waitUntil<T extends unknown>(
     if (!result) throw new Error(`Wait loop failed`);
     else return result as Exclude<T, false>;
 }
-
-export interface Deferred<T> {
-    resolve: (arg: T) => void,
-    reject: (e?: Error) => void,
-    promise: Promise<T>
-}
-
-export function getDeferred<T = void>(): Deferred<T> {
-    let resolve: undefined | ((arg: T) => void) = undefined;
-    let reject: undefined | ((e?: Error) => void) = undefined;
-
-    let promise = new Promise<T>((resolveCb, rejectCb) => {
-        resolve = resolveCb;
-        reject = rejectCb;
-    });
-
-    // TS thinks we're using these before they're assigned, which is why
-    // we need the undefined types, and the any here.
-    return { resolve, reject, promise } as any;
-}
diff --git a/test/integration/e2e-api-test.spec.ts b/test/integration/e2e-api-test.spec.ts
@@ -2,6 +2,7 @@ import * as _ from 'lodash';
 import { spawn, ChildProcess } from 'child_process';
 import * as path from 'path';
 
+import { delay } from '@httptoolkit/util';
 import * as request from 'request-promise-native';
 import * as tmp from 'tmp';
 import decompress from 'decompress';
@@ -11,8 +12,6 @@ import fetch from 'node-fetch';
 
 import { getRemote, getLocal } from 'mockttp';
 
-import { delay } from '../../src/util/promise';
-
 async function setupServerPath() {
     if (!process.env.TEST_BUILT_TARBALL) {
         // By default, test the current folder code
diff --git a/test/integration/interceptors/docker-attachment.spec.ts b/test/integration/interceptors/docker-attachment.spec.ts
@@ -4,10 +4,10 @@ import * as fs from 'fs';
 
 import { expect } from 'chai';
 
+import { delay } from '@httptoolkit/util';
 import Docker from 'dockerode';
 import fetch from 'node-fetch';
 
-import { delay } from '../../../src/util/promise';
 import { FIXTURES_DIR } from '../../test-util';
 import { setupInterceptor, itIsAvailable } from './interceptor-test-utils';
 import { waitForDockerStream } from '../../../src/interceptors/docker/docker-utils';
diff --git a/test/integration/interceptors/docker-terminal-interception.spec.ts b/test/integration/interceptors/docker-terminal-interception.spec.ts
@@ -5,11 +5,11 @@ import Docker from 'dockerode';
 import { ProxySettingCallback } from 'mockttp';
 
 import { expect } from 'chai';
+import { delay } from '@httptoolkit/util';
 
 import { setupTest } from './interceptor-test-utils';
 import { FIXTURES_DIR } from '../../test-util';
 import { spawnToResult } from '../../../src/util/process-management';
-import { delay } from '../../../src/util/promise';
 
 import { getTerminalEnvVars } from '../../../src/interceptors/terminal/terminal-env-overrides';
 
diff --git a/test/unit/send-request.spec.ts b/test/unit/send-request.spec.ts
@@ -1,10 +1,10 @@
 import * as _ from 'lodash';
 import { expect } from 'chai';
 import * as mockttp from 'mockttp';
+import { delay } from '@httptoolkit/util';
 
 import { HttpClient } from '../../src/client/http-client';
 import { streamToArray } from '../../src/util/stream';
-import { delay } from '../../src/util/promise';
 
 describe("The HTTP client API", () => {
 
