internal: (cy.prompt) do not retry on cert failures (#32624)

* internal: (cy.prompt) do not retry on cert failures

* tests and clean up

* additional cleanup and add error message for prompt

* fix unit tests

* Update report_studio_error.ts

* Update packages/network/lib/agent.ts

* cursor comment

* fix build

* fix build

* fix test

* fix build

* fix build

* fix build

* fix build

* fix build

* revert

* Update packages/driver/src/cypress/error_messages.ts

* Update packages/driver/cypress/e2e/commands/prompt/prompt-initialization-error.cy.ts

* fix build

Author: ryanthemanuel

packages/driver/cypress/e2e/commands/prompt/prompt-initialization-error.cy.ts

@@ -34,4 +34,25 @@ describe('src/cy/commands/prompt', () => {
     cy['commandFns']['prompt'].__resetPrompt()
     cy.prompt(['Hello, world!'])
   })
+
+  it('errors with a proxy error', (done) => {
+    const backendStub = cy.stub(Cypress, 'backend').log(false)
+
+    const error = new Error('UNABLE_TO_VERIFY_LEAF_SIGNATURE')
+
+    ;(error as any).code = 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'
+
+    backendStub.callThrough()
+    backendStub.withArgs('wait:for:prompt:ready').resolves({ success: false, error })
+
+    cy.on('fail', (err) => {
+      expect(err.message).to.include('`cy.prompt` requires an internet connection to work. To continue, you may need to configure Cypress with your proxy settings.')
+      done()
+    })
+
+    cy.visit('http://www.foobar.com:3500/fixtures/dom.html')
+
+    cy['commandFns']['prompt'].__resetPrompt()
+    cy.prompt(['Hello, world!'])
+  })
 })

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

@@ -3,6 +3,7 @@ import type { CypressInternal, CyPromptDriverDefaultShape, CyPromptMoreInfoNeede
 import type Emitter from 'component-emitter'
 import $errUtils from '../../../cypress/error_utils'
 import $stackUtils from '../../../cypress/stack_utils'
+import { isNonRetriableCertErrorCode } from '@packages/server/lib/cloud/network/non_retriable_cert_error_codes'
 
 interface CyPromptDriver { default: CyPromptDriverDefaultShape }
 
@@ -39,6 +40,14 @@ const initializeModule = async (Cypress: Cypress.Cypress): Promise<CyPromptDrive
   const { success, error } = await Cypress.backend('wait:for:prompt:ready')
 
   if (error) {
+    if ('code' in error && isNonRetriableCertErrorCode(error.code as string)) {
+      $errUtils.throwErrByPath('prompt.promptProxyError', {
+        args: {
+          error,
+        },
+      })
+    }
+
     $errUtils.throwErrByPath('prompt.promptDownloadError', {
       args: {
         error,

packages/driver/src/cypress/error_messages.ts

@@ -1354,6 +1354,12 @@ export default {
         docsUrl: 'https://on.cypress.io/prompt-download-error',
       }
     },
+    promptProxyError: {
+      message: stripIndent`\
+      \`cy.prompt\` requires an internet connection to work. To continue, you may need to configure Cypress with your proxy settings.
+      `,
+      docsUrl: 'https://on.cypress.io/proxy-configuration',
+    },
     promptTestingTypeError: stripIndent`\
       \`cy.prompt\` is currently only supported in end-to-end tests.
     `,

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

@@ -2,10 +2,12 @@ import { asyncRetry, linearDelay } from '../../../util/async_retry'
 import { isRetryableError } from '../../network/is_retryable_error'
 import fetch from 'cross-fetch'
 import os from 'os'
-import { agent } from '@packages/network'
+import { strictAgent } from '@packages/network'
 import { PUBLIC_KEY_VERSION } from '../../constants'
 import { createWriteStream } from 'fs'
 import { verifySignatureFromFile } from '../../encryption'
+import { HttpError } from '../../network/http_error'
+import { SystemError } from '../../network/system_error'
 
 const pkg = require('@packages/root')
 const _delay = linearDelay(500)
@@ -15,39 +17,56 @@ export const getCyPromptBundle = async ({ cyPromptUrl, projectId, bundlePath }:
   let responseManifestSignature: string | null = null
 
   await (asyncRetry(async () => {
-    const response = await fetch(cyPromptUrl, {
-      // @ts-expect-error - this is supported
-      agent,
-      method: 'GET',
-      headers: {
-        'x-route-version': '1',
-        'x-cypress-signature': PUBLIC_KEY_VERSION,
-        ...(projectId ? { 'x-cypress-project-slug': projectId } : {}),
-        'x-cypress-cy-prompt-mount-version': '1',
-        'x-os-name': os.platform(),
-        'x-cypress-version': pkg.version,
-      },
-      encrypt: 'signed',
-    })
-
-    if (!response.ok) {
-      throw new Error(`Failed to download cy-prompt bundle: ${response.statusText}`)
-    }
+    try {
+      const response = await fetch(cyPromptUrl, {
+        // @ts-expect-error - this is supported
+        agent: strictAgent,
+        method: 'GET',
+        headers: {
+          'x-route-version': '1',
+          'x-cypress-signature': PUBLIC_KEY_VERSION,
+          ...(projectId ? { 'x-cypress-project-slug': projectId } : {}),
+          'x-cypress-cy-prompt-mount-version': '1',
+          'x-os-name': os.platform(),
+          'x-cypress-version': pkg.version,
+        },
+        encrypt: 'signed',
+      })
+
+      if (!response.ok) {
+        const err = await HttpError.fromResponse(response)
+
+        throw err
+      }
 
-    responseSignature = response.headers.get('x-cypress-signature')
-    responseManifestSignature = response.headers.get('x-cypress-manifest-signature')
+      responseSignature = response.headers.get('x-cypress-signature')
+      responseManifestSignature = response.headers.get('x-cypress-manifest-signature')
 
-    await new Promise<void>((resolve, reject) => {
-      const writeStream = createWriteStream(bundlePath)
+      await new Promise<void>((resolve, reject) => {
+        const writeStream = createWriteStream(bundlePath)
 
-      writeStream.on('error', reject)
-      writeStream.on('finish', () => {
-        resolve()
+        writeStream.on('error', reject)
+        writeStream.on('finish', () => {
+          resolve()
+        })
+
+        // @ts-expect-error - this is supported
+        response.body?.pipe(writeStream)
       })
+    } catch (error) {
+      if (HttpError.isHttpError(error)) {
+        throw error
+      }
+
+      if (error.errno || error.code) {
+        const sysError = new SystemError(error, cyPromptUrl, error.code, error.errno)
 
-      // @ts-expect-error - this is supported
-      response.body?.pipe(writeStream)
-    })
+        sysError.stack = error.stack
+        throw sysError
+      }
+
+      throw error
+    }
   }, {
     maxAttempts: 3,
     retryDelay: _delay,

packages/server/lib/cloud/api/cy-prompt/post_cy_prompt_session.ts

@@ -1,8 +1,7 @@
 import { asyncRetry, linearDelay } from '../../../util/async_retry'
 import { isRetryableError } from '../../network/is_retryable_error'
-import fetch from 'cross-fetch'
 import os from 'os'
-import { agent } from '@packages/network'
+import { ParseKinds, postFetch } from '../../network/fetch'
 
 const pkg = require('@packages/root')
 const routes = require('../../routes') as typeof import('../../routes')
@@ -14,28 +13,16 @@ interface PostCyPromptSessionOptions {
 const _delay = linearDelay(500)
 
 export const postCyPromptSession = async ({ projectId }: PostCyPromptSessionOptions) => {
-  return await (asyncRetry(async () => {
-    const response = await fetch(routes.apiRoutes.cyPromptSession(), {
-      // @ts-expect-error - this is supported
-      agent,
-      method: 'POST',
+  return await (asyncRetry(() => {
+    return postFetch<{ cyPromptUrl: string }>(routes.apiRoutes.cyPromptSession(), {
+      parse: ParseKinds.JSON,
       headers: {
         'Content-Type': 'application/json',
         'x-os-name': os.platform(),
         'x-cypress-version': pkg.version,
       },
       body: JSON.stringify({ projectSlug: projectId, cyPromptMountVersion: 1 }),
     })
-
-    if (!response.ok) {
-      throw new Error(`Failed to create cy-prompt session: ${response.statusText}`)
-    }
-
-    const data = await response.json()
-
-    return {
-      cyPromptUrl: data.cyPromptUrl,
-    }
   }, {
     maxAttempts: 3,
     retryDelay: _delay,

packages/server/lib/cloud/api/cy-prompt/report_cy_prompt_error.ts

@@ -17,6 +17,8 @@ interface CyPromptError {
   name: string
   stack: string
   message: string
+  code?: string | number
+  errno?: string | number
   cyPromptMethod: string
   cyPromptMethodArgs?: string
 }
@@ -82,6 +84,8 @@ export function reportCyPromptError ({
         name: stripPath(errorObject.name ?? `Unknown name`),
         stack: stripPath(errorObject.stack ?? `Unknown stack`),
         message: stripPath(errorObject.message ?? `Unknown message`),
+        code: 'code' in errorObject ? errorObject.code as string : undefined,
+        errno: 'errno' in errorObject ? errorObject.errno as number : undefined,
         cyPromptMethod,
         cyPromptMethodArgs: cyPromptMethodArgsString ? stripPath(cyPromptMethodArgsString) : undefined,
       }],

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

@@ -37,7 +37,7 @@ import type { CreateInstanceRequestBody, CreateInstanceResponse } from './create
 
 import { transformError } from './axios_middleware/transform_error'
 import { DecryptionError } from './cloud_request_errors'
-import { isNonRetriableCertErrorCode } from '../network/nonretriable_cert_error_codes'
+import { isNonRetriableCertErrorCode } from '../network/non_retriable_cert_error_codes'
 
 const THIRTY_SECONDS = humanInterval('30 seconds')
 const SIXTY_SECONDS = humanInterval('60 seconds')

packages/server/lib/cloud/api/studio/post_studio_session.ts

@@ -13,7 +13,7 @@ interface PostStudioSessionOptions {
 const _delay = linearDelay(500)
 
 export const postStudioSession = async ({ projectId }: PostStudioSessionOptions) => {
-  return await (asyncRetry(async () => {
+  return await (asyncRetry(() => {
     return postFetch<{ studioUrl: string, protocolUrl: string }>(routes.apiRoutes.studioSession(), {
       parse: ParseKinds.JSON,
       headers: {

packages/server/lib/cloud/network/is_retryable_error.ts

@@ -1,7 +1,7 @@
 import { SystemError } from './system_error'
 import { HttpError } from './http_error'
 import Debug from 'debug'
-import { isNonRetriableCertErrorCode } from './nonretriable_cert_error_codes'
+import { isNonRetriableCertErrorCode } from './non_retriable_cert_error_codes'
 
 const debug = Debug('cypress-verbose:server:is-retryable-error')
 

packages/server/lib/cloud/network/non_retriable_cert_error_codes.ts

@@ -0,0 +1,16 @@
+export const NON_RETRIABLE_CERT_ERROR_CODES = Object.freeze({
+  // The leaf certificate signature can’t be verified
+  UNABLE_TO_VERIFY_LEAF_SIGNATURE: 'UNABLE_TO_VERIFY_LEAF_SIGNATURE',
+  // The certificate is a self-signed certificate and not in trusted root store
+  DEPTH_ZERO_SELF_SIGNED_CERT: 'DEPTH_ZERO_SELF_SIGNED_CERT',
+  // A self-signed certificate exists somewhere in the chain
+  SELF_SIGNED_CERT_IN_CHAIN: 'SELF_SIGNED_CERT_IN_CHAIN',
+  // The issuer certificate is not available locally
+  UNABLE_TO_GET_ISSUER_CERT_LOCALLY: 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY',
+})
+
+type NonRetriableCertErrorCode = typeof NON_RETRIABLE_CERT_ERROR_CODES[keyof typeof NON_RETRIABLE_CERT_ERROR_CODES]
+
+export const isNonRetriableCertErrorCode = (errorCode: string | number): errorCode is NonRetriableCertErrorCode => {
+  return Object.values(NON_RETRIABLE_CERT_ERROR_CODES).includes(errorCode as NonRetriableCertErrorCode)
+}