e2ed/autotests/configurator/mapBackendResponseErrorToLog.ts

E2E testing framework over Playwright

import {BAD_REQUEST_STATUS_CODE} from 'e2ed/constants';

import type {MapBackendResponseErrorToLog} from 'autotests/configurator';

/**
 * Maps responses with errors from the backend to "red" logs (as errors) during the test.
 * It is assumed that the function will select responses with
 * statuse codes of 400 and higher (client and server errors).
 * Backend responses with errors are accumulated in separate "red" log step
 * (with `logEventStatus: 'failed'`).
 * Log the `responseBody` field carefully, as the body of backend response can be very large.
 * If the function returns `undefined`, the response is not logged (skipped).
 */
export const mapBackendResponseErrorToLog: MapBackendResponseErrorToLog = ({
  duration,
  request,
  responseBody,
  responseHeaders,
  statusCode,
}) => {
  if (statusCode < BAD_REQUEST_STATUS_CODE) {
    return undefined;
  }

  return {duration, request, responseBody, responseHeaders};
};