@trackunit/iris-app-e2e 1.4.39 → 1.4.43

package/README.md

@@ -67,6 +67,7 @@ setupDefaultCommands();
 Create a `cypress.config.ts` file:
 
 #### Simple Configuration (Backward Compatible)
+
 ```typescript
 import { defineConfig } from 'cypress';
 import { defaultCypressConfig, setupPlugins } from '@trackunit/iris-app-e2e';
@@ -89,6 +90,7 @@ export default defineConfig({
 ```
 
 #### Advanced Configuration (New API)
+
 ```typescript
 import { defineConfig } from 'cypress';
 import { defaultCypressConfig, setupPlugins } from '@trackunit/iris-app-e2e';

package/index.cjs.js

@@ -347,6 +347,40 @@ const getCodeowner = (currentPath, workspaceRoot, codeownersFileName = "TEAM_COD
     return undefined;
 };
 
+/**
+ * Sanitizes a string to be safe for use in filenames.
+ * Removes special characters and truncates if too long.
+ *
+ * @param str - The string to sanitize (e.g., test suite or test name)
+ * @returns {string} Sanitized string safe for filesystem use
+ */
+function sanitizeForFilename(str) {
+    return str
+        .replace(/[^a-zA-Z0-9-_\s\[\]\(\)]/g, "") // Remove special chars - with exceptions
+        .replace(/-+/g, "-") // Collapse multiple hyphens into one
+        .replace(/\s+/g, " ") // Collapse multiple spaces into one
+        .replace(/^-|-$/g, ""); // Trim leading/trailing hyphens
+}
+/**
+ * Builds a standardized filename for test artifacts (e.g., HAR files, screenshots).
+ * Combines test name, state, and attempt number into a readable filename.
+ *
+ * @param testName - The name of the test (will be sanitized)
+ * @param state - The test state (e.g., 'passed', 'failed')
+ * @param currentRetry - The current retry attempt number (0-based)
+ * @returns {string} A sanitized filename in the format: "testName (state) (attempt N)"
+ * @example
+ * fileNameBuilder("Login Flow", "failed", 0)
+ * // Returns: "Login Flow (failed) (attempt 1)"
+ * @example
+ * fileNameBuilder("Test: with -> special chars", "passed", 2)
+ * // Returns: "Test with - special chars (passed) (attempt 3)"
+ */
+function fileNameBuilder(testName, state, currentRetry) {
+    const fileName = `${testName} ${currentRetry !== undefined ? `(Attempt ${currentRetry + 1})` : ""} (${state.toLowerCase()})`;
+    return sanitizeForFilename(fileName);
+}
+
 /**
  * Utility function to find NX workspace root by looking for nx.json or workspace.json.
  * This is more reliable than hardcoded relative paths and works from any directory.
@@ -417,6 +451,7 @@ const defaultCypressConfig = optionsOrDirname => {
         nxRoot,
         fileServerFolder: ".",
         video: true,
+        trashAssetsBeforeRuns: false, // Don't delete videos from previous test runs (important for sequential runs)
         videosFolder: pluginConfig.videosFolder ?? buildOutputPath("videos"),
         screenshotsFolder: pluginConfig.screenshotsFolder ?? buildOutputPath("screenshots"),
         env: {
@@ -436,10 +471,7 @@ const setupPlugins = (on, config, logWriter, installHarGenerator) => {
         printLogsToFile: "always", // Ensures logs are always printed to a file
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         collectTestLogs: (context, logs) => {
-            const testName = context.state.toUpperCase() +
-                "_" +
-                (config.currentRetry ? `( attempt ${config.currentRetry})_` : "") +
-                context.test;
+            const testName = fileNameBuilder(context.test, context.state);
             createLogFile(config.nxRoot, config.logsFolder, testName, logs, logWriter);
         },
     };
@@ -491,7 +523,7 @@ function setupHarRecording() {
     afterEach(function () {
         if (this.currentTest.state === "failed") {
             const harDir = Cypress.env("hars_folders");
-            const testName = "FAILED_" + Cypress.currentTest.title + (Cypress.currentRetry ? `_( attempt ${Cypress.currentRetry})_` : "");
+            const testName = fileNameBuilder(`${Cypress.currentTest.titlePath[0]} - ${Cypress.currentTest.title}`, "failed", Cypress.currentRetry);
             cy.saveHar({ outDir: harDir, fileName: testName });
         }
     });

package/index.esm.js

@@ -327,6 +327,40 @@ const getCodeowner = (currentPath, workspaceRoot, codeownersFileName = "TEAM_COD
     return undefined;
 };
 
+/**
+ * Sanitizes a string to be safe for use in filenames.
+ * Removes special characters and truncates if too long.
+ *
+ * @param str - The string to sanitize (e.g., test suite or test name)
+ * @returns {string} Sanitized string safe for filesystem use
+ */
+function sanitizeForFilename(str) {
+    return str
+        .replace(/[^a-zA-Z0-9-_\s\[\]\(\)]/g, "") // Remove special chars - with exceptions
+        .replace(/-+/g, "-") // Collapse multiple hyphens into one
+        .replace(/\s+/g, " ") // Collapse multiple spaces into one
+        .replace(/^-|-$/g, ""); // Trim leading/trailing hyphens
+}
+/**
+ * Builds a standardized filename for test artifacts (e.g., HAR files, screenshots).
+ * Combines test name, state, and attempt number into a readable filename.
+ *
+ * @param testName - The name of the test (will be sanitized)
+ * @param state - The test state (e.g., 'passed', 'failed')
+ * @param currentRetry - The current retry attempt number (0-based)
+ * @returns {string} A sanitized filename in the format: "testName (state) (attempt N)"
+ * @example
+ * fileNameBuilder("Login Flow", "failed", 0)
+ * // Returns: "Login Flow (failed) (attempt 1)"
+ * @example
+ * fileNameBuilder("Test: with -> special chars", "passed", 2)
+ * // Returns: "Test with - special chars (passed) (attempt 3)"
+ */
+function fileNameBuilder(testName, state, currentRetry) {
+    const fileName = `${testName} ${currentRetry !== undefined ? `(Attempt ${currentRetry + 1})` : ""} (${state.toLowerCase()})`;
+    return sanitizeForFilename(fileName);
+}
+
 /**
  * Utility function to find NX workspace root by looking for nx.json or workspace.json.
  * This is more reliable than hardcoded relative paths and works from any directory.
@@ -397,6 +431,7 @@ const defaultCypressConfig = optionsOrDirname => {
         nxRoot,
         fileServerFolder: ".",
         video: true,
+        trashAssetsBeforeRuns: false, // Don't delete videos from previous test runs (important for sequential runs)
         videosFolder: pluginConfig.videosFolder ?? buildOutputPath("videos"),
         screenshotsFolder: pluginConfig.screenshotsFolder ?? buildOutputPath("screenshots"),
         env: {
@@ -416,10 +451,7 @@ const setupPlugins = (on, config, logWriter, installHarGenerator) => {
         printLogsToFile: "always", // Ensures logs are always printed to a file
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         collectTestLogs: (context, logs) => {
-            const testName = context.state.toUpperCase() +
-                "_" +
-                (config.currentRetry ? `( attempt ${config.currentRetry})_` : "") +
-                context.test;
+            const testName = fileNameBuilder(context.test, context.state);
             createLogFile(config.nxRoot, config.logsFolder, testName, logs, logWriter);
         },
     };
@@ -471,7 +503,7 @@ function setupHarRecording() {
     afterEach(function () {
         if (this.currentTest.state === "failed") {
             const harDir = Cypress.env("hars_folders");
-            const testName = "FAILED_" + Cypress.currentTest.title + (Cypress.currentRetry ? `_( attempt ${Cypress.currentRetry})_` : "");
+            const testName = fileNameBuilder(`${Cypress.currentTest.titlePath[0]} - ${Cypress.currentTest.title}`, "failed", Cypress.currentRetry);
             cy.saveHar({ outDir: harDir, fileName: testName });
         }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-e2e",
-  "version": "1.4.39",
+  "version": "1.4.43",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "generators": "./generators.json",
@@ -14,7 +14,7 @@
     "cypress-terminal-report": "7.0.3",
     "node-xlsx": "^0.23.0",
     "prettier": "^3.4.2",
-    "@trackunit/react-test-setup": "1.4.39"
+    "@trackunit/react-test-setup": "1.4.42"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/plugins/defaultPlugins.d.ts

@@ -1,6 +1,6 @@
 import { Formatter } from "./writeFileWithPrettier";
 export interface CypressPluginConfig extends Cypress.PluginConfigOptions {
-    currentRetry: number;
+    currentRetry: number | null;
     nxRoot: string;
     logsFolder: string;
 }

package/src/utils/fileNameBuilder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Sanitizes a string to be safe for use in filenames.
+ * Removes special characters and truncates if too long.
+ *
+ * @param str - The string to sanitize (e.g., test suite or test name)
+ * @returns {string} Sanitized string safe for filesystem use
+ */
+export declare function sanitizeForFilename(str: string): string;
+/**
+ * Builds a standardized filename for test artifacts (e.g., HAR files, screenshots).
+ * Combines test name, state, and attempt number into a readable filename.
+ *
+ * @param testName - The name of the test (will be sanitized)
+ * @param state - The test state (e.g., 'passed', 'failed')
+ * @param currentRetry - The current retry attempt number (0-based)
+ * @returns {string} A sanitized filename in the format: "testName (state) (attempt N)"
+ * @example
+ * fileNameBuilder("Login Flow", "failed", 0)
+ * // Returns: "Login Flow (failed) (attempt 1)"
+ * @example
+ * fileNameBuilder("Test: with -> special chars", "passed", 2)
+ * // Returns: "Test with - special chars (passed) (attempt 3)"
+ */
+export declare function fileNameBuilder(testName: string, state: string, currentRetry?: number): string;