chore: internal refactor of privileged commands (#27060)

.circleci/workflows.yml

@@ -74,8 +74,7 @@ windowsWorkflowFilters: &windows-workflow-filters
     - equal: [ develop, << pipeline.git.branch >> ]
     # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
     - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-    - equal: [ 'matth/feat/chrome-headless', << pipeline.git.branch >> ]
-    - equal: [ 'lmiller/fix-windows-regressions', << pipeline.git.branch >> ]
+    - equal: [ 'privileged-commands-refactor', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>

cli/types/cypress-eventemitter.d.ts

@@ -3,8 +3,8 @@ type EventEmitter2 = import("eventemitter2").EventEmitter2
 
 interface CyEventEmitter extends Omit<EventEmitter2, 'waitFor'> {
   proxyTo: (cy: Cypress.cy) => null
-  emitMap: (eventName: string, args: any[]) => Array<(...args: any[]) => any>
-  emitThen: (eventName: string, args: any[]) => Bluebird.BluebirdStatic
+  emitMap: (eventName: string, ...args: any[]) => Array<(...args: any[]) => any>
+  emitThen: (eventName: string, ...args: any[]) => Bluebird.BluebirdStatic
 }
 
 // Copied from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/events.d.ts

packages/app/.gitignore

@@ -1,4 +1,5 @@
 cypress/videos/*
 cypress/screenshots/*
+cypress/downloads/*
 
-components.d.ts
+components.d.ts

packages/app/cypress/e2e/runner/reporter-ct-generator.ts

@@ -343,18 +343,6 @@ export const generateCtErrorTests = (server: 'Webpack' | 'Vite', configFile: str
       })
     })
 
-    it('cy.readFile', () => {
-      const verify = loadErrorSpec({
-        filePath: 'errors/readfile.cy.js',
-        failCount: 1,
-      }, configFile)
-
-      verify('existence failure', {
-        column: [8, 9],
-        message: 'failed because the file does not exist',
-      })
-    })
-
     it('validation errors', () => {
       const verify = loadErrorSpec({
         filePath: 'errors/validation.cy.js',

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

@@ -321,18 +321,6 @@ describe('errors ui', {
     })
   })
 
-  it('cy.readFile', () => {
-    const verify = loadErrorSpec({
-      filePath: 'errors/readfile.cy.js',
-      failCount: 1,
-    })
-
-    verify('existence failure', {
-      column: 8,
-      message: 'failed because the file does not exist',
-    })
-  })
-
   it('validation errors', () => {
     const verify = loadErrorSpec({
       filePath: 'errors/validation.cy.js',

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

@@ -750,7 +750,13 @@ export class EventManager {
      * Return it's response.
      */
     Cypress.primaryOriginCommunicator.on('backend:request', async ({ args }, { source, responseEvent }) => {
-      const response = await Cypress.backend(...args)
+      let response
+
+      try {
+        response = await Cypress.backend(...args)
+      } catch (error) {
+        response = { error }
+      }
 
       Cypress.primaryOriginCommunicator.toSource(source, responseEvent, response)
     })

packages/app/src/runner/index.ts

@@ -152,13 +152,25 @@ function setupRunner () {
   createIframeModel()
 }
 
+interface GetSpecUrlOptions {
+  browserFamily?: string
+  namespace: string
+  specSrc: string
+}
+
 /**
  * Get the URL for the spec. This is the URL of the AUT IFrame.
  * CT uses absolute URLs, and serves from the dev server.
  * E2E uses relative, serving from our internal server's spec controller.
  */
-function getSpecUrl (namespace: string, specSrc: string) {
-  return `/${namespace}/iframes/${specSrc}`
+function getSpecUrl ({ browserFamily, namespace, specSrc }: GetSpecUrlOptions) {
+  let url = `/${namespace}/iframes/${specSrc}`
+
+  if (browserFamily) {
+    url += `?browserFamily=${browserFamily}`
+  }
+
+  return url
 }
 
 /**
@@ -202,13 +214,15 @@ export function addCrossOriginIframe (location) {
     return
   }
 
+  const config = getRunnerConfigFromWindow()
+
   addIframe({
     id,
     // the cross origin iframe is added to the document body instead of the
     // container since it needs to match the size of the top window for screenshots
     $container: document.body,
     className: 'spec-bridge-iframe',
-    src: `${location.origin}/${getRunnerConfigFromWindow().namespace}/spec-bridge-iframes`,
+    src: `${location.origin}/${config.namespace}/spec-bridge-iframes?browserFamily=${config.browser.family}`,
   })
 }
 
@@ -234,7 +248,10 @@ function runSpecCT (config, spec: SpecFile) {
   const autIframe = getAutIframeModel()
   const $autIframe: JQuery<HTMLIFrameElement> = autIframe.create().appendTo($container)
 
-  const specSrc = getSpecUrl(config.namespace, spec.absolute)
+  const specSrc = getSpecUrl({
+    namespace: config.namespace,
+    specSrc: spec.absolute,
+  })
 
   autIframe._showInitialBlankPage()
   $autIframe.prop('src', specSrc)
@@ -297,7 +314,11 @@ function runSpecE2E (config, spec: SpecFile) {
   autIframe.visitBlankPage()
 
   // create Spec IFrame
-  const specSrc = getSpecUrl(config.namespace, encodeURIComponent(spec.relative))
+  const specSrc = getSpecUrl({
+    browserFamily: config.browser.family,
+    namespace: config.namespace,
+    specSrc: encodeURIComponent(spec.relative),
+  })
 
   // FIXME: BILL Determine where to call client with to force browser repaint
   /**

packages/driver/.gitignore

@@ -1,2 +1,3 @@
 cypress/videos
 cypress/screenshots
+cypress/downloads

packages/driver/cypress/e2e/commands/exec.cy.js

@@ -12,14 +12,18 @@ describe('src/cy/commands/exec', () => {
       cy.stub(Cypress, 'backend').callThrough()
     })
 
-    it('triggers \'exec\' with the right options', () => {
+    it('sends privileged exec to backend with the right options', () => {
       Cypress.backend.resolves(okResponse)
 
       cy.exec('ls').then(() => {
-        expect(Cypress.backend).to.be.calledWith('exec', {
-          cmd: 'ls',
-          timeout: 2500,
-          env: {},
+        expect(Cypress.backend).to.be.calledWith('run:privileged', {
+          commandName: 'exec',
+          userArgs: ['ls'],
+          options: {
+            cmd: 'ls',
+            timeout: 2500,
+            env: {},
+          },
         })
       })
     })
@@ -28,17 +32,19 @@ describe('src/cy/commands/exec', () => {
       Cypress.backend.resolves(okResponse)
 
       cy.exec('ls', { env: { FOO: 'foo' } }).then(() => {
-        expect(Cypress.backend).to.be.calledWith('exec', {
-          cmd: 'ls',
-          timeout: 2500,
-          env: {
-            FOO: 'foo',
+        expect(Cypress.backend).to.be.calledWith('run:privileged', {
+          commandName: 'exec',
+          userArgs: ['ls', { env: { FOO: 'foo' } }],
+          options: {
+            cmd: 'ls',
+            timeout: 2500,
+            env: { FOO: 'foo' },
           },
         })
       })
     })
 
-    it('really works', () => {
+    it('works e2e', () => {
       // output is trimmed
       cy.exec('echo foo', { timeout: 20000 }).its('stdout').should('eq', 'foo')
     })

packages/driver/cypress/e2e/commands/files.cy.js

@@ -14,14 +14,20 @@ describe('src/cy/commands/files', () => {
   })
 
   describe('#readFile', () => {
-    it('triggers \'read:file\' with the right options', () => {
+    it('sends privileged readFile to backend with the right options', () => {
       Cypress.backend.resolves(okResponse)
 
       cy.readFile('foo.json').then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'read:file',
-          'foo.json',
-          { encoding: 'utf8' },
+          'run:privileged',
+          {
+            commandName: 'readFile',
+            userArgs: ['foo.json'],
+            options: {
+              file: 'foo.json',
+              encoding: 'utf8',
+            },
+          },
         )
       })
     })
@@ -31,9 +37,15 @@ describe('src/cy/commands/files', () => {
 
       cy.readFile('foo.json', 'ascii').then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'read:file',
-          'foo.json',
-          { encoding: 'ascii' },
+          'run:privileged',
+          {
+            commandName: 'readFile',
+            userArgs: ['foo.json', 'ascii'],
+            options: {
+              file: 'foo.json',
+              encoding: 'ascii',
+            },
+          },
         )
       })
     })
@@ -47,9 +59,15 @@ describe('src/cy/commands/files', () => {
 
       cy.readFile('foo.json', null).then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'read:file',
-          'foo.json',
-          { encoding: null },
+          'run:privileged',
+          {
+            commandName: 'readFile',
+            userArgs: ['foo.json', null],
+            options: {
+              file: 'foo.json',
+              encoding: null,
+            },
+          },
         )
       }).should('eql', Buffer.from('\n'))
     })
@@ -426,17 +444,21 @@ describe('src/cy/commands/files', () => {
   })
 
   describe('#writeFile', () => {
-    it('triggers \'write:file\' with the right options', () => {
+    it('sends privileged writeFile to backend with the right options', () => {
       Cypress.backend.resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents').then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'write:file',
-          'foo.txt',
-          'contents',
+          'run:privileged',
           {
-            encoding: 'utf8',
-            flag: 'w',
+            commandName: 'writeFile',
+            userArgs: ['foo.txt', 'contents'],
+            options: {
+              fileName: 'foo.txt',
+              contents: 'contents',
+              encoding: 'utf8',
+              flag: 'w',
+            },
           },
         )
       })
@@ -447,12 +469,16 @@ describe('src/cy/commands/files', () => {
 
       cy.writeFile('foo.txt', 'contents', 'ascii').then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'write:file',
-          'foo.txt',
-          'contents',
+          'run:privileged',
           {
-            encoding: 'ascii',
-            flag: 'w',
+            commandName: 'writeFile',
+            userArgs: ['foo.txt', 'contents', 'ascii'],
+            options: {
+              fileName: 'foo.txt',
+              contents: 'contents',
+              encoding: 'ascii',
+              flag: 'w',
+            },
           },
         )
       })
@@ -462,14 +488,20 @@ describe('src/cy/commands/files', () => {
     it('explicit null encoding is sent to server as Buffer', () => {
       Cypress.backend.resolves(okResponse)
 
-      cy.writeFile('foo.txt', Buffer.from([0, 0, 54, 255]), null).then(() => {
+      const buffer = Buffer.from([0, 0, 54, 255])
+
+      cy.writeFile('foo.txt', buffer, null).then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'write:file',
-          'foo.txt',
-          Buffer.from([0, 0, 54, 255]),
+          'run:privileged',
           {
-            encoding: null,
-            flag: 'w',
+            commandName: 'writeFile',
+            userArgs: ['foo.txt', buffer, null],
+            options: {
+              fileName: 'foo.txt',
+              contents: buffer,
+              encoding: null,
+              flag: 'w',
+            },
           },
         )
       })
@@ -480,12 +512,16 @@ describe('src/cy/commands/files', () => {
 
       cy.writeFile('foo.txt', 'contents', { encoding: 'ascii' }).then(() => {
         expect(Cypress.backend).to.be.calledWith(
-          'write:file',
-          'foo.txt',
-          'contents',
+          'run:privileged',
           {
-            encoding: 'ascii',
-            flag: 'w',
+            commandName: 'writeFile',
+            userArgs: ['foo.txt', 'contents', { encoding: 'ascii' }],
+            options: {
+              fileName: 'foo.txt',
+              contents: 'contents',
+              encoding: 'ascii',
+              flag: 'w',
+            },
           },
         )
       })
@@ -531,12 +567,16 @@ describe('src/cy/commands/files', () => {
 
         cy.writeFile('foo.txt', 'contents', { flag: 'a+' }).then(() => {
           expect(Cypress.backend).to.be.calledWith(
-            'write:file',
-            'foo.txt',
-            'contents',
+            'run:privileged',
             {
-              encoding: 'utf8',
-              flag: 'a+',
+              commandName: 'writeFile',
+              userArgs: ['foo.txt', 'contents', { flag: 'a+' }],
+              options: {
+                fileName: 'foo.txt',
+                contents: 'contents',
+                encoding: 'utf8',
+                flag: 'a+',
+              },
             },
           )
         })