@rozenite/network-activity-plugin 1.0.0-alpha.9 → 1.1.0

package/dist/src/utils/applyReactNativeResponseHeadersLogic.d.ts

@@ -0,0 +1,9 @@
+import { HttpHeaders, XHRHeaders } from '../shared/client';
+/**
+ * Applies React Native specific logic to response headers.
+ * React Native concatenates multiple header values into single strings,
+ * this function parses them back into arrays where appropriate.
+ *
+ * @see https://github.com/facebook/react-native/blob/588f0c5ce6c283f116228456da2170d2adc3cbf4/ReactAndroid/src/main/java/com/facebook/react/modules/network/NetworkingModule.java#L637
+ */
+export declare const applyReactNativeResponseHeadersLogic: (headers: XHRHeaders) => HttpHeaders;

package/dist/src/utils/cookieParser.d.ts

@@ -0,0 +1,6 @@
+import { Cookie, HttpHeaders } from '../shared/client';
+export declare const parseSetCookieHeader: (setCookieStr: string) => Cookie;
+export declare const splitSetCookieHeaderByComma: (header: string) => string[];
+export declare const parseCookieHeader: (cookieString: string) => Cookie[];
+export declare const parseRequestCookiesFromHeaders: (headers: HttpHeaders) => Cookie[];
+export declare const parseResponseCookiesFromHeaders: (headers: HttpHeaders) => Cookie[];

package/dist/src/utils/getContentTypeMimeType.d.ts

@@ -0,0 +1,2 @@
+import { HttpHeaders } from '../shared/client';
+export declare function getContentTypeMime(headers: HttpHeaders): string | undefined;

package/dist/src/utils/getHttpHeader.d.ts

@@ -0,0 +1,5 @@
+import { HttpHeaders, XHRHeaders } from '../shared/client';
+export declare function getHttpHeader<T extends HttpHeaders | XHRHeaders>(headers: T, name: string): {
+    value: T[Extract<keyof T, string>];
+    originalKey: Extract<keyof T, string>;
+} | undefined;

package/dist/src/utils/getHttpHeaderValueAsString.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Combines multiple HTTP header values according to RFC 7230 Section 3.2.2
+ *
+ * Per RFC 7230 Section 3.2.2: "A recipient MAY combine multiple header fields
+ * with the same field name into one 'field-name: field-value' pair, without
+ * changing the semantics of the message, by appending each subsequent field
+ * value to the combined field value in order, separated by a comma."
+ *
+ * @see https://tools.ietf.org/html/rfc7230#section-3.2.2
+ */
+export declare function getHttpHeaderValueAsString(value: string | string[]): string;

package/dist/src/utils/getStringSizeInBytes.d.ts

@@ -0,0 +1 @@
+export declare const getStringSizeInBytes: (value: string) => number;

package/dist/src/utils/inferContentTypeFromPostData.d.ts

@@ -0,0 +1,2 @@
+import { RequestPostData } from '../shared/client';
+export declare function inferContentTypeFromPostData(postData: RequestPostData): "multipart/form-data" | undefined;

package/dist/src/utils/safeStringify.d.ts

@@ -0,0 +1 @@
+export declare function safeStringify(data: unknown): string;

package/dist/src/utils/typeChecks.d.ts

@@ -0,0 +1,9 @@
+export declare const isBlob: (value: unknown) => value is Blob;
+export declare const isArrayBuffer: (value: unknown) => value is ArrayBuffer | ArrayBufferView;
+export declare const isFormData: (value: unknown) => value is FormData;
+export declare const isNullOrUndefined: (value: unknown) => value is null | undefined;
+export declare const isString: (value: unknown) => value is string;
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isObject: (value: unknown) => value is object;
+export declare const isArray: (value: unknown) => value is unknown[];

package/dist/useNetworkActivityDevTools.cjs

@@ -8,21 +8,37 @@ const WebSocketInterceptor = require("react-native/Libraries/WebSocket/WebSocket
 const eventSource = require("./event-source.cjs");
 const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const WebSocketInterceptor__default = /* @__PURE__ */ _interopDefault(WebSocketInterceptor);
-function getHttpHeaderValue(headers, name) {
+function safeStringify(data) {
+  try {
+    return typeof data === "string" ? data : JSON.stringify(data);
+  } catch {
+    return String(data);
+  }
+}
+function getHttpHeader(headers, name) {
   const lowerName = name.toLowerCase();
   for (const key in headers) {
     if (key.toLowerCase() === lowerName) {
-      return headers[key];
+      return { value: headers[key], originalKey: key };
     }
   }
   return void 0;
 }
+function getContentTypeMime(headers) {
+  const contentType = getHttpHeader(headers, "content-type");
+  if (!contentType) {
+    return void 0;
+  }
+  const { value } = contentType;
+  const actualValue = Array.isArray(value) ? value[0] : value;
+  return actualValue.split(";")[0].trim();
+}
 const getContentType = (request) => {
   const responseHeaders = request.responseHeaders;
   const responseType = request.responseType;
-  const contentType = getHttpHeaderValue(responseHeaders || {}, "content-type");
+  const contentType = getContentTypeMime(responseHeaders || {});
   if (contentType) {
-    return contentType.split(";")[0].trim();
+    return contentType;
   }
   switch (responseType) {
     case "arraybuffer":
@@ -70,6 +86,28 @@ const getNetworkRequestsRegistry = () => {
     clear
   };
 };
+function getBlobName(blob) {
+  if (typeof (blob == null ? void 0 : blob.name) === "string") {
+    return blob.name;
+  }
+  if ((blob == null ? void 0 : blob.data) && typeof blob.data.name === "string") {
+    return blob.data.name;
+  }
+  return void 0;
+}
+function getFormDataEntries(formData) {
+  if (!formData || typeof formData !== "object") {
+    return [];
+  }
+  if (typeof formData.entries === "function") {
+    return formData.entries();
+  }
+  if (Array.isArray(formData._parts)) {
+    return formData._parts;
+  }
+  return [];
+}
+const XMLHttpRequest = global.XMLHttpRequest || window.XMLHttpRequest;
 const originalXHROpen = XMLHttpRequest.prototype.open;
 const originalXHRSend = XMLHttpRequest.prototype.send;
 const originalXHRSetRequestHeader = XMLHttpRequest.prototype.setRequestHeader;
@@ -78,6 +116,7 @@ let sendCallback;
 let requestHeaderCallback;
 let headerReceivedCallback;
 let responseCallback;
+let overrideCallback;
 let isInterceptorEnabled$1 = false;
 const XHRInterceptor = {
   /**
@@ -110,6 +149,12 @@ const XHRInterceptor = {
   setRequestHeaderCallback(callback) {
     requestHeaderCallback = callback;
   },
+  /**
+   * Invoked before XMLHttpRequest.send(...) is called.
+   */
+  setOverrideCallback(callback) {
+    overrideCallback = callback;
+  },
   isInterceptorEnabled() {
     return isInterceptorEnabled$1;
   },
@@ -133,6 +178,9 @@ const XHRInterceptor = {
       if (sendCallback) {
         sendCallback(data, this);
       }
+      if (overrideCallback) {
+        overrideCallback(this);
+      }
       if (this.addEventListener) {
         this.addEventListener(
           "readystatechange",
@@ -193,14 +241,128 @@ const XHRInterceptor = {
     sendCallback = null;
     headerReceivedCallback = null;
     requestHeaderCallback = null;
+    overrideCallback = null;
+  }
+};
+const getStringSizeInBytes = (value) => {
+  return new TextEncoder().encode(value).length;
+};
+const splitSetCookieHeaderByComma = (header) => {
+  const regex = /(?:^|,\s)([^=;,]+=[^;]+(?:;[^,]*)*)/g;
+  const matches = [];
+  let match;
+  while ((match = regex.exec(header)) !== null) {
+    matches.push(match[1].trim());
+  }
+  return matches;
+};
+const applyReactNativeResponseHeadersLogic = (headers) => {
+  const parsedHeaders = { ...headers };
+  const setCookieHeader = getHttpHeader(headers, "set-cookie");
+  if (setCookieHeader) {
+    const { value, originalKey } = setCookieHeader;
+    const cookies = splitSetCookieHeaderByComma(value);
+    parsedHeaders[originalKey] = cookies.length > 0 ? cookies : value;
+  }
+  return parsedHeaders;
+};
+const isBlob = (value) => value instanceof Blob;
+const isArrayBuffer = (value) => value instanceof ArrayBuffer || ArrayBuffer.isView(value);
+const isFormData = (value) => value instanceof FormData;
+const isNullOrUndefined = (value) => value === null || value === void 0;
+const createOverridesRegistry = () => {
+  let overrides = /* @__PURE__ */ new Map();
+  const setOverrides = (newOverrides) => {
+    overrides = new Map(newOverrides);
+  };
+  const getOverrideForUrl = (url) => {
+    return overrides.get(url);
+  };
+  return {
+    setOverrides,
+    getOverrideForUrl
+  };
+};
+let registryInstance = null;
+const getOverridesRegistry = () => {
+  if (!registryInstance) {
+    registryInstance = createOverridesRegistry();
   }
+  return registryInstance;
 };
 const networkRequestsRegistry = getNetworkRequestsRegistry();
+const overridesRegistry$1 = getOverridesRegistry();
+const getBinaryPostData = (body) => ({
+  type: "binary",
+  value: {
+    size: body.size,
+    type: body.type,
+    name: getBlobName(body)
+  }
+});
+const getArrayBufferPostData = (body) => ({
+  type: "binary",
+  value: {
+    size: body.byteLength
+  }
+});
+const getTextPostData = (body) => ({
+  type: "text",
+  value: safeStringify(body)
+});
+const getFormDataPostData = (body) => ({
+  type: "form-data",
+  value: getFormDataEntries(body).reduce(
+    (acc, [key, value]) => {
+      if (isBlob(value)) {
+        acc[key] = getBinaryPostData(value);
+      } else if (isArrayBuffer(value)) {
+        acc[key] = getArrayBufferPostData(value);
+      } else {
+        acc[key] = getTextPostData(value);
+      }
+      return acc;
+    },
+    {}
+  )
+});
+const getRequestBody = (body) => {
+  if (isNullOrUndefined(body)) {
+    return body;
+  }
+  if (isBlob(body)) {
+    return getBinaryPostData(body);
+  }
+  if (isArrayBuffer(body)) {
+    return getArrayBufferPostData(body);
+  }
+  if (isFormData(body)) {
+    return getFormDataPostData(body);
+  }
+  return getTextPostData(body);
+};
 const getResponseSize = (request) => {
-  if (typeof request.response === "object") {
-    return request.response.size;
+  try {
+    const { responseType, response } = request;
+    if (response === null) {
+      return 0;
+    }
+    if (responseType === "" || responseType === "text") {
+      return getStringSizeInBytes(request.responseText);
+    }
+    if (responseType === "json") {
+      return getStringSizeInBytes(safeStringify(response));
+    }
+    if (responseType === "blob") {
+      return response.size;
+    }
+    if (responseType === "arraybuffer") {
+      return response.byteLength;
+    }
+    return 0;
+  } catch {
+    return null;
   }
-  return request.response.length || 0;
 };
 const getResponseBody = async (request) => {
   const responseType = request.responseType;
@@ -219,6 +381,9 @@ const getResponseBody = async (request) => {
       });
     }
   }
+  if (responseType === "json") {
+    return safeStringify(request.response);
+  }
   return null;
 };
 const getInitiatorFromStack = () => {
@@ -260,11 +425,20 @@ const getNetworkInspector = (pluginClient) => {
         url: request._url,
         method: request._method,
         headers: request._headers,
-        postData: data
+        postData: getRequestBody(data)
       },
       type: "XHR",
       initiator
     });
+    request.addEventListener("progress", (event) => {
+      pluginClient.send("request-progress", {
+        requestId,
+        timestamp: Date.now(),
+        loaded: event.loaded,
+        total: event.total,
+        lengthComputable: event.lengthComputable
+      });
+    });
     request.addEventListener("readystatechange", () => {
       if (request.readyState === READY_STATE_HEADERS_RECEIVED) {
         ttfb = Date.now() - sendTime;
@@ -279,7 +453,9 @@ const getNetworkInspector = (pluginClient) => {
           url: request._url,
           status: request.status,
           statusText: request.statusText,
-          headers: request.responseHeaders || {},
+          headers: applyReactNativeResponseHeadersLogic(
+            request.responseHeaders || {}
+          ),
           contentType: getContentType(request),
           size: getResponseSize(request),
           responseTime: Date.now()
@@ -313,10 +489,55 @@ const getNetworkInspector = (pluginClient) => {
         canceled: true
       });
     });
+    request.addEventListener("timeout", () => {
+      pluginClient.send("request-failed", {
+        requestId,
+        timestamp: Date.now(),
+        type: "XHR",
+        error: "Timeout",
+        canceled: false
+      });
+    });
+  };
+  const handleRequestOverride = (request) => {
+    const override = overridesRegistry$1.getOverrideForUrl(
+      request._url
+    );
+    if (!override) {
+      return;
+    }
+    request.addEventListener("readystatechange", () => {
+      if (override.body !== void 0) {
+        Object.defineProperty(request, "responseType", {
+          writable: true
+        });
+        Object.defineProperty(request, "response", {
+          writable: true
+        });
+        Object.defineProperty(request, "responseText", {
+          writable: true
+        });
+        const contentType = getContentType(request);
+        if (contentType === "application/json") {
+          request.responseType = "json";
+        } else if (contentType === "text/plain") {
+          request.responseType = "text";
+        }
+        request.response = override.body;
+        request.responseText = override.body;
+      }
+      if (override.status !== void 0) {
+        Object.defineProperty(request, "status", {
+          writable: true
+        });
+        request.status = override.status;
+      }
+    });
   };
   const enable = () => {
     XHRInterceptor.disableInterception();
     XHRInterceptor.setSendCallback(handleRequestSend);
+    XHRInterceptor.setOverrideCallback(handleRequestOverride);
     XHRInterceptor.enableInterception();
   };
   const disable = () => {
@@ -522,6 +743,8 @@ let closeCallback;
 let isInterceptorEnabled = false;
 const eventSourceClass = eventSource.getEventSource();
 const originalOpen = eventSourceClass.prototype.open;
+const originalDispatch = eventSourceClass.prototype.dispatch;
+const BUILT_IN_EVENT_TYPES = /* @__PURE__ */ new Set(["open", "error", "close", "done"]);
 const SSEInterceptor = {
   /**
    * Invoked when EventSource.open() is called (connection attempt starting).
@@ -569,11 +792,6 @@ const SSEInterceptor = {
           openEventCallback(event, this);
         }
       });
-      this.addEventListener("message", (event) => {
-        if (messageCallback) {
-          messageCallback(event, this);
-        }
-      });
       this.addEventListener(
         "error",
         (event) => {
@@ -589,6 +807,14 @@ const SSEInterceptor = {
       });
       return originalOpen.call(this);
     };
+    eventSourceClass.prototype.dispatch = function(eventType, data) {
+      if (!BUILT_IN_EVENT_TYPES.has(eventType)) {
+        if (messageCallback) {
+          messageCallback(data, this);
+        }
+      }
+      return originalDispatch.call(this, eventType, data);
+    };
     isInterceptorEnabled = true;
   },
   // Unpatch EventSource open method and remove the callbacks.
@@ -598,6 +824,7 @@ const SSEInterceptor = {
     }
     isInterceptorEnabled = false;
     eventSourceClass.prototype.open = originalOpen;
+    eventSourceClass.prototype.dispatch = originalDispatch;
     connectCallback = null;
     messageCallback = null;
     errorCallback = null;
@@ -611,9 +838,7 @@ const getSSEInspector = () => {
     var _a;
     const requestId = (_a = eventSource2._xhr) == null ? void 0 : _a._rozeniteRequestId;
     if (!requestId) {
-      throw new Error(
-        "No request ID found for EventSource. This should never happen!"
-      );
+      return null;
     }
     return requestId;
   };
@@ -622,6 +847,9 @@ const getSSEInspector = () => {
       SSEInterceptor.setOpenEventCallback((_, eventSource2) => {
         const sseEventSource = eventSource2;
         const requestId = getRequestId(sseEventSource);
+        if (!requestId) {
+          return;
+        }
         const sseXhr = sseEventSource._xhr;
         const event = {
           type: "sse-open",
@@ -642,17 +870,26 @@ const getSSEInspector = () => {
       SSEInterceptor.setMessageCallback((messageEvent, eventSource2) => {
         const sseEventSource = eventSource2;
         const requestId = getRequestId(sseEventSource);
+        if (!requestId) {
+          return;
+        }
         const event = {
           type: "sse-message",
           requestId,
           timestamp: Date.now(),
-          data: messageEvent.data || ""
+          payload: {
+            type: messageEvent.type,
+            data: messageEvent.data || ""
+          }
         };
         eventEmitter.emit("sse-message", event);
       });
       SSEInterceptor.setErrorCallback((errorEvent, eventSource2) => {
         const sseEventSource = eventSource2;
         const requestId = getRequestId(sseEventSource);
+        if (!requestId) {
+          return;
+        }
         const event = {
           type: "sse-error",
           requestId,
@@ -667,6 +904,9 @@ const getSSEInspector = () => {
       SSEInterceptor.setCloseCallback((_, eventSource2) => {
         const sseEventSource = eventSource2;
         const requestId = getRequestId(sseEventSource);
+        if (!requestId) {
+          return;
+        }
         const event = {
           type: "sse-close",
           requestId,
@@ -681,26 +921,93 @@ const getSSEInspector = () => {
     },
     isEnabled: () => SSEInterceptor.isInterceptorEnabled(),
     dispose: () => {
+      SSEInterceptor.disableInterception();
       eventEmitter.events = {};
     },
     on: (event, callback) => eventEmitter.on(event, callback)
   };
 };
-const useNetworkActivityDevTools = () => {
+const DEFAULT_CONFIG = {
+  inspectors: {
+    http: true,
+    websocket: true,
+    sse: true
+  },
+  clientUISettings: {
+    showUrlAsName: false
+  }
+};
+const validateConfig = (config) => {
+  const inspectors = config.inspectors;
+  if (!inspectors) {
+    return;
+  }
+  if (inspectors.sse && !inspectors.http) {
+    throw new Error("SSE inspector requires HTTP inspector to be enabled.");
+  }
+};
+const overridesRegistry = getOverridesRegistry();
+const useNetworkActivityDevTools = (config = DEFAULT_CONFIG) => {
+  var _a, _b, _c, _d;
+  const isRecordingEnabledRef = react.useRef(false);
   const client = pluginBridge.useRozeniteDevToolsClient({
     pluginId: "@rozenite/network-activity-plugin"
   });
+  const isHttpInspectorEnabled = ((_a = config.inspectors) == null ? void 0 : _a.http) ?? true;
+  const isWebSocketInspectorEnabled = ((_b = config.inspectors) == null ? void 0 : _b.websocket) ?? true;
+  const isSSEInspectorEnabled = ((_c = config.inspectors) == null ? void 0 : _c.sse) ?? true;
+  const showUrlAsName = (_d = config.clientUISettings) == null ? void 0 : _d.showUrlAsName;
   react.useEffect(() => {
     if (!client) {
       return;
     }
+    validateConfig(config);
+  }, [config]);
+  react.useEffect(() => {
+    if (!client) {
+      return;
+    }
+    const sendClientUISettings = () => {
+      var _a2;
+      client.send("client-ui-settings", {
+        settings: {
+          showUrlAsName: showUrlAsName ?? ((_a2 = DEFAULT_CONFIG.clientUISettings) == null ? void 0 : _a2.showUrlAsName)
+        }
+      });
+    };
+    const subscriptions = [
+      client.onMessage("network-enable", () => {
+        isRecordingEnabledRef.current = true;
+      }),
+      client.onMessage("network-disable", () => {
+        isRecordingEnabledRef.current = false;
+      }),
+      client.onMessage("set-overrides", (data) => {
+        overridesRegistry.setOverrides(data.overrides);
+      }),
+      client.onMessage("get-client-ui-settings", () => {
+        sendClientUISettings();
+      })
+    ];
+    sendClientUISettings();
+    return () => {
+      subscriptions.forEach((subscription) => subscription.remove());
+    };
+  }, [client, showUrlAsName]);
+  react.useEffect(() => {
+    if (!client || !isHttpInspectorEnabled) {
+      return;
+    }
     const networkInspector = getNetworkInspector(client);
+    if (isRecordingEnabledRef.current) {
+      networkInspector.enable();
+    }
     return () => {
       networkInspector.dispose();
     };
-  }, [client]);
+  }, [client, isHttpInspectorEnabled]);
   react.useEffect(() => {
-    if (!client) {
+    if (!client || !isWebSocketInspectorEnabled) {
       return;
     }
     const eventsToForward = [
@@ -724,12 +1031,15 @@ const useNetworkActivityDevTools = () => {
     client.onMessage("network-disable", () => {
       websocketInspector.disable();
     });
+    if (isRecordingEnabledRef.current) {
+      websocketInspector.enable();
+    }
     return () => {
       websocketInspector.dispose();
     };
-  }, [client]);
+  }, [client, isWebSocketInspectorEnabled]);
   react.useEffect(() => {
-    if (!client) {
+    if (!client || !isSSEInspectorEnabled) {
       return;
     }
     const eventsToForward = [
@@ -750,10 +1060,13 @@ const useNetworkActivityDevTools = () => {
     client.onMessage("network-disable", () => {
       sseInspector.disable();
     });
+    if (isRecordingEnabledRef.current) {
+      sseInspector.enable();
+    }
     return () => {
       sseInspector.dispose();
     };
-  }, [client]);
+  }, [client, isSSEInspectorEnabled]);
   return client;
 };
 exports.useNetworkActivityDevTools = useNetworkActivityDevTools;