Add error field to aborted request events, when aborted by an error

pimterry · pimterry · commit 3ddcf06f2a79 · 2022-10-20T18:04:07.000+02:00
This applies to requests that were failed because the upstream
connection failed (more likely with the new error simulation option) or
because of connections that were intentionally closed by a rule.
diff --git a/src/admin/mockttp-admin-model.ts b/src/admin/mockttp-admin-model.ts
@@ -98,8 +98,8 @@ export function buildAdminServerModel(
     mockServer.on('abort', (evt) => {
         pubsub.publish(REQUEST_ABORTED_TOPIC, {
             requestAborted: Object.assign(evt, {
-                // Backward compat: old clients expect this to be present. In future this can be removed
-                // and abort events can switch from Request to InitiatedRequest in the schema.
+                // Backward compat: old clients expect this to be present. In future this can be
+                // removed and abort events can lose the 'body' in the schema.
                 body: Buffer.alloc(0)
             })
         })
diff --git a/src/admin/mockttp-schema.ts b/src/admin/mockttp-schema.ts
@@ -27,7 +27,7 @@ export const MockttpSchema = gql`
         webSocketMessageReceived: WebSocketMessage!
         webSocketMessageSent: WebSocketMessage!
         webSocketClose: WebSocketClose!
-        requestAborted: Request!
+        requestAborted: AbortedRequest!
         failedTlsRequest: TlsRequest!
         failedClientRequest: ClientError!
     }
@@ -126,6 +126,29 @@ export const MockttpSchema = gql`
         body: Buffer!
     }
 
+    type AbortedRequest {
+        id: ID!
+        timingEvents: Json!
+        tags: [String!]!
+        matchedRuleId: ID
+
+        protocol: String!
+        httpVersion: String!
+        method: String!
+        url: String!
+        path: String!
+        remoteIpAddress: String!
+        remotePort: Int!
+        hostname: String
+
+        headers: Json!
+        rawHeaders: Json!
+
+        body: Buffer!
+
+        error: Json
+    }
+
     type Response {
         id: ID!
         timingEvents: Json!
diff --git a/src/client/mockttp-admin-request-builder.ts b/src/client/mockttp-admin-request-builder.ts
@@ -351,6 +351,7 @@ export class MockttpAdminRequestBuilder {
 
                     ${this.schema.asOptionalField('Request', 'timingEvents')}
                     ${this.schema.asOptionalField('Request', 'tags')}
+                    ${this.schema.asOptionalField('AbortedRequest', 'error')}
                 }
             }`,
             'tls-client-error': gql`subscription OnTlsClientError {
@@ -421,6 +422,9 @@ export class MockttpAdminRequestBuilder {
                     }
                 } else if (event === 'websocket-message-received' || event === 'websocket-message-sent') {
                     normalizeWebSocketMessage(data);
+                } else if (event === 'abort') {
+                    normalizeHttpMessage(data, event);
+                    data.error = data.error ? JSON.parse(data.error) : undefined;
                 } else {
                     normalizeHttpMessage(data, event);
                 }
diff --git a/src/mockttp.ts b/src/mockttp.ts
@@ -17,7 +17,8 @@ import {
     ClientError,
     RulePriority,
     WebSocketMessage,
-    WebSocketClose
+    WebSocketClose,
+    AbortedRequest
 } from "./types";
 import type { RequestRuleData } from "./rules/requests/request-rule";
 import type { WebSocketRuleData } from "./rules/websockets/websocket-rule";
@@ -466,7 +467,7 @@ export interface Mockttp {
      *
      * @category Events
      */
-    on(event: 'abort', callback: (req: InitiatedRequest) => void): Promise<void>;
+    on(event: 'abort', callback: (req: AbortedRequest) => void): Promise<void>;
 
     /**
      * Subscribe to hear about requests that start a TLS handshake, but fail to complete it.
diff --git a/src/rules/requests/request-handlers.ts b/src/rules/requests/request-handlers.ts
@@ -115,7 +115,16 @@ export {
 
 // An error that indicates that the handler is aborting the request.
 // This could be intentional, or an upstream server aborting the request.
-export class AbortError extends TypedError { }
+export class AbortError extends TypedError {
+
+    constructor(
+        message: string,
+        readonly code?: string
+    ) {
+        super(message);
+    }
+
+}
 
 function isSerializedBuffer(obj: any): obj is SerializedBuffer {
     return obj && obj.type === 'Buffer' && !!obj.data;
@@ -184,7 +193,7 @@ export class CallbackHandler extends CallbackHandlerDefinition {
 
         if (outResponse === 'close') {
             (request as any).socket.end();
-            throw new AbortError('Connection closed (intentionally)');
+            throw new AbortError('Connection closed intentionally by rule');
         } else {
             await writeResponseFromCallback(outResponse, response);
         }
@@ -553,7 +562,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                 if (modifiedReq.response === 'close') {
                     const socket: net.Socket = (<any> clientReq).socket;
                     socket.end();
-                    throw new AbortError('Connection closed (intentionally)');
+                    throw new AbortError('Connection closed intentionally by rule');
                 } else {
                     // The callback has provided a full response: don't passthrough at all, just use it.
                     await writeResponseFromCallback(modifiedReq.response, clientRes);
@@ -825,7 +834,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                         // Dump the real response data and kill the client socket:
                         serverRes.resume();
                         (clientRes as any).socket.end();
-                        throw new AbortError('Connection closed (intentionally)');
+                        throw new AbortError('Connection closed intentionally by rule');
                     }
 
                     validateCustomHeaders(serverHeaders, modifiedRes?.headers);
@@ -946,7 +955,10 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                     } else {
                         socket.destroy();
                     }
-                    reject(new AbortError('Upstream connection failed'));
+
+                    reject(new AbortError(`Upstream connection error: ${
+                        e.message ?? e
+                    }`, e.code));
                 } else {
                     e.statusCode = 502;
                     e.statusMessage = 'Error communicating with upstream server';
@@ -1084,7 +1096,7 @@ export class CloseConnectionHandler extends CloseConnectionHandlerDefinition {
     async handle(request: OngoingRequest) {
         const socket: net.Socket = (<any> request).socket;
         socket.end();
-        throw new AbortError('Connection closed (intentionally)');
+        throw new AbortError('Connection closed intentionally by rule');
     }
 }
 
diff --git a/src/server/mockttp-server.ts b/src/server/mockttp-server.ts
@@ -33,7 +33,7 @@ import { ServerMockedEndpoint } from "./mocked-endpoint";
 import { createComboServer } from "./http-combo-server";
 import { filter } from "../util/promise";
 import { Mutable } from "../util/type-utils";
-import { isErrorLike } from "../util/error";
+import { ErrorLike, isErrorLike } from "../util/error";
 import { makePropertyWritable } from "../util/util";
 
 import {
@@ -480,12 +480,18 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
         });
     }
 
-    private async announceAbortAsync(request: OngoingRequest) {
+    private async announceAbortAsync(request: OngoingRequest, abortError?: ErrorLike) {
         setImmediate(() => {
             const req = buildInitiatedRequest(request);
             this.eventEmitter.emit('abort', Object.assign(req, {
                 timingEvents: _.clone(req.timingEvents),
-                tags: _.clone(req.tags)
+                tags: _.clone(req.tags),
+                error: abortError ? {
+                    name: abortError.name,
+                    code: abortError.code,
+                    message: abortError.message,
+                    stack: abortError.stack
+                } : undefined
             }));
         });
     }
@@ -582,18 +588,18 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
         if (this.debug) console.log(`Handling request for ${rawRequest.url}`);
 
         let result: 'responded' | 'aborted' | null = null;
-        const abort = () => {
+        const abort = (error?: Error) => {
             if (result === null) {
                 result = 'aborted';
                 request.timingEvents.abortedTimestamp = now();
-                this.announceAbortAsync(request);
+                this.announceAbortAsync(request, error);
             }
         }
         request.once('aborted', abort);
         // In Node 16+ we don't get an abort event in many cases, just closes, but we know
         // it's aborted because the response is closed with no other result being set.
         rawResponse.once('close', () => setImmediate(abort));
-        request.once('error', () => setImmediate(abort));
+        request.once('error', (error) => setImmediate(() => abort(error)));
 
         this.announceInitialRequestAsync(request);
 
@@ -606,7 +612,7 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
         response.id = request.id;
         response.on('error', (error) => {
             console.log('Response error:', this.debug ? error : error.message);
-            abort();
+            abort(error);
         });
 
         try {
@@ -631,7 +637,7 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
             result = result || 'responded';
         } catch (e) {
             if (e instanceof AbortError) {
-                abort();
+                abort(e);
 
                 if (this.debug) {
                     console.error("Failed to handle request due to abort:", e);
@@ -655,7 +661,7 @@ export class MockttpServer extends AbstractMockttp implements Mockttp {
                     response.end((isErrorLike(e) && e.toString()) || e);
                     result = result || 'responded';
                 } catch (e) {
-                    abort();
+                    abort(e as Error);
                 }
             }
         }
diff --git a/src/types.ts b/src/types.ts
@@ -139,6 +139,15 @@ export interface InitiatedRequest extends Request {
     timingEvents: TimingEvents;
 }
 
+export interface AbortedRequest extends InitiatedRequest {
+    error?: {
+        name?: string;
+        code?: string;
+        message?: string;
+        stack?: string;
+    };
+}
+
 // Internal & external representation of a fully completed HTTP request
 export interface CompletedRequest extends Request {
     body: CompletedBody;
diff --git a/test/integration/subscriptions/response-events.spec.ts b/test/integration/subscriptions/response-events.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -351,6 +351,7 @@ export class MockttpAdminRequestBuilder {`
`351`	`351`
`352`	`352`	`${this.schema.asOptionalField('Request', 'timingEvents')}`
`353`	`353`	`${this.schema.asOptionalField('Request', 'tags')}`
	`354`	`+ ${this.schema.asOptionalField('AbortedRequest', 'error')}`
`354`	`355`	`}`
`355`	`356`	}`,
`356`	`357`	'tls-client-error': gql`subscription OnTlsClientError {
`@@ -421,6 +422,9 @@ export class MockttpAdminRequestBuilder {`
`421`	`422`	`}`
`422`	`423`	`} else if (event === 'websocket-message-received' \|\| event === 'websocket-message-sent') {`
`423`	`424`	`normalizeWebSocketMessage(data);`
	`425`	`+ } else if (event === 'abort') {`
	`426`	`+ normalizeHttpMessage(data, event);`
	`427`	`+ data.error = data.error ? JSON.parse(data.error) : undefined;`
`424`	`428`	`} else {`
`425`	`429`	`normalizeHttpMessage(data, event);`
`426`	`430`	`}`