install.ts

import { HttpArchiveLog } from '@currents/cypress-debugger-support';
import {
  ensureBrowserFlags,
  install as installHarPlugin,
} from '@neuralegion/cypress-har-generator';
import path from 'path';
import {
  browserLaunchHandler,
  clearLogs,
  getLogs,
  recordLogs,
} from './browserLogs';
import { createDir, readFile, removeDir, removeFile, writeFile } from './fs';
import { sanitizeFilename, truncatePathParts } from './lib';
import { PluginOptions, TestExecutionResult } from './types';

const harDir = 'dump_har';

const createDumpFile = (data: TestExecutionResult, dumpDir: string): string => {
  createDir(dumpDir);

  const specDirPath = path.join(dumpDir, sanitizeFilename(data.meta.spec));
  createDir(specDirPath);

  const filename = `${data.meta.test.join(' -- ')} (${data.meta.state})${
    data.meta.retryAttempt > 0 ? ` (attempt ${data.meta.retryAttempt + 1})` : ''
  }`;

  const resultsPath = path.join(
    specDirPath,
    `${sanitizeFilename(filename)}.json`
  );
  writeFile(truncatePathParts(resultsPath), JSON.stringify(data, null, 2));
  return resultsPath;
};

const getHar = (filename: string): HttpArchiveLog | null => {
  try {
    const filePath = path.join(harDir, filename);
    const data = readFile(filePath);
    const parsed = JSON.parse(data.toString('utf-8'));

    removeFile(filePath);

    return parsed;
  } catch (error) {
    return null;
  }
};

function install(
  on: Cypress.PluginEvents,
  config: Cypress.PluginConfigOptions,
  options?: PluginOptions
) {
  if (options?.failedTestsOnly) {
    // eslint-disable-next-line no-underscore-dangle, no-param-reassign
    config.env.__cypress_debugger_failedTestsOnly = true;
  }

  on('task', {
    // called in "afterEach" hook
    dumpEvents(
      data: Pick<TestExecutionResult, 'id' | 'cy' | 'rr' | 'meta'> & {
        harFilename: string;
      }
    ) {
      const har = getHar(data.harFilename);

      const browserLogs = getLogs();
      clearLogs();

      const dumpData = {
        id: data.id,
        cy: data.cy,
        rr: data.rr,
        meta: data.meta,
        har,
        browserLogs,
        pluginMeta: options?.meta,
      };

      const dumpDir =
        options?.targetDirectory &&
        path.resolve(options.targetDirectory) !== path.resolve(harDir)
          ? truncatePathParts(options.targetDirectory)
          : 'dump';

      const resultsFilePath = createDumpFile(dumpData, dumpDir);

      if (options && options.callback) {
        options.callback(resultsFilePath, dumpData);
      }

      return null;
    },

    // called in "after" hook
    cleanup() {
      removeDir(harDir);
      return null;
    },
  });

  // install cypress-har-generator
  installHarPlugin(on);

  on('before:browser:launch', (browser, launchOptions) => {
    // cypress-har-generator uses this event, details here: https://github.com/NeuraLegion/cypress-har-generator/blob/master/README.md?plain=1#L74
    ensureBrowserFlags(browser, launchOptions);

    // use chrome debugging protocol to listen to console events
    browserLaunchHandler(browser, launchOptions);

    return launchOptions;
  });

  on('before:spec', async () => {
    await recordLogs();
  });

  return config;
}

export default install;