import { Buffer } from 'buffer'; import { Writable } from 'stream'; import * as _ from 'lodash'; import { OngoingRequest, CompletedRequest, OngoingResponse, Explainable, RulePriority } from "../../types"; import { buildBodyReader, buildInitiatedRequest, waitForCompletedRequest } from '../../util/request-utils'; import { joinAnd, MaybePromise } from '@httptoolkit/util'; import * as matchers from "../matchers"; import { type RequestStepDefinition } from "./request-step-definitions"; import { StepLookup, RequestStepImpl } from "./request-step-impls"; import * as completionCheckers from "../completion-checkers"; import { validateMockRuleData } from '../rule-serialization'; // The internal representation of a mocked endpoint export interface RequestRule extends Explainable { id: string; requests: Promise[]; // We don't extend the main interfaces for these, because MockRules are not Serializable matches(request: OngoingRequest): MaybePromise; handle(request: OngoingRequest, response: OngoingResponse, options: { record: boolean, debug: boolean, keyLogStream?: Writable, emitEventCallback?: (type: string, event: unknown) => void }): Promise; isComplete(): boolean | null; } export interface RequestRuleData { id?: string; priority?: number; // Higher is higher, by default 0 is fallback, 1 is normal, must be positive matchers: matchers.RequestMatcher[]; steps: Array; completionChecker?: completionCheckers.RuleCompletionChecker; } export class RequestRule implements RequestRule { private matchers: matchers.RequestMatcher[]; private steps: Array; private completionChecker?: completionCheckers.RuleCompletionChecker; public id: string; public readonly priority: number; public requests: Promise[] = []; public requestCount = 0; constructor(data: RequestRuleData) { validateMockRuleData(data); this.id = data.id || crypto.randomUUID(); this.priority = data.priority ?? RulePriority.DEFAULT; this.matchers = data.matchers; this.completionChecker = data.completionChecker; this.steps = data.steps.map((stepDefinition: S, i: number) => { const StepImplClass = StepLookup[stepDefinition.type]; if (StepImplClass.isFinal && i !== data.steps.length - 1) { throw new Error( `Cannot create a rule with a final step before the last position ("${ stepDefinition.explain() }" in position ${i + 1} of ${data.steps.length})` ); } // All step impls have a fromDefinition static method that turns a definition into a // full impl (copying data and initializing any impl-only fields). Note that for remote clients, // the definition itself has already been deserialized by impl.deserialize(data) beforehand. return StepImplClass.fromDefinition(stepDefinition as any) as RequestStepImpl; }); } matches(request: OngoingRequest) { return matchers.matchesAll(request, this.matchers); } handle(req: OngoingRequest, res: OngoingResponse, options: { record?: boolean, debug: boolean, keyLogStream?: Writable, emitEventCallback?: (type: string, event: unknown) => void }): Promise { let stepsPromise = (async () => { for (let step of this.steps) { const result = await step.handle(req, res, { emitEventCallback: options.emitEventCallback, keyLogStream: options.keyLogStream, debug: options.debug }); if (!result || result.continue === false) break; } })(); // Requests are added to rule.requests as soon as they start being handled, // as promises, which resolve only when the response & request body is complete. if (options.record) { this.requests.push( Promise.race([ // When the steps all resolve, the request is completed: stepsPromise, // If the response is closed before the step completes (due to aborts, step // timeouts, whatever) then that also counts as the request being completed: new Promise((resolve) => res.on('close', resolve)) ]) .catch(() => {}) // Ignore step errors here - we're only tracking the request .then(() => waitForCompletedRequest(req)) .catch((): CompletedRequest => { // If for some reason the request is not completed, we still want to record it. // TODO: Update the body to return the data that has been received so far. const initiatedRequest = buildInitiatedRequest(req); return { ...initiatedRequest, body: buildBodyReader(Buffer.from([]), req.headers), rawTrailers: [], trailers: {} }; }) ); } // Even if traffic recording is disabled, the number of matched // requests is still tracked this.requestCount += 1; return stepsPromise as Promise; } isComplete(): boolean | null { if (this.completionChecker) { // If we have a specific rule, use that return this.completionChecker.isComplete(this.requestCount); } else if (this.requestCount === 0) { // Otherwise, by default we're definitely incomplete if we've seen no requests return false; } else { // And we're _maybe_ complete if we've seen at least one request. In reality, we're incomplete // but we should be used anyway if we're at any point we're the last matching rule for a request. return null; } } explain(withoutExactCompletion = false): string { let explanation = `Match ${ this.priority === RulePriority.FALLBACK ? 'otherwise unmatched ' : '' }requests ${ matchers.explainMatchers(this.matchers) }, and ${ explainSteps(this.steps) }`; if (this.completionChecker) { explanation += `, ${this.completionChecker.explain( withoutExactCompletion ? undefined : this.requestCount )}.`; } else { explanation += '.'; } return explanation; } dispose() { this.steps.forEach(s => s.dispose()); this.matchers.forEach(m => m.dispose()); if (this.completionChecker) this.completionChecker.dispose(); } } export function explainSteps(steps: RequestStepDefinition[]) { return joinAnd(steps.map(s => s.explain()), { finalSeparator: 'then ', oxfordComma: true }); }