feature: formatUser option (#269)

* formatUser * working test for formatting user * fix nearform action * revert nearform github action * improve types for formatUser * revert describe.only * fix tests * fix merge * chore: lint --------- Co-authored-by: Rômulo Vitoi <[email protected]>
zenpaul · Mar 21, 2023 · 97cd5ab · 97cd5ab
1 parent 0e7f24a
commit 97cd5ab
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,5 +1,5 @@
 import { FastifyPluginCallback, FastifyReply, FastifyRequest } from 'fastify'
-import '@fastify/jwt'
+import { UserType, SignPayloadType } from '@fastify/jwt'
 
 import NodeCache from 'node-cache'
 
@@ -51,6 +51,10 @@ export interface FastifyAuth0VerifyOptions {
      */
     signed?: boolean
   }
+  /**
+   * You may customize the request.user object setting a custom sync function as parameter:
+   */
+  readonly formatUser?: (payload: SignPayloadType) => UserType
 }
 
 export interface Auth0Verify extends Pick<FastifyAuth0VerifyOptions, 'domain' | 'audience' | 'secret'> {

diff --git a/index.js b/index.js
@@ -178,7 +178,8 @@ function fastifyAuth0Verify(instance, options, done) {
       verify: auth0Options.verify,
       cookie: options.cookie,
       secret: getSecret,
-      jwtDecode: 'jwtDecode'
+      jwtDecode: 'jwtDecode',
+      formatUser: options.formatUser
     })
 
     // Setup our decorators

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -29,6 +29,12 @@ fastify.register(fastifyAuth0Verify, {
     signed: true
   }
 })
+fastify.register(fastifyAuth0Verify, {
+  domain: '<auth0 auth domain>',
+  issuer: '<auth0 issuer>',
+  audience: '<auth0 app audience>',
+  formatUser: () => ({ foo: 'bar' }),
+})
 
 fastify.register(function (instance, _options, done) {
   instance.get('/verify', {

diff --git a/test.js b/test.js
@@ -381,6 +381,38 @@ describe('JWT cookie token decoding', function () {
   })
 })
 
+describe('format decoded token', function () {
+  let server
+
+  beforeAll(async function () {
+    server = await buildServer({
+      secret: 'secret',
+      token: 'token',
+      cookie: { cookieName: 'token' },
+      formatUser: user => {
+        return {
+          sub: user.sub,
+          username: user.name,
+          admin: user.admin
+        }
+      }
+    })
+  })
+
+  afterAll(() => server.close())
+
+  it('should format verified user', async function () {
+    const response = await server.inject({
+      method: 'GET',
+      url: '/verify',
+      headers: { Authorization: `Bearer ${tokens.hs256Valid}` }
+    })
+
+    expect(response.statusCode).toEqual(200)
+    expect(response.json()).toEqual({ sub: '1234567890', username: 'John Doe', admin: true })
+  })
+})
+
 describe('HS256 JWT token validation', function () {
   let server