feat: remove __dirname, __filename [EXT-6803] (#779)

* fix: __dirname problems in some hosting envs [EXT-6803]

Author: BobHemphill76

package-lock.json

@@ -37,9 +37,9 @@
     "prepare": "husky install",
     "lint": "eslint --ext .ts ./src",
     "lint:fix": "npm run lint -- --fix",
-    "pretest": "echo ' 🔑 Creating valid keypair for testing' && sh test/make-private-keys.sh &> /dev/null",
-    "test:unit": "mocha -r dotenv/config -r ts-node/register ./src/**/*.spec.ts",
-    "test:integration": "mocha -r dotenv/config -r ts-node/register --timeout 10000 ./test/**/*.test.ts",
+    "pretest": "echo ' 🔑 Creating valid keypair for testing' && bash test/make-private-keys.sh",
+    "test:unit": "vitest run src",
+    "test:integration": "vitest run test",
     "test": "npm run test:unit && npm run test:integration",
     "build": "rm -rf lib && tsup",
     "postbuild": "cp ./lib/index.d.ts ./lib/index.d.cts",
@@ -69,7 +69,9 @@
     "@types/sinon": "17.0.3",
     "@typescript-eslint/eslint-plugin": "7.10.0",
     "@typescript-eslint/parser": "7.10.0",
+    "@vitest/coverage-v8": "^3.2.4",
     "base64url": "3.0.1",
+    "cross-env": "^7.0.3",
     "dotenv": "16.4.5",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
@@ -84,7 +86,8 @@
     "ts-node": "10.9.2",
     "tsup": "^8.3.5",
     "typedoc": "0.25.13",
-    "typescript": "5.4.5"
+    "typescript": "5.4.5",
+    "vitest": "^3.2.4"
   },
   "lint-staged": {
     "*.ts": [

package.json

@@ -1,4 +1,4 @@
-import * as assert from 'assert'
+import { describe, it, expect, beforeEach, afterEach } from 'vitest'
 import * as fs from 'fs'
 import * as path from 'path'
 
@@ -29,6 +29,16 @@ const noop = () => {}
 const defaultCache: LRUCache<string, string> = new LRUCache({ max: 10 })
 
 describe('getManagementToken', () => {
+  let fetchStub: sinon.SinonStub
+
+  beforeEach(() => {
+    fetchStub = sinon.stub(global, 'fetch')
+  })
+
+  afterEach(() => {
+    fetchStub.restore()
+  })
+
   it('fetches a token', async () => {
     const mockToken = 'token'
     const logger = noop as unknown as Logger
@@ -39,13 +49,13 @@ describe('getManagementToken', () => {
 
     const result = await getManagementToken(PRIVATE_KEY, DEFAULT_OPTIONS)
 
-    assert.deepStrictEqual(result, mockToken)
-    assert(
+    expect(result).toEqual(mockToken)
+    expect(
       post.calledWith(
         `spaces/${SPACE_ID}/environments/${ENVIRONMENT_ID}/app_installations/${APP_ID}/access_tokens`,
         sinon.match({ headers: { Authorization: sinon.match.string } }),
       ),
-    )
+    ).toBe(true)
   })
 
   it('caches token while valid', async () => {
@@ -61,11 +71,11 @@ describe('getManagementToken', () => {
 
     const optionsWithCaching = { ...DEFAULT_OPTIONS, reuseToken: true }
     const result = await getManagementToken(PRIVATE_KEY, optionsWithCaching)
-    assert.strictEqual(result, mockToken)
+    expect(result).toBe(mockToken)
     const secondResult = await getManagementToken(PRIVATE_KEY, optionsWithCaching)
-    assert.strictEqual(secondResult, mockToken)
+    expect(secondResult).toBe(mockToken)
 
-    assert(post.calledOnce)
+    expect(post.calledOnce).toBe(true)
   })
 
   it('does not cache expired token', async () => {
@@ -82,7 +92,7 @@ describe('getManagementToken', () => {
 
     const optionsWithCaching = { ...DEFAULT_OPTIONS, reuseToken: true }
     const result = await getManagementToken(PRIVATE_KEY, optionsWithCaching)
-    assert.strictEqual(result, mockToken)
+    expect(result).toBe(mockToken)
 
     // Overwrite TTL expiry to 5ms
     const cacheKey = APP_ID + SPACE_ID + ENVIRONMENT_ID + PRIVATE_KEY.slice(32, 132)
@@ -94,8 +104,8 @@ describe('getManagementToken', () => {
     })
 
     const secondResult = await getManagementToken(PRIVATE_KEY, optionsWithCaching)
-    assert.strictEqual(secondResult, mockToken)
-    assert(post.calledTwice)
+    expect(secondResult).toBe(mockToken)
+    expect(post.calledTwice).toBe(true)
   })
 
   describe('when using a keyId', () => {
@@ -109,27 +119,27 @@ describe('getManagementToken', () => {
 
       const result = await getManagementToken(PRIVATE_KEY, { ...DEFAULT_OPTIONS, keyId: 'keyId' })
 
-      assert.deepStrictEqual(result, mockToken)
-      assert(
+      expect(result).toEqual(mockToken)
+      expect(
         post.calledWith(
           `spaces/${SPACE_ID}/environments/${ENVIRONMENT_ID}/app_installations/${APP_ID}/access_tokens`,
           sinon.match({ headers: { Authorization: sinon.match.string } }),
         ),
-      )
+      ).toBe(true)
     })
   })
 
   describe('when private key is incorrect', () => {
     it('throws if missing', async () => {
-      await assert.rejects(async () => {
+      await expect(async () => {
         // @ts-ignore Testing javascript code
         await getManagementToken(undefined, DEFAULT_OPTIONS)
-      })
+      }).rejects.toThrow()
     })
     it('throws if generated with wrong algorithm', async () => {
-      await assert.rejects(async () => {
+      await expect(async () => {
         await getManagementToken('not_a_private_key', DEFAULT_OPTIONS)
-      })
+      }).rejects.toThrow()
     })
   })
 
@@ -140,9 +150,9 @@ describe('getManagementToken', () => {
       const httpClient = { post } as unknown as HttpClient
       const getManagementToken = createGetManagementToken(logger, httpClient, defaultCache)
 
-      await assert.rejects(async () => {
+      await expect(async () => {
         await getManagementToken(PRIVATE_KEY, DEFAULT_OPTIONS)
-      }, HttpError)
+      }).rejects.toThrow(HttpError)
     })
   })
 })

src/keys/get-management-token.spec.ts

@@ -154,7 +154,7 @@ export const getManagementToken = (privateKey: string, opts: GetManagementTokenO
   const httpClientOpts = typeof opts.host !== 'undefined' ? { prefixUrl: opts.host } : {}
 
   return createGetManagementToken(
-    createLogger({ filename: __filename }),
+    createLogger({ namespace: 'get-management-token.js' }),
     createHttpClient(httpClientOpts),
     defaultCache!,
   )(privateKey, opts)

src/keys/get-management-token.ts

@@ -1,4 +1,4 @@
-import * as assert from 'assert'
+import { describe, it, expect } from 'vitest'
 import { CanonicalRequest, Secret } from './typings'
 import { signRequest } from './sign-request'
 
@@ -11,7 +11,7 @@ const VALID_REQUEST: CanonicalRequest = {
 
 const assertThrowsForFieldInValues = (field: keyof CanonicalRequest, values: any[]) => {
   for (const value of values) {
-    assert.throws(() => {
+    expect(() => {
       signRequest(
         VALID_SECRET,
         {
@@ -21,7 +21,7 @@ const assertThrowsForFieldInValues = (field: keyof CanonicalRequest, values: any
         },
         VALID_TIMESTAMP,
       )
-    }, `Did not throw for ${field.toString()}:${value}`)
+    }).toThrow()
   }
 }
 
@@ -41,15 +41,15 @@ describe('create-signature', () => {
     })
     it('does not throw with empty bodies', () => {
       const { body, ...requestWithoutBody } = VALID_REQUEST
-      assert.doesNotThrow(() => {
+      expect(() => {
         signRequest(VALID_SECRET, requestWithoutBody, VALID_TIMESTAMP)
-      })
+      }).not.toThrow()
     })
     it('does not throw with empty headers', () => {
       const { headers, ...requestWithoutBody } = VALID_REQUEST
-      assert.doesNotThrow(() => {
+      expect(() => {
         signRequest(VALID_SECRET, requestWithoutBody, VALID_TIMESTAMP)
-      })
+      }).not.toThrow()
     })
   })
 
@@ -58,16 +58,16 @@ describe('create-signature', () => {
       const invalidSecrets = [undefined, false, 'too-short', 1103379941037 /* too old */]
 
       for (const secret of invalidSecrets) {
-        assert.throws(() => {
+        expect(() => {
           // @ts-ignore
           signRequest(secret, VALID_REQUEST, VALID_TIMESTAMP)
-        }, `Did not throw for ${secret}`)
+        }).toThrow()
       }
     })
     it('does not throw if valid', () => {
-      assert.doesNotThrow(() => {
+      expect(() => {
         signRequest(VALID_SECRET, VALID_REQUEST, VALID_TIMESTAMP)
-      })
+      }).not.toThrow()
     })
   })
 
@@ -76,16 +76,16 @@ describe('create-signature', () => {
       const invalidTimestamps = [1, false, 'string']
 
       for (const timestamp of invalidTimestamps) {
-        assert.throws(() => {
+        expect(() => {
           // @ts-ignore
           signRequest(VALID_SECRET, VALID_REQUEST, timestamp)
-        }, `Did not throw for ${timestamp}`)
+        }).toThrow()
       }
     })
     it('does not throw if missing', () => {
-      assert.doesNotThrow(() => {
+      expect(() => {
         signRequest(VALID_SECRET, VALID_REQUEST)
-      })
+      }).not.toThrow()
     })
   })
 
@@ -95,12 +95,13 @@ describe('create-signature', () => {
 
       const headers = { headerOne }
 
-      assert.notStrictEqual(
+      expect(
         signRequest(
           VALID_SECRET,
           { ...VALID_REQUEST, path: '/api/resources?q=1&w=2', headers },
           VALID_TIMESTAMP,
         ),
+      ).not.toBe(
         signRequest(
           VALID_SECRET,
           { ...VALID_REQUEST, path: '/api/resources?w=2&q=1', headers },
@@ -114,12 +115,13 @@ describe('create-signature', () => {
 
       const headers = { headerOne }
 
-      assert.notStrictEqual(
+      expect(
         signRequest(
           VALID_SECRET,
           { ...VALID_REQUEST, path: '/api/resources?q=1&w=2', headers },
           VALID_TIMESTAMP,
         ),
+      ).not.toBe(
         signRequest(
           VALID_SECRET,
           { ...VALID_REQUEST, path: '/api/resources?q=12', headers },
@@ -133,7 +135,7 @@ describe('create-signature', () => {
 
       const headers = { headerTwo }
 
-      assert.doesNotThrow(() =>
+      expect(() =>
         signRequest(
           VALID_SECRET,
           {
@@ -142,7 +144,7 @@ describe('create-signature', () => {
           },
           VALID_TIMESTAMP,
         ),
-      )
+      ).not.toThrow()
     })
 
     it('generates same signature if headers key are provided with different casing', () => {
@@ -152,8 +154,7 @@ describe('create-signature', () => {
       const headers = { headerOne, headerTwo }
       const headersCased = { headerone: headerOne, headerTWO: headerTwo }
 
-      assert.deepStrictEqual(
-        signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP),
+      expect(signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP)).toEqual(
         signRequest(VALID_SECRET, { ...VALID_REQUEST, headers: headersCased }, VALID_TIMESTAMP),
       )
     })
@@ -164,15 +165,13 @@ describe('create-signature', () => {
       const headers = { headerOne, headerTwo }
       const headersSpaced = { '      headerOne': headerOne, 'headerTwo        ': headerTwo }
 
-      assert.deepStrictEqual(
-        signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP),
+      expect(signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP)).toEqual(
         signRequest(VALID_SECRET, { ...VALID_REQUEST, headers: headersSpaced }, VALID_TIMESTAMP),
       )
     })
     it('generates different signatures with different secrets', () => {
       const newSecret = `q${VALID_SECRET.slice(1, VALID_SECRET.length)}`
-      assert.notStrictEqual(
-        signRequest(newSecret, VALID_REQUEST, VALID_TIMESTAMP),
+      expect(signRequest(newSecret, VALID_REQUEST, VALID_TIMESTAMP)).not.toBe(
         signRequest(VALID_SECRET, VALID_REQUEST, VALID_TIMESTAMP),
       )
     })
@@ -181,16 +180,15 @@ describe('create-signature', () => {
       const headers = { 'x-contentful-webhook-request-attempt': '1' }
       const retryHeaders = { 'x-contentful-webhook-request-attempt': '2' }
 
-      assert.notStrictEqual(
-        signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP),
+      expect(signRequest(VALID_SECRET, { ...VALID_REQUEST, headers }, VALID_TIMESTAMP)).not.toBe(
         signRequest(VALID_SECRET, { ...VALID_REQUEST, headers: retryHeaders }, VALID_TIMESTAMP),
       )
     })
 
     it('does not return undefined headers', () => {
       const result = signRequest(VALID_SECRET, VALID_REQUEST, undefined)
 
-      assert.ok(Object.values(result).every((h) => typeof h !== 'undefined'))
+      expect(Object.values(result).every((h) => typeof h !== 'undefined')).toBe(true)
     })
 
     it('CRN header is optional', () => {
@@ -200,8 +198,8 @@ describe('create-signature', () => {
         envId: 'envId',
       })
 
-      assert.ok(!result['x-contentful-signed-headers'].includes('x-contentful-crn'))
-      assert.equal(result['x-contentful-crn'], undefined)
+      expect(result['x-contentful-signed-headers'].includes('x-contentful-crn')).toBe(false)
+      expect(result['x-contentful-crn']).toBe(undefined)
     })
 
     it('includes CRN header', () => {
@@ -212,8 +210,8 @@ describe('create-signature', () => {
         envId: 'envId',
       })
 
-      assert.ok(result['x-contentful-signed-headers'].includes('x-contentful-crn'))
-      assert.equal(result['x-contentful-crn'], 'this-is-a-crn')
+      expect(result['x-contentful-signed-headers'].includes('x-contentful-crn')).toBe(true)
+      expect(result['x-contentful-crn']).toBe('this-is-a-crn')
     })
   })
 })