[CSR-593] Custom file names based on spec name

README.md

@@ -102,12 +102,21 @@ debuggerPlugin(on: Cypress.PluginEvents, config: Cypress.PluginConfig, options?:
 ```
 
 - `on` - [`Cypress.PluginEvents`](https://docs.cypress.io/guides/references/configuration#setupNodeEvents) `setupNodeEvents` method first argument
-- `on` - [`Cypress.PluginConfig`](https://docs.cypress.io/guides/references/configuration#setupNodeEvents) `setupNodeEvents` method second argument
+- `config` - [`Cypress.PluginConfig`](https://docs.cypress.io/guides/references/configuration#setupNodeEvents) `setupNodeEvents` method second argument
 - `options` - [`PluginOptions`](./packages/plugin/src/types.ts):
  - `meta: Record<string, unknown>`: an optional field that is added to the `TestExecutionResult` as `pluginMeta`
  - `callback: (path: string, data: TestExecutionResult`: a callback function that will be called after each test
  - `targetDirectory: string`: the path to the reports directory. Default is `dump`
  - `failedTestsOnly: boolean`: whether to generate debug traces for failed tests only, default is `false`
+ - `filenameFn: (ctx: RunContextData) => string`: a function used to generate the filename of each test. By default, the filename is created using `spec_test_attempt` template.
+
+```typescript
+interface RunContextData {
+ spec: string;
+ test: string[];
+ retryAttempt: number;
+}
+```
 
 Example:
 
@@ -126,6 +135,7 @@ module.exports = defineConfig({
  console.log({ path, data });
  },
  targetDirectory: 'cypress/e2e/reports',
+ filenameFn: ({ spec }) => `${spec}_${Date.now()}`,
  });
  },
  },

packages/plugin/src/install.ts

@@ -13,11 +13,19 @@ import {
 import { createDir, readFile, removeDir, removeFile, writeFile } from './fs';
 import { PluginOptions, TestExecutionResult } from './types';
 
+type CreateDumpFileOptions = {
+ dumpDir: string;
+ filename: string;
+};
+
 const harDir = 'dump_har';
 
-const createDumpFile = (data: TestExecutionResult, dumpDir: string): string => {
+const createDumpFile = (
+ data: TestExecutionResult,
+ { dumpDir, filename }: CreateDumpFileOptions
+): string => {
  createDir(dumpDir);
- const resultsPath = path.join(dumpDir, `${data.id}.raw.json`);
+ const resultsPath = path.join(dumpDir, `${filename}.json`);
  writeFile(resultsPath, JSON.stringify(data, null, 2));
  return resultsPath;
 };
@@ -74,7 +82,20 @@ function install(
  ? options.targetDirectory
  : 'dump';
 
- const resultsFilePath = createDumpFile(dumpData, dumpDir);
+ let filename = `${dumpData.meta.spec}_${dumpData.meta.test.join(' > ')}_${
+ dumpData.meta.retryAttempt + 1
+ }`;
+ if (typeof options?.filenameFn === 'function') {
+ const result = options.filenameFn(dumpData.meta);
+ if (typeof result === 'string') {
+ filename = result;
+ }
+ }
+
+ const resultsFilePath = createDumpFile(dumpData, {
+ dumpDir,
+ filename,
+ });
 
  if (options && options.callback) {
  options.callback(resultsFilePath, dumpData);

packages/plugin/src/types.ts

@@ -135,4 +135,5 @@ export type PluginOptions = {
  targetDirectory?: string;
  failedTestsOnly?: boolean;
  callback?: (path: string, result: TestExecutionResult) => void;
+ filenameFn?: (ctx: RunContextData) => string;
 };