Homarr/packages/common/src/fetch-agent.ts

import type { Dispatcher } from "undici";
import { Agent } from "undici";

import { logger } from "@homarr/log";

// The below import statement initializes dns-caching
import "./dns";

export class LoggingAgent extends Agent {
  constructor(...props: ConstructorParameters<typeof Agent>) {
    super(...props);
  }

  dispatch(options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean {
    const path = options.path
      .split("/")
      .map((segment) => (segment.length >= 32 && !segment.startsWith("?") ? "REDACTED" : segment))
      .join("/");
    const url = new URL(`${options.origin as string}${path}`);

    // The below code should prevent sensitive data from being logged as
    // some integrations use query parameters for auth
    url.searchParams.forEach((value, key) => {
      if (value === "") return; // Skip empty values
      if (/^-?\d{1,12}$/.test(value)) return; // Skip small numbers
      if (value === "true" || value === "false") return; // Skip boolean values
      if (/^[a-zA-Z]{1,12}$/.test(value)) return; // Skip short strings
      if (/^\d{4}-\d{2}-\d{2}$/.test(value)) return; // Skip dates
      if (/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/.test(value)) return; // Skip date times

      url.searchParams.set(key, "REDACTED");
    });

    logger.debug(
      `Dispatching request ${url.toString().replaceAll("=&", "&")} (${Object.keys(options.headers ?? {}).length} headers)`,
    );
    return super.dispatch(options, handler);
  }
}