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

package/dist/http.mjs

@@ -1,4 +1,4 @@
-import color2 from 'picocolors';
+import chalk2 from 'chalk';
 import { HttpHeaders, HttpSearchParams, HttpFormData, HTTP_METHODS, HTTP_METHODS_WITH_RESPONSE_BODY } from '@zimic/http';
 import { http, passthrough } from 'msw';
 import * as mswBrowser from 'msw/browser';
@@ -8,6 +8,30 @@ import ClientSocket from 'isomorphic-ws';
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
+// src/http/interceptorWorker/errors/InvalidJSONError.ts
+var InvalidJSONError = class extends SyntaxError {
+  static {
+    __name(this, "InvalidJSONError");
+  }
+  constructor(value) {
+    super(`Failed to parse value as JSON: ${value}`);
+    this.name = "InvalidJSONError";
+  }
+};
+var InvalidJSONError_default = InvalidJSONError;
+
+// src/http/interceptorWorker/errors/InvalidFormDataError.ts
+var InvalidFormDataError = class extends SyntaxError {
+  static {
+    __name(this, "InvalidFormDataError");
+  }
+  constructor(value) {
+    super(`Failed to parse value as form data: ${value}`);
+    this.name = "InvalidFormDataError";
+  }
+};
+var InvalidFormDataError_default = InvalidFormDataError;
+
 // src/http/interceptor/errors/RunningHttpInterceptorError.ts
 var RunningHttpInterceptorError = class extends Error {
   static {
@@ -60,50 +84,6 @@ var UnknownHttpInterceptorTypeError = class extends TypeError {
 };
 var UnknownHttpInterceptorTypeError_default = UnknownHttpInterceptorTypeError;
 
-// src/http/interceptor/errors/RequestSavingSafeLimitExceededError.ts
-var RequestSavingSafeLimitExceededError = class extends TypeError {
-  static {
-    __name(this, "RequestSavingSafeLimitExceededError");
-  }
-  constructor(numberOfSavedRequests, safeLimit) {
-    super(
-      `The number of intercepted requests saved in memory (${numberOfSavedRequests}) exceeded the safe limit of ${safeLimit}. Did you forget to call \`interceptor.clear()\`?
-
-If you need to save requests, make sure to regularly call \`interceptor.clear()\`. Alternatively, you can hide this warning by increasing \`requestSaving.safeLimit\` in your interceptor. Note that saving too many requests in memory can lead to performance issues.
-
-If you do not need to save requests, consider setting \`requestSaving.enabled: false\` in your interceptor.
-
-Learn more: https://github.com/zimicjs/zimic/wiki/api\u2010zimic\u2010interceptor\u2010http#saving-requests`
-    );
-    this.name = "RequestSavingSafeLimitExceededError";
-  }
-};
-var RequestSavingSafeLimitExceededError_default = RequestSavingSafeLimitExceededError;
-
-// src/http/interceptorWorker/errors/InvalidFormDataError.ts
-var InvalidFormDataError = class extends SyntaxError {
-  static {
-    __name(this, "InvalidFormDataError");
-  }
-  constructor(value) {
-    super(`Failed to parse value as form data: ${value}`);
-    this.name = "InvalidFormDataError";
-  }
-};
-var InvalidFormDataError_default = InvalidFormDataError;
-
-// src/http/interceptorWorker/errors/InvalidJSONError.ts
-var InvalidJSONError = class extends SyntaxError {
-  static {
-    __name(this, "InvalidJSONError");
-  }
-  constructor(value) {
-    super(`Failed to parse value as JSON: ${value}`);
-    this.name = "InvalidJSONError";
-  }
-};
-var InvalidJSONError_default = InvalidJSONError;
-
 // src/cli/browser/shared/constants.ts
 var SERVICE_WORKER_FILE_NAME = "mockServiceWorker.js";
 
@@ -135,7 +115,7 @@ var DisabledRequestSavingError = class extends TypeError {
   }
   constructor() {
     super(
-      "Intercepted requests are not being saved. Did you forget to use `requestSaving.enabled: true` in your interceptor?\n\nLearn more: https://github.com/zimicjs/zimic/wiki/api\u2010zimic\u2010interceptor\u2010http#saving-requests"
+      "Intercepted requests are not being saved. Did you forget to use `saveRequests: true` when creating the interceptor?\n\nLearn more: https://github.com/zimicjs/zimic/wiki/api\u2010zimic\u2010interceptor\u2010http#saving-requests"
     );
     this.name = "DisabledRequestSavingError";
   }
@@ -248,7 +228,7 @@ __name(formatValueToLog, "formatValueToLog");
 function logWithPrefix(messageOrMessages, options = {}) {
   const { method = "log" } = options;
   const messages = Array.isArray(messageOrMessages) ? messageOrMessages : [messageOrMessages];
-  console[method](color2.cyan("[@zimic/interceptor]"), ...messages);
+  console[method](chalk2.cyan("[@zimic/interceptor]"), ...messages);
 }
 __name(logWithPrefix, "logWithPrefix");
 
@@ -274,14 +254,14 @@ function createMessageHeader({
 
 Requests evaluated by this handler:
 
-  ${color2.green("- Expected")}
-  ${color2.red("+ Received")}`
+  ${chalk2.green("- Expected")}
+  ${chalk2.red("+ Received")}`
   ].filter((part) => part !== false).join("");
 }
 __name(createMessageHeader, "createMessageHeader");
-function createMessageDiffs({ requestSaving, unmatchedRequestGroups }) {
-  if (!requestSaving.enabled) {
-    return "Tip: use `requestSaving.enabled: true` in your interceptor for more details about the unmatched requests.";
+function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }) {
+  if (!hasSavedRequests) {
+    return "Tip: enable `saveRequests: true` in your interceptor for more details about the unmatched requests.";
   }
   return unmatchedRequestGroups.map(({ request, diff }, index) => {
     const requestNumber = index + 1;
@@ -290,22 +270,22 @@ function createMessageDiffs({ requestSaving, unmatchedRequestGroups }) {
       messageParts.push("Computed restriction:");
       const stringifiedExpected = stringifyValueToLog(diff.computed.expected);
       const stringifiedReceived = stringifyValueToLog(diff.computed.received);
-      messageParts.push(`  ${color2.green(`- return ${stringifiedExpected}`)}`);
-      messageParts.push(`  ${color2.red(`+ return ${stringifiedReceived}`)}`);
+      messageParts.push(`  ${chalk2.green(`- return ${stringifiedExpected}`)}`);
+      messageParts.push(`  ${chalk2.red(`+ return ${stringifiedReceived}`)}`);
     }
     if (diff.headers) {
       messageParts.push("Headers:");
       const stringifiedExpected = stringifyValueToLog(diff.headers.expected);
       const stringifiedReceived = stringifyValueToLog(diff.headers.received);
-      messageParts.push(`  ${color2.green(`- ${stringifiedExpected}`)}`);
-      messageParts.push(`  ${color2.red(`+ ${stringifiedReceived}`)}`);
+      messageParts.push(`  ${chalk2.green(`- ${stringifiedExpected}`)}`);
+      messageParts.push(`  ${chalk2.red(`+ ${stringifiedReceived}`)}`);
     }
     if (diff.searchParams) {
       messageParts.push("Search params:");
       const stringifiedExpected = stringifyValueToLog(diff.searchParams.expected);
       const stringifiedReceived = stringifyValueToLog(diff.searchParams.received);
-      messageParts.push(`  ${color2.green(`- ${stringifiedExpected}`)}`);
-      messageParts.push(`  ${color2.red(`+ ${stringifiedReceived}`)}`);
+      messageParts.push(`  ${chalk2.green(`- ${stringifiedExpected}`)}`);
+      messageParts.push(`  ${chalk2.red(`+ ${stringifiedReceived}`)}`);
     }
     if (diff.body) {
       messageParts.push("Body:");
@@ -315,8 +295,8 @@ function createMessageDiffs({ requestSaving, unmatchedRequestGroups }) {
       const stringifiedReceived = stringifyValueToLog(diff.body.received, {
         includeClassName: { searchParams: true }
       });
-      messageParts.push(`  ${color2.green(`- ${stringifiedExpected}`)}`);
-      messageParts.push(`  ${color2.red(`+ ${stringifiedReceived}`)}`);
+      messageParts.push(`  ${chalk2.green(`- ${stringifiedExpected}`)}`);
+      messageParts.push(`  ${chalk2.red(`+ ${stringifiedReceived}`)}`);
     }
     return messageParts.join("\n     ");
   }).join("\n\n");
@@ -496,7 +476,7 @@ var HttpRequestHandlerClient = class {
     newThis.createResponseDeclaration = this.isResponseDeclarationFactory(declaration) ? declaration : () => declaration;
     newThis.numberOfMatchedRequests = 0;
     newThis.unmatchedRequestGroups.length = 0;
-    newThis.clearInterceptedRequests();
+    newThis._requests.length = 0;
     this.interceptor.registerRequestHandler(this.handler);
     return newThis;
   }
@@ -520,7 +500,7 @@ var HttpRequestHandlerClient = class {
         declarationPointer: this.timesDeclarationPointer,
         unmatchedRequestGroups: this.unmatchedRequestGroups,
         hasRestrictions: this.restrictions.length > 0,
-        requestSaving: this.interceptor.requestSaving
+        hasSavedRequests: this.interceptor.saveRequests
       });
     }
   }
@@ -532,7 +512,7 @@ var HttpRequestHandlerClient = class {
     this.timesDeclarationPointer = void 0;
     this.numberOfMatchedRequests = 0;
     this.unmatchedRequestGroups.length = 0;
-    this.clearInterceptedRequests();
+    this._requests.length = 0;
     this.createResponseDeclaration = void 0;
     return this;
   }
@@ -545,7 +525,7 @@ var HttpRequestHandlerClient = class {
     if (restrictionsMatch.value) {
       this.numberOfMatchedRequests++;
     } else {
-      const shouldSaveUnmatchedGroup = this.interceptor.requestSaving.enabled && this.restrictions.length > 0 && this.timesDeclarationPointer !== void 0;
+      const shouldSaveUnmatchedGroup = this.interceptor.saveRequests && this.restrictions.length > 0 && this.timesDeclarationPointer !== void 0;
       if (shouldSaveUnmatchedGroup) {
         this.unmatchedRequestGroups.push({ request, diff: restrictionsMatch.diff });
       }
@@ -679,11 +659,6 @@ var HttpRequestHandlerClient = class {
   saveInterceptedRequest(request, response) {
     const interceptedRequest = this.createInterceptedRequest(request, response);
     this._requests.push(interceptedRequest);
-    this.interceptor.incrementNumberOfSavedRequests(1);
-  }
-  clearInterceptedRequests() {
-    this.interceptor.incrementNumberOfSavedRequests(-this._requests.length);
-    this._requests.length = 0;
   }
   createInterceptedRequest(request, response) {
     const interceptedRequest = request;
@@ -696,7 +671,7 @@ var HttpRequestHandlerClient = class {
     return interceptedRequest;
   }
   get requests() {
-    if (!this.interceptor.requestSaving.enabled) {
+    if (!this.interceptor.saveRequests) {
       throw new DisabledRequestSavingError_default();
     }
     return this._requests;
@@ -1177,7 +1152,7 @@ var HttpInterceptorWorker = class _HttpInterceptorWorker {
     ]);
     logWithPrefix(
       [
-        `${action === "bypass" ? "Warning:" : "Error:"} Request was not handled and was ${action === "bypass" ? color2.yellow("bypassed") : color2.red("rejected")}.
+        `${action === "bypass" ? "Warning:" : "Error:"} Request was not handled and was ${action === "bypass" ? chalk2.yellow("bypassed") : chalk2.red("rejected")}.
 
  `,
         `${request.method} ${request.url}`,
@@ -1484,7 +1459,6 @@ var RemoteHttpRequestHandler_default = RemoteHttpRequestHandler;
 
 // src/http/interceptor/HttpInterceptorClient.ts
 var SUPPORTED_BASE_URL_PROTOCOLS = Object.freeze(["http", "https"]);
-var DEFAULT_REQUEST_SAVING_SAFE_LIMIT = 1e3;
 var HttpInterceptorClient = class {
   static {
     __name(this, "HttpInterceptorClient");
@@ -1492,8 +1466,7 @@ var HttpInterceptorClient = class {
   worker;
   store;
   _baseURL;
-  requestSaving;
-  numberOfSavedRequests = 0;
+  _saveRequests;
   onUnhandledRequest;
   isRunning = false;
   Handler;
@@ -1510,16 +1483,10 @@ var HttpInterceptorClient = class {
     this.worker = options.worker;
     this.store = options.store;
     this.baseURL = options.baseURL;
-    this.requestSaving = {
-      enabled: options.requestSaving?.enabled ?? this.getDefaultRequestSavingEnabled(),
-      safeLimit: options.requestSaving?.safeLimit ?? DEFAULT_REQUEST_SAVING_SAFE_LIMIT
-    };
+    this._saveRequests = options.saveRequests;
     this.onUnhandledRequest = options.onUnhandledRequest;
     this.Handler = options.Handler;
   }
-  getDefaultRequestSavingEnabled() {
-    return isServerSide() ? process.env.NODE_ENV === "test" : false;
-  }
   get baseURL() {
     return this._baseURL;
   }
@@ -1539,6 +1506,15 @@ var HttpInterceptorClient = class {
     }
     return this.baseURL.href;
   }
+  get saveRequests() {
+    if (this._saveRequests === void 0) {
+      return isServerSide() ? process.env.NODE_ENV === "test" : false;
+    }
+    return this._saveRequests;
+  }
+  set saveRequests(saveRequests) {
+    this._saveRequests = saveRequests;
+  }
   get platform() {
     return this.worker.platform;
   }
@@ -1636,21 +1612,13 @@ var HttpInterceptorClient = class {
     }
     const responseDeclaration = await matchedHandler.applyResponseDeclaration(parsedRequest);
     const response = HttpInterceptorWorker_default.createResponseFromDeclaration(request, responseDeclaration);
-    if (this.requestSaving.enabled) {
+    if (this.saveRequests) {
       const responseClone = response.clone();
       const parsedResponse = await HttpInterceptorWorker_default.parseRawResponse(responseClone);
       matchedHandler.saveInterceptedRequest(parsedRequest, parsedResponse);
     }
     return response;
   }
-  incrementNumberOfSavedRequests(increment) {
-    this.numberOfSavedRequests = Math.max(this.numberOfSavedRequests + increment, 0);
-    const exceedsSafeLimit = this.numberOfSavedRequests > this.requestSaving.safeLimit;
-    if (increment > 0 && exceedsSafeLimit) {
-      const error = new RequestSavingSafeLimitExceededError_default(this.numberOfSavedRequests, this.requestSaving.safeLimit);
-      console.warn(error);
-    }
-  }
   async findMatchedHandler(method, path, parsedRequest) {
     const handlersByPath = this.handlerClientsByMethod[method].get(path) ?? [];
     for (let handlerIndex = handlersByPath.length - 1; handlerIndex >= 0; handlerIndex--) {
@@ -2399,7 +2367,7 @@ var LocalHttpInterceptor = class {
       baseURL,
       Handler: LocalHttpRequestHandler_default,
       onUnhandledRequest: options.onUnhandledRequest,
-      requestSaving: options.requestSaving
+      saveRequests: options.saveRequests
     });
   }
   get type() {
@@ -2411,11 +2379,11 @@ var LocalHttpInterceptor = class {
   set baseURL(baseURL) {
     this.client.baseURL = new URL(baseURL);
   }
-  get requestSaving() {
-    return this.client.requestSaving;
+  get saveRequests() {
+    return this.client.saveRequests;
   }
-  set requestSaving(requestSaving) {
-    this.client.requestSaving = requestSaving;
+  set saveRequests(saveRequests) {
+    this.client.saveRequests = saveRequests;
   }
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;
@@ -2489,7 +2457,7 @@ var RemoteHttpInterceptor = class {
       baseURL,
       Handler: RemoteHttpRequestHandler_default,
       onUnhandledRequest: options.onUnhandledRequest,
-      requestSaving: options.requestSaving
+      saveRequests: options.saveRequests
     });
   }
   get type() {
@@ -2501,11 +2469,11 @@ var RemoteHttpInterceptor = class {
   set baseURL(baseURL) {
     this.client.baseURL = new URL(baseURL);
   }
-  get requestSaving() {
-    return this.client.requestSaving;
+  get saveRequests() {
+    return this.client.saveRequests;
   }
-  set requestSaving(requestSaving) {
-    this.client.requestSaving = requestSaving;
+  set saveRequests(saveRequests) {
+    this.client.saveRequests = saveRequests;
   }
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;
@@ -2608,6 +2576,6 @@ __name(createHttpInterceptor, "createHttpInterceptor");
  * Reply listeners are always present when notified in normal conditions. If they were not present, the request
  * would reach a timeout and not be responded. The empty set serves as a fallback. */
 
-export { DisabledRequestSavingError_default as DisabledRequestSavingError, InvalidFormDataError_default as InvalidFormDataError, InvalidJSONError_default as InvalidJSONError, NotRunningHttpInterceptorError_default as NotRunningHttpInterceptorError, RequestSavingSafeLimitExceededError_default as RequestSavingSafeLimitExceededError, RunningHttpInterceptorError_default as RunningHttpInterceptorError, TimesCheckError_default as TimesCheckError, UnknownHttpInterceptorPlatformError_default as UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError_default as UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError_default as UnregisteredBrowserServiceWorkerError, createHttpInterceptor };
+export { DisabledRequestSavingError_default as DisabledRequestSavingError, InvalidFormDataError_default as InvalidFormDataError, InvalidJSONError_default as InvalidJSONError, NotRunningHttpInterceptorError_default as NotRunningHttpInterceptorError, RunningHttpInterceptorError_default as RunningHttpInterceptorError, TimesCheckError_default as TimesCheckError, UnknownHttpInterceptorPlatformError_default as UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError_default as UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError_default as UnregisteredBrowserServiceWorkerError, createHttpInterceptor };
 //# sourceMappingURL=http.mjs.map
 //# sourceMappingURL=http.mjs.map