@zimic/interceptor 0.16.0-canary.1 → 0.16.0-canary.11

package/src/http/interceptorWorker/HttpInterceptorWorker.ts

@@ -13,7 +13,7 @@ import {
 } from '@zimic/http';
 import isDefined from '@zimic/utils/data/isDefined';
 import { Default, PossiblePromise } from '@zimic/utils/types';
-import chalk from 'chalk';
+import color from 'picocolors';
 
 import { removeArrayElement } from '@/utils/arrays';
 import { formatValueToLog, logWithPrefix } from '@/utils/console';
@@ -35,7 +35,6 @@ import {
 import { DEFAULT_UNHANDLED_REQUEST_STRATEGY } from './constants';
 import InvalidFormDataError from './errors/InvalidFormDataError';
 import InvalidJSONError from './errors/InvalidJSONError';
-import HttpInterceptorWorkerStore from './HttpInterceptorWorkerStore';
 import { HttpResponseFactory } from './types/requests';
 
 abstract class HttpInterceptorWorker {
@@ -47,8 +46,6 @@ abstract class HttpInterceptorWorker {
   private startingPromise?: Promise<void>;
   private stoppingPromise?: Promise<void>;
 
-  private store = new HttpInterceptorWorkerStore();
-
   private runningInterceptors: AnyHttpInterceptorClient[] = [];
 
   abstract start(): Promise<void>;
@@ -142,7 +139,7 @@ abstract class HttpInterceptorWorker {
     request: Request,
     interceptorType: HttpInterceptorType,
   ): Promise<UnhandledRequestStrategy.Declaration[]> {
-    const globalDefaultStrategy = this.getGlobalDefaultUnhandledRequestStrategy(interceptorType);
+    const globalDefaultStrategy = DEFAULT_UNHANDLED_REQUEST_STRATEGY[interceptorType];
 
     try {
       const interceptor = this.findInterceptorByRequestBaseURL(request);
@@ -152,20 +149,13 @@ abstract class HttpInterceptorWorker {
       }
 
       const requestClone = request.clone();
+      const interceptorStrategy = await this.getInterceptorUnhandledRequestStrategy(requestClone, interceptor);
 
-      const [defaultStrategy, interceptorStrategy] = await Promise.all([
-        this.getDefaultUnhandledRequestStrategy(request, interceptorType),
-        this.getInterceptorUnhandledRequestStrategy(requestClone, interceptor),
-      ]);
-
-      const candidatesOrPromises = [interceptorStrategy, defaultStrategy, globalDefaultStrategy];
-      const candidateStrategies = await Promise.all(candidatesOrPromises.filter(isDefined));
-      return candidateStrategies;
+      return [interceptorStrategy, globalDefaultStrategy].filter(isDefined);
     } catch (error) {
       console.error(error);
 
-      const candidateStrategies = [globalDefaultStrategy];
-      return candidateStrategies;
+      return [globalDefaultStrategy];
     }
   }
 
@@ -185,21 +175,6 @@ abstract class HttpInterceptorWorker {
     return interceptor;
   }
 
-  private getGlobalDefaultUnhandledRequestStrategy(interceptorType: HttpInterceptorType) {
-    return DEFAULT_UNHANDLED_REQUEST_STRATEGY[interceptorType];
-  }
-
-  private async getDefaultUnhandledRequestStrategy(request: Request, interceptorType: HttpInterceptorType) {
-    const defaultStrategyOrFactory = this.store.defaultOnUnhandledRequest(interceptorType);
-
-    if (typeof defaultStrategyOrFactory === 'function') {
-      const parsedRequest = await HttpInterceptorWorker.parseRawUnhandledRequest(request);
-      return defaultStrategyOrFactory(parsedRequest);
-    }
-
-    return defaultStrategyOrFactory;
-  }
-
   private async getInterceptorUnhandledRequestStrategy(request: Request, interceptor: AnyHttpInterceptorClient) {
     if (typeof interceptor.onUnhandledRequest === 'function') {
       const parsedRequest = await HttpInterceptorWorker.parseRawUnhandledRequest(request);
@@ -502,7 +477,7 @@ abstract class HttpInterceptorWorker {
     logWithPrefix(
       [
         `${action === 'bypass' ? 'Warning:' : 'Error:'} Request was not handled and was ` +
-          `${action === 'bypass' ? chalk.yellow('bypassed') : chalk.red('rejected')}.\n\n `,
+          `${action === 'bypass' ? color.yellow('bypassed') : color.red('rejected')}.\n\n `,
         `${request.method} ${request.url}`,
         '\n    Headers:',
         formattedHeaders,

package/src/http/requestHandler/HttpRequestHandlerClient.ts

@@ -91,7 +91,8 @@ class HttpRequestHandlerClient<
 
     newThis.numberOfMatchedRequests = 0;
     newThis.unmatchedRequestGroups.length = 0;
-    newThis._requests.length = 0;
+
+    newThis.clearInterceptedRequests();
 
     this.interceptor.registerRequestHandler(this.handler);
 
@@ -132,7 +133,7 @@ class HttpRequestHandlerClient<
         declarationPointer: this.timesDeclarationPointer,
         unmatchedRequestGroups: this.unmatchedRequestGroups,
         hasRestrictions: this.restrictions.length > 0,
-        hasSavedRequests: this.interceptor.saveRequests,
+        requestSaving: this.interceptor.requestSaving,
       });
     }
   }
@@ -148,7 +149,8 @@ class HttpRequestHandlerClient<
 
     this.numberOfMatchedRequests = 0;
     this.unmatchedRequestGroups.length = 0;
-    this._requests.length = 0;
+
+    this.clearInterceptedRequests();
 
     this.createResponseDeclaration = undefined;
 
@@ -168,7 +170,9 @@ class HttpRequestHandlerClient<
       this.numberOfMatchedRequests++;
     } else {
       const shouldSaveUnmatchedGroup =
-        this.interceptor.saveRequests && this.restrictions.length > 0 && this.timesDeclarationPointer !== undefined;
+        this.interceptor.requestSaving.enabled &&
+        this.restrictions.length > 0 &&
+        this.timesDeclarationPointer !== undefined;
 
       if (shouldSaveUnmatchedGroup) {
         this.unmatchedRequestGroups.push({ request, diff: restrictionsMatch.diff });
@@ -378,6 +382,12 @@ class HttpRequestHandlerClient<
   ) {
     const interceptedRequest = this.createInterceptedRequest(request, response);
     this._requests.push(interceptedRequest);
+    this.interceptor.incrementNumberOfSavedRequests(1);
+  }
+
+  private clearInterceptedRequests() {
+    this.interceptor.incrementNumberOfSavedRequests(-this._requests.length);
+    this._requests.length = 0;
   }
 
   private createInterceptedRequest(
@@ -401,7 +411,7 @@ class HttpRequestHandlerClient<
   }
 
   get requests(): readonly InterceptedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[] {
-    if (!this.interceptor.saveRequests) {
+    if (!this.interceptor.requestSaving.enabled) {
       throw new DisabledRequestSavingError();
     }
 

package/src/http/requestHandler/errors/DisabledRequestSavingError.ts

@@ -6,8 +6,8 @@
 class DisabledRequestSavingError extends TypeError {
   constructor() {
     super(
-      'Intercepted requests are not saved by default. ' +
-        'Did you forget to use `saveRequests: true` when creating the interceptor?\n\n' +
+      'Intercepted requests are not being saved. ' +
+        'Did you forget to use `requestSaving.enabled: true` in your interceptor?\n\n' +
         'Learn more: https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests',
     );
     this.name = 'DisabledRequestSavingError';

package/src/http/requestHandler/errors/TimesCheckError.ts

@@ -1,7 +1,8 @@
 import isNonEmpty from '@zimic/utils/data/isNonEmpty';
 import { Range } from '@zimic/utils/types';
-import chalk from 'chalk';
+import color from 'picocolors';
 
+import { HttpInterceptorRequestSaving } from '@/http/interceptor/types/public';
 import { stringifyValueToLog } from '@/utils/console';
 
 import { UnmatchedHttpInterceptorRequestGroup } from '../types/restrictions';
@@ -13,7 +14,7 @@ interface TimesCheckErrorOptions {
   declarationPointer: TimesDeclarationPointer | undefined;
   unmatchedRequestGroups: UnmatchedHttpInterceptorRequestGroup[];
   hasRestrictions: boolean;
-  hasSavedRequests: boolean;
+  requestSaving: HttpInterceptorRequestSaving;
 }
 
 function createMessageHeader({
@@ -45,15 +46,15 @@ function createMessageHeader({
     '.',
 
     unmatchedRequestGroups.length > 0 &&
-      `\n\nRequests evaluated by this handler:\n\n  ${chalk.green('- Expected')}\n  ${chalk.red('+ Received')}`,
+      `\n\nRequests evaluated by this handler:\n\n  ${color.green('- Expected')}\n  ${color.red('+ Received')}`,
   ]
     .filter((part) => part !== false)
     .join('');
 }
 
-function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesCheckErrorOptions) {
-  if (!hasSavedRequests) {
-    return 'Tip: enable `saveRequests: true` in your interceptor for more details about the unmatched requests.';
+function createMessageDiffs({ requestSaving, unmatchedRequestGroups }: TimesCheckErrorOptions) {
+  if (!requestSaving.enabled) {
+    return 'Tip: use `requestSaving.enabled: true` in your interceptor for more details about the unmatched requests.';
   }
 
   return unmatchedRequestGroups
@@ -68,8 +69,8 @@ function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesC
         const stringifiedExpected = stringifyValueToLog(diff.computed.expected);
         const stringifiedReceived = stringifyValueToLog(diff.computed.received);
 
-        messageParts.push(`  ${chalk.green(`- return ${stringifiedExpected}`)}`);
-        messageParts.push(`  ${chalk.red(`+ return ${stringifiedReceived}`)}`);
+        messageParts.push(`  ${color.green(`- return ${stringifiedExpected}`)}`);
+        messageParts.push(`  ${color.red(`+ return ${stringifiedReceived}`)}`);
       }
 
       if (diff.headers) {
@@ -78,8 +79,8 @@ function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesC
         const stringifiedExpected = stringifyValueToLog(diff.headers.expected);
         const stringifiedReceived = stringifyValueToLog(diff.headers.received);
 
-        messageParts.push(`  ${chalk.green(`- ${stringifiedExpected}`)}`);
-        messageParts.push(`  ${chalk.red(`+ ${stringifiedReceived}`)}`);
+        messageParts.push(`  ${color.green(`- ${stringifiedExpected}`)}`);
+        messageParts.push(`  ${color.red(`+ ${stringifiedReceived}`)}`);
       }
 
       if (diff.searchParams) {
@@ -88,8 +89,8 @@ function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesC
         const stringifiedExpected = stringifyValueToLog(diff.searchParams.expected);
         const stringifiedReceived = stringifyValueToLog(diff.searchParams.received);
 
-        messageParts.push(`  ${chalk.green(`- ${stringifiedExpected}`)}`);
-        messageParts.push(`  ${chalk.red(`+ ${stringifiedReceived}`)}`);
+        messageParts.push(`  ${color.green(`- ${stringifiedExpected}`)}`);
+        messageParts.push(`  ${color.red(`+ ${stringifiedReceived}`)}`);
       }
 
       if (diff.body) {
@@ -102,8 +103,8 @@ function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesC
           includeClassName: { searchParams: true },
         });
 
-        messageParts.push(`  ${chalk.green(`- ${stringifiedExpected}`)}`);
-        messageParts.push(`  ${chalk.red(`+ ${stringifiedReceived}`)}`);
+        messageParts.push(`  ${color.green(`- ${stringifiedExpected}`)}`);
+        messageParts.push(`  ${color.red(`+ ${stringifiedReceived}`)}`);
       }
 
       return messageParts.join('\n     ');

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

@@ -147,8 +147,9 @@ export interface LocalHttpRequestHandler<
    * that was not satisfied.
    *
    * When
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `saveRequests: true`}
-   * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
    * expected and received data. This is useful for debugging requests that did not match a handler with
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
    *
@@ -178,11 +179,14 @@ export interface LocalHttpRequestHandler<
    * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
    * useful for testing that the correct requests were made by your application.
    *
-   * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+   * **Important**: This method can only be used if
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in the interceptor. See
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * for more information.
    *
-   * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
+   * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
    * @readonly
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
    */
@@ -284,8 +288,9 @@ export interface SyncedRemoteHttpRequestHandler<
    * that was not satisfied.
    *
    * When
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `saveRequests: true`}
-   * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * true in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
    * expected and received data. This is useful for debugging requests that did not match a handler with
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
    *
@@ -315,11 +320,14 @@ export interface SyncedRemoteHttpRequestHandler<
    * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
    * useful for testing that the correct requests were made by your application.
    *
-   * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+   * **Important**: This method can only be used if
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in the interceptor. See
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * for more information.
    *
-   * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
+   * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
    * @readonly
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
    */

package/src/server/index.ts

@@ -1,5 +1,3 @@
-import InterceptorServerNamespace from './namespace/InterceptorServerNamespace';
-
 export { default as RunningInterceptorServerError } from './errors/RunningInterceptorServerError';
 export { default as NotRunningInterceptorServerError } from './errors/NotRunningInterceptorServerError';
 
@@ -8,12 +6,4 @@ export type { InterceptorServer } from './types/public';
 
 export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE } from './constants';
 
-/**
- * A namespace of interceptor server resources for handling HTTP requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/cli‐zimic‐server#zimic-server `zimic-interceptor server` API reference}
- * @see {@link https://github.com/zimicjs/zimic/wiki/getting‐started#remote-http-interceptors Remote HTTP Interceptors} .
- */
-export const interceptorServer = Object.freeze(new InterceptorServerNamespace());
-
-export type { InterceptorServerNamespace };
+export { createInterceptorServer } from './factory';

package/src/utils/console.ts

@@ -1,6 +1,6 @@
 import { HttpFormData, HttpHeaders, HttpSearchParams } from '@zimic/http';
 import createCachedDynamicImport from '@zimic/utils/import/createCachedDynamicImport';
-import chalk from 'chalk';
+import color from 'picocolors';
 
 import { isClientSide } from './environment';
 import { isGlobalFileAvailable } from './files';
@@ -84,5 +84,5 @@ export function logWithPrefix(messageOrMessages: unknown, options: { method?: 'l
   const { method = 'log' } = options;
 
   const messages = Array.isArray(messageOrMessages) ? messageOrMessages : [messageOrMessages];
-  console[method](chalk.cyan('[@zimic/interceptor]'), ...messages);
+  console[method](color.cyan('[@zimic/interceptor]'), ...messages);
 }