Update to support changes in latest Node types

Author: pimterry

custom-typings/node-type-extensions.d.ts

@@ -1,33 +1,27 @@
 // There's a few places where we attach extra data to some node objects during
 // connection setup etc, to better track data & handle issues:
 
-declare module "net" {
-    import * as net from 'net';
-    import * as stream from 'stream';
+import * as stream from 'stream';
+import * as net from 'net';
 
+declare module "net" {
     interface Socket {
         // Normally only defined on TLSSocket, but useful to explicitly include here
         // Undefined on plain HTTP, 'true' on TLSSocket.
         encrypted?: boolean;
 
         // Internal reference to the parent socket, available on TLS sockets
-        _parent?: Socket;
+        _parent?: net.Socket;
 
         // Internal reference to the underlying stream, available on _stream_wrap
         stream?: stream.Duplex & Partial<net.Socket>;
     }
 }
 
 declare module "tls" {
-    import * as stream from 'stream';
-    import * as net from 'net';
-
     interface TLSSocket {
-        // This is a real field that actually exists - unclear why it's not
-        // in the type definitions.
-        servername?: string;
-
-        _handle?: { // Internal, used for monkeypatching & error tracking
+        // Internal handle, used for monkeypatching & error tracking
+        _handle?: {
             oncertcb?: (info: any) => any;
             _parentWrap?: { // SocketWrapper
                 stream?: stream.Duplex & Partial<net.Socket>
@@ -37,11 +31,6 @@ declare module "tls" {
 }
 
 declare module "http" {
-    // Two missing methods from the official types:
     export function validateHeaderName(name: string): void;
     export function validateHeaderValue(name: string, value: unknown): void;
 }
-
-declare class AggregateError extends Error {
-    errors: Error[]
-}

src/admin/admin-server.ts

@@ -301,7 +301,7 @@ export class AdminServer<Plugins extends { [key: string]: AdminPlugin<any, any>
 
             this.server.on('error', reject);
 
-            this.server.on('upgrade', async (req: http.IncomingMessage, socket: net.Socket, head: Buffer) => {
+            this.server.on('upgrade', async (req, socket, head) => {
                 const reqOrigin = req.headers['origin'] as string | undefined;
                 if (this.requiredOrigin && !await strictOriginMatch(reqOrigin, this.requiredOrigin)) {
                     console.warn(`Websocket request from invalid origin: ${req.headers['origin']}`);

src/server/mockttp-server.ts

@@ -363,7 +363,7 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
         return Promise.resolve();
     }
 
-    public listenerCount(event: string, listener?: Function): number {
+    public listenerCount(event: string, listener?: ((...args: any[]) => void)): number {
         return this.eventEmitter.listenerCount(event, listener);
     }
 
@@ -1217,7 +1217,7 @@ ${await this.suggestRule(request)}`
         upstreamSocket.pipe(socket);
 
         if (type === 'raw') {
-            socket.on('data', (data) => {
+            socket.on('data', (data: Buffer) => {
                 const eventTimestamp = now();
                 setImmediate(() => {
                     this.eventEmitter.emit('raw-passthrough-data', {
@@ -1228,7 +1228,7 @@ ${await this.suggestRule(request)}`
                     } satisfies RawPassthroughDataEvent);
                 });
             });
-            upstreamSocket.on('data', (data) => {
+            upstreamSocket.on('data', (data: Buffer) => {
                 const eventTimestamp = now();
                 setImmediate(() => {
                     this.eventEmitter.emit('raw-passthrough-data', {
@@ -1247,7 +1247,7 @@ ${await this.suggestRule(request)}`
             upstreamSocket.destroy();
         });
 
-        upstreamSocket.on('error', (e) => {
+        upstreamSocket.on('error', (e: ErrorLike) => {
             if (this.debug) console.warn(`Upstream ${type} passthrough error to ${hostname}:${targetPort}:`, e);
             eventData.tags.push(`${type}-passthrough-error:${e.code || 'UNKNOWN'}`);
             socket.destroy()

src/util/socket-extensions.ts

@@ -20,6 +20,16 @@ export interface SocketMetadata {
     [key: string]: any;
 }
 
+export interface SocketTimingData {
+    initialSocket: number; // Initial raw socket time, since unix epoch
+
+    // High-precision timestamps:
+    initialSocketTimestamp: number;
+    tunnelSetupTimestamp?: number; // Latest CONNECT completion, if any
+    tlsConnectedTimestamp?: number; // Latest TLS handshake completion, if any
+    lastRequestTimestamp?: number; // Latest request or websocket request time, if any
+}
+
 declare module 'net' {
     interface Socket {
         /**
@@ -47,15 +57,7 @@ declare module 'net' {
          * Our recordings of various timestamps, used for monitoring &
          * performance analysis later on
          */
-        [SocketTimingInfo]?: {
-            initialSocket: number; // Initial raw socket time, since unix epoch
-
-            // High-precision timestamps:
-            initialSocketTimestamp: number;
-            tunnelSetupTimestamp?: number; // Latest CONNECT completion, if any
-            tlsConnectedTimestamp?: number; // Latest TLS handshake completion, if any
-            lastRequestTimestamp?: number; // Latest request or websocket request time, if any
-        }
+        [SocketTimingInfo]?: SocketTimingData;
 
         // Set on TLSSocket, defined here for convenient access on _all_ sockets
         [TlsMetadata]?: TlsSocketMetadata;
@@ -101,22 +103,22 @@ declare module 'tls' {
 }
 
 declare module 'http2' {
-    class Http2Session {
+    interface Http2Session {
         // session.socket is cleared before error handling kicks in. That's annoying,
         // so we manually preserve the socket elsewhere to work around it.
         initialSocket?: net.Socket;
     }
 
-    class ServerHttp2Stream {
+    interface ServerHttp2Stream {
         // Treated the same as net.Socket, when we unwrap them in our combo server:
-        [LastHopEncrypted]?: net.Socket[typeof LastHopEncrypted];
-        [LastTunnelAddress]?: net.Socket[typeof LastTunnelAddress];
-        [SocketTimingInfo]?: net.Socket[typeof SocketTimingInfo];
+        [LastHopEncrypted]?: boolean;
+        [LastTunnelAddress]?: string;
+        [SocketTimingInfo]?: SocketTimingData;
         [SocketMetadata]?: SocketMetadata;
     }
 }
 
 export type SocketIsh<MinProps extends keyof net.Socket & keyof tls.TLSSocket> =
     streams.Duplex &
     Partial<Pick<net.Socket, MinProps>> &
-    Partial<Pick<tls.TLSSocket, MinProps>>;
+    Partial<Pick<tls.TLSSocket, MinProps>>;

tsconfig.json

@@ -1,14 +1,14 @@
 {
     "compilerOptions": {
-        "target": "ES2020",
+        "target": "ES2022",
         "module": "commonjs",
         "outDir": "./dist",
         "declaration": true,
         "sourceMap": true,
         "declarationMap": true,
         "strict": true,
         "lib": [
-            "ES2020",
+            "ES2022"
         ],
         "paths": {
             "https-proxy-agent": ["./custom-typings/proxy-agent-modules.d.ts"],