feat: update the protocol to be able to flex logic based on project config (#30594)

* feat: update the protocol to be able to flex logic based on project config

* slight refactor

* Update cli/CHANGELOG.md

* Update packages/types/src/protocol.ts

* fix ts

Author: ryanthemanuel

cli/CHANGELOG.md

@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 13.16.0
+
+_Released 11/19/2024 (PENDING)_
+
+**Features:**
+
+- Updated the protocol to be able to flex logic based on project config. Addresses [#30560](https://github.com/cypress-io/cypress/issues/30560).
+
 ## 13.15.2
 
 _Released 11/5/2024_

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

@@ -426,6 +426,8 @@ export default {
       }
 
       if (script) {
+        const config = options.project.getConfig()
+
         await options.project.protocolManager.setupProtocol(script, {
           runId: result.runId,
           projectId: options.projectId,
@@ -435,6 +437,7 @@ export default {
             retryWithBackoff: this.retryWithBackoff,
             requestPromise: this.rp,
           },
+          projectConfig: _.pick(config, ['devServerPublicPathRoute', 'port', 'proxyUrl', 'namespace']),
           mountVersion: runnerCapabilities.protocolMountVersion,
         })
       }

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

@@ -591,6 +591,14 @@ describe('lib/cloud/api', () => {
         get protocolManager () {
           return protocolManager
         },
+        getConfig: () => {
+          return {
+            port: 1234,
+            devServerPublicPathRoute: '/dev-server',
+            proxyUrl: 'http://localhost:1234',
+            namespace: '__cypress',
+          }
+        },
       }
 
       return api.createRun({
@@ -617,6 +625,12 @@ describe('lib/cloud/api', () => {
               retryWithBackoff: api.retryWithBackoff,
               requestPromise: api.rp,
             },
+            projectConfig: {
+              port: 1234,
+              devServerPublicPathRoute: '/dev-server',
+              proxyUrl: 'http://localhost:1234',
+              namespace: '__cypress',
+            },
           },
         )
       })
@@ -666,6 +680,14 @@ describe('lib/cloud/api', () => {
         get protocolManager () {
           return protocolManager
         },
+        getConfig: () => {
+          return {
+            port: 1234,
+            devServerPublicPathRoute: '/dev-server',
+            proxyUrl: 'http://localhost:1234',
+            namespace: '__cypress',
+          }
+        },
       }
 
       return api.createRun({
@@ -692,6 +714,12 @@ describe('lib/cloud/api', () => {
               retryWithBackoff: api.retryWithBackoff,
               requestPromise: api.rp,
             },
+            projectConfig: {
+              port: 1234,
+              devServerPublicPathRoute: '/dev-server',
+              proxyUrl: 'http://localhost:1234',
+              namespace: '__cypress',
+            },
           },
         )
       })

packages/types/src/protocol.ts

@@ -85,6 +85,13 @@ export type CaptureArtifact = {
   filePath: string
 }
 
+type ProjectConfig = {
+  devServerPublicPathRoute: string
+  namespace: string
+  port: number
+  proxyUrl: string
+}
+
 export type ProtocolManagerOptions = {
   runId: string
   testingType: 'e2e' | 'component'
@@ -96,6 +103,7 @@ export type ProtocolManagerOptions = {
       get (options: any): Promise<any>
     }
   }
+  projectConfig: ProjectConfig
   mountVersion?: number
 }