internal: (studio) fix studio and runner states during opening, closing, and refreshing #32153

astone123 · 2025-08-04T15:42:15Z

Additional details

This PR fixes four main issues:

Opening the studio panel while a test is running opens that test instead of the "new test" view
Refreshing the page when the studio panel is open to the "new test" view results in the test body not being displayed in the command log
AUT URL getting replaced with "Enter URL" when tests are running and the "new test" view is open in the studio panel
The spec re-runs when the user closes the studio panel from the "new test" view

Steps to test

Test out the three issues that I mentioned above ^

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?

…reshing

cypress · 2025-08-04T16:18:53Z

cypress Run #64494

Run Properties: Passed #64494 • 8bc82a7110: Merge branch 'develop' into fix-studio-reload

Project	`cypress`
Branch Review	`fix-studio-reload`
Run status	`Passed #64494`
Run duration	`19m 34s`
Commit	`8bc82a7110: Merge branch 'develop' into fix-studio-reload`
Committer	`Adam Stone-Lord`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`13`
Pending	`1101`
Skipped	`0`
Passing	`26537`
View all changes introduced in this branch ↗︎

UI Coverage `44.99%`
Untested elements	`187`
Tested elements	`157`

Accessibility `97.72%`
Failed rules	`4 critical` `8 serious` `2 moderate` `2 minor`
Failed elements	`110`

astone123 · 2025-08-04T19:55:48Z

packages/app/src/store/studio-store.ts

@@ -862,7 +867,7 @@ export const useStudioStore = defineStore('studioRecorder', {
    },

    needsUrl: (state) => {
-      return state.isActive && !state.url && !state.isFailed
+      return state.isActive && !state.url && !state.isFailed && state._hasStarted


This was causing the AUT URL to get removed whenever the panel was open at all, even if it was just the new test screen

mschile · 2025-08-07T16:30:02Z

packages/app/src/runner/event-manager.ts

+    // Only intercept logs when Studio is actually recording a specific test
+    // Don't intercept when Studio is just open in "new test" mode
+    if (this.studioStore.isActive && this.studioStore.testId) {


Is this function still needed? We don't even display logs anymore.

yeah this still gets called - we don't display anything but it seems like if the logs are intercepted here, they don't get displayed in the command log. So I need to update this because otherwise when we refresh the page and studio is open to "new test", the test body section doesn't get displayed in the left panel.

mschile · 2025-08-07T16:36:36Z

packages/app/src/store/studio-store.ts

@@ -175,6 +175,11 @@ export const useStudioStore = defineStore('studioRecorder', {
      this.newTestLineNumber = undefined
    },

+    needsProtocolCleanup () {
+      // Protocol cleanup (page reload) is only needed if Studio has actually been used for recording
+      return this._hasStarted || this.logs.length > 0 || this._isStudioCreatedTest


Is the check on logs needed? We don't display studio logs anymore.

yeah that condition isn't needed... I changed it to this.testId

mschile · 2025-08-07T16:42:31Z

packages/app/src/store/studio-store.ts

@@ -175,6 +175,11 @@ export const useStudioStore = defineStore('studioRecorder', {
      this.newTestLineNumber = undefined
    },

+    needsProtocolCleanup () {
+      // Protocol cleanup (page reload) is only needed if Studio has actually been used for recording
+      return this._hasStarted || this.logs.length > 0 || this._isStudioCreatedTest


I think we would want to cleanup protocol regardless of whether or not an action has been recorded since protocol would'e still been initialized and possibly written to. I'm thinking we may just need to check if there is a testId.

mschile · 2025-08-07T16:51:53Z

packages/app/src/runner/event-manager.ts

@@ -857,7 +864,9 @@ export class EventManager {
      performance.measure('run', 'run-s', 'run-e')
    })

-    const hasRunnableId = !!this.studioStore.testId || !!this.studioStore.suiteId
+    const hasActiveStudio = !!this.studioStore.testId ||
+                           (!!this.studioStore.suiteId && this.studioStore._hasStarted) ||


I'm not sure this check is needed.

(!!this.studioStore.suiteId && this.studioStore._hasStarted) ||

yeah good call, it isn't. I removed those two conditions from this variable

mschile · 2025-08-07T16:53:38Z

packages/app/cypress/e2e/studio/studio.cy.ts

+    // verify URL still shows suite mode, not edit test mode
+    cy.location().its('hash').should('contain', 'suiteId=r1').and('not.contain', 'testId=')
+
+    cy.waitForSpecToFinish()


Why do we need to waitForSpecToFinish here?

We do not - removed

mschile · 2025-08-07T16:54:41Z

packages/app/cypress/e2e/studio/studio.cy.ts

+    cy.get('.test').should('have.length', 1)
+    cy.get('.test').first().should('have.class', 'runnable-active')
+
+    cy.wait(500)


Is there another way we can wait instead of a hard-coded value? Seems like may we should be using waitForSpecToFinish here?

I ended up not needing this. I originally added it because the test wasn't correctly failing when I backed out my code changes - but I just tested it again and everything works without waiting

mschile · 2025-08-07T16:57:22Z

packages/app/cypress/e2e/studio/studio.cy.ts

AUT URL getting replaced with "Enter URL" when tests are running and the "new test" view is open in the studio panel

The spec re-runs when the user closes the studio panel from the "new test" view

We should add a couple tests to verify this new behavior.

added tests for both of these 👍🏻

mschile

Added a few comments.

mschile · 2025-08-11T14:53:44Z

packages/app/cypress/e2e/studio/studio.cy.ts

@@ -737,6 +737,27 @@ describe('studio functionality', () => {
    cy.location().its('hash').and('not.contain', 'testId=').and('not.contain', 'studio=')
  })

+  it('does not prompt for URL when creating a new test in studio', () => {


Suggested change

it('does not prompt for URL when creating a new test in studio', () => {

it('does not prompt for URL when creating a new test in studio that already visits', () => {

I think I need to re-word this a different way. The issue was that when the user opens the studio panel to "new test" mode, we were already prompting for a URL in the address bar, even when the spec file was currently running and the AUT was at a URL already.

We only want to prompt for a URL once the test is actually created and it doesn't visit anything yet

mschile · 2025-08-11T14:57:37Z

packages/app/src/store/studio-store.ts

@@ -175,6 +175,11 @@ export const useStudioStore = defineStore('studioRecorder', {
      this.newTestLineNumber = undefined
    },

+    needsProtocolCleanup () {
+      // Protocol cleanup (page reload) is only needed if Studio has actually been used for recording


I don't think this comment is accurate anymore.

I think it is... we only want to refresh the page when studio closes if we've actually entered recording mode (like, we've made it past the "new test" screen and actually created a test or opened an existing test in studio)

ok, so by recording you just mean entering single test mode not that the user actually recorded anything?

yeah, exactly - I'll update the comment to make that more clear

packages/app/cypress/e2e/studio/studio.cy.ts

packages/app/src/store/studio-store.ts

cypress-bot · 2025-08-20T17:48:16Z

Released in 15.0.0.

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

internal: (studio) fix studio states during opening, closing, and ref…

807b949

…reshing

astone123 self-assigned this Aug 4, 2025

test title

9a0521e

fix tests

967300c

astone123 commented Aug 4, 2025

View reviewed changes

astone123 requested review from jennifer-shehane, mschile and mabela416 August 4, 2025 19:56

mabela416 approved these changes Aug 5, 2025

View reviewed changes

astone123 requested a review from ryanthemanuel August 6, 2025 13:57

astone123 added 2 commits August 6, 2025 13:36

Merge branch 'release/15.0.0' into fix-studio-reload

e94f9be

Merge branch 'release/15.0.0' into fix-studio-reload

4df5587

mschile reviewed Aug 7, 2025

View reviewed changes

mschile requested changes Aug 7, 2025

View reviewed changes

astone123 added 3 commits August 8, 2025 10:59

feedback

071e1a4

Merge branch 'release/15.0.0' into fix-studio-reload

62a2550

add test coverage

ed87881

astone123 requested a review from mschile August 8, 2025 15:25

Merge branch 'release/15.0.0' into fix-studio-reload

d516243

mschile reviewed Aug 11, 2025

View reviewed changes

astone123 changed the base branch from release/15.0.0 to develop August 11, 2025 15:31

astone123 commented Aug 11, 2025

View reviewed changes

packages/app/cypress/e2e/studio/studio.cy.ts Outdated Show resolved Hide resolved

Update packages/app/cypress/e2e/studio/studio.cy.ts

b541855

astone123 commented Aug 11, 2025

View reviewed changes

packages/app/src/store/studio-store.ts Outdated Show resolved Hide resolved

astone123 added 2 commits August 11, 2025 11:52

Update packages/app/src/store/studio-store.ts

95faad5

Merge branch 'develop' into fix-studio-reload

8bc82a7

astone123 requested a review from mschile August 11, 2025 17:33

mschile approved these changes Aug 11, 2025

View reviewed changes

AtofStryker merged commit e59949f into develop Aug 11, 2025
85 of 90 checks passed

AtofStryker deleted the fix-studio-reload branch August 11, 2025 20:32

cypress-bot bot locked as resolved and limited conversation to collaborators Aug 20, 2025

	it('does not prompt for URL when creating a new test in studio', () => {
	it('does not prompt for URL when creating a new test in studio that already visits', () => {

internal: (studio) fix studio and runner states during opening, closing, and refreshing #32153

internal: (studio) fix studio and runner states during opening, closing, and refreshing #32153

Uh oh!

Conversation

astone123 commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional details

Steps to test

PR Tasks

Uh oh!

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

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!

mschile 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!

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!

Uh oh!

Uh oh!

Uh oh!

cypress-bot bot commented Aug 20, 2025

Uh oh!

Uh oh!

astone123 commented Aug 4, 2025 •

edited

Loading

cypress bot commented Aug 4, 2025 •

edited

Loading