chore: send standard identity headers on cy-prompt/studio session requests (#34039)

The cy-prompt and studio session requests sent only Content-Type,
x-os-name, and x-cypress-version, so cloud-side telemetry on these
endpoints could not attribute traffic by machine (x-machine-id was
absent from the spans).

Add a shared getStandardHeaders() helper that returns the standard
cloud identity headers (x-os-name, x-cypress-version, x-machine-id)
and use it in both session helpers. Headers are resolved once before
the retry loop so the machine id is not re-read on each attempt.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: ryanthemanuel

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

@@ -1,9 +1,8 @@
 import { asyncRetry, linearDelay } from '../../../util/async_retry'
 import { isRetryableError } from '../../network/is_retryable_error'
-import os from 'os'
 import { ParseKinds, postFetch } from '../../network/fetch'
+import { getStandardHeaders } from '../get_standard_headers'
 
-const pkg = require('@packages/root')
 const routes = require('../../routes') as typeof import('../../routes')
 
 interface PostCyPromptSessionOptions {
@@ -13,14 +12,15 @@ interface PostCyPromptSessionOptions {
 const _delay = linearDelay(500)
 
 export const postCyPromptSession = async ({ projectId }: PostCyPromptSessionOptions) => {
+  const headers = {
+    'Content-Type': 'application/json',
+    ...(await getStandardHeaders()),
+  }
+
   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,
-      },
+      headers,
       body: JSON.stringify({ projectSlug: projectId, cyPromptMountVersion: 2 }),
     })
   }, {

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

@@ -0,0 +1,20 @@
+import os from 'os'
+import { machineId } from '../machine_id'
+
+const pkg = require('@packages/root')
+
+/**
+ * The standard identity headers sent on cloud requests so the backend can
+ * attribute traffic by Cypress version, OS, and machine. The recording-service
+ * records these on its Honeycomb request spans.
+ *
+ * `x-machine-id` resolves to an empty string when the machine id is
+ * unavailable, matching the behavior of other cloud requests.
+ */
+export const getStandardHeaders = async (): Promise<Record<string, string>> => {
+  return {
+    'x-os-name': os.platform(),
+    'x-cypress-version': pkg.version,
+    'x-machine-id': await machineId() ?? '',
+  }
+}

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

@@ -1,9 +1,8 @@
 import { asyncRetry, linearDelay } from '../../../util/async_retry'
 import { isRetryableError } from '../../network/is_retryable_error'
-import os from 'os'
 import { ParseKinds, postFetch } from '../../network/fetch'
+import { getStandardHeaders } from '../get_standard_headers'
 
-const pkg = require('@packages/root')
 const routes = require('../../routes') as typeof import('../../routes')
 
 interface PostStudioSessionOptions {
@@ -13,14 +12,15 @@ interface PostStudioSessionOptions {
 const _delay = linearDelay(500)
 
 export const postStudioSession = async ({ projectId }: PostStudioSessionOptions) => {
+  const headers = {
+    'Content-Type': 'application/json',
+    ...(await getStandardHeaders()),
+  }
+
   return await (asyncRetry(() => {
     return postFetch<{ studioUrl: string, protocolUrl: string }>(routes.apiRoutes.studioSession(), {
       parse: ParseKinds.JSON,
-      headers: {
-        'Content-Type': 'application/json',
-        'x-os-name': os.platform(),
-        'x-cypress-version': pkg.version,
-      },
+      headers,
       body: JSON.stringify({ projectSlug: projectId, studioMountVersion: 1, protocolMountVersion: 2 }),
     })
   }, {

packages/server/test/unit/cloud/api/cy-prompt/post_cy_prompt_session_spec.ts

@@ -1,10 +1,14 @@
 import { SystemError } from '../../../../../lib/cloud/network/system_error'
 import { proxyquire } from '../../../../spec_helper'
-import os from 'os'
-import pkg from '@packages/root'
 import { ParseKinds } from '../../../../../lib/cloud/network/fetch'
 import sinon from 'sinon'
 
+const standardHeaders = {
+  'x-os-name': 'test-os',
+  'x-cypress-version': 'test-version',
+  'x-machine-id': 'test-machine-id',
+}
+
 describe('postCyPromptSession', () => {
   let postCyPromptSession: typeof import('@packages/server/lib/cloud/api/cy-prompt/post_cy_prompt_session').postCyPromptSession
   let postFetchStub: sinon.SinonStub = sinon.stub()
@@ -15,6 +19,9 @@ describe('postCyPromptSession', () => {
       '../../network/fetch': {
         postFetch: postFetchStub,
       },
+      '../get_standard_headers': {
+        getStandardHeaders: sinon.stub().resolves(standardHeaders),
+      },
     }) as typeof import('@packages/server/lib/cloud/api/cy-prompt/post_cy_prompt_session')).postCyPromptSession
   })
 
@@ -38,8 +45,7 @@ describe('postCyPromptSession', () => {
         parse: ParseKinds.JSON,
         headers: {
           'Content-Type': 'application/json',
-          'x-os-name': os.platform(),
-          'x-cypress-version': pkg.version,
+          ...standardHeaders,
         },
         body: JSON.stringify({ projectSlug: '12345', cyPromptMountVersion: 2 }),
       },

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

@@ -0,0 +1,34 @@
+import { proxyquire } from '../../../spec_helper'
+import os from 'os'
+import pkg from '@packages/root'
+import sinon from 'sinon'
+
+describe('getStandardHeaders', () => {
+  const loadWithMachineId = (machineId: string | null) => {
+    return (proxyquire('@packages/server/lib/cloud/api/get_standard_headers', {
+      '../machine_id': {
+        machineId: sinon.stub().resolves(machineId),
+      },
+    }) as typeof import('@packages/server/lib/cloud/api/get_standard_headers')).getStandardHeaders
+  }
+
+  it('returns the standard identity headers', async () => {
+    const getStandardHeaders = loadWithMachineId('test-machine-id')
+
+    expect(await getStandardHeaders()).to.deep.equal({
+      'x-os-name': os.platform(),
+      'x-cypress-version': pkg.version,
+      'x-machine-id': 'test-machine-id',
+    })
+  })
+
+  it('falls back to an empty x-machine-id when the machine id is unavailable', async () => {
+    const getStandardHeaders = loadWithMachineId(null)
+
+    expect(await getStandardHeaders()).to.deep.equal({
+      'x-os-name': os.platform(),
+      'x-cypress-version': pkg.version,
+      'x-machine-id': '',
+    })
+  })
+})

packages/server/test/unit/cloud/api/studio/post_studio_session_spec.ts

@@ -1,10 +1,14 @@
 import { SystemError } from '../../../../../lib/cloud/network/system_error'
 import { proxyquire } from '../../../../spec_helper'
-import os from 'os'
-import pkg from '@packages/root'
 import { ParseKinds } from '../../../../../lib/cloud/network/fetch'
 import sinon from 'sinon'
 
+const standardHeaders = {
+  'x-os-name': 'test-os',
+  'x-cypress-version': 'test-version',
+  'x-machine-id': 'test-machine-id',
+}
+
 describe('postStudioSession', () => {
   let postStudioSession: typeof import('@packages/server/lib/cloud/api/studio/post_studio_session').postStudioSession
   let postFetchStub: sinon.SinonStub = sinon.stub()
@@ -15,6 +19,9 @@ describe('postStudioSession', () => {
       '../../network/fetch': {
         postFetch: postFetchStub,
       },
+      '../get_standard_headers': {
+        getStandardHeaders: sinon.stub().resolves(standardHeaders),
+      },
     }) as typeof import('@packages/server/lib/cloud/api/studio/post_studio_session')).postStudioSession
   })
 
@@ -40,8 +47,7 @@ describe('postStudioSession', () => {
         parse: ParseKinds.JSON,
         headers: {
           'Content-Type': 'application/json',
-          'x-os-name': os.platform(),
-          'x-cypress-version': pkg.version,
+          ...standardHeaders,
         },
         body: JSON.stringify({ projectSlug: '12345', studioMountVersion: 1, protocolMountVersion: 2 }),
       },