Detect Bun and worked runtimes in platform headers (#11)

Added detection for Bun and Cloudflare Workers (workerd) runtimes in platform header generation. Updated types and logic in detect-platform.ts, and added tests for new runtime detection.

Author: CHANDRAHARSHIT

src/internal/detect-platform.ts

@@ -13,30 +13,54 @@ export const isRunningInBrowser = () => {
   );
 };
 
-type DetectedPlatform = 'deno' | 'node' | 'edge' | 'unknown';
+type DetectedPlatform = 'deno' | 'bun' | 'workerd' | 'edge' | 'node' | 'unknown';
 
 /**
  * Note this does not detect 'browser'; for that, use getBrowserInfo().
  */
 function getDetectedPlatform(): DetectedPlatform {
+  // Deno
   if (typeof Deno !== 'undefined' && Deno.build != null) {
     return 'deno';
   }
+  // Bun (must be checked before Node since Bun provides a Node-compatible process)
+  if (typeof Bun !== 'undefined') {
+    return 'bun';
+  }
+  // Cloudflare Workers / workerd
+  // Heuristics: WebSocketPair global and/or navigator.userAgent === 'Cloudflare-Workers'
+  if (
+    typeof WebSocketPair !== 'undefined' ||
+    (typeof navigator !== 'undefined' && navigator && (navigator as any).userAgent === 'Cloudflare-Workers')
+  ) {
+    return 'workerd';
+  }
+  // Vercel Edge Runtime
   if (typeof EdgeRuntime !== 'undefined') {
     return 'edge';
   }
+  // Node.js
   if (
     Object.prototype.toString.call(
       typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0,
     ) === '[object process]'
   ) {
     return 'node';
   }
+  // Fallback Node.js heuristic for environments where toString check fails (e.g., some test runners)
+  if (typeof (globalThis as any).process !== 'undefined') {
+    const p = (globalThis as any).process;
+    if ((p?.versions && typeof p.versions.node === 'string') || p?.release?.name === 'node') {
+      return 'node';
+    }
+  }
   return 'unknown';
 }
 
 declare const Deno: any;
 declare const EdgeRuntime: any;
+declare const Bun: any;
+declare const WebSocketPair: any;
 type Arch = 'x32' | 'x64' | 'arm' | 'arm64' | `other:${string}` | 'unknown';
 type PlatformName =
   | 'MacOS'
@@ -54,7 +78,7 @@ type PlatformProperties = {
   'X-Stainless-Package-Version': string;
   'X-Stainless-OS': PlatformName;
   'X-Stainless-Arch': Arch;
-  'X-Stainless-Runtime': 'node' | 'deno' | 'edge' | `browser:${Browser}` | 'unknown';
+  'X-Stainless-Runtime': 'node' | 'deno' | 'bun' | 'workerd' | 'edge' | `browser:${Browser}` | 'unknown';
   'X-Stainless-Runtime-Version': string;
 };
 const getPlatformProperties = (): PlatformProperties => {
@@ -70,6 +94,28 @@ const getPlatformProperties = (): PlatformProperties => {
         typeof Deno.version === 'string' ? Deno.version : Deno.version?.deno ?? 'unknown',
     };
   }
+  if (detectedPlatform === 'bun') {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': normalizePlatform((globalThis as any).process?.platform ?? 'unknown'),
+      'X-Stainless-Arch': normalizeArch((globalThis as any).process?.arch ?? 'unknown'),
+      'X-Stainless-Runtime': 'bun',
+      'X-Stainless-Runtime-Version': (globalThis as any).Bun?.version ??
+        (globalThis as any).process?.versions?.bun ?? 'unknown',
+    };
+  }
+  if (detectedPlatform === 'workerd') {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': 'Unknown',
+      'X-Stainless-Arch': 'unknown',
+      'X-Stainless-Runtime': 'workerd',
+      'X-Stainless-Runtime-Version':
+        (typeof navigator !== 'undefined' && (navigator as any)?.userAgent) || 'unknown',
+    };
+  }
   if (typeof EdgeRuntime !== 'undefined') {
     return {
       'X-Stainless-Lang': 'js',

tests/internal/detect-platform.test.ts

@@ -0,0 +1,107 @@
+// @ts-nocheck
+/**
+ * Tests for runtime detection headers in src/internal/detect-platform.ts
+ */
+
+describe('getPlatformHeaders runtime detection', () => {
+  const g: any = globalThis as any;
+
+  const saveGlobals = () => ({
+    Deno: g.Deno,
+    Bun: g.Bun,
+    EdgeRuntime: g.EdgeRuntime,
+    WebSocketPair: g.WebSocketPair,
+    navigator: g.navigator,
+    process: g.process,
+  });
+
+  const restoreGlobals = (saved: any) => {
+    g.Deno = saved.Deno;
+    g.Bun = saved.Bun;
+    g.EdgeRuntime = saved.EdgeRuntime;
+    g.WebSocketPair = saved.WebSocketPair;
+    g.navigator = saved.navigator;
+    g.process = saved.process;
+  };
+
+  beforeEach(() => {
+    jest.resetModules();
+  });
+
+  test('detects Bun runtime', async () => {
+    const saved = saveGlobals();
+    try {
+      g.Bun = { version: '1.1.0' };
+      g.process = { platform: 'linux', arch: 'x64' };
+
+      jest.resetModules();
+      const mod = await import('../../src/internal/detect-platform');
+      const headers = (mod as any).getPlatformHeaders();
+      expect(headers['X-Stainless-Runtime']).toBe('bun');
+      expect(headers['X-Stainless-Runtime-Version']).toBe('1.1.0');
+      expect(headers['X-Stainless-OS']).toBe('Linux');
+      expect(headers['X-Stainless-Arch']).toBe('x64');
+    } finally {
+      restoreGlobals(saved);
+    }
+  });
+
+  test('detects Cloudflare Workers (workerd)', async () => {
+    const saved = saveGlobals();
+    try {
+      g.WebSocketPair = function () {};
+      g.navigator = { userAgent: 'Cloudflare-Workers' };
+
+      jest.resetModules();
+      const mod = await import('../../src/internal/detect-platform');
+      const headers = (mod as any).getPlatformHeaders();
+      expect(headers['X-Stainless-Runtime']).toBe('workerd');
+      expect(headers['X-Stainless-Runtime-Version']).toBe('Cloudflare-Workers');
+    } finally {
+      restoreGlobals(saved);
+    }
+  });
+
+  test('detects Edge runtime', async () => {
+    const saved = saveGlobals();
+    try {
+      g.EdgeRuntime = 'vercel-edge-1';
+      g.process = { version: 'v18.18.0' };
+
+      jest.resetModules();
+      const mod = await import('../../src/internal/detect-platform');
+      const headers = (mod as any).getPlatformHeaders();
+      expect(headers['X-Stainless-Runtime']).toBe('edge');
+      expect(headers['X-Stainless-Runtime-Version']).toBe('v18.18.0');
+    } finally {
+      restoreGlobals(saved);
+    }
+  });
+
+  test('falls back to Node when no special runtime', async () => {
+    const saved = saveGlobals();
+    try {
+      delete g.Deno;
+      delete g.Bun;
+      delete g.EdgeRuntime;
+      delete g.WebSocketPair;
+      delete g.navigator;
+      g.process = {
+        platform: 'win32',
+        arch: 'x64',
+        version: 'v18.18.0',
+        versions: { node: '18.18.0' },
+      };
+
+      jest.resetModules();
+      const mod = await import('../../src/internal/detect-platform');
+      const headers = (mod as any).getPlatformHeaders();
+      expect(headers['X-Stainless-Runtime']).toBe('node');
+      expect(headers['X-Stainless-OS']).toBe('Windows');
+      expect(headers['X-Stainless-Arch']).toBe('x64');
+      expect(headers['X-Stainless-Runtime-Version']).toBe('v18.18.0');
+    } finally {
+      restoreGlobals(saved);
+    }
+  });
+});