@zimic/interceptor 1.1.7 → 1.2.0-canary.0

package/dist/server.js

@@ -1,29 +1,29 @@
 'use strict';
 
-var chunkC4BVIHSP_js = require('./chunk-C4BVIHSP.js');
+var chunk6VVX2QLH_js = require('./chunk-6VVX2QLH.js');
 require('./chunk-DGUM43GV.js');
 
 
 
 Object.defineProperty(exports, "DEFAULT_ACCESS_CONTROL_HEADERS", {
   enumerable: true,
-  get: function () { return chunkC4BVIHSP_js.DEFAULT_ACCESS_CONTROL_HEADERS; }
+  get: function () { return chunk6VVX2QLH_js.DEFAULT_ACCESS_CONTROL_HEADERS; }
 });
 Object.defineProperty(exports, "DEFAULT_PREFLIGHT_STATUS_CODE", {
   enumerable: true,
-  get: function () { return chunkC4BVIHSP_js.DEFAULT_PREFLIGHT_STATUS_CODE; }
+  get: function () { return chunk6VVX2QLH_js.DEFAULT_PREFLIGHT_STATUS_CODE; }
 });
 Object.defineProperty(exports, "NotRunningInterceptorServerError", {
   enumerable: true,
-  get: function () { return chunkC4BVIHSP_js.NotRunningInterceptorServerError_default; }
+  get: function () { return chunk6VVX2QLH_js.NotRunningInterceptorServerError_default; }
 });
 Object.defineProperty(exports, "RunningInterceptorServerError", {
   enumerable: true,
-  get: function () { return chunkC4BVIHSP_js.RunningInterceptorServerError_default; }
+  get: function () { return chunk6VVX2QLH_js.RunningInterceptorServerError_default; }
 });
 Object.defineProperty(exports, "createInterceptorServer", {
   enumerable: true,
-  get: function () { return chunkC4BVIHSP_js.createInterceptorServer; }
+  get: function () { return chunk6VVX2QLH_js.createInterceptorServer; }
 });
 //# sourceMappingURL=server.js.map
 //# sourceMappingURL=server.js.map

package/dist/server.mjs

@@ -1,4 +1,4 @@
-export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, NotRunningInterceptorServerError_default as NotRunningInterceptorServerError, RunningInterceptorServerError_default as RunningInterceptorServerError, createInterceptorServer } from './chunk-YPRAL5BM.mjs';
+export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, NotRunningInterceptorServerError_default as NotRunningInterceptorServerError, RunningInterceptorServerError_default as RunningInterceptorServerError, createInterceptorServer } from './chunk-HHCXRRYN.mjs';
 import './chunk-BJTO5JO5.mjs';
 //# sourceMappingURL=server.mjs.map
 //# sourceMappingURL=server.mjs.map

package/package.json

@@ -14,7 +14,7 @@
     "api",
     "static"
   ],
-  "version": "1.1.7",
+  "version": "1.2.0-canary.0",
   "homepage": "https://zimic.dev/docs/interceptor",
   "repository": {
     "type": "git",

package/src/http/index.ts

@@ -17,6 +17,7 @@ export { default as TimesCheckError } from './requestHandler/errors/TimesCheckEr
 export type {
   HttpRequestHandlerResponseDeclaration,
   HttpRequestHandlerResponseDeclarationFactory,
+  HttpRequestHandlerResponseDelayFactory,
   HttpInterceptorRequest,
   HttpInterceptorResponse,
   InterceptedHttpInterceptorRequest,

package/src/http/requestHandler/HttpRequestHandlerClient.ts

@@ -12,9 +12,11 @@ import {
 import blobEquals from '@zimic/utils/data/blobEquals';
 import jsonContains from '@zimic/utils/data/jsonContains';
 import jsonEquals from '@zimic/utils/data/jsonEquals';
+import waitForDelay from '@zimic/utils/time/waitForDelay';
 import { Default, Range } from '@zimic/utils/types';
 
 import { convertArrayBufferToBlob, convertReadableStreamToBlob } from '@/utils/data';
+import { random } from '@/utils/numbers';
 
 import HttpInterceptorClient from '../interceptor/HttpInterceptorClient';
 import DisabledRequestSavingError from './errors/DisabledRequestSavingError';
@@ -27,6 +29,7 @@ import {
   HttpInterceptorResponse,
   HttpRequestHandlerResponseDeclaration,
   HttpRequestHandlerResponseDeclarationFactory,
+  HttpRequestHandlerResponseDelayFactory,
   InterceptedHttpInterceptorRequest,
 } from './types/requests';
 import {
@@ -60,7 +63,7 @@ class HttpRequestHandlerClient<
     numberOfRequests: DEFAULT_NUMBER_OF_REQUEST_LIMITS,
   };
 
-  private timesDeclarationPointer?: TimesDeclarationPointer;
+  private timesPointer?: TimesDeclarationPointer;
 
   private numberOfMatchedRequests = 0;
   private unmatchedRequestGroups: UnmatchedHttpInterceptorRequestGroup[] = [];
@@ -72,6 +75,8 @@ class HttpRequestHandlerClient<
     StatusCode
   >;
 
+  private createResponseDelay?: HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>;
+
   constructor(
     private interceptor: HttpInterceptorClient<Schema>,
     public method: Method,
@@ -84,6 +89,28 @@ class HttpRequestHandlerClient<
     return this;
   }
 
+  delay(
+    minMilliseconds: number | HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>,
+    maxMilliseconds?: number,
+  ): this {
+    if (minMilliseconds === maxMilliseconds) {
+      return this.delay(minMilliseconds);
+    }
+
+    if (typeof minMilliseconds === 'number' && typeof maxMilliseconds === 'number') {
+      this.createResponseDelay = () => random(minMilliseconds, maxMilliseconds);
+      return this;
+    }
+
+    if (typeof minMilliseconds === 'number') {
+      this.createResponseDelay = () => minMilliseconds;
+      return this;
+    }
+
+    this.createResponseDelay = minMilliseconds;
+    return this;
+  }
+
   respond<NewStatusCode extends HttpStatusCode>(
     declaration:
       | HttpRequestHandlerResponseDeclaration<Default<Schema[Path][Method]>, NewStatusCode>
@@ -122,7 +149,7 @@ class HttpRequestHandlerClient<
       max: maxNumberOfRequests ?? minNumberOfRequests,
     };
 
-    this.timesDeclarationPointer = new TimesDeclarationPointer(minNumberOfRequests, maxNumberOfRequests);
+    this.timesPointer = new TimesDeclarationPointer(minNumberOfRequests, maxNumberOfRequests);
 
     return this;
   }
@@ -136,7 +163,7 @@ class HttpRequestHandlerClient<
       throw new TimesCheckError({
         requestLimits: this.limits.numberOfRequests,
         numberOfMatchedRequests: this.numberOfMatchedRequests,
-        declarationPointer: this.timesDeclarationPointer,
+        declarationPointer: this.timesPointer,
         unmatchedRequestGroups: this.unmatchedRequestGroups,
         hasRestrictions: this.restrictions.length > 0,
         requestSaving: this.interceptor.requestSaving,
@@ -151,7 +178,7 @@ class HttpRequestHandlerClient<
       numberOfRequests: DEFAULT_NUMBER_OF_REQUEST_LIMITS,
     };
 
-    this.timesDeclarationPointer = undefined;
+    this.timesPointer = undefined;
 
     this.numberOfMatchedRequests = 0;
     this.unmatchedRequestGroups.length = 0;
@@ -159,6 +186,7 @@ class HttpRequestHandlerClient<
     this.clearInterceptedRequests();
 
     this.createResponseDeclaration = undefined;
+    this.createResponseDelay = undefined;
 
     return this;
   }
@@ -196,9 +224,7 @@ class HttpRequestHandlerClient<
     options: { diff: RestrictionDiffs },
   ) {
     const shouldSaveUnmatchedRequests =
-      this.interceptor.requestSaving.enabled &&
-      this.restrictions.length > 0 &&
-      this.timesDeclarationPointer !== undefined;
+      this.interceptor.requestSaving.enabled && this.restrictions.length > 0 && this.timesPointer !== undefined;
 
     if (shouldSaveUnmatchedRequests) {
       this.unmatchedRequestGroups.push({ request, diff: options.diff });
@@ -414,6 +440,14 @@ class HttpRequestHandlerClient<
       throw new NoResponseDefinitionError();
     }
 
+    if (this.createResponseDelay) {
+      const delay = await this.createResponseDelay(request);
+
+      if (delay > 0) {
+        await waitForDelay(delay);
+      }
+    }
+
     const appliedDeclaration = await this.createResponseDeclaration(request);
     return appliedDeclaration;
   }

package/src/http/requestHandler/LocalHttpRequestHandler.ts

@@ -9,6 +9,7 @@ import {
   HttpInterceptorResponse,
   HttpRequestHandlerResponseDeclaration,
   HttpRequestHandlerResponseDeclarationFactory,
+  HttpRequestHandlerResponseDelayFactory,
   InterceptedHttpInterceptorRequest,
 } from './types/requests';
 import { HttpRequestHandlerRestriction } from './types/restrictions';
@@ -41,6 +42,14 @@ class LocalHttpRequestHandler<
     return this;
   }
 
+  delay(
+    minMilliseconds: number | HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>,
+    maxMilliseconds?: number,
+  ): this {
+    this.client.delay(minMilliseconds, maxMilliseconds);
+    return this;
+  }
+
   respond<NewStatusCode extends HttpStatusCode>(
     declaration:
       | HttpRequestHandlerResponseDeclaration<Default<Schema[Path][Method]>, NewStatusCode>

package/src/http/requestHandler/RemoteHttpRequestHandler.ts

@@ -12,6 +12,7 @@ import {
   HttpInterceptorResponse,
   HttpRequestHandlerResponseDeclaration,
   HttpRequestHandlerResponseDeclarationFactory,
+  HttpRequestHandlerResponseDelayFactory,
   InterceptedHttpInterceptorRequest,
 } from './types/requests';
 import { HttpRequestHandlerRestriction } from './types/restrictions';
@@ -75,6 +76,14 @@ class RemoteHttpRequestHandler<
     return this.unsynced;
   }
 
+  delay(
+    minMilliseconds: number | HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>,
+    maxMilliseconds?: number,
+  ): this {
+    this.client.delay(minMilliseconds, maxMilliseconds);
+    return this.unsynced;
+  }
+
   respond<NewStatusCode extends HttpStatusCode>(
     declaration:
       | HttpRequestHandlerResponseDeclaration<Default<Schema[Path][Method]>, NewStatusCode>

package/src/http/requestHandler/types/public.ts

@@ -11,6 +11,7 @@ import HttpRequestHandlerClient from '../HttpRequestHandlerClient';
 import {
   HttpRequestHandlerResponseDeclaration,
   HttpRequestHandlerResponseDeclarationFactory,
+  HttpRequestHandlerResponseDelayFactory,
   InterceptedHttpInterceptorRequest,
 } from './requests';
 import { HttpRequestHandlerRestriction } from './restrictions';
@@ -56,6 +57,12 @@ export interface LocalHttpRequestHandler<
   /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
   with: (restriction: HttpRequestHandlerRestriction<Schema, Method, Path>) => this;
 
+  /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerdelay `handler.delay()` API reference} */
+  delay: ((
+    milliseconds: number | HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>,
+  ) => this) &
+    ((minMilliseconds: number, maxMilliseconds: number) => this);
+
   /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
   respond: <NewStatusCode extends HttpResponseSchemaStatusCode<Default<Default<Schema[Path][Method]>['response']>>>(
     declaration:
@@ -99,6 +106,15 @@ export interface SyncedRemoteHttpRequestHandler<
     restriction: HttpRequestHandlerRestriction<Schema, Method, Path>,
   ) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>;
 
+  /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerdelay `handler.delay()` API reference} */
+  delay: ((
+    milliseconds: number | HttpRequestHandlerResponseDelayFactory<Path, Default<Schema[Path][Method]>>,
+  ) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>) &
+    ((
+      minMilliseconds: number,
+      maxMilliseconds: number,
+    ) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>);
+
   /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
   respond: <NewStatusCode extends HttpResponseSchemaStatusCode<Default<Default<Schema[Path][Method]>['response']>>>(
     declaration:

package/src/http/requestHandler/types/requests.ts

@@ -62,6 +62,11 @@ export type HttpRequestHandlerResponseDeclarationFactory<
   request: Omit<HttpInterceptorRequest<Path, MethodSchema>, 'response'>,
 ) => PossiblePromise<HttpRequestHandlerResponseDeclaration<MethodSchema, StatusCode>>;
 
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerdelay `handler.delay()` API reference} */
+export type HttpRequestHandlerResponseDelayFactory<Path extends string, MethodSchema extends HttpMethodSchema> = (
+  request: Omit<HttpInterceptorRequest<Path, MethodSchema>, 'response'>,
+) => PossiblePromise<number>;
+
 /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference} */
 export interface HttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema>
   extends Omit<HttpRequest, keyof Body | 'headers' | 'clone'> {

package/src/utils/numbers.ts

@@ -1,4 +1,13 @@
+export function random(lowerLimit: number, upperLimit: number): number {
+  const range = Math.max(upperLimit - lowerLimit, 0);
+
+  if (range === 0) {
+    return lowerLimit;
+  }
+
+  return Math.random() * range + lowerLimit;
+}
+
 export function randomInt(lowerLimit: number, upperLimit: number): number {
-  const range = upperLimit - lowerLimit;
-  return Math.floor(Math.random() * range + lowerLimit);
+  return Math.floor(random(lowerLimit, upperLimit));
 }

package/src/utils/time.ts

@@ -0,0 +1,10 @@
+export async function usingElapsedTime<ReturnType>(callback: () => Promise<ReturnType>) {
+  const startTime = performance.now();
+
+  const result = await callback();
+
+  const endTime = performance.now();
+  const elapsedTime = endTime - startTime;
+
+  return { result, startTime, endTime, elapsedTime };
+}