fix: (cy.prompt) handle when the prompt is executed by in CT or when the experiment is not enabled

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

@@ -1,4 +1,8 @@
 describe('src/cy/commands/prompt', () => {
+  afterEach(() => {
+    Cypress.testingType = 'e2e'
+  })
+
   it('executes the prompt command', () => {
     // TODO: (cy.prompt) We will look into supporting other browsers
     // as this is rolled out. We will add error messages for other browsers
@@ -15,4 +19,17 @@ describe('src/cy/commands/prompt', () => {
 
     cy.get('#log').should('contain', 'clicked')
   })
+
+  it('fails when testingType is component', (done) => {
+    cy.on('fail', (err) => {
+      expect(err.message).to.eq('`cy.prompt` is currently only supported in end-to-end tests.')
+      done()
+    })
+
+    Cypress.testingType = 'component'
+
+    cy.visit('http://www.foobar.com:3500/fixtures/prompt.html')
+
+    cy.prompt(['Click the "click me" button'])
+  })
 })

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

@@ -137,5 +137,15 @@ export default (Commands: Cypress.Cypress['Commands'], Cypress: Cypress.Cypress,
     }
 
     Commands.addAll(commands)
+  } else {
+    Commands.addAll({
+      prompt (steps: string[], commandOptions: object = {}) {
+        if (Cypress.testingType === 'component') {
+          $errUtils.throwErrByPath('prompt.promptTestingTypeError')
+        }
+
+        $errUtils.throwErrByPath('prompt.experimentalPromptCommandError')
+      },
+    })
   }
 }

packages/driver/src/cypress/error_messages.ts

@@ -1356,6 +1356,14 @@ export default {
         docsUrl: 'https://on.cypress.io/prompt-download-error',
       }
     },
+    promptTestingTypeError: stripIndent`\
+      \`cy.prompt\` is currently only supported in end-to-end tests.
+    `,
+    experimentalPromptCommandError: stripIndent`\
+      \`cy.prompt\` cannot be called without the \`experimentalPromptCommand\` being set. 
+
+      Please set this in your Cypress config file to continue using \`cy.prompt\`.
+    `,
   },
 
   proxy: {

system-tests/__snapshots__/prompt_spec.ts.js

@@ -0,0 +1,70 @@
+exports['e2e prompt / fails when experimentalPromptCommand is not set'] = `
+
+====================================================================================================
+
+  (Run Starting)
+
+  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
+  │ Cypress:    1.2.3                                                                              │
+  │ Browser:    FooBrowser 88                                                                      │
+  │ Specs:      1 found (prompt.cy.js)                                                             │
+  │ Searched:   cypress/e2e/prompt.cy.js                                                           │
+  └────────────────────────────────────────────────────────────────────────────────────────────────┘
+
+
+────────────────────────────────────────────────────────────────────────────────────────────────────
+
+  Running:  prompt.cy.js                                                                    (1 of 1)
+
+
+  prompt
+    1) should fail when experimentalPromptCommand is not set
+
+
+  0 passing
+  1 failing
+
+  1) prompt
+       should fail when experimentalPromptCommand is not set:
+     CypressError: \`cy.prompt\` cannot be called without the \`experimentalPromptCommand\` being set. 
+
+Please set this in your Cypress config file to continue using \`cy.prompt\`.
+      [stack trace lines]
+
+
+
+
+  (Results)
+
+  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
+  │ Tests:        1                                                                                │
+  │ Passing:      0                                                                                │
+  │ Failing:      1                                                                                │
+  │ Pending:      0                                                                                │
+  │ Skipped:      0                                                                                │
+  │ Screenshots:  1                                                                                │
+  │ Video:        false                                                                            │
+  │ Duration:     X seconds                                                                        │
+  │ Spec Ran:     prompt.cy.js                                                                     │
+  └────────────────────────────────────────────────────────────────────────────────────────────────┘
+
+
+  (Screenshots)
+
+  -  /XXX/XXX/XXX/cypress/screenshots/prompt.cy.js/prompt -- should fail when experim    (2560x1440)
+     entalPromptCommand is not set (failed).png                                                     
+
+
+====================================================================================================
+
+  (Run Finished)
+
+
+       Spec                                              Tests  Passing  Failing  Pending  Skipped  
+  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
+  │ ✖  prompt.cy.js                             XX:XX        1        -        1        -        - │
+  └────────────────────────────────────────────────────────────────────────────────────────────────┘
+    ✖  1 of 1 failed (100%)                     XX:XX        1        -        1        -        -  
+
+
+`

system-tests/projects/experimentalPromptCommand/cypress-disabled-prompt-experiment.config.js

@@ -0,0 +1,7 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    supportFile: false,
+  },
+})

system-tests/projects/experimentalPromptCommand/cypress/e2e/prompt.cy.js

@@ -0,0 +1,5 @@
+describe('prompt', () => {
+  it('should fail when experimentalPromptCommand is not set', () => {
+    cy.prompt(['Click the "click me" button'])
+  })
+})

system-tests/test/prompt_spec.ts

@@ -0,0 +1,14 @@
+import systemTests from '../lib/system-tests'
+
+describe('e2e prompt', () => {
+  systemTests.setup()
+
+  systemTests.it('fails when experimentalPromptCommand is not set', {
+    browser: 'electron',
+    project: 'experimentalPromptCommand',
+    spec: 'prompt.cy.js',
+    configFile: 'cypress-disabled-prompt-experiment.config.js',
+    expectedExitCode: 1,
+    snapshot: true,
+  })
+})