BREAKING CHANGE: use fetch (#322)

* feat: migrate

* BREAKING CHANGE: remove node-fetch in favour of fetch

package.json

@@ -14,7 +14,7 @@
     "directory": "./test/types"
   },
   "scripts": {
-    "test": "tap test/*.spec.js && tsd",
+    "test": "node --test test/*.spec.js && tsd",
     "lint": "eslint ."
   },
   "repository": {
@@ -33,22 +33,19 @@
   "homepage": "https://github.com/nearform/get-jwks#readme",
   "dependencies": {
     "jwk-to-pem": "^2.0.4",
-    "lru-cache": "^11.0.0",
-    "node-fetch": "^2.6.1"
+    "lru-cache": "^11.0.0"
   },
   "devDependencies": {
     "@fastify/jwt": "^8.0.0",
     "@types/node": "^22.0.0",
-    "@types/node-fetch": "^2.6.2",
     "eslint": "^8.6.0",
     "fast-jwt": "^4.0.0",
     "fastify": "^4.0.3",
     "jsonwebtoken": "^9.0.0",
-    "nock": "^13.0.7",
+    "nock": "^v14.0.0-beta.16",
     "prettier": "^3.0.0",
     "sinon": "^19.0.2",
-    "tap": "^16.0.0",
     "tsd": "^0.31.0",
     "typescript": "^5.0.2"
   }
-}
+}

src/error.d.ts

@@ -1,5 +1,3 @@
-import type { Response } from 'node-fetch'
-
 export enum errorCode {
   OPENID_CONFIGURATION_REQUEST_FAILED = 'OPENID_CONFIGURATION_REQUEST_FAILED',
   JWKS_REQUEST_FAILED = 'JWKS_REQUEST_FAILED',

src/get-jwks.d.ts

@@ -1,5 +1,4 @@
 import type { LRUCache } from 'lru-cache'
-import type { Agent } from 'https'
 
 type GetPublicKeyOptions = {
   domain?: string
@@ -24,8 +23,7 @@ type GetJwksOptions = {
   issuersWhitelist?: string[]
   providerDiscovery?: boolean
   jwksPath?: string
-  agent?: Agent
-  timeout?: number
+  fetchOptions?: RequestInit
 }
 
 declare namespace buildGetJwks {

src/get-jwks.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const fetch = require('node-fetch')
 const { LRUCache } = require('lru-cache')
 const jwkToPem = require('jwk-to-pem')
 
@@ -20,14 +19,13 @@ function ensureNoLeadingSlash(path) {
 function buildGetJwks(options = {}) {
   const max = options.max || 100
   const ttl = options.ttl || ONE_MINUTE
-  const timeout = options.timeout || FIVE_SECONDS
   const issuersWhitelist = (options.issuersWhitelist || []).map(ensureTrailingSlash)
   const checkIssuer = options.checkIssuer
   const providerDiscovery = options.providerDiscovery || false
   const jwksPath = options.jwksPath
     ? ensureNoLeadingSlash(options.jwksPath)
     : false
-  const agent = options.agent || null
+  const fetchOptions = { timeout: FIVE_SECONDS, ...options.fetchOptions }
   const staleCache = new LRUCache({ max: max * 2, ttl })
   const cache = new LRUCache({
     max,
@@ -38,10 +36,7 @@ function buildGetJwks(options = {}) {
   async function getJwksUri(normalizedDomain) {
     const response = await fetch(
       `${normalizedDomain}.well-known/openid-configuration`,
-      {
-        agent,
-        timeout,
-      }
+      fetchOptions,
     )
     const body = await response.json()
 
@@ -111,7 +106,7 @@ function buildGetJwks(options = {}) {
       ? await getJwksUri(normalizedDomain)
       : `${normalizedDomain}.well-known/jwks.json`
 
-    const response = await fetch(jwksUri, { agent, timeout })
+    const response = await fetch(jwksUri, fetchOptions)
     const body = await response.json()
 
     if (!response.ok) {

test/cache.spec.js

@@ -1,14 +1,14 @@
 'use strict'
 
-const t = require('tap')
+const {test} = require('node:test')
 const nock = require('nock')
 const jwkToPem = require('jwk-to-pem')
 
 const { jwks, domain } = require('./constants')
 
 const buildGetJwks = require('../src/get-jwks')
 
-t.test(
+test(
   'if there is already a key in cache, it should not make a http request',
   async t => {
     const getJwks = buildGetJwks()
@@ -20,14 +20,14 @@ t.test(
 
     const publicKey = await getJwks.getPublicKey({ domain, alg, kid })
     const jwk = await getJwks.getJwk({ domain, alg, kid })
-    t.ok(publicKey)
-    t.ok(jwk)
-    t.equal(publicKey, jwkToPem(jwk))
-    t.same(jwk, localKey)
+    t.assert.ok(publicKey)
+    t.assert.ok(jwk)
+    t.assert.equal(publicKey, jwkToPem(jwk))
+    t.assert.equal(jwk, localKey)
   }
 )
 
-t.test(
+test(
   'if initialized without any cache settings it should use default values',
   async t => {
     nock('https://localhost/').get('/.well-known/jwks.json').reply(200, jwks)
@@ -37,10 +37,10 @@ t.test(
     const publicKey = await getJwks.getPublicKey({ domain, alg, kid })
     const jwk = await getJwks.getJwk({ domain, alg, kid })
 
-    t.ok(publicKey)
-    t.ok(jwk)
-    t.ok(getJwks.cache)
-    t.equal(cache.max, 100)
-    t.equal(cache.ttl, 60000)
+    t.assert.ok(publicKey)
+    t.assert.ok(jwk)
+    t.assert.ok(getJwks.cache)
+    t.assert.equal(cache.max, 100)
+    t.assert.equal(cache.ttl, 60000)
   }
 )

test/fast-jwt-integration.spec.js

@@ -1,22 +1,22 @@
 'use strict'
 
-const t = require('tap')
+const {beforeEach, afterEach, test} = require('node:test')
 const nock = require('nock')
 const { createVerifier } = require('fast-jwt')
 
 const { jwks, token } = require('./constants')
 const buildGetJwks = require('../src/get-jwks')
 
-t.beforeEach(() => {
+beforeEach(() => {
   nock.disableNetConnect()
 })
 
-t.afterEach(() => {
+afterEach(() => {
   nock.cleanAll()
   nock.enableNetConnect()
 })
 
-t.test('fast-jwt integration tests', async t => {
+test('fast-jwt integration tests', async t => {
   const domain = 'https://localhost/'
   nock(domain).get('/.well-known/jwks.json').reply(200, jwks)
 
@@ -33,5 +33,5 @@ t.test('fast-jwt integration tests', async t => {
   })
   const payload = await verifyWithPromise(token)
 
-  t.equal(payload.name, 'Jane Doe')
+  t.assert.equal(payload.name, 'Jane Doe')
 })

test/fastify-jwt-integrations.spec.js

@@ -1,23 +1,23 @@
 'use strict'
 
-const t = require('tap')
+const { beforeEach, afterEach, test } = require('node:test')
 const nock = require('nock')
 const Fastify = require('fastify')
 const fjwt = require('@fastify/jwt')
 
 const { oidcConfig, jwks, token, domain } = require('./constants')
 const buildGetJwks = require('../src/get-jwks')
 
-t.beforeEach(() => {
+beforeEach(() => {
   nock.disableNetConnect()
 })
 
-t.afterEach(() => {
+afterEach(() => {
   nock.cleanAll()
   nock.enableNetConnect()
 })
 
-t.test('@fastify/jwt integration tests', async t => {
+test('@fastify/jwt integration tests', async t => {
   nock(domain).get('/.well-known/jwks.json').reply(200, jwks)
 
   const fastify = Fastify()
@@ -52,11 +52,11 @@ t.test('@fastify/jwt integration tests', async t => {
     },
   })
 
-  t.equal(response.statusCode, 200)
-  t.equal(response.body, 'Jane Doe')
+  t.assert.equal(response.statusCode, 200)
+  t.assert.equal(response.body, 'Jane Doe')
 })
 
-t.test('@fastify/jwt integration tests with providerDiscovery', async t => {
+test('@fastify/jwt integration tests with providerDiscovery', async t => {
   nock(domain)
     .get('/.well-known/openid-configuration')
     .once()
@@ -94,6 +94,6 @@ t.test('@fastify/jwt integration tests with providerDiscovery', async t => {
     },
   })
 
-  t.equal(response.statusCode, 200)
-  t.equal(response.body, 'Jane Doe')
+  t.assert.equal(response.statusCode, 200)
+  t.assert.equal(response.body, 'Jane Doe')
 })