Merge branch 'develop' into electron-34

Author: jennifer-shehane

.circleci/workflows.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 chrome-stable-version: &chrome-stable-version "134.0.6998.88"
-chrome-beta-version: &chrome-beta-version "135.0.7049.3"
+chrome-beta-version: &chrome-beta-version "135.0.7049.17"
 firefox-stable-version: &firefox-stable-version "135.0"
 
 orbs:

cli/types/cypress.d.ts

@@ -3314,7 +3314,8 @@ declare namespace Cypress {
     socketIoRoute: string
     spec: Cypress['spec'] | null
     specs: Array<Cypress['spec']>
-    protocolEnabled: boolean
+    isDefaultProtocolEnabled: boolean
+    isStudioProtocolEnabled: boolean
     hideCommandLog: boolean
     hideRunnerUi: boolean
   }

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

@@ -1,6 +1,9 @@
-export function launchStudio ({ specName = 'spec.cy.js', createNewTest = false, cliArgs = [''] } = {}) {
+export function launchStudio ({ specName = 'spec.cy.js', createNewTest = false, cliArgs = [''], enableCloudStudio = false } = {}) {
   cy.scaffoldProject('experimental-studio')
-  cy.openProject('experimental-studio', cliArgs)
+  cy.openProject('experimental-studio', cliArgs, {
+    cloudStudio: enableCloudStudio,
+  })
+
   cy.startAppServer('e2e')
   cy.visitApp()
   cy.specsPageIsVisible()

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

@@ -21,6 +21,16 @@ describe('Cypress Studio', () => {
     })
   }
 
+  it('loads the cloud studio page', () => {
+    launchStudio({ specName: 'spec.cy.js', enableCloudStudio: true })
+
+    cy.window().then((win) => {
+      expect(win.Cypress.config('isDefaultProtocolEnabled')).to.be.false
+      expect(win.Cypress.config('isStudioProtocolEnabled')).to.be.true
+      expect(win.Cypress.state('isProtocolEnabled')).to.be.true
+    })
+  })
+
   it('updates an existing test with an action', () => {
     launchStudio()
 

packages/app/package.json

@@ -51,7 +51,7 @@
     "@vitejs/plugin-legacy": "5.4.0",
     "@vitejs/plugin-vue": "5.0.4",
     "@vitejs/plugin-vue-jsx": "3.1.0",
-    "@vueuse/core": "7.2.2",
+    "@vueuse/core": "7.7.1",
     "ansi-to-html": "0.7.2",
     "bluebird": "3.5.3",
     "classnames": "2.3.1",

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

@@ -281,18 +281,40 @@ export class EventManager {
     this.reporterBus.on('studio:init:test', (testId) => {
       this.studioStore.setTestId(testId)
 
-      studioInit()
+      this.ws.emit('studio:init', (error) => {
+        if (error) {
+          // eslint-disable-next-line no-console
+          console.error(error)
+        }
+
+        studioInit()
+      })
     })
 
     this.reporterBus.on('studio:init:suite', (suiteId) => {
       this.studioStore.setSuiteId(suiteId)
 
-      studioInit()
+      this.ws.emit('studio:init', (error) => {
+        if (error) {
+          // eslint-disable-next-line no-console
+          console.error(error)
+        }
+
+        studioInit()
+      })
     })
 
     this.reporterBus.on('studio:cancel', () => {
-      this.studioStore.cancel()
-      rerun()
+      this.ws.emit('studio:destroy', (error) => {
+        if (error) {
+          // eslint-disable-next-line no-console
+          console.error(error)
+        }
+
+        this.studioStore.cancel()
+        // Reloading for now. This is the easiest way to clear out the protocol code from the front end
+        window.location.reload()
+      })
     })
 
     this.reporterBus.on('studio:remove:command', (commandId) => {
@@ -316,14 +338,31 @@ export class EventManager {
         if (err) {
           this.reporterBus.emit('test:set:state', this.studioStore.saveError(err), noop)
         } else {
-          this.studioStore.saveSuccess()
+          this.ws.emit('studio:destroy', (error) => {
+            if (error) {
+              // eslint-disable-next-line no-console
+              console.error(error)
+            }
+
+            this.studioStore.saveSuccess()
+            // Reloading for now. This is the easiest way to clear out the protocol code from the front end
+            window.location.reload()
+          })
         }
       })
     })
 
     this.localBus.on('studio:cancel', () => {
-      this.studioStore.cancel()
-      rerun()
+      this.ws.emit('studio:destroy', (error) => {
+        if (error) {
+          // eslint-disable-next-line no-console
+          console.error(error)
+        }
+
+        this.studioStore.cancel()
+        // Reloading for now. This is the easiest way to clear out the protocol code from the front end
+        window.location.reload()
+      })
     })
 
     this.ws.on('aut:destroy:init', () => {
@@ -396,6 +435,14 @@ export class EventManager {
     // @ts-ignore
     window.Cypress = Cypress
 
+    this.studioStore.setup(config)
+
+    const isDefaultProtocolEnabled = Cypress.config('isDefaultProtocolEnabled')
+    const isStudioProtocolEnabled = Cypress.config('isStudioProtocolEnabled')
+    const isStudioInScope = this.studioStore.isActive || this.studioStore.isLoading
+
+    Cypress.state('isProtocolEnabled', isDefaultProtocolEnabled || (isStudioProtocolEnabled && isStudioInScope))
+
     this._addListeners()
   }
 
@@ -421,7 +468,7 @@ export class EventManager {
 
           const hideCommandLog = Cypress.config('hideCommandLog')
 
-          this.studioStore.initialize(config)
+          this.studioStore.initialize()
 
           const runnables = Cypress.runner.normalizeAll(runState.tests, hideCommandLog, testFilter)
 
@@ -466,7 +513,7 @@ export class EventManager {
   _addListeners () {
     addTelemetryListeners(Cypress)
 
-    if (Cypress.config('protocolEnabled')) {
+    if (Cypress.state('isProtocolEnabled')) {
       addCaptureProtocolListeners(Cypress)
     }
 

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

@@ -185,7 +185,7 @@ export const useStudioStore = defineStore('studioRecorder', {
       this.isFailed = true
     },
 
-    initialize (config) {
+    setup (config) {
       const studio = this._getUrlParams()
 
       if (studio.testId) {
@@ -203,12 +203,14 @@ export const useStudioStore = defineStore('studioRecorder', {
       if (this.testId || this.suiteId) {
         this.setAbsoluteFile(config.spec.absolute)
         this.startLoading()
+      }
+    },
 
-        if (this.suiteId) {
-          getCypress().runner.setOnlySuiteId(this.suiteId)
-        } else if (this.testId) {
-          getCypress().runner.setOnlyTestId(this.testId)
-        }
+    initialize () {
+      if (this.suiteId) {
+        getCypress().runner.setOnlySuiteId(this.suiteId)
+      } else if (this.testId) {
+        getCypress().runner.setOnlyTestId(this.testId)
       }
     },
 

packages/config/__snapshots__/index.spec.ts.js

@@ -104,7 +104,8 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
   'socketId': null,
   'socketIoCookie': '__socket',
   'socketIoRoute': '/__socket',
-  'protocolEnabled': false,
+  'isDefaultProtocolEnabled': false,
+  'isStudioProtocolEnabled': false,
   'hideCommandLog': false,
   'hideRunnerUi': false,
 }
@@ -195,7 +196,8 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
   'socketId': null,
   'socketIoCookie': '__socket',
   'socketIoRoute': '/__socket',
-  'protocolEnabled': false,
+  'isDefaultProtocolEnabled': false,
+  'isStudioProtocolEnabled': false,
   'hideCommandLog': false,
   'hideRunnerUi': false,
 }

packages/config/src/options.ts

@@ -589,7 +589,12 @@ const runtimeOptions: Array<RuntimeConfigOption> = [
     validation: validate.isString,
     isInternal: true,
   }, {
-    name: 'protocolEnabled',
+    name: 'isDefaultProtocolEnabled',
+    defaultValue: false,
+    validation: validate.isBoolean,
+    isInternal: true,
+  }, {
+    name: 'isStudioProtocolEnabled',
     defaultValue: false,
     validation: validate.isBoolean,
     isInternal: true,

packages/data-context/src/sources/HtmlDataSource.ts

@@ -56,7 +56,8 @@ export class HtmlDataSource {
       'reporterUrl',
       'namespace',
       'socketIoRoute',
-      'protocolEnabled',
+      'isDefaultProtocolEnabled',
+      'isStudioProtocolEnabled',
       'hideCommandLog',
       'hideRunnerUi',
     ]

packages/driver/cypress/e2e/commands/actions/check.cy.ts

@@ -632,7 +632,8 @@ describe('src/cy/commands/actions/check', () => {
         })
       })
 
-      it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+      it('can turn off logging when protocol is disabled', function () {
+        cy.state('isProtocolEnabled', false)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -647,7 +648,8 @@ describe('src/cy/commands/actions/check', () => {
         })
       })
 
-      it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+      it('can send hidden log when protocol is enabled', function () {
+        cy.state('isProtocolEnabled', true)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -1294,7 +1296,8 @@ describe('src/cy/commands/actions/check', () => {
         })
       })
 
-      it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+      it('can turn off logging when protocol is disabled', function () {
+        cy.state('isProtocolEnabled', false)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -1309,7 +1312,8 @@ describe('src/cy/commands/actions/check', () => {
         })
       })
 
-      it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+      it('can send hidden log when protocol is enabled', function () {
+        cy.state('isProtocolEnabled', true)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })

packages/driver/cypress/e2e/commands/actions/clear.cy.ts

@@ -493,7 +493,8 @@ describe('src/cy/commands/actions/type - #clear', () => {
       })
     })
 
-    it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+    it('can turn off logging when protocol is disabled', function () {
+      cy.state('isProtocolEnabled', false)
       cy.on('_log:added', (attrs, log) => {
         this.hiddenLog = log
       })
@@ -507,7 +508,8 @@ describe('src/cy/commands/actions/type - #clear', () => {
       })
     })
 
-    it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+    it('can send hidden log when protocol is enabled', function () {
+      cy.state('isProtocolEnabled', true)
       cy.on('_log:added', (attrs, log) => {
         this.hiddenLog = log
       })

packages/driver/cypress/e2e/commands/actions/click.cy.ts

@@ -2648,7 +2648,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+      it('can turn off logging when protocol is disabled', function () {
+        cy.state('isProtocolEnabled', false)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -2663,7 +2664,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+      it('can send hidden log when protocol is enabled', function () {
+        cy.state('isProtocolEnabled', true)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -3557,7 +3559,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+      it('can turn off logging when protocol is disabled', function () {
+        cy.state('isProtocolEnabled', false)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -3572,7 +3575,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+      it('can send hidden log when protocol is enabled', function () {
+        cy.state('isProtocolEnabled', true)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -3993,7 +3997,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can turn off logging when protocol is disabled', { protocolEnabled: false }, function () {
+      it('can turn off logging when protocol is disabled', function () {
+        cy.state('isProtocolEnabled', false)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })
@@ -4008,7 +4013,8 @@ describe('src/cy/commands/actions/click', () => {
         })
       })
 
-      it('can send hidden log when protocol is enabled', { protocolEnabled: true }, function () {
+      it('can send hidden log when protocol is enabled', function () {
+        cy.state('isProtocolEnabled', true)
         cy.on('_log:added', (attrs, log) => {
           this.hiddenLog = log
         })