chore: Open in IDE button for block and hook definitions in Runner UI #30859

cacieprins · 2025-01-10T19:54:26Z

Closes Open in IDE is no longer working in Cy 14 prerelease #30847

Additional details

When a testing context is created or a hook is defined, Cypress captures the stack at that point in order to display an Open in IDE button in open mode.

With the changes to cy.origin() and the injection of document.domain, the stack is much more verbose than previously, and includes codepoints within the cypress before and after codepoints in the test file being executed.

This PR updates the stack analysis code so we can properly determine the most recent codepoint from the spec, which is used to populate the Open in IDE button.

In order to ensure correctness for this change, this PR also introduces vitest for the @packages/driver package, enabling swift and straightforward unit tests for this package in the future. Testing this via the integration test in packages/driver/cypress/e2e/cypress/stack_utils.cy.js was considered, but those tests operate more like integration tests, and preparing mocks for that situation proved more labor intensive than just using vitest.

Steps to test

Using the binary, run a test in open mode and click the "Open in IDE" button next to a test or hook block.

How has the user experience changed?

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?

cacieprins · 2025-01-10T20:28:54Z

packages/driver/vitest.config.mjs

+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {


vitest docs recommend defining a test key in the main vite.config.mjs file. However, attempting to run vitest with that configuration method resulted in runtime exceptions regarding require.resolve. Since unit tests should mock out dependencies, the aliasing of various modules there is fairly unnecessary, so far.

cacieprins · 2025-01-10T20:30:45Z

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

+            config,
+          )
+
+          // getSourcePosition is not called directly from getInvocationDetails, but via:


This indirect call of the spied upon function does introduce brittleness to this test. It will not pass if the underlying implementation is changed. We should consider refactoring stack analysis, especially for user invocation codepoints, to standard patterns to ease testing flexibility.

cacieprins · 2025-01-10T20:31:51Z

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

+  beforeEach(() => {
+    // @ts-expect-error
+    global.Cypress = {
+      config: vi.fn(),


The results of this function call are inconsequential to the logic under test, but the lack of a global Cypress definition was throwing runtime exceptions.

cacieprins · 2025-01-10T20:33:00Z

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

+import stack_utils from '../../../src/cypress/stack_utils'
+import stackFrameFixture from './__fixtures__/spec_stackframes.json'
+
+vi.mock('../../../src/cypress/source_map_utils', () => {


This could have been left unmocked, with the return value of getInvocationDetails asserted upon, however source_map_utils imports a .wasm dependency which vitest could not handle (even with vite-plugin-wasm included). It was more expedient to mock out the entire module.

cacieprins · 2025-01-10T20:37:33Z

packages/driver/test/unit/cypress/__fixtures__/spec_stackframes.json

+    },
+    {
+      "browser": "firefox",
+      "build": "dev",


injectDocumentDomain stacks in firefox do not differ materially from binary or dev stacks, so that test case is omitted.

cypress · 2025-01-10T20:46:52Z

cypress Run #59886

Run Properties: Passed #59886 • f70871bba8: Update cli/CHANGELOG.md

Project	`cypress`
Branch Review	`cacie/fix-hook-test-stack-analysis`
Run status	`Passed #59886`
Run duration	`11m 17s`
Commit	`f70871bba8: Update cli/CHANGELOG.md`
Committer	`Cacie Prins`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`1`
Skipped	`0`
Passing	`667`
View all changes introduced in this branch ↗︎

UI Coverage `38.03%`
Untested elements	`132`
Tested elements	`81`

Accessibility `92.04%`
Failed rules	`3 critical` `7 serious` `1 moderate` `1 minor`
Failed elements	`538`

cacieprins · 2025-01-10T20:51:58Z

packages/driver/src/cy/commands/actions/scroll.ts

@@ -128,6 +128,7 @@ export default (Commands, Cypress, cy, state) => {
      const scrollIntoView = () => {
        return new Promise((resolve, reject) => {
          // scroll our axes
+          // @ts-expect-error - scrollTo does not define a 'done()' key on its config object.


Unsure of why this was newly causing a ts-check failure in this branch.

The config to jquery.scrollTo doesn't accept a done key. We should consider using the onAfter key, as there may be bugs with the existing promise resolution.

…ize it as valid

…s apparently flaky

AtofStryker

@cacieprins do you have the binaries available for mac? I can give it a test in linux x64 but might be good to build the binaries all around for a thorough test

cacieprins · 2025-01-13T14:12:14Z

@AtofStryker I'll flag CI to build binaries for this. Considering adding a binary system test.

… lenient about the order of xml fields

… protocol events

mschile · 2025-01-14T19:05:52Z

cli/CHANGELOG.md

@@ -55,6 +55,7 @@ in this [GitHub issue](https://github.com/cypress-io/cypress/issues/30447). Addr
 - Fixed a visibility issue for elements with `textContent` but without a width or height. Fixed in [#29688](https://github.com/cypress-io/cypress/pull/29688). Fixes [#29687](https://github.com/cypress-io/cypress/issues/29687).
 - Elements whose parent elements has `overflow: clip` and no height/width will now correctly show as hidden. Fixed in [#29778](https://github.com/cypress-io/cypress/pull/29778). Fixes [#23852](https://github.com/cypress-io/cypress/issues/23852).
 - The CSS pseudo-class `:dir()` is now supported when testing in Electron. Addresses [#29766](https://github.com/cypress-io/cypress/issues/29766).
+- The Open in IDE button next to blocks and hooks in the runner UI will now properly open the IDE. This bug was introduced in a prerelease version of Cypress 14.0.0. Fixed in [#30859](https://github.com/cypress-io/cypress/pull/30859). Fixes [#30847](https://github.com/cypress-io/cypress/issues/30847).


I don't think this deserves an entry in the changelog since it was never released. I would just mark this as a chore without a changelog entry.

updated in f70871b

ryanthemanuel · 2025-01-14T19:15:33Z

Looks good (with Matt's suggestion to remove from the Changelog)

cli/CHANGELOG.md

cypress-bot · 2025-01-16T21:34:46Z

Released in 14.0.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v14.0.0, please open a new issue.

cacieprins and others added 4 commits January 10, 2025 14:31

init vitest unit test harness for @packages/driver

237c825

unit tests with stack examples

6106400

drop lines until __cypress/tests rather than just __cypress

877d8b2

Merge branch 'develop' into cacie/fix-hook-test-stack-analysis

c92a883

cacieprins changed the title ~~fix: invocation stack analysis for block invocationDetails~~ fix: Open in IDE button for block and hook definitions in Runner UI Jan 10, 2025

cacieprins added 2 commits January 10, 2025 15:00

changelog

84519d6

changelog

d99c450

cacieprins marked this pull request as ready for review January 10, 2025 20:04

remove vitest globals (unnecessary) from driver tsconfig

f137526

cacieprins commented Jan 10, 2025

View reviewed changes

cacieprins added 3 commits January 10, 2025 15:49

bump the number of junit reports expected from the unit tests job

6cedebc

fix ts-check error in scroll.ts

c6c9d28

fix type definition for getInvocationDetails

edd10e7

cacieprins commented Jan 10, 2025

View reviewed changes

cacieprins added 5 commits January 10, 2025 15:53

rm packageManager key on package.json

21a757e

remove junit reporter, as script that verifies result does not recogn…

921d67f

…ize it as valid

change @ts-expect-error to @ts-ignore for .scroll, as this ts check i…

f406080

…s apparently flaky

set expected mocha result back to 19

da40a47

add ct style stacks for cy in cy ct tests

e06a2c4

AtofStryker assigned cacieprins Jan 10, 2025

AtofStryker reviewed Jan 10, 2025

View reviewed changes

cacieprins and others added 3 commits January 13, 2025 09:12

Merge branch 'develop' into cacie/fix-hook-test-stack-analysis

03c0865

re-enable junit reporter, update mocha result verification to be more…

6d580b0

… lenient about the order of xml fields

persist binaries for this branch

b3018b4

cacieprins added 10 commits January 13, 2025 09:59

expect 20 junit reports again

6c2ded8

fix mocha v vitest verification?

30d0f45

add binary system test to verify correct file paths for codepoints in…

cc42d8c

… protocol events

fix invocation details system test filename

475fbfa

add required config for binary tests

d0d7993

build on darwin to fix binary system tests

bce0e55

build linux-arm64 for this branch

0c38ce9

simplify binary test

4996e11

build windows binary

2234703

rm binary system test

15ed6aa

mschile requested review from mschile and ryanthemanuel January 14, 2025 16:52

Merge branch 'develop' into cacie/fix-hook-test-stack-analysis

b5490b3

mschile reviewed Jan 14, 2025

View reviewed changes

ryanthemanuel approved these changes Jan 14, 2025

View reviewed changes

cacieprins changed the title ~~fix: Open in IDE button for block and hook definitions in Runner UI~~ chore: Open in IDE button for block and hook definitions in Runner UI Jan 14, 2025

cacieprins commented Jan 14, 2025

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

Update cli/CHANGELOG.md

f70871b

cacieprins requested a review from mschile January 14, 2025 19:16

mschile approved these changes Jan 14, 2025

View reviewed changes

cacieprins merged commit 0532f92 into develop Jan 14, 2025
112 of 120 checks passed

cacieprins deleted the cacie/fix-hook-test-stack-analysis branch January 14, 2025 20:33

cypress-bot bot locked as resolved and limited conversation to collaborators Jan 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Open in IDE button for block and hook definitions in Runner UI #30859

chore: Open in IDE button for block and hook definitions in Runner UI #30859

cacieprins commented Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025

cacieprins Jan 10, 2025

cacieprins Jan 10, 2025

cacieprins Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025 •

edited

Loading

cypress bot commented Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025 •

edited

Loading

AtofStryker left a comment

cacieprins commented Jan 13, 2025

mschile Jan 14, 2025

cacieprins Jan 14, 2025

ryanthemanuel commented Jan 14, 2025

cypress-bot bot commented Jan 16, 2025

chore: Open in IDE button for block and hook definitions in Runner UI #30859

chore: Open in IDE button for block and hook definitions in Runner UI #30859

Conversation

cacieprins commented Jan 10, 2025 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cacieprins Jan 10, 2025

Choose a reason for hiding this comment

cacieprins Jan 10, 2025

Choose a reason for hiding this comment

cacieprins Jan 10, 2025

Choose a reason for hiding this comment

cacieprins Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

cacieprins Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

cypress bot commented Jan 10, 2025 • edited Loading

cypress Run #59886

cacieprins Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

AtofStryker left a comment

Choose a reason for hiding this comment

cacieprins commented Jan 13, 2025

mschile Jan 14, 2025

Choose a reason for hiding this comment

cacieprins Jan 14, 2025

Choose a reason for hiding this comment

ryanthemanuel commented Jan 14, 2025

cypress-bot bot commented Jan 16, 2025

cacieprins commented Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025 •

edited

Loading

cypress bot commented Jan 10, 2025 •

edited

Loading

cacieprins Jan 10, 2025 •

edited

Loading