Ignore SEAM_API_KEY when clientSessionToken is defined

Author: razor-x

src/lib/seam/connect/options.ts

@@ -44,7 +44,7 @@ export const isSeamHttpOptionsWithApiKey = (
 
   if ('clientSessionToken' in options && options.clientSessionToken != null) {
     throw new SeamHttpInvalidOptionsError(
-      'The clientSessionToken option cannot be used with the apiKey option.',
+      'The clientSessionToken option cannot be used with the apiKey option',
     )
   }
 
@@ -64,7 +64,7 @@ export const isSeamHttpOptionsWithClientSessionToken = (
 
   if ('apiKey' in options && options.apiKey != null) {
     throw new SeamHttpInvalidOptionsError(
-      'The clientSessionToken option cannot be used with the apiKey option.',
+      'The clientSessionToken option cannot be used with the apiKey option',
     )
   }
 

src/lib/seam/connect/parse-options.ts

@@ -1,5 +1,7 @@
 import { isSeamHttpOptionsWithClient, type SeamHttpOptions } from './options.js'
 
+const defaultEndpoint = 'https://connect.getseam.com'
+
 export const parseOptions = (
   apiKeyOrOptions: string | SeamHttpOptions,
 ): Required<SeamHttpOptions> => {
@@ -10,14 +12,10 @@ export const parseOptions = (
 
   if (isSeamHttpOptionsWithClient(options)) return options
 
-  const endpoint =
-    options.endpoint ??
-    globalThis.process?.env?.SEAM_ENDPOINT ??
-    globalThis.process?.env?.SEAM_API_URL ??
-    'https://connect.getseam.com'
+  const endpoint = options.endpoint ?? getEndpointFromEnv() ?? defaultEndpoint
 
   const apiKey =
-    'apiKey' in options ? options.apiKey : globalThis.process?.env?.SEAM_API_KEY
+    'apiKey' in options ? options.apiKey : getApiKeyFromEnv(options)
 
   return {
     ...options,
@@ -27,3 +25,19 @@ export const parseOptions = (
     axiosRetryOptions: options.axiosRetryOptions ?? {},
   }
 }
+
+const getApiKeyFromEnv = (
+  options: SeamHttpOptions,
+): string | null | undefined => {
+  if ('clientSessionToken' in options && options.clientSessionToken != null) {
+    return null
+  }
+  return globalThis.process?.env?.SEAM_API_KEY
+}
+
+const getEndpointFromEnv = (): string | null | undefined => {
+  return (
+    globalThis.process?.env?.SEAM_ENDPOINT ??
+    globalThis.process?.env?.SEAM_API_URL
+  )
+}

test/seam/connect/env.test.ts

@@ -8,11 +8,13 @@ import { SeamHttp, SeamHttpInvalidOptionsError } from '@seamapi/http/connect'
 /*
  * Tests in this file must run serially to ensure a clean environment for each test.
  */
-test.afterEach(() => {
+const cleanupEnv = (): void => {
   delete env.SEAM_API_KEY
   delete env.SEAM_ENDPOINT
   delete env.SEAM_API_URL
-})
+}
+test.afterEach(cleanupEnv)
+test.beforeEach(cleanupEnv)
 
 test.serial(
   'SeamHttp: constructor uses SEAM_API_KEY environment variable',
@@ -32,7 +34,7 @@ test.serial(
   'SeamHttp: apiKey option overrides environment variables',
   async (t) => {
     const { seed, endpoint } = await getTestServer(t)
-    env.SEAM_API_KEY = 'some-invalid-api-key'
+    env.SEAM_API_KEY = 'some-invalid-api-key-1'
     const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
     const device = await seam.devices.get({
       device_id: seed.august_device_1,
@@ -45,7 +47,7 @@ test.serial(
 test.serial(
   'SeamHttp: apiKey option as first argument overrides environment variables',
   (t) => {
-    env.SEAM_API_KEY = 'some-invalid-api-key'
+    env.SEAM_API_KEY = 'some-invalid-api-key-2'
     const seam = new SeamHttp('seam_apikey_token')
     t.truthy(seam)
   },
@@ -70,17 +72,6 @@ test.serial(
   },
 )
 
-test.serial(
-  'SeamHttp: constructor throws if SEAM_API_KEY environment variable is used with clientSessionToken',
-  (t) => {
-    env.SEAM_API_KEY = 'seam_apikey_token'
-    t.throws(() => new SeamHttp({ clientSessionToken: 'seam_cst1_token' }), {
-      instanceOf: SeamHttpInvalidOptionsError,
-      message: /apiKey/,
-    })
-  },
-)
-
 test.serial(
   'SeamHttp: SEAM_ENDPOINT environment variable is used first',
   async (t) => {
@@ -140,6 +131,39 @@ test.serial(
   },
 )
 
+test.serial(
+  'SeamHttp: constructor ignores SEAM_API_KEY environment variable if used with clientSessionToken',
+  async (t) => {
+    const { seed, endpoint } = await getTestServer(t)
+    env.SEAM_API_KEY = 'some-invalid-api-key-3'
+    const seam = new SeamHttp({
+      clientSessionToken: seed.seam_cst1_token,
+      endpoint,
+    })
+    const device = await seam.devices.get({
+      device_id: seed.august_device_1,
+    })
+    t.is(device.workspace_id, seed.seed_workspace_1)
+    t.is(device.device_id, seed.august_device_1)
+  },
+)
+
+test.serial(
+  'SeamHttp: SEAM_API_KEY environment variable is ignored with fromClientSessionToken',
+  async (t) => {
+    const { seed, endpoint } = await getTestServer(t)
+    env.SEAM_API_KEY = 'some-invalid-api-key-4'
+    const seam = SeamHttp.fromClientSessionToken(seed.seam_cst1_token, {
+      endpoint,
+    })
+    const device = await seam.devices.get({
+      device_id: seed.august_device_1,
+    })
+    t.is(device.workspace_id, seed.seed_workspace_1)
+    t.is(device.device_id, seed.august_device_1)
+  },
+)
+
 test.serial(
   'SeamHttp: SEAM_ENDPOINT environment variable is used with fromClientSessionToken',
   async (t) => {