chore: remove experimentalPromptCommand config (#33497)

* chore: remove experimentalPromptCommand config

* Update with code review

* feat: add projectId handling in CyPromptLifecycleManager and ProjectBase

- Enhanced ProjectBase to include projectId in the context.
- Updated CyPromptLifecycleManager to utilize projectId, with fallback handling when project configuration fails.
- Added tests to verify behavior when project configuration is unavailable, ensuring fallback projectId is used correctly.

* Update with code review

* Update with code review

Author: estrada9166

cli/types/cypress.d.ts

@@ -3355,11 +3355,6 @@ declare namespace Cypress {
      * @default false
      */
     experimentalOriginDependencies?: boolean
-    /**
-     * Enables support for `cy.prompt`, an AI-powered command that turns natural language steps into executable Cypress test code.
-     * @default false
-     */
-    experimentalPromptCommand?: boolean
   }
 
   /**

guides/cy-prompt-development.md

@@ -22,7 +22,6 @@ Regardless of running against local or deployed `cy.prompt`:
   - Run `yarn`
   - Run `yarn cypress:open`
   - Log In to the Cloud via the App
-  - Open a project that has `experimentalPromptCommand: true` set in the config of the `cypress.config.js|ts` file within `e2e`. Ensure the project has the feature flag `cy-prompt` enabled.
 
 To run against a deployed version of `cy.prompt`:
 

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

@@ -453,11 +453,9 @@ export class EventManager {
 
     this._addListeners()
 
-    if (Cypress.config('experimentalPromptCommand')) {
-      await new Promise((resolve) => {
-        this.ws.emit('prompt:reset', resolve)
-      })
-    }
+    await new Promise((resolve) => {
+      this.ws.emit('prompt:reset', resolve)
+    })
   }
 
   isBrowserFamily (family: string) {

packages/config/src/options.ts

@@ -28,6 +28,7 @@ const BREAKING_OPTION_ERROR_KEY: Readonly<AllCypressErrorNames[]> = [
   'VIDEO_UPLOAD_ON_PASSES_REMOVED',
   'RENAMED_CONFIG_OPTION',
   'EXPERIMENTAL_STUDIO_REMOVED',
+  'EXPERIMENTAL_PROMPT_COMMAND_REMOVED',
   'CYPRESS_ENV_DEPRECATION',
 ] as const
 
@@ -256,12 +257,6 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     isExperimental: true,
     overrideLevel: 'any',
     requireRestartOnChange: 'browser',
-  }, {
-    name: 'experimentalPromptCommand',
-    defaultValue: false,
-    validation: validate.isBoolean,
-    isExperimental: true,
-    requireRestartOnChange: 'server',
   }, {
     name: 'experimentalSourceRewriting',
     defaultValue: false,
@@ -659,6 +654,11 @@ export const breakingOptions: Readonly<BreakingOption[]> = [
     errorKey: 'EXPERIMENTAL_STUDIO_REMOVED',
     isWarning: true,
   },
+  {
+    name: 'experimentalPromptCommand',
+    errorKey: 'EXPERIMENTAL_PROMPT_COMMAND_REMOVED',
+    isWarning: true,
+  },
   {
     name: 'allowCypressEnv',
     errorKey: 'CYPRESS_ENV_DEPRECATION',
@@ -711,12 +711,6 @@ export const breakingRootOptions: Array<BreakingOption> = [
     isWarning: false,
     testingTypes: ['e2e'],
   },
-  {
-    name: 'experimentalPromptCommand',
-    errorKey: 'EXPERIMENTAL_PROMPT_COMMAND_E2E_ONLY',
-    isWarning: false,
-    testingTypes: ['e2e'],
-  },
   {
     name: 'justInTimeCompile',
     errorKey: 'JIT_COMPONENT_TESTING',
@@ -764,11 +758,6 @@ export const testingTypeBreakingOptions: { e2e: Array<BreakingOption>, component
       errorKey: 'EXPERIMENTAL_ORIGIN_DEPENDENCIES_E2E_ONLY',
       isWarning: false,
     },
-    {
-      name: 'experimentalPromptCommand',
-      errorKey: 'EXPERIMENTAL_PROMPT_COMMAND_E2E_ONLY',
-      isWarning: false,
-    },
     {
       name: 'injectDocumentDomain',
       errorKey: 'INJECT_DOCUMENT_DOMAIN_E2E_ONLY',

packages/config/test/__snapshots__/index.spec.ts.snap

@@ -7,6 +7,7 @@ exports[`config/src/index > .getBreakingKeys > returns list of breaking config k
   "experimentalSkipDomainInjection",
   "videoUploadOnPasses",
   "experimentalStudio",
+  "experimentalPromptCommand",
   "allowCypressEnv",
 ]
 `;
@@ -45,7 +46,6 @@ exports[`config/src/index > .getDefaultValues > returns list of public config ke
   "experimentalMemoryManagement": false,
   "experimentalModifyObstructiveThirdPartyCode": false,
   "experimentalOriginDependencies": false,
-  "experimentalPromptCommand": false,
   "experimentalRunAllSpecs": false,
   "experimentalSingleTabRunMode": false,
   "experimentalSourceRewriting": false,
@@ -143,7 +143,6 @@ exports[`config/src/index > .getDefaultValues > returns list of public config ke
   "experimentalMemoryManagement": false,
   "experimentalModifyObstructiveThirdPartyCode": false,
   "experimentalOriginDependencies": false,
-  "experimentalPromptCommand": false,
   "experimentalRunAllSpecs": false,
   "experimentalSingleTabRunMode": false,
   "experimentalSourceRewriting": false,
@@ -231,7 +230,6 @@ exports[`config/src/index > .getPublicConfigKeys > returns list of public config
   "experimentalModifyObstructiveThirdPartyCode",
   "injectDocumentDomain",
   "experimentalOriginDependencies",
-  "experimentalPromptCommand",
   "experimentalSourceRewriting",
   "experimentalSingleTabRunMode",
   "experimentalWebKitSupport",

packages/config/test/index.spec.ts

@@ -162,6 +162,26 @@ describe('config/src/index', () => {
       expect(errorFn).toHaveBeenCalledTimes(0)
     })
 
+    it('calls warning callback if config contains experimentalPromptCommand', () => {
+      const warningFn = vi.fn()
+      const errorFn = vi.fn()
+
+      configUtil.validateNoBreakingConfig({
+        experimentalPromptCommand: true,
+        configFile: 'config.js',
+      }, warningFn, errorFn, 'e2e')
+
+      expect(warningFn).toHaveBeenCalledExactlyOnceWith('EXPERIMENTAL_PROMPT_COMMAND_REMOVED', {
+        name: 'experimentalPromptCommand',
+        newName: undefined,
+        value: undefined,
+        testingType: 'e2e',
+        configFile: 'config.js',
+      })
+
+      expect(errorFn).toHaveBeenCalledTimes(0)
+    })
+
     it('calls error callback if config contains breaking option that should throw an error', () => {
       const warningFn = vi.fn()
       const errorFn = vi.fn()

packages/config/test/project/utils.spec.ts

@@ -1193,7 +1193,6 @@ describe('config/src/project/utils', () => {
           experimentalInteractiveRunEvents: { value: false, from: 'default' },
           experimentalMemoryManagement: { value: false, from: 'default' },
           experimentalOriginDependencies: { value: false, from: 'default' },
-          experimentalPromptCommand: { value: false, from: 'default' },
           experimentalRunAllSpecs: { value: false, from: 'default' },
           experimentalSingleTabRunMode: { value: false, from: 'default' },
           experimentalSourceRewriting: { value: false, from: 'default' },
@@ -1318,7 +1317,6 @@ describe('config/src/project/utils', () => {
           experimentalInteractiveRunEvents: { value: false, from: 'default' },
           experimentalMemoryManagement: { value: false, from: 'default' },
           experimentalOriginDependencies: { value: false, from: 'default' },
-          experimentalPromptCommand: { value: false, from: 'default' },
           experimentalRunAllSpecs: { value: false, from: 'default' },
           experimentalSingleTabRunMode: { value: false, from: 'default' },
           experimentalSourceRewriting: { value: false, from: 'default' },

packages/data-context/schemas/schema.graphql

@@ -1182,7 +1182,7 @@ enum ErrorTypeEnum {
   ERROR_WRITING_FILE
   EXPERIMENTAL_JIT_COMPILE_REMOVED
   EXPERIMENTAL_ORIGIN_DEPENDENCIES_E2E_ONLY
-  EXPERIMENTAL_PROMPT_COMMAND_E2E_ONLY
+  EXPERIMENTAL_PROMPT_COMMAND_REMOVED
   EXPERIMENTAL_SESSION_AND_ORIGIN_REMOVED
   EXPERIMENTAL_SINGLE_TAB_RUN_MODE
   EXPERIMENTAL_SKIP_DOMAIN_INJECTION_REMOVED

packages/driver/cypress.config.ts

@@ -25,7 +25,6 @@ export const baseConfig: Cypress.ConfigOptions = {
     configFile: '../../mocha-reporter-config.json',
   },
   e2e: {
-    experimentalPromptCommand: true,
     experimentalOriginDependencies: true,
     experimentalModifyObstructiveThirdPartyCode: true,
     setupNodeEvents: (on, config) => {

packages/driver/src/cy/commands/prompt/index.ts

@@ -163,90 +163,61 @@ const initializeCloudCyPrompt = async (Cypress: Cypress.Cypress, cy: Cypress.Cyp
 }
 
 export default (Commands: Cypress.Cypress['Commands'], Cypress: Cypress.Cypress, cy: Cypress.Cypress['cy']) => {
-  // @ts-expect-error - these types are not yet implemented until the prompt command is rolled out
-  if (Cypress.config('experimentalPromptCommand')) {
-    let initializeCloudCyPromptPromise = initializeCloudCyPrompt(Cypress, cy)
-
-    const commands = {
-      prompt (steps: string[], commandOptions: object = {}) {
-        const promptCmd = cy.state('current')
-
-        const downloadTimeout = '_downloadTimeout' in commandOptions ? commandOptions._downloadTimeout as number : 45000
-
-        let timeoutId: NodeJS.Timeout
-        const timeoutPromise = new Promise((resolve) => {
-          timeoutId = setTimeout(() => {
-            resolve({
-              error: undefined,
-              timedOut: true,
-            })
-          }, downloadTimeout)
-        })
-        const raceBundleResult = Promise.race([
-          initializeCloudCyPromptPromise,
-          timeoutPromise,
-        ]).finally(() => {
-          clearTimeout(timeoutId)
-        }) as Promise<BundleResult>
-
-        return cy.wrap(raceBundleResult, { log: false, timeout: 1e9 }).then((bundleResult: BundleResult) => {
-          if (bundleResult.timedOut) {
-            cy.state('current', promptCmd)
-
-            return $errUtils.throwErrByPath('prompt.promptDownloadTimedOut', {
-              args: {
-                error: new Error('cy.prompt bundle download timed out'),
-              },
-            })
-          }
+  let initializeCloudCyPromptPromise = initializeCloudCyPrompt(Cypress, cy)
 
-          if (bundleResult.error) {
-            cy.state('current', promptCmd)
-            throw bundleResult.error
-          }
+  const commands = {
+    prompt (steps: string[], commandOptions: object = {}) {
+      const promptCmd = cy.state('current')
 
-          const cyPrompt = bundleResult.bundle
+      const downloadTimeout = '_downloadTimeout' in commandOptions ? commandOptions._downloadTimeout as number : 45000
 
-          return cyPrompt({
-            steps,
-            commandOptions,
-            promptCmd,
+      let timeoutId: NodeJS.Timeout
+      const timeoutPromise = new Promise((resolve) => {
+        timeoutId = setTimeout(() => {
+          resolve({
+            error: undefined,
+            timedOut: true,
           })
-        })
-      },
-    }
-
-    commands.prompt['__resetPrompt'] = async (delay: number = 0) => {
-      initializedModule = null
-      initializeCloudCyPromptPromise = new Promise((resolve) => setTimeout(resolve, delay)).then(() => initializeCloudCyPrompt(Cypress, cy))
-    }
-
-    Commands.addAll(commands)
-  } else {
-    Commands.addAll({
-      prompt () {
-        const stack = cy.state('current').get('userInvocationStack')
-
-        if (Cypress.testingType === 'component') {
-          $errUtils.throwErrByPath('prompt.promptTestingTypeError', {
-            errProps: {
-              name: 'PromptTestingTypeError',
-            },
-            onFail: (err) => {
-              err.stack = stack
+        }, downloadTimeout)
+      })
+      const raceBundleResult = Promise.race([
+        initializeCloudCyPromptPromise,
+        timeoutPromise,
+      ]).finally(() => {
+        clearTimeout(timeoutId)
+      }) as Promise<BundleResult>
+
+      return cy.wrap(raceBundleResult, { log: false, timeout: 1e9 }).then((bundleResult: BundleResult) => {
+        if (bundleResult.timedOut) {
+          cy.state('current', promptCmd)
+
+          return $errUtils.throwErrByPath('prompt.promptDownloadTimedOut', {
+            args: {
+              error: new Error('cy.prompt bundle download timed out'),
             },
           })
         }
 
-        $errUtils.throwErrByPath('prompt.experimentalPromptCommandError', {
-          errProps: {
-            name: 'PromptNotEnabledError',
-          },
-          onFail: (err) => {
-            err.stack = stack
-          },
+        if (bundleResult.error) {
+          cy.state('current', promptCmd)
+          throw bundleResult.error
+        }
+
+        const cyPrompt = bundleResult.bundle
+
+        return cyPrompt({
+          steps,
+          commandOptions,
+          promptCmd,
         })
-      },
-    })
+      })
+    },
   }
+
+  commands.prompt['__resetPrompt'] = async (delay: number = 0) => {
+    initializedModule = null
+    initializeCloudCyPromptPromise = new Promise((resolve) => setTimeout(resolve, delay)).then(() => initializeCloudCyPrompt(Cypress, cy))
+  }
+
+  Commands.addAll(commands)
 }