chore: pass file preprocesor override to protocol as debug data

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

@@ -49,6 +49,10 @@ export interface SerializedLoadConfigReply {
   requires: string[]
 }
 
+export interface DebugData {
+  filePreprocessorHandlerString?: string
+}
+
 /**
  * The ProjectConfigIpc is an EventEmitter wrapping the childProcess,
  * adding a "send" method for sending events from the parent process into the childProcess,
@@ -65,6 +69,7 @@ export class ProjectConfigIpc extends EventEmitter {
     readonly configFile: string | false,
     readonly onError: (cypressError: CypressError, title?: string | undefined) => void,
     readonly onWarning: (cypressError: CypressError) => void,
+    readonly onDebugData: (debugData: DebugData) => void,
   ) {
     super()
     this._childProcess = this.forkConfigProcess()
@@ -131,6 +136,7 @@ export class ProjectConfigIpc extends EventEmitter {
    */
   once(evt: 'setupTestingType:reply', listener: (payload: SetupNodeEventsReply) => void): this
   once(evt: 'setupTestingType:error', listener: (error: CypressError) => void): this
+  once(evt: 'file:preprocessor:overridden', listener: (payload: { handlerString: string }) => void): this
   once (evt: string, listener: (...args: any[]) => void) {
     return super.once(evt, listener)
   }
@@ -238,6 +244,12 @@ export class ProjectConfigIpc extends EventEmitter {
         reject(err)
       })
 
+      this.once('file:preprocessor:overridden', ({ handlerString }) => {
+        this.onDebugData({
+          filePreprocessorHandlerString: handlerString,
+        })
+      })
+
       const handleWarning = (warningErr: CypressError) => {
         debug('plugins process warning:', warningErr.stack)
 

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

@@ -1,5 +1,5 @@
 import { CypressError, getError } from '@packages/errors'
-import { IpcHandler, LoadConfigReply, ProjectConfigIpc, SetupNodeEventsReply } from './ProjectConfigIpc'
+import { DebugData, IpcHandler, LoadConfigReply, ProjectConfigIpc, SetupNodeEventsReply } from './ProjectConfigIpc'
 import assert from 'assert'
 import type { AllModeOptions, FullConfig, TestingType } from '@packages/types'
 import debugLib from 'debug'
@@ -57,6 +57,7 @@ export class ProjectConfigManager {
   private _loadConfigPromise: Promise<LoadConfigReply> | undefined
   private _cachedLoadConfig: LoadConfigReply | undefined
   private _cypressEnv: CypressEnv
+  private _debugData: DebugData
 
   constructor (private options: ProjectConfigManagerOptions) {
     this._cypressEnv = new CypressEnv({
@@ -66,9 +67,15 @@ export class ProjectConfigManager {
       },
     })
 
+    this._debugData = {}
+
     return autoBindDebug(this)
   }
 
+  get debugData () {
+    return this._debugData
+  }
+
   get isLoadingNodeEvents () {
     return this._state === 'loadingNodeEvents'
   }
@@ -372,6 +379,12 @@ export class ProjectConfigManager {
           this.options.ctx.onError(cypressError, title)
         },
         this.options.ctx.onWarning,
+        (debugData: DebugData) => {
+          this._debugData = {
+            ...this._debugData,
+            ...debugData,
+          }
+        },
       )
 
       this._loadConfigPromise = this._eventsIpc.loadConfig()

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

@@ -102,6 +102,10 @@ export class ProjectLifecycleManager {
     return this.ctx.coreData.currentProjectGitInfo
   }
 
+  get configDebugData () {
+    return this._configManager?.debugData
+  }
+
   async getProjectId (): Promise<string | null> {
     try {
       // No need to kick off config initialization if we need to migrate

packages/data-context/test/unit/data/ProjectConfigIpc.spec.ts

@@ -20,6 +20,7 @@ describe('ProjectConfigIpc', () => {
         false,
         (error) => {},
         () => {},
+        () => {},
       )
     })
 
@@ -74,6 +75,7 @@ describe('ProjectConfigIpc', () => {
                 false,
                 (error) => {},
                 () => {},
+                () => {},
               )
 
               expect(forkSpy).to.have.been.calledWith(sinon.match.string, sinon.match.array, sinon.match({
@@ -116,6 +118,7 @@ describe('ProjectConfigIpc', () => {
                 false,
                 (error) => {},
                 () => {},
+                () => {},
               )
 
               expect(forkSpy).to.have.been.calledWith(sinon.match.string, sinon.match.array, sinon.match({

packages/server/lib/cloud/api/index.ts

@@ -438,6 +438,7 @@ export default {
           },
           projectConfig: _.pick(config, ['devServerPublicPathRoute', 'port', 'proxyUrl', 'namespace']),
           mountVersion: runnerCapabilities.protocolMountVersion,
+          debugData: options.project.configDebugData,
         })
       }
 

packages/server/lib/plugins/child/run_plugins.js

@@ -64,7 +64,7 @@ class RunPlugins {
 
     // we track the register calls and then send them all at once
     // to the parent process
-    const registerChildEvent = (event, handler) => {
+    const registerChildEvent = (event, handler, isDefaultHandler = false) => {
       const { isValid, userEvents, error } = validateEvent(event, handler, initialConfig)
 
       if (!isValid) {
@@ -97,6 +97,10 @@ class RunPlugins {
         }
       }
 
+      if (event === 'file:preprocessor' && !isDefaultHandler) {
+        this.ipc.send('file:preprocessor:overridden', { handlerString: handler.toString() })
+      }
+
       const eventId = this.eventIdCount++
 
       this.registeredEventsById[eventId] = { event, handler }
@@ -124,7 +128,7 @@ class RunPlugins {
     .tap(() => {
       if (!this.registeredEventsByName['file:preprocessor']) {
         debug('register default preprocessor')
-        registerChildEvent('file:preprocessor', this._getDefaultPreprocessor(initialConfig))
+        registerChildEvent('file:preprocessor', this._getDefaultPreprocessor(initialConfig), true)
       }
     })
     .then((modifiedCfg) => {

packages/server/lib/project-base.ts

@@ -588,6 +588,10 @@ export class ProjectBase extends EE {
     return getCtx().lifecycleManager.getProjectId()
   }
 
+  get configDebugData () {
+    return this.ctx.lifecycleManager.configDebugData
+  }
+
   // For testing
   // Do not use this method outside of testing
   // pass all your options when you create a new instance!

packages/server/test/unit/cloud/api/api_spec.js

@@ -599,6 +599,11 @@ describe('lib/cloud/api', () => {
             namespace: '__cypress',
           }
         },
+        get configDebugData () {
+          return {
+            filePreprocessorHandlerString: 'function () {}',
+          }
+        },
       }
 
       return api.createRun({
@@ -631,6 +636,9 @@ describe('lib/cloud/api', () => {
               proxyUrl: 'http://localhost:1234',
               namespace: '__cypress',
             },
+            debugData: {
+              filePreprocessorHandlerString: 'function () {}',
+            },
           },
         )
       })
@@ -688,6 +696,9 @@ describe('lib/cloud/api', () => {
             namespace: '__cypress',
           }
         },
+        configDebugData: {
+          filePreprocessorHandlerString: 'function () {}',
+        },
       }
 
       return api.createRun({
@@ -720,6 +731,9 @@ describe('lib/cloud/api', () => {
               proxyUrl: 'http://localhost:1234',
               namespace: '__cypress',
             },
+            debugData: {
+              filePreprocessorHandlerString: 'function () {}',
+            },
           },
         )
       })

packages/types/src/protocol.ts

@@ -105,6 +105,9 @@ export type ProtocolManagerOptions = {
   }
   projectConfig: ProjectConfig
   mountVersion?: number
+  debugData?: {
+    filePreprocessorHandlerString?: string
+  }
 }
 
 type UploadCaptureArtifactResult = {

system-tests/__snapshots__/protocol_spec.js

@@ -1,5 +1,6 @@
 exports['e2e events'] = `
 {
+  "debugData": {},
   "beforeSpec": [
     {
       "name": "/path/to/name",
@@ -6138,6 +6139,7 @@ exports['e2e events'] = `
 
 exports['component events - experimentalSingleTabRunMode: true'] = `
 {
+  "debugData": {},
   "beforeSpec": [
     {
       "name": "/path/to/name",
@@ -7956,6 +7958,7 @@ exports['component events - experimentalSingleTabRunMode: true'] = `
 
 exports['component events - experimentalSingleTabRunMode: false'] = `
 {
+  "debugData": {},
   "beforeSpec": [
     {
       "name": "/path/to/name",

system-tests/lib/protocol-stubs/protocolStub.ts

@@ -1,6 +1,6 @@
 import path from 'path'
 import fs from 'fs-extra'
-import type { AppCaptureProtocolInterface, ResponseEndedWithEmptyBodyOptions, ResponseStreamOptions, ResponseStreamTimedOutOptions } from '@packages/types'
+import type { AppCaptureProtocolInterface, ProtocolManagerOptions, ResponseEndedWithEmptyBodyOptions, ResponseStreamOptions, ResponseStreamTimedOutOptions } from '@packages/types'
 import type { Readable } from 'stream'
 
 const getFilePath = (filename) => {
@@ -33,6 +33,7 @@ const DURATIONS = {
 export class AppCaptureProtocol implements AppCaptureProtocolInterface {
   private filename: string
   private events = {
+    debugData: {},
     beforeSpec: [],
     afterSpec: [],
     beforeTest: [],
@@ -52,6 +53,10 @@ export class AppCaptureProtocol implements AppCaptureProtocolInterface {
   private cdpClient: any
   private scriptToEvaluateId: any
 
+  constructor (options: ProtocolManagerOptions) {
+    this.events.debugData = options.debugData
+  }
+
   getDbMetadata (): { offset: number, size: number } {
     return {
       offset: 0,

system-tests/projects/protocol/cypress-with-file-preprocessor.config.ts

@@ -0,0 +1,45 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+  projectId: 'pid123',
+  e2e: {
+    supportFile: false,
+    setupNodeEvents: (on, config) => {
+      on('file:preprocessor', (file) => {
+        return file.filePath
+      })
+
+      return config
+    },
+  },
+  component: {
+    devServer: {
+      framework: 'react',
+      bundler: 'webpack',
+      webpackConfig: {
+        module: {
+          rules: [
+            {
+              test: /\.(js|jsx|ts|tsx)$/,
+              exclude: /node_modules/,
+              use: {
+                loader: 'babel-loader',
+                options: {
+                  presets: [
+                    '@babel/preset-env',
+                    '@babel/preset-react',
+                    '@babel/preset-typescript',
+                  ],
+                },
+              },
+            },
+            {
+              test: /\.css$/i,
+              use: ['style-loader', 'css-loader'],
+            },
+          ],
+        },
+      },
+    },
+  },
+})

system-tests/test/protocol_spec.js

@@ -57,6 +57,22 @@ describe('capture-protocol', () => {
         fs.removeSync(getFilePath('e9e81b5e-cc58-4026-b2ff-8ae3161435a6.db'))
       })
     })
+
+    it('verifies that the debug data is correct', async function () {
+      await systemTests.exec(this, {
+        key: 'f858a2bc-b469-4e48-be67-0876339ee7e1',
+        project: 'protocol',
+        spec: 'protocol.cy.js',
+        record: true,
+        expectedExitCode: 0,
+        port: 2121,
+        configFile: 'cypress-with-file-preprocessor.config.ts',
+      })
+
+      const protocolEvents = await fs.promises.readFile(getFilePath('e9e81b5e-cc58-4026-b2ff-8ae3161435a6.db'), 'utf8')
+
+      expect(JSON.parse(protocolEvents).debugData.filePreprocessorHandlerString).to.equal('(file) => {\n                return file.filePath;\n            }')
+    })
   })
 
   describe('component', () => {