feat: (cy.prompt) give cy.prompt access to recording information (#32110)

* feat: (cy.prompt) give cy.prompt access to recording information

* undo bad refactor

* undo bad refactor

* undo bad refactor

* rename

* fix typo

* Update packages/server/test/unit/modes/record_spec.js

* Update packages/server/test/unit/modes/record_spec.js

* Update packages/server/test/unit/modes/record_spec.js

* Update packages/server/test/unit/modes/record_spec.js

* Update packages/server/test/unit/modes/record_spec.js

Author: ryanthemanuel

packages/data-context/src/DataActions.ts

@@ -14,6 +14,7 @@ import {
   CohortsActions,
   CodegenActions,
   CloudProjectActions,
+  CurrentRecordingActions,
 } from './actions'
 import { ErrorActions } from './actions/ErrorActions'
 import { EventCollectorActions } from './actions/EventCollectorActions'
@@ -39,6 +40,7 @@ export class DataActions {
   private _codegen: CodegenActions
   private _notification: NotificationActions
   private _cloudProject: CloudProjectActions
+  private _currentRecording: CurrentRecordingActions
 
   constructor (private ctx: DataContext) {
     this._error = new ErrorActions(this.ctx)
@@ -59,6 +61,7 @@ export class DataActions {
     this._codegen = new CodegenActions(this.ctx)
     this._notification = new NotificationActions(this.ctx)
     this._cloudProject = new CloudProjectActions(this.ctx)
+    this._currentRecording = new CurrentRecordingActions(this.ctx)
   }
 
   get error () {
@@ -132,4 +135,8 @@ export class DataActions {
   get cloudProject () {
     return this._cloudProject
   }
+
+  get currentRecording () {
+    return this._currentRecording
+  }
 }

packages/data-context/src/actions/CurrentRecordingActions.ts

@@ -0,0 +1,17 @@
+import type { DataContext } from '..'
+
+export class CurrentRecordingActions {
+  constructor (private ctx: DataContext) {}
+
+  startRun (runId: string) {
+    this.ctx.update((d) => {
+      d.currentRecordingInfo.runId = runId
+    })
+  }
+
+  startInstance (instanceId: string) {
+    this.ctx.update((d) => {
+      d.currentRecordingInfo.instanceId = instanceId
+    })
+  }
+}

packages/data-context/src/actions/ProjectActions.ts

@@ -117,6 +117,7 @@ export class ProjectActions {
       d.scaffoldedFiles = null
       d.app.browserStatus = 'closed'
       d.app.browserUserAgent = null
+      d.currentRecordingInfo = {}
     })
 
     // Also clear any data associated with the linked cloud project

packages/data-context/src/actions/index.ts

@@ -7,6 +7,7 @@ export * from './BrowserActions'
 export * from './CloudProjectActions'
 export * from './CodegenActions'
 export * from './CohortsActions'
+export * from './CurrentRecordingActions'
 export * from './DataEmitterActions'
 export * from './DevActions'
 export * from './ElectronActions'

packages/data-context/src/data/coreDataShape.ts

@@ -132,6 +132,11 @@ interface CloudDataShape {
   }
 }
 
+interface RecordingInfo {
+  runId?: string
+  instanceId?: string
+}
+
 export interface CoreDataShape {
   cliBrowser: string | null
   cliTestingType: string | null
@@ -166,6 +171,7 @@ export interface CoreDataShape {
   didBrowserPreviouslyHaveUnexpectedExit: boolean
   studioLifecycleManager?: StudioLifecycleManagerShape
   cyPromptLifecycleManager?: CyPromptLifecycleManagerShape
+  currentRecordingInfo: RecordingInfo
 }
 
 /**
@@ -248,6 +254,7 @@ export function makeCoreData (modeOptions: Partial<AllModeOptions> = {}): CoreDa
     eventCollectorSource: null,
     didBrowserPreviouslyHaveUnexpectedExit: false,
     studioLifecycleManager: undefined,
+    currentRecordingInfo: {},
   }
 
   async function machineId (): Promise<string | null> {

packages/data-context/test/unit/actions/CurrentRecordingActions.spec.ts

@@ -0,0 +1,27 @@
+import { createTestDataContext } from '../helper'
+import type { DataContext } from '../../../src'
+import { expect } from 'chai'
+
+describe('CurrentRecordingActions', () => {
+  let ctx: DataContext
+
+  beforeEach(() => {
+    ctx = createTestDataContext('open')
+  })
+
+  describe('startRun', () => {
+    it('updates the current run id', () => {
+      ctx.actions.currentRecording.startRun('12345')
+
+      expect(ctx.coreData.currentRecordingInfo.runId).to.equal('12345')
+    })
+  })
+
+  describe('startInstance', () => {
+    it('updates the current instance id', () => {
+      ctx.actions.currentRecording.startInstance('12345')
+
+      expect(ctx.coreData.currentRecordingInfo.instanceId).to.equal('12345')
+    })
+  })
+})

packages/server/lib/cloud/api/cy-prompt/report_cy-prompt_error.ts

@@ -10,6 +10,7 @@ export interface ReportCyPromptErrorOptions {
   error: unknown
   cyPromptMethod: string
   cyPromptMethodArgs?: unknown[]
+  additionalHeaders?: Record<string, string>
 }
 
 interface CyPromptError {
@@ -33,6 +34,7 @@ export function reportCyPromptError ({
   error,
   cyPromptMethod,
   cyPromptMethodArgs,
+  additionalHeaders,
 }: ReportCyPromptErrorOptions): void {
   debug('Error reported:', error)
 
@@ -87,7 +89,7 @@ export function reportCyPromptError ({
       {
         headers: {
           'Content-Type': 'application/json',
-          ...cloudApi.cloudHeaders,
+          ...additionalHeaders,
         },
       },
     ).catch((e: unknown) => {

packages/server/lib/cloud/cy-prompt/CyPromptLifecycleManager.ts

@@ -12,7 +12,7 @@ import { readFile } from 'fs-extra'
 import { ensureCyPromptBundle } from './ensure_cy_prompt_bundle'
 import chokidar from 'chokidar'
 import { getCloudMetadata } from '../get_cloud_metadata'
-import type { CyPromptAuthenticatedUserShape } from '@packages/types'
+import type { CyPromptAuthenticatedUserShape, CyPromptServerOptions } from '@packages/types'
 import crypto from 'crypto'
 import { reportCyPromptError } from '../api/cy-prompt/report_cy-prompt_error'
 
@@ -52,13 +52,23 @@ export class CyPromptLifecycleManager {
       data.cyPromptLifecycleManager = this
     })
 
+    const recordingInfo = {
+      get runId () {
+        return ctx.coreData.currentRecordingInfo.runId
+      },
+      get instanceId () {
+        return ctx.coreData.currentRecordingInfo.instanceId
+      },
+    }
+
     const getProjectOptions = async () => {
       return {
         user: await ctx.actions.auth.authApi.getUser(),
         projectSlug: (await ctx.project.getConfig()).projectId || undefined,
         record,
         key,
         isOpenMode: ctx.isOpenMode,
+        ...(record ? { recordingInfo } : {}),
       }
     }
 
@@ -75,12 +85,12 @@ export class CyPromptLifecycleManager {
       reportCyPromptError({
         cloudApi: {
           cloudUrl,
-          cloudHeaders,
           CloudRequest,
           createCloudRequest,
           isRetryableError,
           asyncRetry,
         },
+        additionalHeaders: cloudHeaders,
         cyPromptHash: this.cyPromptHash,
         projectSlug: (await ctx.project.getConfig()).projectId || undefined,
         error,
@@ -118,12 +128,7 @@ export class CyPromptLifecycleManager {
   }: {
     projectId?: string
     cloudDataSource: CloudDataSource
-    getProjectOptions: () => Promise<{
-      user?: CyPromptAuthenticatedUserShape
-      projectSlug?: string
-      record?: boolean
-      key?: string
-    }>
+    getProjectOptions: CyPromptServerOptions['getProjectOptions']
   }): Promise<{ cyPromptManager?: CyPromptManager, error?: Error }> {
     let cyPromptPath: string
     let manifest: Record<string, string>

packages/server/lib/cloud/cy-prompt/CyPromptManager.ts

@@ -1,4 +1,4 @@
-import type { CyPromptManagerShape, CyPromptStatus, CyPromptServerDefaultShape, CyPromptServerShape, CyPromptCloudApi, CyPromptCDPClient, CyPromptAuthenticatedUserShape, CyPromptAddSocketListenerOptions } from '@packages/types'
+import type { CyPromptManagerShape, CyPromptStatus, CyPromptServerDefaultShape, CyPromptServerShape, CyPromptCloudApi, CyPromptCDPClient, CyPromptAddSocketListenerOptions, CyPromptServerOptions } from '@packages/types'
 import type { Router } from 'express'
 import Debug from 'debug'
 import { requireScript } from '../require_script'
@@ -12,12 +12,7 @@ interface SetupOptions {
   cyPromptHash?: string
   projectSlug?: string
   cloudApi: CyPromptCloudApi
-  getProjectOptions: () => Promise<{
-    user?: CyPromptAuthenticatedUserShape
-    projectSlug?: string
-    record?: boolean
-    key?: string
-  }>
+  getProjectOptions: CyPromptServerOptions['getProjectOptions']
   manifest: Record<string, string>
 }
 

packages/server/lib/modes/record.ts

@@ -571,6 +571,7 @@ const createRunAndRecordSpecs = (options: any = {}) => {
     testingType,
     quiet,
     autoCancelAfterFailures,
+    ctx,
   } = options
   const recordKey = options.key
 
@@ -621,6 +622,8 @@ const createRunAndRecordSpecs = (options: any = {}) => {
         })
       }
 
+      ctx.actions.currentRecording.startRun(resp.runId)
+
       const { runUrl, runId, machineId, groupId } = resp
       const protocolCaptureMeta = resp.capture || {}
 
@@ -645,6 +648,7 @@ const createRunAndRecordSpecs = (options: any = {}) => {
         })
         .then((resp: any = {}) => {
           instanceId = resp.instanceId
+          ctx.actions.currentRecording.startInstance(instanceId)
 
           // pull off only what we need
           const result = _