chore: adding beforeTest and AfterTest to protocol

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

@@ -551,10 +551,6 @@ export class EventManager {
       })
     })
 
-    Cypress.on('test:after:run', (test, _runnable) => {
-      this.reporterBus.emit('test:after:run', test, Cypress.config('isInteractive'))
-    })
-
     Cypress.on('run:start', async () => {
       if (Cypress.config('experimentalMemoryManagement') && Cypress.isBrowser({ family: 'chromium' })) {
         await Cypress.backend('start:memory:profiling', Cypress.config('spec'))
@@ -597,29 +593,33 @@ export class EventManager {
     })
 
     Cypress.on('test:before:run:async', async (...args) => {
-      const [attr, test] = args
+      const [attributes, test] = args
 
-      this.reporterBus.emit('test:before:run:async', attr)
+      this.reporterBus.emit('test:before:run:async', attributes)
 
       this.studioStore.interceptTest(test)
 
       // if the experimental flag is on and we are in a chromium based browser,
       // check the memory pressure to determine if garbage collection is needed
       if (Cypress.config('experimentalMemoryManagement') && Cypress.isBrowser({ family: 'chromium' })) {
         await Cypress.backend('check:memory:pressure', {
-          test: { title: test.title, order: test.order, currentRetry: test.currentRetry() },
+          test: { title: attributes.title, order: attributes.order, currentRetry: attributes.currentRetry },
         })
       }
 
-      await Cypress.backend('protocol:test:before:run:async', { id: test.id, title: test.title, wallClockStartedAt: test.wallClockStartedAt.getTime() })
+      await Cypress.backend('protocol:test:before:run:async', attributes)
 
       Cypress.primaryOriginCommunicator.toAllSpecBridges('test:before:run:async', ...args)
     })
 
-    Cypress.on('test:after:run', (test) => {
-      if (this.studioStore.isOpen && test.state !== 'passed') {
+    Cypress.on('test:after:run', (attributes) => {
+      this.reporterBus.emit('test:after:run', attributes, Cypress.config('isInteractive'))
+
+      if (this.studioStore.isOpen && attributes.state !== 'passed') {
         this.studioStore.testFailed()
       }
+
+      Cypress.backend('protocol:test:after:run', attributes)
     })
 
     handlePausing(this.getCypress, this.reporterBus)

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

@@ -15,7 +15,7 @@ describe('src/cy/commands/files', () => {
 
   describe('#readFile', () => {
     it('triggers \'read:file\' with the right options', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('read:file').resolves(okResponse)
 
       cy.readFile('foo.json').then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -27,7 +27,7 @@ describe('src/cy/commands/files', () => {
     })
 
     it('can take encoding as second argument', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('read:file').resolves(okResponse)
 
       cy.readFile('foo.json', 'ascii').then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -40,7 +40,7 @@ describe('src/cy/commands/files', () => {
 
     // https://github.com/cypress-io/cypress/issues/1558
     it('passes explicit null encoding through to server and decodes response', () => {
-      Cypress.backend.resolves({
+      Cypress.backend.withArgs('read:file').resolves({
         contents: Buffer.from('\n'),
         filePath: '/path/to/foo.json',
       })
@@ -55,7 +55,7 @@ describe('src/cy/commands/files', () => {
     })
 
     it('sets the contents as the subject', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('read:file').resolves(okResponse)
 
       cy.readFile('foo.json').then((subject) => {
         expect(subject).to.equal('contents')
@@ -127,7 +127,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('can turn off logging', () => {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('read:file').resolves(okResponse)
 
         cy.readFile('foo.json', { log: false }).then(function () {
           const logs = _.filter(this.logs, (log) => {
@@ -139,7 +139,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('logs immediately before resolving', function () {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('read:file').resolves(okResponse)
 
         cy.on('log:added', (attrs, log) => {
           if (attrs.name === 'readFile') {
@@ -238,12 +238,12 @@ describe('src/cy/commands/files', () => {
         err.code = 'EISDIR'
         err.filePath = '/path/to/foo'
 
-        Cypress.backend.rejects(err)
+        Cypress.backend.withArgs('read:file').rejects(err)
 
         cy.on('fail', (err) => {
           const { fileLog } = this
 
-          assertLogLength(this.logs, 2)
+          assertLogLength(this.logs, 3)
           expect(fileLog.get('error')).to.eq(err)
           expect(fileLog.get('state')).to.eq('failed')
           expect(err.message).to.eq(stripIndent`\
@@ -270,7 +270,7 @@ describe('src/cy/commands/files', () => {
         err.code = 'ENOENT'
         err.filePath = '/path/to/foo.json'
 
-        Cypress.backend.rejects(err)
+        Cypress.backend.withArgs('read:file').rejects(err)
 
         cy.on('fail', (err) => {
           const { fileLog } = this
@@ -299,7 +299,7 @@ describe('src/cy/commands/files', () => {
         err.code = 'ENOENT'
         err.filePath = '/path/to/foo.json'
 
-        Cypress.backend.rejects(err)
+        Cypress.backend.withArgs('read:file').rejects(err)
         let hasRetried = false
 
         cy.on('command:retry', () => {
@@ -328,7 +328,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('throws a specific error when file exists when it shouldn\'t', function (done) {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('read:file').resolves(okResponse)
 
         cy.on('fail', (err) => {
           const { fileLog, logs } = this
@@ -355,7 +355,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('passes through assertion error when not about existence', function (done) {
-        Cypress.backend.resolves({
+        Cypress.backend.withArgs('read:file').resolves({
           contents: 'foo',
         })
 
@@ -378,7 +378,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('throws when the read timeout expires', function (done) {
-        Cypress.backend.callsFake(() => {
+        Cypress.backend.withArgs('read:file').callsFake(() => {
           return new Cypress.Promise(() => { /* Broken promise for timeout */ })
         })
 
@@ -402,7 +402,7 @@ describe('src/cy/commands/files', () => {
       it('uses defaultCommandTimeout config value if option not provided', {
         defaultCommandTimeout: 42,
       }, function (done) {
-        Cypress.backend.callsFake(() => {
+        Cypress.backend.withArgs('read:file').callsFake(() => {
           return new Cypress.Promise(() => { /* Broken promise for timeout */ })
         })
 
@@ -427,7 +427,7 @@ describe('src/cy/commands/files', () => {
 
   describe('#writeFile', () => {
     it('triggers \'write:file\' with the right options', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents').then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -443,7 +443,7 @@ describe('src/cy/commands/files', () => {
     })
 
     it('can take encoding as third argument', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents', 'ascii').then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -460,7 +460,7 @@ describe('src/cy/commands/files', () => {
 
     // https://github.com/cypress-io/cypress/issues/1558
     it('explicit null encoding is sent to server as Buffer', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', Buffer.from([0, 0, 54, 255]), null).then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -476,7 +476,7 @@ describe('src/cy/commands/files', () => {
     })
 
     it('can take encoding as part of options', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents', { encoding: 'ascii' }).then(() => {
         expect(Cypress.backend).to.be.calledWith(
@@ -492,27 +492,27 @@ describe('src/cy/commands/files', () => {
     })
 
     it('yields null', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents').then((subject) => {
         expect(subject).to.eq(null)
       })
     })
 
     it('can write a string', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.txt', 'contents')
     })
 
     it('can write an array as json', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.json', [])
     })
 
     it('can write an object as json', () => {
-      Cypress.backend.resolves(okResponse)
+      Cypress.backend.withArgs('write:file').resolves(okResponse)
 
       cy.writeFile('foo.json', {})
     })
@@ -527,7 +527,7 @@ describe('src/cy/commands/files', () => {
 
     describe('.flag', () => {
       it('sends a flag if specified', () => {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('write:file').resolves(okResponse)
 
         cy.writeFile('foo.txt', 'contents', { flag: 'a+' }).then(() => {
           expect(Cypress.backend).to.be.calledWith(
@@ -564,7 +564,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('can turn off logging', () => {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('write:file').resolves(okResponse)
 
         cy.writeFile('foo.txt', 'contents', { log: false }).then(function () {
           const logs = _.filter(this.logs, (log) => {
@@ -576,7 +576,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('logs immediately before resolving', function () {
-        Cypress.backend.resolves(okResponse)
+        Cypress.backend.withArgs('write:file').resolves(okResponse)
 
         cy.on('log:added', (attrs, log) => {
           if (attrs.name === 'writeFile') {
@@ -679,7 +679,7 @@ describe('src/cy/commands/files', () => {
         err.code = 'WHOKNOWS'
         err.filePath = '/path/to/foo.txt'
 
-        Cypress.backend.rejects(err)
+        Cypress.backend.withArgs('write:file').rejects(err)
 
         cy.on('fail', (err) => {
           const { lastLog } = this
@@ -705,7 +705,7 @@ describe('src/cy/commands/files', () => {
       })
 
       it('throws when the write timeout expires', function (done) {
-        Cypress.backend.callsFake(() => {
+        Cypress.backend.withArgs('write:file').callsFake(() => {
           return new Cypress.Promise(() => {})
         })
 
@@ -730,7 +730,7 @@ describe('src/cy/commands/files', () => {
       it('uses defaultCommandTimeout config value if option not provided', {
         defaultCommandTimeout: 42,
       }, function (done) {
-        Cypress.backend.callsFake(() => {
+        Cypress.backend.withArgs('write:file').callsFake(() => {
           return new Cypress.Promise(() => { /* Broken promise for timeout */ })
         })
 

packages/driver/src/cypress/runner.ts

@@ -1,4 +1,3 @@
-/* eslint-disable prefer-rest-params */
 import _ from 'lodash'
 import dayjs from 'dayjs'
 import Promise from 'bluebird'
@@ -16,11 +15,11 @@ const mochaCtxKeysRe = /^(_runnable|test)$/
 const betweenQuotesRe = /\"(.+?)\"/
 
 const HOOKS = ['beforeAll', 'beforeEach', 'afterEach', 'afterAll'] as const
-const TEST_BEFORE_RUN_ASYNC_EVENT = 'runner:test:before:run:async'
 // event fired before hooks and test execution
+const TEST_BEFORE_RUN_ASYNC_EVENT = 'runner:test:before:run:async'
 const TEST_BEFORE_RUN_EVENT = 'runner:test:before:run'
 const TEST_AFTER_RUN_EVENT = 'runner:test:after:run'
-const TEST_AFTER_RUN_ASYNC_EVENT = 'runner:runnable:after:run:async'
+const RUNNABLE_AFTER_RUN_ASYNC_EVENT = 'runner:runnable:after:run:async'
 
 const RUNNABLE_LOGS = ['routes', 'agents', 'commands', 'hooks'] as const
 const RUNNABLE_PROPS = [
@@ -34,7 +33,7 @@ const RUNNER_EVENTS = [
   TEST_BEFORE_RUN_ASYNC_EVENT,
   TEST_BEFORE_RUN_EVENT,
   TEST_AFTER_RUN_EVENT,
-  TEST_AFTER_RUN_ASYNC_EVENT,
+  RUNNABLE_AFTER_RUN_ASYNC_EVENT,
 ] as const
 
 export type HandlerType = 'error' | 'unhandledrejection'
@@ -76,7 +75,7 @@ const runnableAfterRunAsync = (runnable, Cypress) => {
 
   return Promise.try(() => {
     // NOTE: other events we do not fire more than once, but this needed to change for test-retries
-    return fire(TEST_AFTER_RUN_ASYNC_EVENT, runnable, Cypress)
+    return fire(RUNNABLE_AFTER_RUN_ASYNC_EVENT, runnable, Cypress)
   })
 }
 

packages/server/lib/cloud/protocol.ts

@@ -79,10 +79,15 @@ class ProtocolManagerImpl implements ProtocolManager {
   }
 
   beforeTest (test) {
-    debug('initialize new test %O', test)
+    debug('before test %O', test)
     this.protocol?.beforeTest(test)
   }
 
+  afterTest (test) {
+    debug('after test %O', test)
+    this.protocol?.afterTest(test)
+  }
+
   close () {
     debug('closing')
     this.protocol?.close()

packages/server/lib/socket-base.ts

@@ -458,6 +458,8 @@ export class SocketBase {
               return memory.checkMemoryPressure({ ...args[0], automation })
             case 'protocol:test:before:run:async':
               return this.protocolManager?.beforeTest(args[0])
+            case 'protocol:test:after:run':
+              return this.protocolManager?.afterTest(args[0])
             default:
               throw new Error(`You requested a backend event we cannot handle: ${eventName}`)
           }

packages/types/src/protocol.ts

@@ -7,7 +7,8 @@ export interface AppCaptureProtocolInterface {
   connectToBrowser (options: { target: string, host: string, port: number }): Promise<void>
   beforeSpec (spec: SpecFile & { instanceId: string }): void
   afterSpec (): void
-  beforeTest (test: { id: string, title: string, wallClockStartedAt: number }): void
+  beforeTest(test: Record<string, any>): void
+  afterTest(test: Record<string, any>): void
   close(): void
 }