@zimic/interceptor 0.16.0-canary.5 → 0.16.0-canary.6

package/dist/http.js

@@ -142,7 +142,7 @@ var DisabledRequestSavingError = class extends TypeError {
   }
   constructor() {
     super(
-      "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"
+      "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"
     );
     this.name = "DisabledRequestSavingError";
   }
@@ -286,9 +286,9 @@ Requests evaluated by this handler:
   ].filter((part) => part !== false).join("");
 }
 __name(createMessageHeader, "createMessageHeader");
-function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }) {
-  if (!hasSavedRequests) {
-    return "Tip: enable `saveRequests: true` in your interceptor for more details about the unmatched requests.";
+function createMessageDiffs({ requestSaving, unmatchedRequestGroups }) {
+  if (!requestSaving.enabled) {
+    return "Tip: use `requestSaving.enabled: true` in your interceptor for more details about the unmatched requests.";
   }
   return unmatchedRequestGroups.map(({ request, diff }, index) => {
     const requestNumber = index + 1;
@@ -503,7 +503,7 @@ var HttpRequestHandlerClient = class {
     newThis.createResponseDeclaration = this.isResponseDeclarationFactory(declaration) ? declaration : () => declaration;
     newThis.numberOfMatchedRequests = 0;
     newThis.unmatchedRequestGroups.length = 0;
-    newThis._requests.length = 0;
+    newThis.clearInterceptedRequests();
     this.interceptor.registerRequestHandler(this.handler);
     return newThis;
   }
@@ -527,7 +527,7 @@ var HttpRequestHandlerClient = class {
         declarationPointer: this.timesDeclarationPointer,
         unmatchedRequestGroups: this.unmatchedRequestGroups,
         hasRestrictions: this.restrictions.length > 0,
-        hasSavedRequests: this.interceptor.saveRequests
+        requestSaving: this.interceptor.requestSaving
       });
     }
   }
@@ -539,7 +539,7 @@ var HttpRequestHandlerClient = class {
     this.timesDeclarationPointer = void 0;
     this.numberOfMatchedRequests = 0;
     this.unmatchedRequestGroups.length = 0;
-    this._requests.length = 0;
+    this.clearInterceptedRequests();
     this.createResponseDeclaration = void 0;
     return this;
   }
@@ -552,7 +552,7 @@ var HttpRequestHandlerClient = class {
     if (restrictionsMatch.value) {
       this.numberOfMatchedRequests++;
     } else {
-      const shouldSaveUnmatchedGroup = this.interceptor.saveRequests && this.restrictions.length > 0 && this.timesDeclarationPointer !== void 0;
+      const shouldSaveUnmatchedGroup = this.interceptor.requestSaving.enabled && this.restrictions.length > 0 && this.timesDeclarationPointer !== void 0;
       if (shouldSaveUnmatchedGroup) {
         this.unmatchedRequestGroups.push({ request, diff: restrictionsMatch.diff });
       }
@@ -686,6 +686,11 @@ 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;
@@ -698,7 +703,7 @@ var HttpRequestHandlerClient = class {
     return interceptedRequest;
   }
   get requests() {
-    if (!this.interceptor.saveRequests) {
+    if (!this.interceptor.requestSaving.enabled) {
       throw new DisabledRequestSavingError_default();
     }
     return this._requests;
@@ -1484,8 +1489,29 @@ var RemoteHttpRequestHandler = class {
 };
 var RemoteHttpRequestHandler_default = RemoteHttpRequestHandler;
 
+// 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/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");
@@ -1493,7 +1519,8 @@ var HttpInterceptorClient = class {
   worker;
   store;
   _baseURL;
-  _saveRequests;
+  requestSaving;
+  numberOfSavedRequests = 0;
   onUnhandledRequest;
   isRunning = false;
   Handler;
@@ -1510,7 +1537,10 @@ var HttpInterceptorClient = class {
     this.worker = options.worker;
     this.store = options.store;
     this.baseURL = options.baseURL;
-    this._saveRequests = options.saveRequests;
+    this.requestSaving = {
+      enabled: options.requestSaving?.enabled ?? (isServerSide() ? process.env.NODE_ENV === "test" : false),
+      safeLimit: options.requestSaving?.safeLimit ?? DEFAULT_REQUEST_SAVING_SAFE_LIMIT
+    };
     this.onUnhandledRequest = options.onUnhandledRequest;
     this.Handler = options.Handler;
   }
@@ -1533,15 +1563,6 @@ 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;
   }
@@ -1639,13 +1660,21 @@ var HttpInterceptorClient = class {
     }
     const responseDeclaration = await matchedHandler.applyResponseDeclaration(parsedRequest);
     const response = HttpInterceptorWorker_default.createResponseFromDeclaration(request, responseDeclaration);
-    if (this.saveRequests) {
+    if (this.requestSaving.enabled) {
       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--) {
@@ -2394,7 +2423,7 @@ var LocalHttpInterceptor = class {
       baseURL,
       Handler: LocalHttpRequestHandler_default,
       onUnhandledRequest: options.onUnhandledRequest,
-      saveRequests: options.saveRequests
+      requestSaving: options.requestSaving
     });
   }
   get type() {
@@ -2406,11 +2435,11 @@ var LocalHttpInterceptor = class {
   set baseURL(baseURL) {
     this.client.baseURL = new URL(baseURL);
   }
-  get saveRequests() {
-    return this.client.saveRequests;
+  get requestSaving() {
+    return this.client.requestSaving;
   }
-  set saveRequests(saveRequests) {
-    this.client.saveRequests = saveRequests;
+  set requestSaving(requestSaving) {
+    this.client.requestSaving = requestSaving;
   }
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;
@@ -2484,7 +2513,7 @@ var RemoteHttpInterceptor = class {
       baseURL,
       Handler: RemoteHttpRequestHandler_default,
       onUnhandledRequest: options.onUnhandledRequest,
-      saveRequests: options.saveRequests
+      requestSaving: options.requestSaving
     });
   }
   get type() {
@@ -2496,11 +2525,11 @@ var RemoteHttpInterceptor = class {
   set baseURL(baseURL) {
     this.client.baseURL = new URL(baseURL);
   }
-  get saveRequests() {
-    return this.client.saveRequests;
+  get requestSaving() {
+    return this.client.requestSaving;
   }
-  set saveRequests(saveRequests) {
-    this.client.saveRequests = saveRequests;
+  set requestSaving(requestSaving) {
+    this.client.requestSaving = requestSaving;
   }
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;