actionhero/src/modules/utils/filterResponseForLogging.ts

The reusable, scalable, and quick node.js API server for stateless and stateful applications

import { isPlainObject } from "./isPlainObject";
import { deepCopy } from "./deepCopy";
import { config } from "../config";
import * as dotProp from "dot-prop";

/**
 * Prepares acton response for logging.
 * Hides any sensitive data as defined by `api.config.general.filteredResponse`
 * Truncates long strings via `api.config.logger.maxLogStringLength`
 */
export function filterResponseForLogging(response: Record<string, any>): {
  [key: string]: any;
} {
  response = deepCopy(response);
  const sanitizedResponse: Record<string, any> = {};

  for (const i in response) {
    if (
      Array.isArray(response[i]) &&
      response[i].length > (config.logger?.maxLogArrayLength ?? 10)
    ) {
      response[i] = `${response[i].length} items`;
    }

    if (isPlainObject(response[i])) {
      sanitizedResponse[i] = response[i];
    } else if (typeof response[i] === "string") {
      sanitizedResponse[i] = response[i].substring(
        0,
        config.logger.maxLogStringLength,
      );
    } else if (response[i] instanceof Error) {
      sanitizedResponse[i] = response[i].message ?? String(response[i]);
    } else {
      sanitizedResponse[i] = response[i];
    }
  }

  let filteredResponse: string[];
  if (typeof config.general.filteredResponse === "function") {
    filteredResponse = config.general.filteredResponse();
  } else {
    filteredResponse = config.general.filteredResponse;
  }

  filteredResponse.forEach((configParam) => {
    if (dotProp.get(response, configParam) !== undefined) {
      dotProp.set(sanitizedResponse, configParam, "[FILTERED]");
    }
  });

  return sanitizedResponse;
}