fix(SDK-6463): robust TS config compile in NX monorepos + tolerate a11y afterEach scan timeouts#1131
fix(SDK-6463): robust TS config compile in NX monorepos + tolerate a11y afterEach scan timeouts#1131Bhargavi-BS wants to merge 10 commits into
Conversation
When the cypress config is TypeScript and lives in an NX/monorepo, the extends temp tsconfig inherited base options (noEmit / emitDeclarationOnly / composite / noEmitOnError) that suppress or redirect the compiled JS, and any tsc type-error short-circuited the '&&'-chained tsc-alias so path aliases were left un-rewritten. The compiled config then could not be found/required, the error was silently swallowed, and getNumberOfSpecFiles fell back to a default glob that found 0 specs -> setParallels collapsed parallels to 1. Force emit-friendly overrides in the extends temp tsconfig and run tsc-alias unconditionally (& / ; instead of &&). Adds regression tests covering the emit-override and unconditional-alias behavior. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…K-6463)
A hung accessibility scan made the 30s cy.wrap() time out and fail the afterEach hook, which makes Cypress skip ALL remaining tests in the spec (they surface as 'skipped' instead of running). Add .catch handlers to both cy.wrap(..., {timeout:30000}) chains (performScan and saveTestResults) so a timeout is logged instead of cascading into skipped tests. Adds a regression test that loads the real plugin afterEach and asserts tolerance.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
amaanbs
left a comment
There was a problem hiding this comment.
Automated SDK PR Review
Verdict: Request Changes — 1 finding to address before merging (W1), 1 suggestion for follow-up (S1).
Summary: 0 critical · 1 warning · 1 suggestion across 2 files reviewed.
The Unix half of the fix (; instead of && between tsc and tsc-alias) is correct and ready to ship. The Windows half (&) has a concurrency concern — on Windows CMD, & starts the second command without waiting for the first to finish, which may cause tsc-alias to process a not-yet-emitted file. This is verifiable empirically; see W1 for the idiomatic Windows fix. S1 (silent a11y scan timeout) is a follow-up suggestion, not a blocker.
See inline comments below for full Problem and Suggested Fix detail.
Generated by Automated SDK PR review.
…ways-settle (SDK-6463) The earlier afterEach used .catch() on Cypress chains (cy.wrap(...).then(...).catch(...)). Cypress Chainable has no .catch (commands are not promises), so it threw 'cy.wrap(...).then(...).catch is not a function' synchronously in the hook, failing it and aborting the rest of the spec — the customer's exact symptom. Rework: performScan/saveTestResults now ALWAYS settle (internal timeout tunable via ACCESSIBILITY_SCAN_TIMEOUT, default 25s) and guard cross-origin window access, so cy.wrap's 30s timeout never fires and the hook never throws. Verified with REAL Cypress (headed): the old code reproduces 'skipping all of the remaining tests'; the reworked code runs all tests and completes the scan path (Payload to send / Saved accessibility test results logged). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…nsion (SDK-6463) glob.sync (glob@7->minimatch@3, and even glob@10->minimatch@9) throws 'expand is not a function' / 'brace_expansion_1.default is not a function' when a project force-resolves brace-expansion to an incompatible major (e.g. 5.x) via yarn resolutions / npm overrides. That crash aborted getNumberOfSpecFiles and produced builds with 0 executed tests (or crashed the run). A secondary bug in deleteBaseUrlFromError (err.replace on a non-string) then masked the real error. - Wrap glob.sync in safeGlobSync: log once and return [] on failure so spec discovery and the run proceed (specs are resolved on BrowserStack regardless of the local count). - Backstop try/catch in getNumberOfSpecFiles so it never throws. - Guard deleteBaseUrlFromError against non-string errors. Verified against a real glob@7 + brace-expansion@5 crash. Adds regression tests. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ion-resilience fix(SDK-6463): survive glob/minimatch crash from incompatible brace-expansion (0-test builds)
… repeated scan timeouts (SDK-6463)
The always-settle rework stops scan/save promises from hanging, but the a11y afterEach can still FAIL from its own Cypress commands — e.g. cy.window() on a cross-origin page (SSO redirect to login.microsoftonline.com) or cy.task('get_test_run_uuid') when the TO node plugin isn't registered. Cypress chains have no .catch, so the correct 'catch' is the per-test fail listener: cy.on('fail', () => false) registered at the top of the hook suppresses any failure raised by the hook's commands, so the user's test is never failed and the spec is never aborted.
Also adds a circuit breaker: each hung scan/save costs up to ACCESSIBILITY_SCAN_TIMEOUT (default 25s) per test; after 3 consecutive timeouts (configurable via ACCESSIBILITY_SCAN_CIRCUIT_LIMIT) the plugin stops attempting accessibility work for the rest of the spec instead of stalling every remaining test and wrapped command.
Verified with REAL Cypress 13.15.0 (headed):
- unregistered-task scenario: without guard -> hook fails, 'skipping all of the remaining tests' (0 passing); with guard -> all tests pass
- hung-scanner scenario: all tests pass, no abort
- circuit breaker: deterministic server-side count shows A11Y_SCAN stops after the circuit opens (2 hits across 4 tests)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…il-guard fix(SDK-6463): catch a11y afterEach failures (cy.on fail guard) + circuit-break repeated scan timeouts
amaanbs
left a comment
There was a problem hiding this comment.
Remove ticket identifiers from comments.
Addresses review feedback on #1131 — comments now describe the behavior without referencing the internal ticket. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Same review convention as requested on #1131. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
done |
SDK-6463 — Cypress test-count / status inconsistencies (customer: Sapiens, NX monorepo)
Fixes two client-side
browserstack-cypress-clidefects surfaced by SDK-6463. The customer's reported dashboard count discrepancy is largely not a CLI bug (see RCA below); these two fixes address the genuine CLI defects: silently broken parallelization in NX monorepos, and accessibility-hook timeouts skipping tests.RCA — the "inconsistency" is three layers
@cypress/greptags +browserstack.jsonexclude globs) — expected behavior.C.1 — TS cypress-config compile fails silently in NX monorepos → parallelization collapses
readCypressConfigUtil.convertTsConfigcompiles the TS config to read it. In an NX/monorepo:noEmit/emitDeclarationOnly/composite/noEmitOnError) that suppress or redirect the compiled JS, and&&-chainedtsc-alias, leaving path aliases (e.g.@org/lib) un-rewritten so the compiled config couldn't berequire()d.The read error was then silently swallowed (
readCypressConfigFilecatch) →cypressConfigFile = {}→getNumberOfSpecFilesfell back to the defaultcypress/e2e/**glob → 0 specs →setParallelsforcedparallelstobrowserCombinations.length. This is the customer'sParallels limit specified: 1(despiteparallels: 3) and the repeatedCypress config file not found at: …tmpBstackCompiledJs/…errors.Fix (
bin/helpers/readCypressConfigUtil.js):noEmit:false, emitDeclarationOnly:false, composite:false, declaration:false, declarationMap:false, noEmitOnError:false, incremental:false. These only affect the throwaway temp tsconfig used to read the config — not the user's real build.tsc-aliasunconditionally (&on Windows /;on Unix instead of&&) so a tsc type error doesn't leave aliases un-rewritten.convertTsConfigalready tolerates tsc errors by parsing the emitted-files output.C.2 — accessibility
afterEachscan/save timeout skips the rest of the specbin/accessibility-automation/cypress/index.jscallscy.wrap(performScan(win), {timeout:30000})andcy.wrap(saveTestResults(win, …), {timeout:30000})in the globalafterEachwith no rejection handling. When the in-page scanner doesn't echoA11Y_SCAN_FINISHED/A11Y_RESULTS_SAVED, the wrap times out, theafterEachhook fails, and Cypress skips all remaining tests in the spec — the ticket's "cy.wrap() timed out … Because this error occurred during a after each hook we are skipping all of the remaining tests" and "should have failed but got skipped".Fix: add
.catchto both wrap chains so a hung scan/save is logged, not cascaded into skipped tests.Validation
C.1 — real BrowserStack infra (same project & config, only the CLI differs):
Cypress config file not founderrorsParallels limit specified(config hasparallels: 3)7493f8339065f0570cd0867d7bec599487bb6dd9bba6009df5e214058e1567f17ac268ea312675e0C.1 — local NX tsconfig matrix:
noEmit/emitDeclarationOnly/composite/noEmitOnError+type-error all fail to read the config before the fix and read OK after it.C.2 — local simulation: drives the real plugin
afterEachwith a hung scanner; the new regression test fails without the fix and passes with it across hung-scan, hung-save, and happy-path scenarios.Unit suite: 685 passing (was 678 → +7 new tests), 0 new failures (13 failures pre-exist on a clean tree and are unrelated).
Files
bin/helpers/readCypressConfigUtil.js— C.1 fixbin/accessibility-automation/cypress/index.js— C.2 fixtest/unit/bin/helpers/readCypressConfigUtil.js— +3 C.1 regression teststest/unit/bin/accessibility-automation/cypress/index.js— new, +4 C.2 regression testsNotes / follow-ups
index.js:292references an undefinedincludeTags(should beincludeTagArray), reachable only when accessibility include/exclude tags are set. Not fixed here; worth a separate ticket.🤖 Generated with Claude Code