@trackunit/iris-app-e2e 1.1.4 → 1.1.6

package/index.cjs.js

@@ -220,6 +220,133 @@ function createLogFile(nxRoot, logsPath, fileNameWithoutExtension, logs, logWrit
     }
 }
 
+/**
+ * Parses lines from a CODEOWNERS‐style file into a mapping of patterns → owners.
+ * Skips blank lines and comments (lines beginning with `#`).
+ *
+ * @param {string[]} lines - Each element is a line from your CODEOWNERS file.
+ * @returns {Record<string, string>} An object whose keys are normalized path patterns (no leading/trailing slashes)
+ *                                  and whose values are the owner (e.g. a GitHub team handle).
+ * @example
+ * ```ts
+ * const lines = [
+ *   "# Our CODEOWNERS",
+ *   "/src @team/backend",
+ *   "README.md    @team/docs",
+ *   "",                 // blank lines ignored
+ *   "# end of file"
+ * ];
+ * const owners = parseCodeowners(lines);
+ * // → { "src": "@team/backend", "README.md": "@team/docs" }
+ * ```
+ */
+const parseCodeowners = (lines) => {
+    const patterns = {};
+    for (const line of lines) {
+        const trimmed = line.trim();
+        if (!trimmed || trimmed.startsWith("#")) {
+            continue;
+        }
+        const [pattern, owner] = trimmed.split(/\s+/, 2);
+        if (pattern && owner) {
+            const normalizedPattern = pattern.replace(/^\/+|\/+$/g, "");
+            patterns[normalizedPattern] = owner;
+        }
+    }
+    return patterns;
+};
+/**
+ * Converts a full team handle (potentially namespaced and with platform suffix)
+ * into its “short” team name.
+ *
+ * - Strips any leading `@org/` prefix
+ * - Removes `-be` or `-fe` suffix if present
+ *
+ * @param {string} teamName - e.g. `"@trackunit/backend-be"` or `"@trackunit/frontend-fe"`
+ * @returns {string} e.g. `"backend"` or `"frontend"`
+ * @example
+ * ```ts
+ * toShortTeamName("@trackunit/backend-be");   // → "backend"
+ * toShortTeamName("@trackunit/frontend-fe");  // → "frontend"
+ * toShortTeamName("infra");                   // → "infra"
+ * ```
+ */
+const toShortTeamName = (teamName) => {
+    if (!teamName) {
+        return undefined;
+    }
+    let shortName = teamName;
+    if (teamName.startsWith("@")) {
+        shortName = shortName.slice(shortName.indexOf("/") + 1);
+    }
+    if (shortName.endsWith("-be") || shortName.endsWith("-fe")) {
+        shortName = shortName.slice(0, shortName.lastIndexOf("-"));
+    }
+    return shortName;
+};
+/**
+ * Recursively looks up the CODEOWNER for a given file or directory path
+ * by reading your workspace’s CODEOWNERS file.
+ *
+ * Walks up the directory tree until it finds a matching pattern. If no
+ * deeper match is found but there is a `"."` entry, returns that.
+ *
+ * @param {string} currentPath - Absolute path to the file/directory you’re querying.
+ * @param {string} workspaceRoot - Absolute path to your repo/workspace root.
+ * @param {string} [codeownersFileName="TEAM_CODEOWNERS"] - Filename to read at the root.
+ * @returns {string|undefined} The owner handle (e.g. `"@team/backend"`) or `undefined` if none found.
+ * @example
+ * ```ts
+ * // Suppose your repo root has a TEAM_CODEOWNERS file containing:
+ * // src @team/backend
+ * // src/utils @team/utils
+ * // . @team/root
+ *
+ * const owner1 = getCodeowner(
+ *   "/Users/alice/project/src/utils/helpers.ts",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/utils"
+ *
+ * const owner2 = getCodeowner(
+ *   "/Users/alice/project/other/file.txt",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/root"  (falls back to the "." entry)
+ * ```
+ */
+const getCodeowner = (currentPath, workspaceRoot, codeownersFileName = "TEAM_CODEOWNERS") => {
+    if (!workspaceRoot) {
+        return undefined;
+    }
+    const codeownersPath = path.join(workspaceRoot, codeownersFileName);
+    if (!fs.existsSync(codeownersPath)) {
+        return undefined;
+    }
+    const codeownersLines = fs.readFileSync(codeownersPath, "utf8").split("\n");
+    const codeowners = parseCodeowners(codeownersLines);
+    let relPath = path
+        .relative(workspaceRoot, currentPath)
+        .replace(/\\/g, "/")
+        .replace(/^\/+|\/+$/g, "");
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+        const codeowner = codeowners[relPath];
+        if (codeowner) {
+            return codeowner;
+        }
+        const parent = path.posix.dirname(relPath);
+        if ((parent === relPath || parent === ".") && codeowners["."]) {
+            return codeowners["."];
+        }
+        if (parent === relPath || parent === ".") {
+            break;
+        }
+        relPath = parent;
+    }
+    return undefined;
+};
+
 /**
  * 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.
@@ -337,11 +464,16 @@ const setupPlugins = (on, config, logWriter, installHarGenerator) => {
         },
     });
     /* ---- END: Task setup ---- */
+    /* ---- BEGIN: codeowner setup ---- */
+    const codeowner = toShortTeamName(getCodeowner(config.projectRoot, config.nxRoot));
+    config.env.codeowner = codeowner;
+    /* ---- END: codeowner setup ---- */
     /* ---- BEGIN: HAR setup ---- */
     // Installing the HAR geneartor should happen last according to the documentation
     // https://github.com/NeuraLegion/cypress-har-generator?tab=readme-ov-file#setting-up-the-plugin
     installHarGenerator(on);
     /* ---- END: HAR setup ---- */
+    return config;
 };
 
 /* eslint-disable local-rules/no-typescript-assertion, @typescript-eslint/no-explicit-any */
@@ -385,6 +517,25 @@ function setupE2E() {
         return false;
     });
 }
+const originalDescribe = global.describe;
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+if (originalDescribe) {
+    const codeowner = Cypress.env("codeowner");
+    const addOwnerToTitle = (title) => {
+        return codeowner ? title + ` [${codeowner}]` : title;
+    };
+    function patchedDescribe(title, fn) {
+        return originalDescribe(addOwnerToTitle(title), fn);
+    }
+    patchedDescribe.only = (title, fn) => {
+        return originalDescribe.only(addOwnerToTitle(title), fn);
+    };
+    patchedDescribe.skip = (title, fn) => {
+        return originalDescribe.skip(addOwnerToTitle(title), fn);
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    global.describe = patchedDescribe;
+}
 
 exports.createLogFile = createLogFile;
 exports.defaultCypressConfig = defaultCypressConfig;

package/index.esm.js

@@ -200,6 +200,133 @@ function createLogFile(nxRoot, logsPath, fileNameWithoutExtension, logs, logWrit
     }
 }
 
+/**
+ * Parses lines from a CODEOWNERS‐style file into a mapping of patterns → owners.
+ * Skips blank lines and comments (lines beginning with `#`).
+ *
+ * @param {string[]} lines - Each element is a line from your CODEOWNERS file.
+ * @returns {Record<string, string>} An object whose keys are normalized path patterns (no leading/trailing slashes)
+ *                                  and whose values are the owner (e.g. a GitHub team handle).
+ * @example
+ * ```ts
+ * const lines = [
+ *   "# Our CODEOWNERS",
+ *   "/src @team/backend",
+ *   "README.md    @team/docs",
+ *   "",                 // blank lines ignored
+ *   "# end of file"
+ * ];
+ * const owners = parseCodeowners(lines);
+ * // → { "src": "@team/backend", "README.md": "@team/docs" }
+ * ```
+ */
+const parseCodeowners = (lines) => {
+    const patterns = {};
+    for (const line of lines) {
+        const trimmed = line.trim();
+        if (!trimmed || trimmed.startsWith("#")) {
+            continue;
+        }
+        const [pattern, owner] = trimmed.split(/\s+/, 2);
+        if (pattern && owner) {
+            const normalizedPattern = pattern.replace(/^\/+|\/+$/g, "");
+            patterns[normalizedPattern] = owner;
+        }
+    }
+    return patterns;
+};
+/**
+ * Converts a full team handle (potentially namespaced and with platform suffix)
+ * into its “short” team name.
+ *
+ * - Strips any leading `@org/` prefix
+ * - Removes `-be` or `-fe` suffix if present
+ *
+ * @param {string} teamName - e.g. `"@trackunit/backend-be"` or `"@trackunit/frontend-fe"`
+ * @returns {string} e.g. `"backend"` or `"frontend"`
+ * @example
+ * ```ts
+ * toShortTeamName("@trackunit/backend-be");   // → "backend"
+ * toShortTeamName("@trackunit/frontend-fe");  // → "frontend"
+ * toShortTeamName("infra");                   // → "infra"
+ * ```
+ */
+const toShortTeamName = (teamName) => {
+    if (!teamName) {
+        return undefined;
+    }
+    let shortName = teamName;
+    if (teamName.startsWith("@")) {
+        shortName = shortName.slice(shortName.indexOf("/") + 1);
+    }
+    if (shortName.endsWith("-be") || shortName.endsWith("-fe")) {
+        shortName = shortName.slice(0, shortName.lastIndexOf("-"));
+    }
+    return shortName;
+};
+/**
+ * Recursively looks up the CODEOWNER for a given file or directory path
+ * by reading your workspace’s CODEOWNERS file.
+ *
+ * Walks up the directory tree until it finds a matching pattern. If no
+ * deeper match is found but there is a `"."` entry, returns that.
+ *
+ * @param {string} currentPath - Absolute path to the file/directory you’re querying.
+ * @param {string} workspaceRoot - Absolute path to your repo/workspace root.
+ * @param {string} [codeownersFileName="TEAM_CODEOWNERS"] - Filename to read at the root.
+ * @returns {string|undefined} The owner handle (e.g. `"@team/backend"`) or `undefined` if none found.
+ * @example
+ * ```ts
+ * // Suppose your repo root has a TEAM_CODEOWNERS file containing:
+ * // src @team/backend
+ * // src/utils @team/utils
+ * // . @team/root
+ *
+ * const owner1 = getCodeowner(
+ *   "/Users/alice/project/src/utils/helpers.ts",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/utils"
+ *
+ * const owner2 = getCodeowner(
+ *   "/Users/alice/project/other/file.txt",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/root"  (falls back to the "." entry)
+ * ```
+ */
+const getCodeowner = (currentPath, workspaceRoot, codeownersFileName = "TEAM_CODEOWNERS") => {
+    if (!workspaceRoot) {
+        return undefined;
+    }
+    const codeownersPath = path__default.join(workspaceRoot, codeownersFileName);
+    if (!fs.existsSync(codeownersPath)) {
+        return undefined;
+    }
+    const codeownersLines = fs.readFileSync(codeownersPath, "utf8").split("\n");
+    const codeowners = parseCodeowners(codeownersLines);
+    let relPath = path__default
+        .relative(workspaceRoot, currentPath)
+        .replace(/\\/g, "/")
+        .replace(/^\/+|\/+$/g, "");
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+        const codeowner = codeowners[relPath];
+        if (codeowner) {
+            return codeowner;
+        }
+        const parent = path__default.posix.dirname(relPath);
+        if ((parent === relPath || parent === ".") && codeowners["."]) {
+            return codeowners["."];
+        }
+        if (parent === relPath || parent === ".") {
+            break;
+        }
+        relPath = parent;
+    }
+    return undefined;
+};
+
 /**
  * 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.
@@ -317,11 +444,16 @@ const setupPlugins = (on, config, logWriter, installHarGenerator) => {
         },
     });
     /* ---- END: Task setup ---- */
+    /* ---- BEGIN: codeowner setup ---- */
+    const codeowner = toShortTeamName(getCodeowner(config.projectRoot, config.nxRoot));
+    config.env.codeowner = codeowner;
+    /* ---- END: codeowner setup ---- */
     /* ---- BEGIN: HAR setup ---- */
     // Installing the HAR geneartor should happen last according to the documentation
     // https://github.com/NeuraLegion/cypress-har-generator?tab=readme-ov-file#setting-up-the-plugin
     installHarGenerator(on);
     /* ---- END: HAR setup ---- */
+    return config;
 };
 
 /* eslint-disable local-rules/no-typescript-assertion, @typescript-eslint/no-explicit-any */
@@ -365,5 +497,24 @@ function setupE2E() {
         return false;
     });
 }
+const originalDescribe = global.describe;
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+if (originalDescribe) {
+    const codeowner = Cypress.env("codeowner");
+    const addOwnerToTitle = (title) => {
+        return codeowner ? title + ` [${codeowner}]` : title;
+    };
+    function patchedDescribe(title, fn) {
+        return originalDescribe(addOwnerToTitle(title), fn);
+    }
+    patchedDescribe.only = (title, fn) => {
+        return originalDescribe.only(addOwnerToTitle(title), fn);
+    };
+    patchedDescribe.skip = (title, fn) => {
+        return originalDescribe.skip(addOwnerToTitle(title), fn);
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    global.describe = patchedDescribe;
+}
 
 export { createLogFile, defaultCypressConfig, setupDefaultCommands, setupE2E, setupHarRecording, setupPlugins, writeFileWithPrettier };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-e2e",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "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.1.4"
+    "@trackunit/react-test-setup": "1.1.6"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/plugins/defaultPlugins.d.ts

@@ -45,4 +45,4 @@ export declare const defaultCypressConfig: (optionsOrDirname?: E2EConfigOptions
  * Sets up Cypress plugins for logging, tasks, and HAR generation.
  * Configures terminal reporting, XLSX parsing, and HTTP archive recording.
  */
-export declare const setupPlugins: (on: Cypress.PluginEvents, config: CypressPluginConfig, logWriter: Formatter, installHarGenerator: (on: Cypress.PluginEvents) => void) => void;
+export declare const setupPlugins: (on: Cypress.PluginEvents, config: CypressPluginConfig, logWriter: Formatter, installHarGenerator: (on: Cypress.PluginEvents) => void) => CypressPluginConfig;

package/src/utils/Codeowner.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Parses lines from a CODEOWNERS‐style file into a mapping of patterns → owners.
+ * Skips blank lines and comments (lines beginning with `#`).
+ *
+ * @param {string[]} lines - Each element is a line from your CODEOWNERS file.
+ * @returns {Record<string, string>} An object whose keys are normalized path patterns (no leading/trailing slashes)
+ *                                  and whose values are the owner (e.g. a GitHub team handle).
+ * @example
+ * ```ts
+ * const lines = [
+ *   "# Our CODEOWNERS",
+ *   "/src @team/backend",
+ *   "README.md    @team/docs",
+ *   "",                 // blank lines ignored
+ *   "# end of file"
+ * ];
+ * const owners = parseCodeowners(lines);
+ * // → { "src": "@team/backend", "README.md": "@team/docs" }
+ * ```
+ */
+export declare const parseCodeowners: (lines: Array<string>) => Record<string, string>;
+/**
+ * Converts a full team handle (potentially namespaced and with platform suffix)
+ * into its “short” team name.
+ *
+ * - Strips any leading `@org/` prefix
+ * - Removes `-be` or `-fe` suffix if present
+ *
+ * @param {string} teamName - e.g. `"@trackunit/backend-be"` or `"@trackunit/frontend-fe"`
+ * @returns {string} e.g. `"backend"` or `"frontend"`
+ * @example
+ * ```ts
+ * toShortTeamName("@trackunit/backend-be");   // → "backend"
+ * toShortTeamName("@trackunit/frontend-fe");  // → "frontend"
+ * toShortTeamName("infra");                   // → "infra"
+ * ```
+ */
+export declare const toShortTeamName: (teamName?: string) => string | undefined;
+/**
+ * Recursively looks up the CODEOWNER for a given file or directory path
+ * by reading your workspace’s CODEOWNERS file.
+ *
+ * Walks up the directory tree until it finds a matching pattern. If no
+ * deeper match is found but there is a `"."` entry, returns that.
+ *
+ * @param {string} currentPath - Absolute path to the file/directory you’re querying.
+ * @param {string} workspaceRoot - Absolute path to your repo/workspace root.
+ * @param {string} [codeownersFileName="TEAM_CODEOWNERS"] - Filename to read at the root.
+ * @returns {string|undefined} The owner handle (e.g. `"@team/backend"`) or `undefined` if none found.
+ * @example
+ * ```ts
+ * // Suppose your repo root has a TEAM_CODEOWNERS file containing:
+ * // src @team/backend
+ * // src/utils @team/utils
+ * // . @team/root
+ *
+ * const owner1 = getCodeowner(
+ *   "/Users/alice/project/src/utils/helpers.ts",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/utils"
+ *
+ * const owner2 = getCodeowner(
+ *   "/Users/alice/project/other/file.txt",
+ *   "/Users/alice/project"
+ * );
+ * // → "@team/root"  (falls back to the "." entry)
+ * ```
+ */
+export declare const getCodeowner: (currentPath: string, workspaceRoot: string, codeownersFileName?: string) => string | undefined;