properly normalize SDK and Node version numbers in tests

Author: nicknisi

src/common/utils/runtime-info.ts

@@ -2,7 +2,6 @@ import { detectRuntime } from './env';
 
 // Extend globalThis to include runtime-specific globals
 declare global {
-  // eslint-disable-next-line no-var
   var Deno:
     | {
         version: {
@@ -11,7 +10,6 @@ declare global {
       }
     | undefined;
 
-  // eslint-disable-next-line no-var
   var Bun:
     | {
         version: string;

src/sso/__snapshots__/sso.spec.ts.snap

@@ -19,15 +19,6 @@ exports[`SSO SSO getAuthorizationUrl with state generates an authorize url with
 exports[`SSO SSO getProfileAndToken with all information provided sends a request to the WorkOS api for a profile 1`] = `"client_id=proj_123&client_secret=sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU&grant_type=authorization_code&code=authorization_code"`;
 
 exports[`SSO SSO getProfileAndToken with all information provided sends a request to the WorkOS api for a profile 2`] = `
-{
-  "Accept": "application/json, text/plain, */*",
-  "Authorization": "Bearer sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU",
-  "Content-Type": "application/x-www-form-urlencoded;charset=utf-8",
-  "User-Agent": "workos-node/VERSION/fetch (node/v18.0.0)",
-}
-`;
-
-exports[`SSO SSO getProfileAndToken with all information provided sends a request to the WorkOS api for a profile 3`] = `
 {
   "connectionId": "conn_123",
   "connectionType": "OktaSAML",
@@ -63,15 +54,6 @@ exports[`SSO SSO getProfileAndToken with all information provided sends a reques
 exports[`SSO SSO getProfileAndToken without a groups attribute sends a request to the WorkOS api for a profile 1`] = `"client_id=proj_123&client_secret=sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU&grant_type=authorization_code&code=authorization_code"`;
 
 exports[`SSO SSO getProfileAndToken without a groups attribute sends a request to the WorkOS api for a profile 2`] = `
-{
-  "Accept": "application/json, text/plain, */*",
-  "Authorization": "Bearer sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU",
-  "Content-Type": "application/x-www-form-urlencoded;charset=utf-8",
-  "User-Agent": "workos-node/VERSION/fetch (node/v18.0.0)",
-}
-`;
-
-exports[`SSO SSO getProfileAndToken without a groups attribute sends a request to the WorkOS api for a profile 3`] = `
 {
   "connectionId": "conn_123",
   "connectionType": "OktaSAML",

src/sso/sso.spec.ts

@@ -302,14 +302,19 @@ describe('SSO', () => {
           expect(fetch.mock.calls.length).toEqual(1);
 
           expect(fetchBody()).toMatchSnapshot();
+
           const headers = fetchHeaders() as Record<string, string>;
-          const normalizedHeaders = {
-            ...headers,
-            'User-Agent': headers['User-Agent']
-              .replace(/workos-node\/[^\s/]+/, 'workos-node/VERSION')
-              .replace(/\(node\/v[\d.]+\)/, '(node/v18.0.0)'),
-          };
-          expect(normalizedHeaders).toMatchSnapshot();
+          expect(headers['Accept']).toBe('application/json, text/plain, */*');
+          expect(headers['Authorization']).toBe(
+            'Bearer sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+          );
+          expect(headers['Content-Type']).toBe(
+            'application/x-www-form-urlencoded;charset=utf-8',
+          );
+          expect(headers['User-Agent']).toMatch(
+            /^workos-node\/\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?\/fetch \(node\/v\d+\.\d+\.\d+\)$/,
+          );
+
           expect(accessToken).toBe('01DMEK0J53CVMC32CK5SE0KZ8Q');
           expect(profile).toMatchSnapshot();
         });
@@ -349,14 +354,19 @@ describe('SSO', () => {
           expect(fetch.mock.calls.length).toEqual(1);
 
           expect(fetchBody()).toMatchSnapshot();
+
           const headers = fetchHeaders() as Record<string, string>;
-          const normalizedHeaders = {
-            ...headers,
-            'User-Agent': headers['User-Agent']
-              .replace(/workos-node\/[^\s/]+/, 'workos-node/VERSION')
-              .replace(/\(node\/v[\d.]+\)/, '(node/v18.0.0)'),
-          };
-          expect(normalizedHeaders).toMatchSnapshot();
+          expect(headers['Accept']).toBe('application/json, text/plain, */*');
+          expect(headers['Authorization']).toBe(
+            'Bearer sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+          );
+          expect(headers['Content-Type']).toBe(
+            'application/x-www-form-urlencoded;charset=utf-8',
+          );
+          expect(headers['User-Agent']).toMatch(
+            /^workos-node\/\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?\/fetch \(node\/v\d+\.\d+\.\d+\)$/,
+          );
+
           expect(accessToken).toBe('01DMEK0J53CVMC32CK5SE0KZ8Q');
           expect(profile).toMatchSnapshot();
         });

src/workos.spec.ts

@@ -1,6 +1,5 @@
 import fetch from 'jest-fetch-mock';
 import { fetchOnce, fetchHeaders, fetchBody } from './common/utils/test-utils';
-import fs from 'fs/promises';
 import {
   GenericServerException,
   NoApiKeyProvidedException,
@@ -107,10 +106,6 @@ describe('WorkOS', () => {
       it('applies the configuration to the fetch client user-agent', async () => {
         fetchOnce('{}');
 
-        const packageJson = JSON.parse(
-          await fs.readFile('package.json', 'utf8'),
-        );
-
         const workos = new WorkOS('sk_test', {
           appInfo: {
             name: 'fooApp',
@@ -120,45 +115,25 @@ describe('WorkOS', () => {
 
         await workos.post('/somewhere', {});
 
-        expect(fetchHeaders()).toMatchObject({
-          'User-Agent': `workos-node/${packageJson.version}/fetch (node/v18.20.7) fooApp: 1.0.0`,
-        });
-      });
-    });
-
-    describe('when no `appInfo` option is provided', () => {
-      it('adds the HTTP client name to the user-agent', async () => {
-        fetchOnce('{}');
-
-        const packageJson = JSON.parse(
-          await fs.readFile('package.json', 'utf8'),
+        const headers = fetchHeaders() as Record<string, string>;
+        expect(headers['User-Agent']).toMatch(
+          /^workos-node\/\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?\/fetch \(node\/v\d+\.\d+\.\d+\) fooApp: 1\.0\.0$/,
         );
-
-        const workos = new WorkOS('sk_test');
-
-        await workos.post('/somewhere', {});
-
-        expect(fetchHeaders()).toMatchObject({
-          'User-Agent': `workos-node/${packageJson.version}/fetch (node/v18.20.7)`,
-        });
       });
     });
 
     describe('when no `appInfo` option is provided', () => {
       it('adds the HTTP client name to the user-agent', async () => {
         fetchOnce('{}');
 
-        const packageJson = JSON.parse(
-          await fs.readFile('package.json', 'utf8'),
-        );
-
         const workos = new WorkOS('sk_test');
 
         await workos.post('/somewhere', {});
 
-        expect(fetchHeaders()).toMatchObject({
-          'User-Agent': `workos-node/${packageJson.version}/fetch (node/v18.20.7)`,
-        });
+        const headers = fetchHeaders() as Record<string, string>;
+        expect(headers['User-Agent']).toMatch(
+          /^workos-node\/\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?\/fetch \(node\/v\d+\.\d+\.\d+\)$/,
+        );
       });
     });
 
@@ -174,14 +149,10 @@ describe('WorkOS', () => {
   });
 
   describe('version', () => {
-    it('matches the version in `package.json`', async () => {
+    it('is a valid semver string', async () => {
       const workos = new WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 
-      // Read `package.json` using file I/O instead of `require` so we don't run
-      // into issues with the `require` cache.
-      const packageJson = JSON.parse(await fs.readFile('package.json', 'utf8'));
-
-      expect(workos.version).toBe(packageJson.version);
+      expect(workos.version).toMatch(/^\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?$/);
     });
   });