Merge pull request #58 from supabase/refactor/plugins

refactor: make JWT and PostgREST client plugins

Author: inian

package-lock.json

@@ -32,6 +32,7 @@
     "fastify": "^3.14.0",
     "fastify-cors": "^5.2.0",
     "fastify-multipart": "^4.0.1",
+    "fastify-plugin": "^3.0.0",
     "fastify-swagger": "^4.4.1",
     "fs-extra": "^8.1.0",
     "fs-xattr": "^0.3.1",

package.json

@@ -0,0 +1,14 @@
+import fastifyPlugin from 'fastify-plugin'
+
+declare module 'fastify' {
+  interface FastifyRequest {
+    jwt: string
+  }
+}
+
+export default fastifyPlugin(async (fastify) => {
+  fastify.decorateRequest('jwt', null)
+  fastify.addHook('preHandler', async (request) => {
+    request.jwt = (request.headers.authorization as string).substring('Bearer '.length)
+  })
+})

src/plugins/jwt.ts

@@ -0,0 +1,16 @@
+import { PostgrestClient } from '@supabase/postgrest-js'
+import fastifyPlugin from 'fastify-plugin'
+import { getPostgrestClient } from '../utils'
+
+declare module 'fastify' {
+  interface FastifyRequest {
+    postgrest: PostgrestClient
+  }
+}
+
+export default fastifyPlugin(async (fastify) => {
+  fastify.decorateRequest('postgrest', null)
+  fastify.addHook('preHandler', async (request) => {
+    request.postgrest = getPostgrestClient(request.jwt)
+  })
+})

src/plugins/postgrest.ts

@@ -1,7 +1,7 @@
 import { FastifyInstance } from 'fastify'
 import { FromSchema } from 'json-schema-to-ts'
 import { AuthenticatedRequest, Bucket } from '../../types/types'
-import { getOwner, getPostgrestClient, isValidKey, transformPostgrestError } from '../../utils'
+import { getOwner, isValidKey, transformPostgrestError } from '../../utils'
 import { createDefaultSchema, createResponse } from '../../utils/generic-routes'
 
 const createBucketBodySchema = {
@@ -39,12 +39,9 @@ export default async function routes(fastify: FastifyInstance) {
       schema,
     },
     async (request, response) => {
-      const authHeader = request.headers.authorization
-      const jwt = authHeader.substring('Bearer '.length)
-      const postgrest = getPostgrestClient(jwt)
       let owner
       try {
-        owner = await getOwner(jwt)
+        owner = await getOwner(request.jwt)
       } catch (err) {
         console.log(err)
         return response.status(400).send(createResponse(err.message, '400', err.message))
@@ -64,7 +61,7 @@ export default async function routes(fastify: FastifyInstance) {
           .send(createResponse('The key contains invalid characters', '400', 'Invalid key'))
       }
 
-      const { data: results, error, status } = await postgrest
+      const { data: results, error, status } = await request.postgrest
         .from<Bucket>('buckets')
         .insert(
           [

src/routes/bucket/createBucket.ts

@@ -38,17 +38,14 @@ export default async function routes(fastify: FastifyInstance) {
       schema,
     },
     async (request, response) => {
-      const authHeader = request.headers.authorization
-      const jwt = authHeader.substring('Bearer '.length)
       const { bucketId } = request.params
-      const userPostgrest = getPostgrestClient(jwt)
       const superUserPostgrest = getPostgrestClient(serviceKey)
 
       const {
         data: bucketResults,
         error: bucketError,
         status: bucketStatus,
-      } = await userPostgrest.from<Bucket>('buckets').select('id').eq('id', bucketId).single()
+      } = await request.postgrest.from<Bucket>('buckets').select('id').eq('id', bucketId).single()
 
       if (bucketError) {
         request.log.error({ error: bucketError }, 'error bucket')
@@ -84,7 +81,7 @@ export default async function routes(fastify: FastifyInstance) {
           )
       }
 
-      const { data: results, error, status } = await userPostgrest
+      const { data: results, error, status } = await request.postgrest
         .from<Bucket>('buckets')
         .delete()
         .eq('id', bucketId)

src/routes/bucket/deleteBucket.ts

@@ -1,7 +1,7 @@
 import { FastifyInstance } from 'fastify'
 import { FromSchema } from 'json-schema-to-ts'
 import { AuthenticatedRequest, Bucket, Obj } from '../../types/types'
-import { getPostgrestClient, transformPostgrestError } from '../../utils'
+import { transformPostgrestError } from '../../utils'
 import { getConfig } from '../../utils/config'
 import { createDefaultSchema, createResponse } from '../../utils/generic-routes'
 import { S3Backend } from '../../backend/s3'
@@ -47,12 +47,9 @@ export default async function routes(fastify: FastifyInstance) {
       schema,
     },
     async (request, response) => {
-      const authHeader = request.headers.authorization
-      const jwt = authHeader.substring('Bearer '.length)
       const { bucketId } = request.params
-      const postgrest = getPostgrestClient(jwt)
 
-      const bucketResponse = await postgrest
+      const bucketResponse = await request.postgrest
         .from<Bucket>('buckets')
         .select('name')
         .eq('id', bucketId)
@@ -67,7 +64,11 @@ export default async function routes(fastify: FastifyInstance) {
 
       let deleteError, deleteData, objectError, objects, objectStatus
       do {
-        ;({ data: objects, error: objectError, status: objectStatus } = await postgrest
+        ;({
+          data: objects,
+          error: objectError,
+          status: objectStatus,
+        } = await request.postgrest
           .from<Obj>('objects')
           .select('name, id')
           .eq('bucket_id', bucketId)
@@ -80,7 +81,7 @@ export default async function routes(fastify: FastifyInstance) {
         request.log.info({ results: objects }, 'results')
 
         if (objects && objects.length > 0) {
-          ;({ error: deleteError, data: deleteData } = await postgrest
+          ;({ error: deleteError, data: deleteData } = await request.postgrest
             .from<Obj>('objects')
             .delete()
             .in(

src/routes/bucket/emptyBucket.ts

@@ -1,7 +1,7 @@
 import { FastifyInstance } from 'fastify'
 import { bucketSchema } from '../../schemas/bucket'
 import { AuthenticatedRequest, Bucket } from '../../types/types'
-import { getPostgrestClient, transformPostgrestError } from '../../utils'
+import { transformPostgrestError } from '../../utils'
 import { createDefaultSchema } from '../../utils/generic-routes'
 
 const successResponseSchema = {
@@ -33,11 +33,7 @@ export default async function routes(fastify: FastifyInstance) {
     },
     async (request, response) => {
       // get list of all buckets
-      const authHeader = request.headers.authorization
-      const jwt = authHeader.substring('Bearer '.length)
-
-      const postgrest = getPostgrestClient(jwt)
-      const { data: results, error, status } = await postgrest
+      const { data: results, error, status } = await request.postgrest
         .from<Bucket>('buckets')
         .select('id, name, public, owner, created_at, updated_at')
 

src/routes/bucket/getAllBuckets.ts

@@ -2,7 +2,7 @@ import { FastifyInstance } from 'fastify'
 import { FromSchema } from 'json-schema-to-ts'
 import { bucketSchema } from '../../schemas/bucket'
 import { AuthenticatedRequest, Bucket } from '../../types/types'
-import { getPostgrestClient, transformPostgrestError } from '../../utils'
+import { transformPostgrestError } from '../../utils'
 import { createDefaultSchema } from '../../utils/generic-routes'
 
 const getBucketParamsSchema = {
@@ -32,11 +32,8 @@ export default async function routes(fastify: FastifyInstance) {
       schema,
     },
     async (request, response) => {
-      const authHeader = request.headers.authorization
-      const jwt = authHeader.substring('Bearer '.length)
       const { bucketId } = request.params
-      const postgrest = getPostgrestClient(jwt)
-      const { data: results, error, status } = await postgrest
+      const { data: results, error, status } = await request.postgrest
         .from<Bucket>('buckets')
         .select('id, name, owner, public, created_at, updated_at')
         .eq('id', bucketId)

src/routes/bucket/getBucket.ts

@@ -1,4 +1,6 @@
 import { FastifyInstance } from 'fastify'
+import jwt from '../../plugins/jwt'
+import postgrest from '../../plugins/postgrest'
 import createBucket from './createBucket'
 import deleteBucket from './deleteBucket'
 import emptyBucket from './emptyBucket'
@@ -8,6 +10,9 @@ import updateBucket from './updateBucket'
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export default async function routes(fastify: FastifyInstance) {
+  fastify.register(jwt)
+  fastify.register(postgrest)
+
   fastify.register(createBucket)
   fastify.register(deleteBucket)
   fastify.register(emptyBucket)