@capillarytech/cap-ui-utils 3.0.20 → 3.1.1

package/e2e/utils/automationBypassUtil.ts

@@ -0,0 +1,46 @@
+/**
+ * Env-driven kill-switch that lets a module's automation be turned off without a
+ * code change or a CI job edit. In prod the value is injected into the runner
+ * container as a plain environment variable (sourced from AWS); locally it comes
+ * from `.env` (loaded once via `import 'dotenv/config'` in test/wdio.conf.ts).
+ *
+ * AUTOMATION_BYPASS_MODULES is a JSON array of module names, e.g.
+ *   AUTOMATION_BYPASS_MODULES=["garudaUI","loyalty"]
+ * following the existing MODULES_WITH_AUTOMATION_CLEANUP convention. When the
+ * running `module` is in that list, the module's wdio config swaps its specs for
+ * test/bypass/automationBypassed.ts, which just logs and passes.
+ *
+ * Note this is unrelated to src/utils/featureFlagUtil.ts, which reads the app's
+ * in-browser feature flags and needs a live session; this gate runs at config
+ * load time, before any browser exists.
+ */
+class AutomationBypass {
+    /**
+     * Parse AUTOMATION_BYPASS_MODULES into a module-name list. A malformed value
+     * must never break a run, so anything unparseable is logged and treated as
+     * "nothing bypassed".
+     */
+    private getBypassedModules(): string[] {
+        const raw = (process.env.AUTOMATION_BYPASS_MODULES || '').trim();
+        if (!raw) return [];
+        try {
+            const parsed = JSON.parse(raw);
+            if (!Array.isArray(parsed)) {
+                console.log(`[automation-bypass] AUTOMATION_BYPASS_MODULES must be a JSON array, got: ${raw}`);
+                return [];
+            }
+            return parsed.map((m) => String(m).trim()).filter(Boolean);
+        } catch (error) {
+            console.log(`[automation-bypass] Could not parse AUTOMATION_BYPASS_MODULES (${raw}): ${error}`);
+            return [];
+        }
+    }
+
+    /** True when the given module's automation should be bypassed. */
+    isBypassed(module: string | undefined = process.env.module): boolean {
+        if (!module) return false;
+        return this.getBypassedModules().includes(module);
+    }
+}
+
+export default new AutomationBypass();

package/e2e/utils/debugModeUtil.ts

@@ -0,0 +1,32 @@
+/**
+ * Central gate for the FULL_DEBUG capture feature (request-payload + screenshot
+ * recording) and, indirectly, for whether the devtools automation protocol is
+ * registered at all (see wdio.conf.ts).
+ *
+ * Capture is enabled only when FULL_DEBUG_MODE=true AND, if the optional
+ * DEBUG_MODULES list is provided, the current `module` is in that list.
+ *
+ * DEBUG_MODULES is a comma-separated list of module names, e.g.
+ *   FULL_DEBUG_MODE=true DEBUG_MODULES=engage,creatives module=engage npx wdio ...
+ * captures only for `engage` and `creatives`. When DEBUG_MODULES is empty/unset,
+ * capture applies to every module (falls back to FULL_DEBUG_MODE alone).
+ */
+class DebugMode {
+    /** Parse DEBUG_MODULES into a trimmed, non-empty module-name list. */
+    private getDebugModules(): string[] {
+        return (process.env.DEBUG_MODULES || '')
+            .split(',')
+            .map((m) => m.trim())
+            .filter(Boolean);
+    }
+
+    /** True when request/screenshot capture should run for the current module. */
+    isCaptureEnabled(): boolean {
+        if (process.env.FULL_DEBUG_MODE !== 'true') return false;
+        const modules = this.getDebugModules();
+        if (modules.length === 0) return true;
+        return modules.includes(process.env.module || '');
+    }
+}
+
+export default new DebugMode();

package/e2e/utils/deletionRegistry.ts

@@ -0,0 +1,15 @@
+class DeletionRegistry {
+  private deleted = new Set<string>();
+
+  has(name: string): boolean {
+    return this.deleted.has(name);
+  }
+
+  register(name: string): void {
+    this.deleted.add(name);
+    console.log(`DeletionRegistry: registered "${name}"`);
+  }
+}
+
+const deletionRegistry = new DeletionRegistry();
+export default deletionRegistry;