@koenvanbelle/cypress-soft-assertions 2.2.1 → 2.3.1

package/README.md

@@ -168,6 +168,87 @@ SOFT ASSERTION FAILURES (3 failed):
   ```
 - **Cypress Studio / Command Log**: When a soft assertion fails definitively, the plugin swallows the error so the test can continue. Cypress treats the command as resolved, which means it may not appear as a failed step in the Cypress Studio command log or may look like the assertion was skipped. The assertions **do** execute and failures **are** captured — they just don't show visually in the command log. Check the final `SoftAssertionError` report for the complete list of failures.
 
+## Compatibility: cypress-translation-checker
+
+`@koenvanbelle/cypress-soft-assertions` is compatible with `cypress-translation-checker` (verified with `cypress-translation-checker@1.3.4` and Cypress 15).
+
+### Install
+
+```bash
+npm install --save-dev @koenvanbelle/cypress-soft-assertions cypress-translation-checker
+```
+
+### 1. Register translation-checker tasks in Cypress config
+
+`cypress-translation-checker` uses Cypress tasks to persist collected page results. Add these in `setupNodeEvents`.
+
+```typescript
+import { defineConfig } from 'cypress';
+
+const translationResults = new Map<string, { url: string; errors: any[]; testContext: string }>();
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      on('task', {
+        storeTranslationResult({
+          url,
+          errors,
+          testContext,
+        }: {
+          url: string;
+          errors: any[];
+          testContext: string;
+        }) {
+          translationResults.set(url, { url, errors, testContext });
+          return null;
+        },
+        getTranslationResults() {
+          return Array.from(translationResults.values());
+        },
+        clearTranslationResults() {
+          translationResults.clear();
+          return null;
+        },
+      });
+
+      return config;
+    },
+  },
+});
+```
+
+### 2. Import both plugins in support file
+
+Enable soft assertions and then enable automatic translation checks.
+
+```typescript
+import '@koenvanbelle/cypress-soft-assertions';
+import { enableAutoTranslationCheck } from 'cypress-translation-checker/commands';
+
+enableAutoTranslationCheck({
+  waitTime: 500,
+});
+```
+
+### 3. Write tests normally with `soft_it`
+
+Soft assertion failures are still aggregated into one `SoftAssertionError` at test end.
+
+```typescript
+soft_it('works with automatic translation checks', () => {
+  cy.visit('/');
+  cy.get('h1').should('have.text', 'Expected title');
+  cy.get('#status').should('have.text', 'Ready');
+});
+```
+
+### Notes
+
+- If translation-checker tasks are missing, Cypress will fail with unknown task errors.
+- Both plugins register hooks/events, but they can run together safely with the setup above.
+- Keep translation-checker in non-invasive mode (`failOnError: false` in auto mode) so functional assertions remain the source of test pass/fail behavior.
+
 ## License
 
 MIT

package/dist/index.js

@@ -15,12 +15,16 @@
  * - An afterEach hook finalizes: aggregates all failures and reports them.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
 let softAssertionErrors = [];
 let retryAssertionFailures = new Map();
 let retryFirstSeen = new Map();
 let isInSoftTest = false;
 let activeFailHandler = null;
 let originalChaiAssert = null;
+// ---------------------------------------------------------------------------
+// Module-level state
+// ---------------------------------------------------------------------------
 function getEffectiveTimeout() {
     var _a;
     try {
@@ -37,40 +41,13 @@ function getEffectiveTimeout() {
         return 4000;
     }
 }
+// ---------------------------------------------------------------------------
+// Internal helpers (Cypress-dependent — not unit-testable in isolation)
+// ---------------------------------------------------------------------------
 function captureSoftAssertion(error) {
     const message = (error === null || error === void 0 ? void 0 : error.message) || String(error);
     const stack = error === null || error === void 0 ? void 0 : error.stack;
-    const lastEntry = softAssertionErrors[softAssertionErrors.length - 1];
-    if (!lastEntry || lastEntry.message !== message || lastEntry.stack !== stack) {
-        softAssertionErrors.push({ message, stack });
-    }
-}
-function getSubjectKey(assertionContext) {
-    const obj = assertionContext === null || assertionContext === void 0 ? void 0 : assertionContext._obj;
-    const first = Array.isArray(obj) ? obj[0] : obj === null || obj === void 0 ? void 0 : obj[0];
-    if (first && typeof first.id === 'string' && first.id.length > 0) {
-        return `#${first.id}`;
-    }
-    const selector = obj === null || obj === void 0 ? void 0 : obj.selector;
-    if (typeof selector === 'string' && selector.length > 0) {
-        return selector;
-    }
-    return '';
-}
-function toTokenPart(value) {
-    if (value === undefined)
-        return 'undefined';
-    if (value === null)
-        return 'null';
-    const kind = typeof value;
-    if (kind === 'string' || kind === 'number' || kind === 'boolean')
-        return String(value);
-    try {
-        return JSON.stringify(value);
-    }
-    catch (_a) {
-        return String(value);
-    }
+    (0, utils_1.appendUniqueError)(softAssertionErrors, message, stack);
 }
 function getRetryableCommandId() {
     var _a, _b, _c, _d, _e, _f, _g;
@@ -91,13 +68,6 @@ function getRetryableCommandId() {
     catch ( /* ignore */_h) { /* ignore */ }
     return '';
 }
-function getAssertionToken(assertionContext, args) {
-    const subjectKey = getSubjectKey(assertionContext);
-    if (!subjectKey)
-        return '';
-    const expected = args === null || args === void 0 ? void 0 : args[3];
-    return `${subjectKey}|${toTokenPart(expected)}`;
-}
 function patchChaiAssertions() {
     var _a;
     const assertionProto = (_a = chai === null || chai === void 0 ? void 0 : chai.Assertion) === null || _a === void 0 ? void 0 : _a.prototype;
@@ -110,13 +80,18 @@ function patchChaiAssertions() {
     assertionProto.assert = patchedAssertionAssert;
 }
 function resolveStableToken(assertionContext, args) {
-    const token = getAssertionToken(assertionContext, args);
-    if (token)
-        return token;
-    const retryableCid = getRetryableCommandId();
-    if (retryableCid)
-        return `__cmd__|${retryableCid}|${toTokenPart(args === null || args === void 0 ? void 0 : args[3])}`;
-    return '';
+    return (0, utils_1.resolveToken)((0, utils_1.getAssertionToken)(assertionContext, args), getRetryableCommandId(), args);
+}
+function isRunningHookContext() {
+    var _a;
+    try {
+        const runnable = cy.state('runnable');
+        const type = (_a = runnable === null || runnable === void 0 ? void 0 : runnable.type) !== null && _a !== void 0 ? _a : runnable === null || runnable === void 0 ? void 0 : runnable._type;
+        return type === 'hook';
+    }
+    catch (_b) {
+        return false;
+    }
 }
 function patchedAssertionAssert(...args) {
     if (!originalChaiAssert)
@@ -136,6 +111,8 @@ function patchedAssertionAssert(...args) {
     catch (error) {
         if (!isInSoftTest)
             throw error;
+        if (isRunningHookContext())
+            throw error;
         const errorEntry = {
             message: String((error === null || error === void 0 ? void 0 : error.message) || error),
             stack: error === null || error === void 0 ? void 0 : error.stack,
@@ -178,6 +155,8 @@ function setupSoftAssertions() {
         activeFailHandler = (error) => {
             if (!isInSoftTest)
                 throw error;
+            if (isRunningHookContext())
+                throw error;
             // Final aggregated error must propagate to fail the test.
             if (String((error === null || error === void 0 ? void 0 : error.name) || '') === 'SoftAssertionError')
                 throw error;
@@ -215,27 +194,11 @@ function restoreAssertions() {
 function buildSoftAssertionError() {
     // Promote any remaining retry-tracked failures that weren't already
     // captured by the fail handler (dedup by message).
-    for (const entry of retryAssertionFailures.values()) {
-        const isDuplicate = softAssertionErrors.some(e => e.message === entry.message);
-        if (!isDuplicate) {
-            softAssertionErrors.push(entry);
-        }
-    }
+    softAssertionErrors = (0, utils_1.mergeRetryFailures)(softAssertionErrors, retryAssertionFailures);
     retryAssertionFailures.clear();
     retryFirstSeen.clear();
-    if (softAssertionErrors.length > 0) {
-        const errorMessages = softAssertionErrors
-            .map((entry, index) => `  ${index + 1}. ${entry.message}`)
-            .join('\n');
-        const finalMessage = [
-            '',
-            '='.repeat(80),
-            `SOFT ASSERTION FAILURES (${softAssertionErrors.length} failed):`,
-            '='.repeat(80),
-            errorMessages,
-            '='.repeat(80),
-            '',
-        ].join('\n');
+    const finalMessage = (0, utils_1.formatSoftAssertionErrors)(softAssertionErrors);
+    if (finalMessage !== null) {
         softAssertionErrors = [];
         const error = new Error(finalMessage);
         error.name = 'SoftAssertionError';
@@ -302,15 +265,24 @@ globalThis.soft_it.skip = it.skip;
 // Registered at the root level so it applies to all suites.
 // For non-soft tests (isInSoftTest === false), this is a no-op.
 afterEach(function () {
-    var _a;
+    var _a, _b, _c;
     if (!isInSoftTest)
         return;
     const finalError = finalizeSoftTest();
     if (finalError) {
-        // Use runner.fail() to mark the TEST as failed rather than the hook.
-        // Throwing from afterEach would skip remaining tests in the suite.
-        const runner = (_a = Cypress.mocha) === null || _a === void 0 ? void 0 : _a.getRunner();
         const test = this.currentTest;
+        const currentRetry = (_a = test === null || test === void 0 ? void 0 : test._currentRetry) !== null && _a !== void 0 ? _a : 0;
+        const maxRetries = (_b = test === null || test === void 0 ? void 0 : test._retries) !== null && _b !== void 0 ? _b : 0;
+        if (currentRetry < maxRetries) {
+            // Intermediate retry attempt — throw so Cypress triggers the next retry.
+            // Cypress's retry machinery intercepts hook failures during non-final
+            // attempts and does NOT abort the suite, so this is safe here.
+            throw finalError;
+        }
+        // Last (or only) attempt — use runner.fail() to mark the TEST as failed
+        // rather than the hook. Throwing from afterEach on the final attempt
+        // would skip remaining tests in the suite.
+        const runner = (_c = Cypress.mocha) === null || _c === void 0 ? void 0 : _c.getRunner();
         if (runner && test) {
             runner.fail(test, finalError);
         }

package/dist/utils.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Pure utility functions for the soft assertions plugin.
+ *
+ * These are free of Cypress/Chai globals and module-level state, making them
+ * suitable for fast, isolated unit testing without a running Cypress instance.
+ */
+export interface ErrorEntry {
+    message: string;
+    stack?: string;
+}
+/**
+ * Converts any value to a stable string token component.
+ * Used when building assertion identity tokens for retry-tracking.
+ */
+export declare function toTokenPart(value: any): string;
+/**
+ * Extracts a stable key from a Chai assertion context's subject.
+ * Returns '#<id>' for elements with an id, the jQuery selector string if available,
+ * or '' when nothing stable can be derived.
+ */
+export declare function getSubjectKey(assertionContext: any): string;
+/**
+ * Builds a stable token that uniquely identifies a retryable assertion by
+ * combining the subject key with the expected value.
+ * Returns '' when no stable key can be derived (token-less assertion).
+ */
+export declare function getAssertionToken(assertionContext: any, args: any[]): string;
+/**
+ * Appends an error to the list only if it is not a consecutive duplicate.
+ * "Duplicate" means the immediately preceding entry has an identical message
+ * AND identical stack. Non-consecutive duplicates are always appended.
+ *
+ * Mutates the provided array in place (matching the original behaviour of
+ * captureSoftAssertion).
+ */
+export declare function appendUniqueError(errors: ErrorEntry[], message: string, stack?: string): void;
+/**
+ * Promotes entries from retryFailures into softErrors, skipping any entry
+ * whose message already appears in softErrors (message-only dedup).
+ *
+ * Returns a new array — does not mutate either input. The retry map is also
+ * left untouched; callers are responsible for clearing it afterwards.
+ */
+export declare function mergeRetryFailures(softErrors: ErrorEntry[], retryFailures: Map<string, ErrorEntry>): ErrorEntry[];
+/**
+ * Resolves the stable token that identifies a retryable assertion.
+ *
+ * Priority:
+ *  1. assertionToken (derived from subject id / selector + expected value)
+ *  2. commandId-based token (used when the subject has no stable id/selector)
+ *  3. '' (token-less — assertion will be captured immediately instead of tracked)
+ */
+export declare function resolveToken(assertionToken: string, commandId: string, args: any[]): string;
+/**
+ * Formats a list of captured soft assertion errors into the final
+ * SoftAssertionError message string.
+ * Returns null when the list is empty (no failures to report).
+ */
+export declare function formatSoftAssertionErrors(errors: ErrorEntry[]): string | null;

package/dist/utils.js

@@ -0,0 +1,130 @@
+"use strict";
+/**
+ * Pure utility functions for the soft assertions plugin.
+ *
+ * These are free of Cypress/Chai globals and module-level state, making them
+ * suitable for fast, isolated unit testing without a running Cypress instance.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTokenPart = toTokenPart;
+exports.getSubjectKey = getSubjectKey;
+exports.getAssertionToken = getAssertionToken;
+exports.appendUniqueError = appendUniqueError;
+exports.mergeRetryFailures = mergeRetryFailures;
+exports.resolveToken = resolveToken;
+exports.formatSoftAssertionErrors = formatSoftAssertionErrors;
+/**
+ * Converts any value to a stable string token component.
+ * Used when building assertion identity tokens for retry-tracking.
+ */
+function toTokenPart(value) {
+    if (value === undefined)
+        return 'undefined';
+    if (value === null)
+        return 'null';
+    const kind = typeof value;
+    if (kind === 'string' || kind === 'number' || kind === 'boolean')
+        return String(value);
+    try {
+        return JSON.stringify(value);
+    }
+    catch (_a) {
+        return String(value);
+    }
+}
+/**
+ * Extracts a stable key from a Chai assertion context's subject.
+ * Returns '#<id>' for elements with an id, the jQuery selector string if available,
+ * or '' when nothing stable can be derived.
+ */
+function getSubjectKey(assertionContext) {
+    const obj = assertionContext === null || assertionContext === void 0 ? void 0 : assertionContext._obj;
+    const first = Array.isArray(obj) ? obj[0] : obj === null || obj === void 0 ? void 0 : obj[0];
+    if (first && typeof first.id === 'string' && first.id.length > 0) {
+        return `#${first.id}`;
+    }
+    const selector = obj === null || obj === void 0 ? void 0 : obj.selector;
+    if (typeof selector === 'string' && selector.length > 0) {
+        return selector;
+    }
+    return '';
+}
+/**
+ * Builds a stable token that uniquely identifies a retryable assertion by
+ * combining the subject key with the expected value.
+ * Returns '' when no stable key can be derived (token-less assertion).
+ */
+function getAssertionToken(assertionContext, args) {
+    const subjectKey = getSubjectKey(assertionContext);
+    if (!subjectKey)
+        return '';
+    const expected = args === null || args === void 0 ? void 0 : args[3];
+    return `${subjectKey}|${toTokenPart(expected)}`;
+}
+/**
+ * Appends an error to the list only if it is not a consecutive duplicate.
+ * "Duplicate" means the immediately preceding entry has an identical message
+ * AND identical stack. Non-consecutive duplicates are always appended.
+ *
+ * Mutates the provided array in place (matching the original behaviour of
+ * captureSoftAssertion).
+ */
+function appendUniqueError(errors, message, stack) {
+    const lastEntry = errors[errors.length - 1];
+    if (!lastEntry || lastEntry.message !== message || lastEntry.stack !== stack) {
+        errors.push({ message, stack });
+    }
+}
+/**
+ * Promotes entries from retryFailures into softErrors, skipping any entry
+ * whose message already appears in softErrors (message-only dedup).
+ *
+ * Returns a new array — does not mutate either input. The retry map is also
+ * left untouched; callers are responsible for clearing it afterwards.
+ */
+function mergeRetryFailures(softErrors, retryFailures) {
+    const result = [...softErrors];
+    for (const entry of retryFailures.values()) {
+        const isDuplicate = result.some(e => e.message === entry.message);
+        if (!isDuplicate) {
+            result.push(entry);
+        }
+    }
+    return result;
+}
+/**
+ * Resolves the stable token that identifies a retryable assertion.
+ *
+ * Priority:
+ *  1. assertionToken (derived from subject id / selector + expected value)
+ *  2. commandId-based token (used when the subject has no stable id/selector)
+ *  3. '' (token-less — assertion will be captured immediately instead of tracked)
+ */
+function resolveToken(assertionToken, commandId, args) {
+    if (assertionToken)
+        return assertionToken;
+    if (commandId)
+        return `__cmd__|${commandId}|${toTokenPart(args === null || args === void 0 ? void 0 : args[3])}`;
+    return '';
+}
+/**
+ * Formats a list of captured soft assertion errors into the final
+ * SoftAssertionError message string.
+ * Returns null when the list is empty (no failures to report).
+ */
+function formatSoftAssertionErrors(errors) {
+    if (errors.length === 0)
+        return null;
+    const errorMessages = errors
+        .map((entry, index) => `  ${index + 1}. ${entry.message}`)
+        .join('\n');
+    return [
+        '',
+        '='.repeat(80),
+        `SOFT ASSERTION FAILURES (${errors.length} failed):`,
+        '='.repeat(80),
+        errorMessages,
+        '='.repeat(80),
+        '',
+    ].join('\n');
+}

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@koenvanbelle/cypress-soft-assertions",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "A Cypress plugin that provides soft_it() for soft assertions - all assertions continue on failure and are reported together",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "prepare": "npm run build",
     "prepublishOnly": "npm run build",
     "cy:open": "cypress open",
     "cy:run": "cypress run",
-    "test": "npm run build && cypress run && npm run test:runner",
+    "test": "npm run build && npm run test:unit && cypress run && npm run test:runner",
+    "test:unit": "node --test test/unit.test.mjs",
     "test:runner": "node --test test/runner.test.mjs"
   },
   "keywords": [
@@ -37,9 +39,10 @@
     "cypress": ">=10.0.0"
   },
   "devDependencies": {
+    "@types/mocha": "^10.0.10",
     "cypress": "^15.9.0",
-    "typescript": "^5.9.3",
-    "@types/mocha": "^10.0.10"
+    "cypress-translation-checker": "^1.3.4",
+    "typescript": "^5.9.3"
   },
   "files": [
     "dist",