fix: resolve the cloud env when the urql client is created (#34536)

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

Author: mschile

cli/CHANGELOG.md

@@ -3,6 +3,7 @@
 
 **Bugfixes:**
 
+- Fixed a regression in [15.20.0](#15-20-0) where the Cypress app sent all Cypress Cloud requests to `http://localhost:3000` instead of Cypress Cloud. Logging in could not complete, and the Runs and Debug pages reported no data. Addressed in [#34536](https://github.com/cypress-io/cypress/pull/34536).
 - Fixed a regression in [15.18.0](#15-18-0) where pinning a command in the Command Log could leave the AUT snapshot permanently blank, with the pin stuck on. Stopping a run in open mode also no longer clears the AUT. Addressed in [#34502](https://github.com/cypress-io/cypress/pull/34502).
 
 **Misc:**

packages/data-context/src/actions/EventCollectorActions.ts

@@ -24,16 +24,18 @@ type EventInputs = {
  * Defaults to staging when doing development. To override to production for development,
  * explicitly set process.env.CYPRESS_INTERNAL_ENV to 'production`
  */
-const cloudEnv = (process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV || 'production') as 'development' | 'staging' | 'production'
+function resolveEventCollectorEnv () {
+  return (process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV || 'production') as 'development' | 'staging' | 'production'
+}
 
 export class EventCollectorActions {
   constructor (private ctx: DataContext) {
-    debug('Using %s environment for Event Collection', cloudEnv)
+    debug('Using %s environment for Event Collection', resolveEventCollectorEnv())
   }
 
   async recordEvent (event: CollectibleEvent, includeMachineId: boolean): Promise<boolean> {
     try {
-      const cloudUrl = this.ctx.cloud.getCloudUrl(cloudEnv)
+      const cloudUrl = this.ctx.cloud.getCloudUrl(resolveEventCollectorEnv())
       const eventUrl = includeMachineId ? `${cloudUrl}/machine-collect` : `${cloudUrl}/anon-collect`
       const headers = {
         'Content-Type': 'application/json',

packages/data-context/src/sources/CloudDataSource.ts

@@ -31,7 +31,6 @@ import { pathToArray } from 'graphql/jsutils/Path'
 export type CloudDataResponse<T = any> = ExecutionResult<T> & Partial<OperationResult<T | null>> & { executing?: Promise<ExecutionResult<T> & Partial<OperationResult<T | null>>> }
 
 const debug = debugLib('cypress:data-context:sources:CloudDataSource')
-const cloudEnv = resolveCloudEnv()
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type StartsWith<T, Prefix extends string> = T extends `${Prefix}${infer _U}` ? T : never
@@ -117,7 +116,7 @@ export class CloudDataSource {
 
   reset () {
     return this.#cloudUrqlClient = createClient({
-      url: `${this.getCloudUrl(cloudEnv)}/test-runner-graphql`,
+      url: `${this.getCloudUrl(resolveCloudEnv())}/test-runner-graphql`,
       exchanges: [
         dedupExchange,
         cacheExchange({

packages/data-context/test/unit/actions/EventCollectorActions.spec.ts

@@ -65,5 +65,23 @@ describe('EventCollectorActions', () => {
 
       expect(result).toBe(false)
     })
+
+    it('resolves the environment when the event is recorded, not when the module loads', async () => {
+      const original = process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV
+
+      process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV = 'staging'
+
+      try {
+        await actions.recordEvent({ campaign: '', medium: '', messageId: '', cohort: '' }, false)
+      } finally {
+        if (original === undefined) {
+          delete process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV
+        } else {
+          process.env.CYPRESS_INTERNAL_EVENT_COLLECTOR_ENV = original
+        }
+      }
+
+      expect(ctx.util.fetch).toHaveBeenNthCalledWith(1, 'https://cloud-staging.cypress.io/anon-collect', expect.anything())
+    })
   })
 })

packages/data-context/test/unit/sources/CloudDataSource.spec.ts

@@ -348,4 +348,36 @@ describe('CloudDataSource', () => {
       expect(fetchStub).toHaveBeenCalledTimes(1)
     })
   })
+
+  describe('cloud url', () => {
+    const originalEnv = process.env.CYPRESS_INTERNAL_ENV
+
+    afterEach(() => {
+      if (originalEnv === undefined) {
+        delete process.env.CYPRESS_INTERNAL_ENV
+      } else {
+        process.env.CYPRESS_INTERNAL_ENV = originalEnv
+      }
+    })
+
+    it('does not freeze the environment at module load', async () => {
+      process.env.CYPRESS_INTERNAL_ENV = 'production'
+
+      const source = new CloudDataSource({
+        fetch: fetchStub,
+        getUser: getUserStub,
+        logout: logoutStub,
+        invalidateClientUrqlCache: invalidateCacheStub,
+      })
+
+      await source.executeRemoteGraphQL({
+        fieldName: 'cloudViewer',
+        operationDoc: FAKE_USER_QUERY,
+        operationVariables: {},
+        operationType: 'query',
+      })
+
+      expect(fetchStub).toHaveBeenCalledWith('https://cloud.cypress.io/test-runner-graphql', expect.anything())
+    })
+  })
 })

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

@@ -17,7 +17,7 @@ import type { AfterSpecDurations } from '@packages/types'
 import { agent } from '@packages/network'
 import type { CombinedAgent } from '@packages/network'
 
-import { apiUrl, apiRoutes, makeRoutes } from '../routes'
+import { getApiUrl, apiRoutes, makeRoutes } from '../routes'
 import { getText } from '../../util/status_code'
 import * as enc from '../encryption'
 import getEnvInformationForProjectRoot from '../environment'
@@ -465,7 +465,7 @@ export default {
           projectId: options.projectId,
           testingType: options.testingType,
           cloudApi: {
-            url: apiUrl,
+            url: getApiUrl(),
             retryWithBackoff: this.retryWithBackoff,
             requestPromise: this.rp,
           },
@@ -634,6 +634,7 @@ export default {
     return retryWithBackoff(async (attemptIndex) => {
       const { projectRoot, timeout, ...preflightRequestBody } = preflightInfo
 
+      const apiUrl = getApiUrl()
       const preflightBaseProxy = apiUrl.replace('api', 'api-proxy')
 
       const envInformation = await getEnvInformationForProjectRoot(projectRoot, process.pid.toString())

packages/server/lib/cloud/routes.ts

@@ -3,7 +3,9 @@ import UrlParse from 'url-parse'
 
 const app_config = require('../../config/app.json')
 
-export const apiUrl = app_config[process.env.CYPRESS_CONFIG_ENV || process.env.CYPRESS_INTERNAL_ENV || 'development'].api_url
+export const getApiUrl = (): string => {
+  return app_config[process.env.CYPRESS_CONFIG_ENV || process.env.CYPRESS_INTERNAL_ENV || 'development'].api_url
+}
 
 const CLOUD_ENDPOINTS = {
   api: '',
@@ -42,10 +44,10 @@ const parseArgs = function (url, args: any[] = []) {
   return url
 }
 
-const _makeRoutes = (baseUrl: string, routes: typeof CLOUD_ENDPOINTS) => {
+const _makeRoutes = (baseUrl: string | (() => string), routes: typeof CLOUD_ENDPOINTS) => {
   return _.reduce(routes, (memo, value, key) => {
     memo[key] = function (...args: any[]) {
-      let url = new UrlParse(baseUrl, true)
+      let url = new UrlParse(typeof baseUrl === 'function' ? baseUrl() : baseUrl, true)
 
       if (value) {
         url.set('pathname', value)
@@ -62,6 +64,6 @@ const _makeRoutes = (baseUrl: string, routes: typeof CLOUD_ENDPOINTS) => {
   }, {} as Record<keyof typeof CLOUD_ENDPOINTS, (...args: any[]) => string>)
 }
 
-export const apiRoutes = _makeRoutes(apiUrl, CLOUD_ENDPOINTS)
+export const apiRoutes = _makeRoutes(getApiUrl, CLOUD_ENDPOINTS)
 
 export const makeRoutes = (baseUrl) => _makeRoutes(baseUrl, CLOUD_ENDPOINTS)

packages/server/lib/cloud/studio/StudioLifecycleManager.ts

@@ -293,7 +293,7 @@ export class StudioLifecycleManager {
       projectId: currentProjectOptions.projectSlug,
       testingType: cfg.testingType,
       cloudApi: {
-        url: routes.apiUrl,
+        url: routes.getApiUrl(),
         retryWithBackoff: api.retryWithBackoff,
         requestPromise: api.rp,
       },

packages/server/test/unit/cloud/api/api_spec.ts

@@ -419,18 +419,25 @@ describe('lib/cloud/api', () => {
 
     describe('errors', () => {
       it('[F1] POST /preflight TimeoutError', () => {
-        preflightNock(API_BASEURL)
-        .times(2)
+        const scopeProxy = preflightNock(API_PROD_PROXY_BASEURL)
+        .delayConnection(5000)
+        .reply(200, {})
+
+        const scopeApi = preflightNock(API_PROD_BASEURL)
         .delayConnection(5000)
         .reply(200, {})
 
-        return api.sendPreflight({
+        return prodApi.sendPreflight({
+          projectId: 'abc123',
           timeout: 100,
         })
         .then(() => {
           throw new Error('should have thrown here')
         })
         .catch((err) => {
+          scopeProxy.done()
+          scopeApi.done()
+
           expect(err.message).to.eq('Error: ESOCKETTIMEDOUT')
         })
       })

packages/server/test/unit/cloud/routes_spec.ts

@@ -96,5 +96,18 @@ describe('lib/cloud/routes', () => {
 
       expect(routes().apiRoutes.api()).to.eq('https://api-staging.cypress.io/')
     })
+
+    it('resolves per call rather than when the module is evaluated', () => {
+      process.env.CYPRESS_INTERNAL_ENV = 'staging'
+
+      const loaded = routes()
+
+      expect(loaded.apiRoutes.api()).to.eq('https://api-staging.cypress.io/')
+
+      process.env.CYPRESS_INTERNAL_ENV = 'production'
+
+      expect(loaded.apiRoutes.api()).to.eq('https://api.cypress.io/')
+      expect(loaded.getApiUrl()).to.eq('https://api.cypress.io/')
+    })
   })
 })