chore: cy prompt infrastructure (#31748)

* feat: cy prompt infrastructure

* refactor and add tests

* refactor

* rename experimental config

* prompt

* fix test

* Update cy-prompt-development.md

* Update cy-prompt-development.md

* PR comments

* Update packages/server/lib/cloud/api/cy-prompt/get_cy_prompt_bundle.ts

Co-authored-by: Copilot <[email protected]>

* PR comments

---------

Co-authored-by: Copilot <[email protected]>

Author: ryanthemanuel

cli/types/cypress.d.ts

@@ -1826,6 +1826,11 @@ declare namespace Cypress {
      */
     prevUntil<E extends Node = HTMLElement>(element: E | JQuery<E>, filter?: string, options?: Partial<Loggable & Timeoutable>): Chainable<JQuery<E>>
 
+    /**
+     * TODO: add docs
+     */
+    prompt(message: string, options?: Partial<Loggable & Timeoutable>): Chainable<Subject>
+
     /**
      * Read a file and yield its contents.
      *
@@ -3158,6 +3163,11 @@ declare namespace Cypress {
      * @default false
      */
     experimentalStudio: boolean
+    /**
+     * Enables the prompt command feature.
+     * @default false
+     */
+    experimentalPromptCommand: boolean
     /**
      * Adds support for testing in the WebKit browser engine used by Safari. See https://on.cypress.io/webkit-experiment for more information.
      * @default false

guides/cy-prompt-development.md

@@ -1 +1,30 @@
+# `cy.prompt` Development
 
+In production, the code used to facilitate the prompt command will be retrieved from the Cloud.
+
+To run against locally developed `cy.prompt`:
+
+- Clone the `cypress-services` repo
+  - Run `yarn`
+  - Run `yarn watch` in `app/packages/cy-prompt`
+- Set:
+  - `CYPRESS_INTERNAL_ENV=<environment>` (e.g. `staging` or `production` if you want to hit those deployments of `cypress-services` or `development` if you want to hit a locally running version of `cypress-services`)
+  - `CYPRESS_LOCAL_CY_PROMPT_PATH` to the path to the `cypress-services/app/packages/cy-prompt/dist/development` directory
+- Clone the `cypress` repo
+  - Run `yarn`
+  - Run `yarn cypress:open`
+  - Log In to the Cloud via the App
+  - Open a project that has `experimentalPromptCommand: true` set in the `e2e` config of the `cypress.config.js|ts` file.
+ 
+To run against a deployed version of `cy.prompt`:
+
+- Set:
+  - `CYPRESS_INTERNAL_ENV=<environment>` (e.g. `staging` or `production` if you want to hit those deployments of `cypress-services` or `development` if you want to hit a locally running version of `cypress-services`)
+
+## Testing
+
+### Unit/Component Testing
+
+The code that supports cloud `cy.prompt` and lives in the `cypress` monorepo is unit, integration, and e2e tested in a similar fashion to the rest of the code in the repo. See the [contributing guide](https://github.com/cypress-io/cypress/blob/ad353fcc0f7fdc51b8e624a2a1ef4e76ef9400a0/CONTRIBUTING.md?plain=1#L366) for more specifics.
+
+The code that supports cloud `cy.prompt` and lives in the `cypress-services` monorepo has unit tests that live alongside the code in that monorepo.

packages/config/__snapshots__/index.spec.ts.js

@@ -46,6 +46,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
   'experimentalSourceRewriting': false,
   'experimentalSingleTabRunMode': false,
   'experimentalStudio': false,
+  'experimentalPromptCommand': false,
   'experimentalWebKitSupport': false,
   'fileServerFolder': '',
   'fixturesFolder': 'cypress/fixtures',
@@ -137,6 +138,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
   'experimentalSourceRewriting': false,
   'experimentalSingleTabRunMode': false,
   'experimentalStudio': false,
+  'experimentalPromptCommand': false,
   'experimentalWebKitSupport': false,
   'fileServerFolder': '',
   'fixturesFolder': 'cypress/fixtures',
@@ -224,6 +226,7 @@ exports['config/src/index .getPublicConfigKeys returns list of public config key
   'experimentalSourceRewriting',
   'experimentalSingleTabRunMode',
   'experimentalStudio',
+  'experimentalPromptCommand',
   'experimentalWebKitSupport',
   'fileServerFolder',
   'fixturesFolder',

packages/config/src/options.ts

@@ -259,6 +259,12 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     validation: validate.isBoolean,
     isExperimental: true,
     requireRestartOnChange: 'browser',
+  }, {
+    name: 'experimentalPromptCommand',
+    defaultValue: false,
+    validation: validate.isBoolean,
+    isExperimental: true,
+    requireRestartOnChange: 'server',
   }, {
     name: 'experimentalWebKitSupport',
     defaultValue: false,

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

@@ -1078,6 +1078,7 @@ describe('config/src/project/utils', () => {
             experimentalRunAllSpecs: { value: false, from: 'default' },
             experimentalSingleTabRunMode: { value: false, from: 'default' },
             experimentalStudio: { value: false, from: 'default' },
+            experimentalPromptCommand: { value: false, from: 'default' },
             experimentalSourceRewriting: { value: false, from: 'default' },
             experimentalWebKitSupport: { value: false, from: 'default' },
             fileServerFolder: { value: '', from: 'default' },
@@ -1197,6 +1198,7 @@ describe('config/src/project/utils', () => {
             experimentalRunAllSpecs: { value: false, from: 'default' },
             experimentalSingleTabRunMode: { value: false, from: 'default' },
             experimentalStudio: { value: false, from: 'default' },
+            experimentalPromptCommand: { value: false, from: 'default' },
             experimentalSourceRewriting: { value: false, from: 'default' },
             experimentalWebKitSupport: { value: false, from: 'default' },
             fileServerFolder: { value: '', from: 'default' },

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

@@ -1,4 +1,4 @@
-import { FoundBrowser, Editor, AllowedState, AllModeOptions, TestingType, BrowserStatus, PACKAGE_MANAGERS, AuthStateName, MIGRATION_STEPS, MigrationStep, StudioLifecycleManagerShape } from '@packages/types'
+import { FoundBrowser, Editor, AllowedState, AllModeOptions, TestingType, BrowserStatus, PACKAGE_MANAGERS, AuthStateName, MIGRATION_STEPS, MigrationStep, StudioLifecycleManagerShape, CyPromptLifecycleManagerShape } from '@packages/types'
 import { WizardBundler, CT_FRAMEWORKS, resolveComponentFrameworkDefinition, ErroredFramework } from '@packages/scaffold-config'
 import type { NexusGenObjects } from '@packages/graphql/src/gen/nxs.gen'
 // tslint:disable-next-line no-implicit-dependencies - electron dep needs to be defined
@@ -165,6 +165,7 @@ export interface CoreDataShape {
   eventCollectorSource: EventCollectorSource | null
   didBrowserPreviouslyHaveUnexpectedExit: boolean
   studioLifecycleManager?: StudioLifecycleManagerShape
+  cyPromptLifecycleManager?: CyPromptLifecycleManagerShape
 }
 
 /**

packages/driver/cypress.config.ts

@@ -7,6 +7,7 @@ export const baseConfig: Cypress.ConfigOptions = {
   experimentalStudio: true,
   experimentalMemoryManagement: true,
   experimentalWebKitSupport: true,
+  experimentalPromptCommand: true,
   hosts: {
     'foobar.com': '127.0.0.1',
     '*.foobar.com': '127.0.0.1',

packages/driver/cypress/e2e/commands/prompt.cy.ts

@@ -0,0 +1,9 @@
+describe('src/cy/commands/prompt', () => {
+  it('executes the prompt command', () => {
+    cy.visit('/fixtures/dom.html')
+
+    // TODO: add more tests when cy.prompt is built out, but for now this just
+    // verifies that the command executes without throwing an error
+    cy.prompt('Hello, world!')
+  })
+})

packages/driver/cypress/e2e/e2e/origin/commands/misc.cy.ts

@@ -224,7 +224,7 @@ it('verifies number of cy commands', () => {
     'writeFile', 'fixture', 'clearLocalStorage', 'url', 'hash', 'location', 'end', 'noop', 'log', 'wrap', 'reload', 'go', 'visit',
     'focused', 'get', 'contains', 'shadow', 'within', 'request', 'session', 'screenshot', 'task', 'find', 'filter', 'not',
     'children', 'eq', 'closest', 'first', 'last', 'next', 'nextAll', 'nextUntil', 'parent', 'parents', 'parentsUntil', 'prev', 'press',
-    'prevAll', 'prevUntil', 'siblings', 'wait', 'title', 'window', 'document', 'viewport', 'server', 'route', 'intercept', 'origin',
+    'prevAll', 'prevUntil', 'prompt', 'siblings', 'wait', 'title', 'window', 'document', 'viewport', 'server', 'route', 'intercept', 'origin',
     'mount', 'as', 'root', 'getAllLocalStorage', 'clearAllLocalStorage', 'getAllSessionStorage', 'clearAllSessionStorage',
     'getAllCookies', 'clearAllCookies',
   ]

packages/driver/package.json

@@ -22,6 +22,7 @@
     "@cypress/unique-selector": "0.0.5",
     "@cypress/webpack-dev-server": "0.0.0-development",
     "@cypress/webpack-preprocessor": "0.0.0-development",
+    "@module-federation/runtime": "^0.8.11",
     "@packages/config": "0.0.0-development",
     "@packages/errors": "0.0.0-development",
     "@packages/net-stubbing": "0.0.0-development",