Migrate to @httptoolkit/util

pimterry · pimterry · commit 8ff797bf30ea · 2025-04-24T14:34:35.000+02:00
diff --git a/package.json b/package.json
@@ -162,6 +162,7 @@
     "@graphql-tools/utils": "^8.8.0",
     "@httptoolkit/httpolyglot": "^2.2.1",
     "@httptoolkit/subscriptions-transport-ws": "^0.11.2",
+    "@httptoolkit/util": "^0.1.6",
     "@httptoolkit/websocket-stream": "^6.0.1",
     "@types/cors": "^2.8.6",
     "@types/node": "*",
diff --git a/src/admin/admin-plugin-types.ts b/src/admin/admin-plugin-types.ts
@@ -1,8 +1,7 @@
 import { Duplex } from "stream";
 import { DocumentNode } from "graphql";
 import { IResolvers } from "@graphql-tools/utils";
-
-import { MaybePromise } from "../util/type-utils";
+import { MaybePromise } from "@httptoolkit/util";
 
 export interface AdminPlugin<StartParams, ClientResponse> {
     // Called when a /start request is received that references this plugin
diff --git a/src/admin/admin-server.ts b/src/admin/admin-server.ts
@@ -9,15 +9,15 @@ import * as Ws from 'ws';
 import { v4 as uuid } from "uuid";
 
 import { createHandler as createGraphQLHandler } from 'graphql-http/lib/use/express';
-import { execute, formatError, GraphQLScalarType, subscribe } from 'graphql';
+import { execute, GraphQLScalarType, subscribe } from 'graphql';
 import gql from 'graphql-tag';
 import { makeExecutableSchema } from '@graphql-tools/schema';
 import { SubscriptionServer } from '@httptoolkit/subscriptions-transport-ws';
 import { EventEmitter } from 'stream';
 import DuplexPair = require('native-duplexpair');
 
 import { makeDestroyable, DestroyableServer } from "destroyable-server";
-import { isErrorLike } from '../util/error';
+import { isErrorLike } from '@httptoolkit/util';
 import { objectAllPromise } from '../util/promise';
 
 import { DEFAULT_ADMIN_SERVER_PORT } from '../types';
diff --git a/src/client/admin-client.ts b/src/client/admin-client.ts
@@ -7,14 +7,14 @@ import * as CrossFetch from 'cross-fetch';
 import * as WebSocket from 'isomorphic-ws';
 import connectWebSocketStream = require('@httptoolkit/websocket-stream');
 import { SubscriptionClient } from '@httptoolkit/subscriptions-transport-ws';
+import { MaybePromise, getDeferred } from '@httptoolkit/util';
 import { print } from 'graphql';
 
 import { DEFAULT_ADMIN_SERVER_PORT } from "../types";
 
-import { MaybePromise, RequireProps } from '../util/type-utils';
-import { delay, isNode } from '../util/util';
-import { isErrorLike } from '../util/error';
-import { getDeferred } from '../util/promise';
+import { RequireProps } from '../util/type-utils';
+import { isNode } from '../util/util';
+import { delay, isErrorLike } from '@httptoolkit/util';
 
 import { introspectionQuery } from './schema-introspection';
 import { MockttpPluginOptions } from '../admin/mockttp-admin-plugin';
diff --git a/src/client/admin-query.ts b/src/client/admin-query.ts
@@ -4,8 +4,7 @@ import {
     SelectionNode,
     SelectionSetNode
 } from "graphql";
-
-import { MaybePromise } from "../util/type-utils";
+import { MaybePromise } from "@httptoolkit/util";
 
 import type { AdminClient } from "./admin-client";
 
diff --git a/src/main.ts b/src/main.ts
@@ -1,3 +1,5 @@
+export type { MaybePromise } from '@httptoolkit/util';
+
 import { Mockttp, MockttpOptions, MockttpHttpsOptions, SubscribableEvent, PortRange } from "./mockttp";
 import { MockttpServer } from "./server/mockttp-server";
 import {
@@ -88,7 +90,6 @@ export type {
 } from './util/tls';
 export type { CachedDns, DnsLookupFunction } from './util/dns';
 export type { Serialized, SerializedValue } from './serialization/serialization';
-export type { MaybePromise } from './util/type-utils';
 
 // Export the core API:
 
diff --git a/src/rules/matchers.ts b/src/rules/matchers.ts
@@ -2,6 +2,7 @@ import * as _ from 'lodash';
 import * as url from 'url';
 import { oneLine } from 'common-tags';
 import * as multipart from 'parse-multipart-data';
+import { MaybePromise } from '@httptoolkit/util';
 
 import { CompletedRequest, Method, Explainable, OngoingRequest } from "../types";
 import {
@@ -14,7 +15,7 @@ import {
 import { waitForCompletedRequest } from '../util/request-utils';
 import { Serializable, ClientServerChannel } from "../serialization/serialization";
 import { withDeserializedBodyReader, withSerializedBodyReader } from '../serialization/body-serialization';
-import { MaybePromise, Replace } from '../util/type-utils';
+import { Replace } from '../util/type-utils';
 
 export interface RequestMatcher extends Explainable, Serializable {
     type: keyof typeof MatcherLookup;
diff --git a/src/rules/passthrough-handling.ts b/src/rules/passthrough-handling.ts
@@ -13,7 +13,7 @@ import { isLocalhostAddress, normalizeIP } from '../util/socket-util';
 import { CachedDns, dnsLookup, DnsLookupFunction } from '../util/dns';
 import { isMockttpBody, encodeBodyBuffer } from '../util/request-utils';
 import { areFFDHECurvesSupported } from '../util/openssl-compat';
-import { ErrorLike } from '../util/error';
+import { ErrorLike } from '@httptoolkit/util';
 import { getHeaderValue } from '../util/header-utils';
 
 import {
diff --git a/src/rules/proxy-config.ts b/src/rules/proxy-config.ts
@@ -1,6 +1,6 @@
 import * as _ from 'lodash';
 
-import { MaybePromise } from '../util/type-utils';
+import { MaybePromise } from '@httptoolkit/util';
 import { RuleParameterReference } from './rule-parameters';
 import { CADefinition } from './passthrough-handling-definitions';
 
diff --git a/src/rules/requests/request-handler-definitions.ts b/src/rules/requests/request-handler-definitions.ts
@@ -8,6 +8,7 @@ import {
     Operation as JsonPatchOperation,
     validate as validateJsonPatch
 } from 'fast-json-patch';
+import { MaybePromise } from '@httptoolkit/util';
 
 import {
     Headers,
@@ -18,7 +19,7 @@ import {
     RawHeaders
 } from "../../types";
 
-import { MaybePromise, Replace } from '../../util/type-utils';
+import { Replace } from '../../util/type-utils';
 import { buildBodyReader } from '../../util/request-utils';
 import { asBuffer } from '../../util/buffer-utils';
 import {
diff --git a/src/rules/requests/request-handlers.ts b/src/rules/requests/request-handlers.ts
@@ -20,7 +20,7 @@ import {
     OngoingResponse
 } from "../../types";
 
-import { MaybePromise } from '../../util/type-utils';
+import { MaybePromise, ErrorLike, isErrorLike } from '@httptoolkit/util';
 import { isAbsoluteUrl, getEffectivePort } from '../../util/url';
 import {
     waitForCompletedRequest,
@@ -61,7 +61,6 @@ import {
     withDeserializedCallbackBuffers,
     WithSerializedCallbackBuffers
 } from '../../serialization/body-serialization';
-import { ErrorLike, isErrorLike } from '../../util/error';
 
 import { assertParamDereferenced, RuleParameters } from '../rule-parameters';
 
diff --git a/src/rules/requests/request-rule-builder.ts b/src/rules/requests/request-rule-builder.ts
@@ -1,5 +1,6 @@
 import { merge, isString, isBuffer } from "lodash";
 import { Readable } from "stream";
+import { MaybePromise } from '@httptoolkit/util';
 
 import { Headers, CompletedRequest, Method, MockedEndpoint, Trailers } from "../../types";
 import type { RequestRuleData } from "./request-rule";
@@ -18,7 +19,6 @@ import {
     ResetConnectionHandlerDefinition,
     CallbackResponseMessageResult
 } from "./request-handler-definitions";
-import { MaybePromise } from "../../util/type-utils";
 import { byteLength } from "../../util/util";
 import { BaseRuleBuilder } from "../base-rule-builder";
 import { MethodMatcher, RegexPathMatcher, SimplePathMatcher, WildcardMatcher } from "../matchers";
diff --git a/src/rules/requests/request-rule.ts b/src/rules/requests/request-rule.ts
@@ -3,7 +3,7 @@ import { v4 as uuid } from "uuid";
 
 import { OngoingRequest, CompletedRequest, OngoingResponse, Explainable, RulePriority } from "../../types";
 import { buildBodyReader, buildInitiatedRequest, waitForCompletedRequest } from '../../util/request-utils';
-import { MaybePromise } from '../../util/type-utils';
+import { MaybePromise } from '@httptoolkit/util';
 
 import * as matchers from "../matchers";
 import type { RequestHandlerDefinition } from "./request-handler-definitions";
diff --git a/src/rules/websockets/websocket-handlers.ts b/src/rules/websockets/websocket-handlers.ts
@@ -28,7 +28,7 @@ import {
     rawHeadersToObjectPreservingCase
 } from '../../util/header-utils';
 import { streamToBuffer } from '../../util/buffer-utils';
-import { MaybePromise } from '../../util/type-utils';
+import { MaybePromise } from '@httptoolkit/util';
 
 import { getAgent } from '../http-agents';
 import { ProxySettingSource } from '../proxy-config';
diff --git a/src/rules/websockets/websocket-rule.ts b/src/rules/websockets/websocket-rule.ts
@@ -10,7 +10,7 @@ import {
     RulePriority
 } from "../../types";
 import { waitForCompletedRequest } from '../../util/request-utils';
-import { MaybePromise } from '../../util/type-utils';
+import { MaybePromise } from '@httptoolkit/util';
 
 import { validateMockRuleData } from '../rule-serialization';
 
diff --git a/src/serialization/serialization.ts b/src/serialization/serialization.ts
@@ -2,7 +2,7 @@ import * as _ from 'lodash';
 import { Duplex } from 'stream';
 import { v4 as uuid } from "uuid";
 
-import { MaybePromise } from '../util/type-utils';
+import { MaybePromise } from '@httptoolkit/util';
 import {
     dereferenceParam,
     isParamReference,
diff --git a/src/server/http-combo-server.ts b/src/server/http-combo-server.ts
@@ -8,7 +8,8 @@ import * as streams from 'stream';
 
 import * as semver from 'semver';
 import { makeDestroyable, DestroyableServer } from 'destroyable-server';
-import httpolyglot = require('@httptoolkit/httpolyglot');
+import * as httpolyglot from '@httptoolkit/httpolyglot';
+import { delay } from '@httptoolkit/util';
 import {
     calculateJa3FromFingerprintData,
     calculateJa4FromHelloData,
@@ -19,7 +20,6 @@ import { URLPattern } from "urlpattern-polyfill";
 
 import { TlsHandshakeFailure } from '../types';
 import { getCA } from '../util/tls';
-import { delay } from '../util/util';
 import { shouldPassThrough } from '../util/server-utils';
 import {
     getParentSocket,
diff --git a/src/server/mockttp-server.ts b/src/server/mockttp-server.ts
@@ -12,6 +12,7 @@ import cors = require("cors");
 import now = require("performance-now");
 import WebSocket = require("ws");
 import { Mutex } from 'async-mutex';
+import { ErrorLike, isErrorLike } from '@httptoolkit/util';
 
 import {
     InitiatedRequest,
@@ -42,7 +43,6 @@ import { ServerMockedEndpoint } from "./mocked-endpoint";
 import { createComboServer } from "./http-combo-server";
 import { filter } from "../util/promise";
 import { Mutable } from "../util/type-utils";
-import { ErrorLike, isErrorLike } from "../util/error";
 import { makePropertyWritable } from "../util/util";
 
 import { isAbsoluteUrl, getPathFromAbsoluteUrl } from "../util/url";
diff --git a/src/util/error.ts b/src/util/error.ts
diff --git a/src/util/promise.ts b/src/util/promise.ts
@@ -1,5 +1,5 @@
 import _ = require("lodash");
-import { MaybePromise } from "./type-utils";
+import { MaybePromise } from "@httptoolkit/util";
 
 export async function filter<T>(
     array: T[],
@@ -11,21 +11,4 @@ export async function filter<T>(
 
 export async function objectAllPromise<V>(obj: _.Dictionary<MaybePromise<V>>): Promise<_.Dictionary<V>> {
     return _.zipObject(Object.keys(obj), await Promise.all(Object.values(obj)));
-}
-
-export type Deferred<T> = Promise<T> & {
-    resolve(value: T): void,
-    reject(e: Error): void
-}
-export function getDeferred<T>(): Deferred<T> {
-    let resolveCallback: (value: T) => void;
-    let rejectCallback: (e: Error) => void;
-    let result = <Deferred<T>> new Promise((resolve, reject) => {
-        resolveCallback = resolve;
-        rejectCallback = reject;
-    });
-    result.resolve = resolveCallback!;
-    result.reject = rejectCallback!;
-
-    return result;
 }
diff --git a/src/util/type-utils.ts b/src/util/type-utils.ts
@@ -4,8 +4,6 @@ export type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
 export type RequireProps<T, K extends keyof T> =
     Omit<T, K> & Required<Pick<T, K>>;
 
-export type MaybePromise<T> = T | Promise<T>;
-
 type SubsetKeyOf<T, Ks extends keyof T = keyof T> = Ks;
 export type Replace<T, KV extends { [K in SubsetKeyOf<T, any>]: unknown }> =
     Omit<T, keyof KV> & { [K in keyof KV]: KV[K] };
diff --git a/src/util/util.ts b/src/util/util.ts
@@ -23,10 +23,6 @@ export function byteLength(input: string | Uint8Array | Buffer) {
     }
 }
 
-export function delay(t: number): Promise<void> {
-    return new Promise((r) => setTimeout(r, t));
-}
-
 declare const WorkerGlobalScope: Function | undefined;
 export const isWorker = typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope;
 export const isWeb = typeof Window !== 'undefined' && self instanceof Window;
diff --git a/test/integration/websockets.spec.ts b/test/integration/websockets.spec.ts
@@ -14,10 +14,10 @@ import {
     browserOnly,
     startDnsServer,
     DestroyableServer,
-    makeDestroyable
+    makeDestroyable,
+    delay
 } from '../test-utils';
 import { getCA } from '../../src/util/tls';
-import { delay } from '../../src/util/util';
 import { pairFlatRawHeaders } from '../../src/util/header-utils';
 
 browserOnly(() => {
diff --git a/test/test-utils.ts b/test/test-utils.ts
@@ -21,16 +21,29 @@ import * as semver from 'semver';
 import chai = require("chai");
 import chaiAsPromised = require("chai-as-promised");
 import chaiFetch = require("chai-fetch");
+import { makeDestroyable, DestroyableServer } from "destroyable-server";
+import {
+    delay,
+    getDeferred,
+    Deferred
+} from '@httptoolkit/util';
 
 import * as dns2 from 'dns2'; // Imported here just for types
 
 import { Mockttp } from "..";
 
-export { getDeferred, Deferred } from '../src/util/promise';
-import { makeDestroyable, DestroyableServer } from "destroyable-server";
-import { isNode, isWeb, delay } from '../src/util/util';
+import { isNode, isWeb } from '../src/util/util';
 import { getEffectivePort } from '../src/util/url';
-export { isNode, isWeb, delay, makeDestroyable, DestroyableServer };
+
+export {
+    isNode,
+    isWeb,
+    makeDestroyable,
+    DestroyableServer,
+    delay,
+    getDeferred,
+    Deferred
+};
 
 if (isNode) {
     // Run a target websocket server in the background. In browsers, this is
