fix: normalize test body `invocationDetails` from stack traces #32699

astone123 · 2025-10-10T19:39:17Z

This PR closes https://github.com/cypress-io/cypress-services/issues/11991

Additional details

There are a few cases where we don't correctly derive the test body invocation details from the stack trace. This PR fixes those scenarios by looking for at eval or at Suite.eval in Chrome stack traces, and lines with anonymous functions in Firefox stack traces. This will allow Cypress Studio and "Open in IDE" features to work in more cases than they did before.

One of these situations is when it has been re-written as itGrep which happens in the @cypress/grep and @bahmutov/cy-grep plugins. This allows us to determine the correct invocation details for the test.

Steps to test

I tested this with the @bahmutov/cy-grep package. Install the package and register it in your support file in accordance with the documentation. Open Cypress Studio by clicking the "edit in studio" button next to a test. Verify that the test content is loaded correctly and you can edit and save the test as expected.

How has the user experience changed?

Users of @bahmutov/cy-grep package can now use Cypress studio as intended

PR Tasks

Have tests been added/updated?
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?

Note

Normalizes test body invocation details from stack traces (Chrome/Firefox), updates Mocha to request test-specific details, and adds targeted tests plus changelog entry.

Driver:
- stack_utils: add browser-aware trimming via stackTrimmedToTestInvocation() and extend getInvocationDetails(specWindow, root, 'test') to normalize test invocation frames.
- mocha.ts: pass 'test' to getInvocationDetails when adding tests so IDE/Studio get accurate file/line/column.
Tests:
- E2E: expand reporter.hooks.cy.ts with assertions for correct "Open in IDE" invocation details (before hook, basic body, .only, wrapped it).
- Unit: add cases validating stack trimming and fallback behavior in stack_utils.spec.ts.
- Fixtures: add hooks/wrapped-it.cy.js.
Docs/Meta:
- Update cli/CHANGELOG.md with a bugfix note about correcting invocation details from stack traces.

^{Written by Cursor Bugbot for commit 4a53ed1. This will update automatically on new commits. Configure here.}

… invocationDetails

cypress · 2025-10-10T20:22:11Z

cypress Run #67291

Run Properties: Failed #67291 • 4a53ed1626: changelog entry

Project	`cypress`
Branch Review	`astone123/fix-itgrep-trace`
Run status	`Failed #67291`
Run duration	`18m 53s`
Commit	`4a53ed1626: changelog entry`
Committer	`astone123`
View all properties for this run ↗︎

Test results
Failures	`1`
Flaky	`12`
Pending	`1098`
Skipped	`4`
Passing	`26596`
View all changes introduced in this branch ↗︎

Warning

Partial Report: The results for the Application Quality reports may be incomplete.

UI Coverage `45.48%`
Untested elements	`188`
Tested elements	`161`

Accessibility `97.99%`
Failed rules	`4 critical` `8 serious` `2 moderate` `2 minor`
Failed elements	`101`

Tests for review

cypress/e2e/commands/files.cy.js • 1 failed test • 5x-driver-firefox

View Output

Test Artifacts

src/cy/commands/files > #readFile > retries to read when ENOENT

    </td>
  </tr></table>

commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test		Artifacts
... > stops waiting when an fetch request is canceled		`Test Replay`

issues/28527.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

e2e/origin/config_env.cy.ts • 1 flaky test • 5x-driver-inject-document-domain-chrome:beta

View Output

Test		Artifacts
cy.origin- Cypress.config() > serializable > overwrites different values in secondary if one exists in the primary		`Test Replay`

e2e/origin/config_env.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
cy.origin- Cypress.config() > serializable > overwrites different values in secondary if one exists in the primary		`Test Replay`

issues/28527.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

The first 5 flaky specs are shown, see all 11 specs in Cypress Cloud.

astone123 · 2025-10-28T13:07:05Z

@mschile @mabela416
After looking at fixing this on the cloud side for a bit, I think the best way to handle the grep stack issue is with a solution like this on the app side. We use the invocation details in various places across the app to decide which test to focus in studio mode and other things, so normalizing the stack on the cloud side doesn't fix the issue entirely. Let me know what you think

mabela416

I tested it locally and it works

AtofStryker · 2025-10-31T15:51:12Z

packages/driver/src/cypress/stack_utils.ts

      }
    }

+    // if the stack includes the 'itGrep' function, remove any lines that include it


Likely good to reference what itGrep is and where it is coming from (same with above) https://github.com/cypress-io/cypress/blob/develop/npm/grep/src/register.ts#L77. people who aren't familiar with @cypress/grep will struggle to understand what this means.

The other concern I have is that there could be something legitimate in the stack that has itGrep in it that we want to capture but are omitting it here. Or is this only considered when trying to calculate the row/column in the spec file where the error occurred?

Added a comment there. I'm pretty sure this function is specifically used to identify where the test was executed from, so this shouldn't affect anything else. If it does, it'll be limited to use of the grep plugin

astone123 · 2025-11-03T16:17:38Z

@mschile I updated this so that it works for tests with .only as well as tests that are nested in suite definitions

packages/driver/src/cypress/stack_utils.ts

mschile · 2025-11-12T17:36:27Z

packages/driver/src/cypress/stack_utils.ts

+      ) {
+        lines.shift()
+      }
+    } else if (specWindow.Cypress.isBrowser('firefox')) {


Where is firefox tested?

We need to make sure we have sufficient testing where if the stack implementation changed, our tests would fail for both chromium and firefox.

packages/driver/src/cypress/mocha.ts

packages/driver/src/cypress/stack_utils.ts

mschile · 2025-11-12T18:08:41Z

packages/driver/src/cypress/stack_utils.ts

+    if (specWindow.Cypress.isBrowser('chrome')) {
+    // There are cases where there are other lines in the stack trace before the invocation (eg. `context.it.only`, `createRunnable`, etc)
+    // Remove lines from the start until the top line starts with 'at eval' or 'at Suite.eval' so that we only keep the actual invocation line.
+      while (


Suggest using _.dropWhile (also used elsewhere in the file).

mschile · 2025-11-12T18:17:22Z

packages/driver/src/cypress/stack_utils.ts

+        return splitAtAt.length > 1 && splitAtAt[0].trim().length === 0
+      }
+
+      while (


mschile · 2025-11-12T18:28:38Z

packages/driver/src/cypress/stack_utils.ts

+  })
+
+  // if we removed all the lines then something went wrong. return the original stack instead
+  if (modifiedStack.length === 0) {


I don't think this works since the error will still be on the stack as shown with the return value in stackWithLinesRemoved.

updated this logic to return the original stack if the modified stack is Error

mschile · 2025-11-12T18:35:55Z

packages/driver/test/unit/cypress/stack_utils.spec.ts

+    })
+
+    it('returns the correct invocation details for a grep stack trace for a test body', () => {
+      const stack = `Error at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)


The Error should be on it's own line:

Suggested change

const stack = `Error at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

const stack = `Error

at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

mschile · 2025-11-12T18:36:28Z

packages/driver/test/unit/cypress/stack_utils.spec.ts

+    })
+
+    it('returns the original stack if it cannot be normalized for a test body', () => {
+      const stack = `Error at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)


The Error should be on it's own line:

Suggested change

const stack = `Error at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

const stack = `Error

at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

mschile · 2025-11-12T18:36:41Z

packages/driver/test/unit/cypress/stack_utils.spec.ts

+      }))
+    })
+
+    it('returns the original stack if it cannot be normalized for a test body', () => {


Suggested change

it('returns the original stack if it cannot be normalized for a test body', () => {

it('returns the original stack if it cannot be normalized for a test', () => {

mschile · 2025-11-12T18:37:46Z

packages/driver/test/unit/cypress/stack_utils.spec.ts

      })
    }
+
+    it('returns the correct invocation details for a grep stack trace', () => {


Suggested change

it('returns the correct invocation details for a grep stack trace', () => {

it('returns the correct invocation details for a test with a stack that needs to be trimmed', () => {

mschile · 2025-11-12T18:43:16Z

packages/driver/test/unit/cypress/stack_utils.spec.ts

+      const stack = `Error\n at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)\n 
+at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:14:1)\n
+at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:18:12)\n
+at eval (<anonymous>)\n


Suggested change

const stack = `Error\n at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)\n

at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:14:1)\n

at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:18:12)\n

at eval (<anonymous>)\n

const stack = `Error

at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:14:1)

at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:18:12)

at eval (<anonymous>)

mschile · 2025-11-12T18:52:48Z

packages/app/cypress/e2e/runner/reporter.hooks.cy.ts

    })

-    cy.get('.hook-open-in-ide').first().invoke('show').click()
+    it('sends the correct invocation details for .only test body', () => {


Is this supposed to test the new logic because I don't think it is.

mschile

Added some comments.

Co-authored-by: Matt Schile <[email protected]>

packages/driver/src/cypress/mocha.ts

packages/driver/src/cypress/stack_utils.ts

fix: (studio) remove itGrep lines from stack trace when determining…

3bb1471

… invocationDetails

astone123 self-assigned this Oct 10, 2025

astone123 requested review from AtofStryker and mschile October 10, 2025 19:40

astone123 closed this Oct 10, 2025

astone123 reopened this Oct 28, 2025

Merge branch 'develop' into astone123/fix-itgrep-trace

b6bc0f5

astone123 requested a review from mabela416 October 28, 2025 13:07

mabela416 approved these changes Oct 30, 2025

View reviewed changes

AtofStryker reviewed Oct 31, 2025

View reviewed changes

astone123 added 3 commits November 3, 2025 11:12

handle .only and suites

926e1fc

Merge branch 'develop' into astone123/fix-itgrep-trace

49165cf

Merge branch 'develop' into astone123/fix-itgrep-trace

61311ee

cursor bot reviewed Nov 3, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

Merge branch 'develop' into astone123/fix-itgrep-trace

0a8de00

cursor bot reviewed Nov 6, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

for test block hooks, trim the stack to find the invocation details

a1480d8

astone123 changed the title ~~fix: (studio) remove itGrep lines from stack trace when determining invocationDetails~~ fix: normalize test body invocationDetails from stack traces Nov 6, 2025

astone123 added 2 commits November 6, 2025 17:27

Merge branch 'develop' into astone123/fix-itgrep-trace

36064a6

fix stop only

65d656c

cursor bot reviewed Nov 6, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Show resolved Hide resolved

astone123 added 2 commits November 7, 2025 09:42

fix cypress object access

c0fb620

Merge branch 'develop' into astone123/fix-itgrep-trace

96a9a10

cursor bot reviewed Nov 7, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

astone123 requested a review from AtofStryker November 7, 2025 15:57

AtofStryker approved these changes Nov 7, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

update comment to use generic host

d0dfb88

astone123 added 2 commits November 11, 2025 10:40

Merge branch 'develop' into astone123/fix-itgrep-trace

5d5cc2d

Merge branch 'develop' into astone123/fix-itgrep-trace

79c51da

cursor bot reviewed Nov 11, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/mocha.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2025

View reviewed changes

mschile requested changes Nov 12, 2025

View reviewed changes

astone123 and others added 5 commits November 12, 2025 14:46

Update packages/driver/src/cypress/stack_utils.ts

a7e5bb2

Co-authored-by: Matt Schile <[email protected]>

Update packages/driver/src/cypress/stack_utils.ts

7bb0f76

Co-authored-by: Matt Schile <[email protected]>

Update packages/driver/src/cypress/mocha.ts

42d6495

Co-authored-by: Matt Schile <[email protected]>

Update packages/driver/src/cypress/stack_utils.ts

1929cba

Co-authored-by: Matt Schile <[email protected]>

Update packages/driver/src/cypress/stack_utils.ts

ec9dad3

Co-authored-by: Matt Schile <[email protected]>

cursor bot reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/mocha.ts Show resolved Hide resolved

astone123 added 2 commits November 12, 2025 15:16

feedback

85756f0

Merge branch 'develop' into astone123/fix-itgrep-trace

1bc1d68

cursor bot reviewed Nov 12, 2025

View reviewed changes

packages/driver/src/cypress/stack_utils.ts Show resolved Hide resolved

changelog entry

4a53ed1

	const stack = `Error at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)
	const stack = `Error
	at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)

	it('returns the original stack if it cannot be normalized for a test body', () => {
	it('returns the original stack if it cannot be normalized for a test', () => {

	it('returns the correct invocation details for a grep stack trace', () => {
	it('returns the correct invocation details for a test with a stack that needs to be trimmed', () => {

fix: normalize test body invocationDetails from stack traces #32699

Are you sure you want to change the base?

fix: normalize test body invocationDetails from stack traces #32699

Uh oh!

Conversation

astone123 commented Oct 10, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

cypress bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tests for review

Uh oh!

astone123 commented Oct 28, 2025

Uh oh!

mabela416 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astone123 commented Nov 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fix: normalize test body `invocationDetails` from stack traces #32699

fix: normalize test body `invocationDetails` from stack traces #32699

astone123 commented Oct 10, 2025 •

edited by cursor bot

Loading

cypress bot commented Oct 10, 2025 •

edited

Loading