refactor: begin to use axios for cloud api requests

packages/errors/src/errors.ts

@@ -155,25 +155,31 @@ export const AllCypressErrors = {
   CLOUD_CANCEL_SKIPPED_SPEC: () => {
     return errTemplate`${fmt.off(`\n  `)}This spec and its tests were skipped because the run has been canceled.`
   },
-  CLOUD_API_RESPONSE_FAILED_RETRYING: (arg1: {tries: number, delayMs: number, response: Error}) => {
+  CLOUD_API_RESPONSE_FAILED_RETRYING: (
+    arg1: {tries: number, delayMs: number, response: Error },
+  ) => {
     const time = pluralize('time', arg1.tries)
     const delay = humanTime.long(arg1.delayMs, false)
 
+    const message = arg1.response.name === 'AxiosError' ? arg1.response.message : `${arg1.response.name}: ${arg1.response.message}`
+
     return errTemplate`\
         We encountered an unexpected error communicating with our servers.
 
-        ${fmt.highlightSecondary(arg1.response)}
+        ${fmt.highlightSecondary(message)}
 
         We will retry ${fmt.off(arg1.tries)} more ${fmt.off(time)} in ${fmt.off(delay)}...
         `
     /* Because of fmt.listFlags() and fmt.listItems() */
     /* eslint-disable indent */
   },
   CLOUD_CANNOT_PROCEED_IN_PARALLEL: (arg1: {flags: any, response: Error}) => {
+    const message = arg1.response.name === 'AxiosError' ? arg1.response.message : `${arg1.response.name}: ${arg1.response.message}`
+
     return errTemplate`\
         We encountered an unexpected error communicating with our servers.
 
-        ${fmt.highlightSecondary(arg1.response)}
+        ${fmt.highlightSecondary(message)}
 
         Because you passed the ${fmt.flag(`--parallel`)} flag, this run cannot proceed since it requires a valid response from our servers.
 
@@ -183,10 +189,12 @@ export const AllCypressErrors = {
     })}`
   },
   CLOUD_CANNOT_PROCEED_IN_SERIAL: (arg1: {flags: any, response: Error}) => {
+    const message = arg1.response.name === 'AxiosError' ? arg1.response.message : `${arg1.response.name}: ${arg1.response.message}`
+
     return errTemplate`\
         We encountered an unexpected error communicating with our servers.
 
-        ${fmt.highlightSecondary(arg1.response)}
+        ${fmt.highlightSecondary(message)}
 
         Because you passed the ${fmt.flag(`--record`)} flag, this run cannot proceed since it requires a valid response from our servers.
 
@@ -196,10 +204,12 @@ export const AllCypressErrors = {
     })}`
   },
   CLOUD_UNKNOWN_INVALID_REQUEST: (arg1: {flags: any, response: Error}) => {
+    const message = arg1.response.name === 'AxiosError' ? arg1.response.message : `${arg1.response.name}: ${arg1.response.message}`
+
     return errTemplate`\
         We encountered an unexpected error communicating with our servers.
 
-        ${fmt.highlightSecondary(arg1.response)}
+        ${fmt.highlightSecondary(message)}
 
         There is likely something wrong with the request.
 

packages/network/lib/agent.ts

@@ -330,8 +330,14 @@ class HttpsAgent extends https.Agent {
     // (https://github.com/nodejs/node/blob/master/lib/_http_client.js#L164) since we are a combined agent
     // rather than an http or https agent. This will cause issues with fetch requests (@cypress/request already handles it:
     // https://github.com/cypress-io/request/blob/master/request.js#L301-L303)
-    if (!options.uri.port && options.uri.protocol === 'https:') {
-      options.uri.port = String(443)
+    // The combined agent adds this when it calls addRequest, but axios calls this
+    // directly.
+    if (!options?.uri?.port && options?.uri?.protocol === 'https:') {
+      options.uri = {
+        ...options.uri,
+        port: String(443),
+      }
+
       options.port = 443
     }
 
@@ -441,3 +447,7 @@ class HttpsAgent extends https.Agent {
 const agent = new CombinedAgent()
 
 export default agent
+
+export const httpsAgent = new HttpsAgent()
+
+export const httpAgent = new HttpAgent()

packages/server/lib/browsers/cdp-connection.ts

@@ -193,7 +193,7 @@ export class CDPConnection {
         return 100
       },
       shouldRetry (err) {
-        return !(err && CDPTerminatedError.isCDPTerminatedError(err))
+        return !(err && err instanceof Error && CDPTerminatedError.isCDPTerminatedError(err))
       },
     })()
 

packages/server/lib/cloud/api/axios_middleware/logging.ts

@@ -0,0 +1,26 @@
+import type { InternalAxiosRequestConfig, AxiosResponse, AxiosError, AxiosInstance } from 'axios'
+import Debug from 'debug'
+
+const debug = Debug('cypress:server:cloud:api')
+
+const logRequest = (req: InternalAxiosRequestConfig): InternalAxiosRequestConfig => {
+  debug(`${req.method} ${req.url}`)
+
+  return req
+}
+
+const logResponse = (res: AxiosResponse): AxiosResponse => {
+  debug(`${res.config.method} ${res.config.url} Success: %d %s -> \n  Response: %o`, res.status, res.statusText, res.data)
+
+  return res
+}
+
+const logResponseErr = (err: AxiosError): never => {
+  debug(`${err.config?.method} ${err.config?.url} Error: %s -> \n  Response: %o`, err.response?.statusText || err.code, err.response?.data)
+  throw err
+}
+
+export const installLogging = (axios: AxiosInstance) => {
+  axios.interceptors.request.use(logRequest)
+  axios.interceptors.response.use(logResponse, logResponseErr)
+}

packages/server/lib/cloud/api/axios_middleware/transform_error.ts

@@ -0,0 +1,28 @@
+import { isObject } from 'lodash'
+import axios, { AxiosError, AxiosInstance } from 'axios'
+
+declare module 'axios' {
+  export interface AxiosError {
+    isApiError?: boolean
+  }
+}
+
+export const transformError = (err: AxiosError | Error & { error?: any, statusCode: number, isApiError?: boolean }): never => {
+  const { data, status } = axios.isAxiosError(err) ?
+    { data: err.response?.data, status: err.status } :
+    { data: err.error, status: err.statusCode }
+
+  if (isObject(data)) {
+    const body = JSON.stringify(data, null, 2)
+
+    err.message = [status, body].join('\n\n')
+  }
+
+  err.isApiError = true
+
+  throw err
+}
+
+export const installErrorTransform = (axios: AxiosInstance) => {
+  axios.interceptors.response.use(undefined, transformError)
+}

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

@@ -0,0 +1,50 @@
+import os from 'os'
+
+import axios, { AxiosInstance } from 'axios'
+
+import pkg from '@packages/root'
+import { httpAgent, httpsAgent } from '@packages/network/lib/agent'
+
+import app_config from '../../../config/app.json'
+import { installErrorTransform } from './axios_middleware/transform_error'
+import { installLogging } from './axios_middleware/logging'
+
+// initialized with an export for testing purposes
+export const _create = (): AxiosInstance => {
+  const cfgKey = process.env.CYPRESS_CONFIG_ENV || process.env.CYPRESS_INTERNAL_ENV || 'development'
+
+  const instance = axios.create({
+    baseURL: app_config[cfgKey].api_url,
+    httpAgent,
+    httpsAgent,
+    headers: {
+      'x-os-name': os.platform(),
+      'x-cypress-version': pkg.version,
+      'User-Agent': `cypress/${pkg.version}`,
+    },
+  })
+
+  installLogging(instance)
+  installErrorTransform(instance)
+
+  return instance
+}
+
+export const CloudRequest = _create()
+
+export const isRetryableCloudError = (error: unknown) => {
+  // setting this env via mocha's beforeEach coerces this to a string, even if it's a boolean
+  const disabled = process.env.DISABLE_API_RETRIES && process.env.DISABLE_API_RETRIES !== 'false'
+
+  if (disabled) {
+    return false
+  }
+
+  const axiosErr = axios.isAxiosError(error) ? error : undefined
+
+  if (axiosErr && axiosErr.status) {
+    return [408, 429, 500, 502, 503, 504].includes(axiosErr.status)
+  }
+
+  return true
+}

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

@@ -0,0 +1,68 @@
+import { CloudRequest, isRetryableCloudError } from './cloud_request'
+import { asyncRetry, exponentialBackoff } from '../../util/async_retry'
+import * as errors from '../../errors'
+import { isAxiosError } from 'axios'
+
+const MAX_RETRIES = 3
+
+interface CreateInstanceResponse {
+  spec: string | null
+  instanceId: string | null
+  claimedInstances: number
+  estimatedWallClockDuration: number | null
+  totalInstances: number
+}
+
+interface CreateInstanceRequestBody {
+  spec: string | null
+  groupId: string
+  machineId: string
+  platform: {
+    browserName: string
+    browserVersion: string
+    osCpus: any[]
+    osMemory: Record<string, any> | null
+    osName: string
+    osVersion: string
+  }
+}
+
+export const createInstance = async (runId: string, instanceData: CreateInstanceRequestBody, timeout: number = 0): Promise<CreateInstanceResponse> => {
+  let attemptNumber = 0
+
+  return asyncRetry(async () => {
+    try {
+      const { data } = await CloudRequest.post<CreateInstanceResponse>(
+        `/runs/${runId}/instances`,
+        instanceData,
+        {
+          headers: {
+            'x-route-version': '5',
+            'x-cypress-run-id': runId,
+            'x-cypress-request-attempt': `${attemptNumber}`,
+          },
+          timeout,
+        },
+      )
+
+      return data
+    } catch (err: unknown) {
+      attemptNumber++
+
+      throw err
+    }
+  }, {
+    maxAttempts: MAX_RETRIES,
+    retryDelay: exponentialBackoff(),
+    shouldRetry: isRetryableCloudError,
+    onRetry: (delay, err) => {
+      errors.warning(
+        'CLOUD_API_RESPONSE_FAILED_RETRYING', {
+          delayMs: delay,
+          tries: MAX_RETRIES - attemptNumber,
+          response: isAxiosError(err) ? err : err instanceof Error ? err : new Error(String(err)),
+        },
+      )
+    },
+  })()
+}

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

@@ -25,6 +25,9 @@ import type { ProjectBase } from '../../project-base'
 import type { AfterSpecDurations } from '@packages/types'
 import { PUBLIC_KEY_VERSION } from '../constants'
 
+import { createInstance } from './create_instance'
+import { transformError } from './axios_middleware/transform_error'
+
 const THIRTY_SECONDS = humanInterval('30 seconds')
 const SIXTY_SECONDS = humanInterval('60 seconds')
 const TWO_MINUTES = humanInterval('2 minutes')
@@ -207,19 +210,6 @@ const retryWithBackoff = (fn) => {
   return attempt(0)
 }
 
-const formatResponseBody = function (err) {
-  // if the body is JSON object
-  if (_.isObject(err.error)) {
-    // transform the error message to include the
-    // stringified body (represented as the 'error' property)
-    const body = JSON.stringify(err.error, null, 2)
-
-    err.message = [err.statusCode, body].join('\n\n')
-  }
-
-  throw err
-}
-
 const tagError = function (err) {
   err.isApiError = true
   throw err
@@ -444,37 +434,11 @@ export default {
 
       return result
     })
-    .catch(RequestErrors.StatusCodeError, formatResponseBody)
+    .catch(RequestErrors.StatusCodeError, transformError)
     .catch(tagError)
   },
 
-  createInstance (options) {
-    const { runId, timeout } = options
-
-    const body = _.pick(options, [
-      'spec',
-      'groupId',
-      'machineId',
-      'platform',
-    ])
-
-    return retryWithBackoff((attemptIndex) => {
-      return rp.post({
-        body,
-        url: recordRoutes.instances(runId),
-        json: true,
-        encrypt: preflightResult.encrypt,
-        timeout: timeout ?? SIXTY_SECONDS,
-        headers: {
-          'x-route-version': '5',
-          'x-cypress-run-id': runId,
-          'x-cypress-request-attempt': attemptIndex,
-        },
-      })
-    })
-    .catch(RequestErrors.StatusCodeError, formatResponseBody)
-    .catch(tagError)
-  },
+  createInstance,
 
   postInstanceTests (options) {
     const { instanceId, runId, timeout, ...body } = options
@@ -492,7 +456,7 @@ export default {
         },
         body,
       })
-      .catch(RequestErrors.StatusCodeError, formatResponseBody)
+      .catch(RequestErrors.StatusCodeError, transformError)
       .catch(tagError)
     })
   },
@@ -512,7 +476,7 @@ export default {
 
         },
       })
-      .catch(RequestErrors.StatusCodeError, formatResponseBody)
+      .catch(RequestErrors.StatusCodeError, transformError)
       .catch(tagError)
     })
   },
@@ -532,7 +496,7 @@ export default {
           'x-cypress-request-attempt': attemptIndex,
         },
       })
-      .catch(RequestErrors.StatusCodeError, formatResponseBody)
+      .catch(RequestErrors.StatusCodeError, transformError)
       .catch(tagError)
     })
   },
@@ -559,7 +523,7 @@ export default {
           'metadata',
         ]),
       })
-      .catch(RequestErrors.StatusCodeError, formatResponseBody)
+      .catch(RequestErrors.StatusCodeError, transformError)
       .catch(tagError)
     })
   },