node: enhance detect runtime to include cf workers (#760)

Author: silesky

packages/node/src/__tests__/http-integration.test.ts

@@ -51,11 +51,11 @@ describe('Method Smoke Tests', () => {
       ajs.identify({ userId: 'my_user_id', traits: { foo: 'bar' } })
       await resolveCtx(ajs, 'identify')
       expect(calls[0].batch[0]._metadata).toMatchInlineSnapshot(
-        { nodeVersion: expect.any(String), runtime: 'node' },
+        { nodeVersion: expect.any(String), jsRuntime: 'node' },
         `
         Object {
+          "jsRuntime": "node",
           "nodeVersion": Any<String>,
-          "runtime": "node",
         }
       `
       )

packages/node/src/lib/__tests__/env.test.ts

@@ -31,4 +31,13 @@ describe(detectRuntime, () => {
     process = { env: {} }
     expect(detectRuntime()).toEqual<RuntimeEnv>('node')
   })
+
+  it('should return cloudflare worker if correct env', () => {
+    // @ts-ignore
+    // eslint-disable-next-line
+    delete process.env
+    // @ts-ignore
+    globalThis.WebSocketPair = {}
+    expect(detectRuntime()).toEqual<RuntimeEnv>('cloudflare-worker')
+  })
 })

packages/node/src/lib/env.ts

@@ -1,4 +1,9 @@
-export type RuntimeEnv = 'node' | 'browser' | 'web-worker' | 'unknown'
+export type RuntimeEnv =
+  | 'node'
+  | 'browser'
+  | 'web-worker'
+  | 'cloudflare-worker'
+  | 'unknown'
 
 export const detectRuntime = (): RuntimeEnv => {
   if (typeof process === 'object' && process && process.env) {
@@ -9,9 +14,14 @@ export const detectRuntime = (): RuntimeEnv => {
     return 'browser'
   }
 
+  // @ts-ignore
+  if (typeof WebSocketPair !== 'undefined') {
+    return 'cloudflare-worker'
+  }
+
   if (
     // @ts-ignore
-    typeof WorkerGlobalScope !== 'undefined' && // this may sometimes be available in a CF worker, so check for importScripts
+    typeof WorkerGlobalScope !== 'undefined' &&
     // @ts-ignore
     typeof importScripts === 'function'
   ) {

packages/node/src/plugins/segmentio/index.ts

@@ -12,7 +12,7 @@ function normalizeEvent(ctx: Context) {
   if (runtime === 'node') {
     ctx.updateEvent('_metadata.nodeVersion', process.versions.node)
   }
-  ctx.updateEvent('_metadata.runtime', runtime)
+  ctx.updateEvent('_metadata.jsRuntime', runtime)
 }
 
 type DefinedPluginFields =