merge: upstream/main

packages/server/README.md

@@ -110,6 +110,11 @@ This can be used to implement post-processing validation.
 This can be used for things like access control.
 You can `throw` an Object and the HTTP request will be aborted with the provided `body` and `status_code` (or their fallbacks).
 
+#### `options.onResponseError`
+
+`onResponseError` will be invoked when an error response is about to be sent by the server.
+you use this function to map custom errors to tus errors or for custom observability. (`(req, res, err) =>  Promise<{status_code: number; body: string} | void> | {status_code: number; body: string} | void`)
+
 #### `server.handle(req, res)`
 
 The main server request handler invoked on every request.
@@ -203,6 +208,7 @@ const port = 1080
 const app = express()
 const uploadApp = express()
 const server = new Server({
+  path: '/uploads',
   datastore: new FileStore({directory: '/files'}),
 })
 

packages/server/src/server.ts

@@ -156,14 +156,21 @@ export class Server<
       req.method = (req.headers['x-http-method-override'] as string).toUpperCase()
     }
 
-    const onError = (error: {
+    const onError = async (error: {
       status_code?: number
       body?: string
       message: string
-      name?: string
     }) => {
-      const status_code = error.status_code || ERRORS.UNKNOWN_ERROR.status_code
-      const body = error.body || `${ERRORS.UNKNOWN_ERROR.body}${error.message || ''}\n`
+      let status_code = error.status_code || ERRORS.UNKNOWN_ERROR.status_code
+      let body = error.body || `${ERRORS.UNKNOWN_ERROR.body}${error.message || ''}\n`
+
+      if (this.options.onResponseError) {
+        const errorMapping = await this.options.onResponseError(req, res, error as Error)
+        if (errorMapping) {
+          status_code = errorMapping.status_code
+          body = errorMapping.body
+        }
+      }
 
       return this.write(context, req, res, status_code, body)
     }

packages/server/src/types.ts

@@ -58,6 +58,16 @@ export type ServerOptions<
     uploadId: string,
     context: Context
   ) => Promise<void>
+  // `onResponseError` will be invoked when an error response is about to be sent by the server.
+  // you use this function to map custom errors to tus errors or for custom observability.
+  onResponseError?: (
+    req: http.IncomingMessage,
+    res: http.ServerResponse,
+    err: Error | {status_code: number; body: string}
+  ) =>
+    | Promise<{status_code: number; body: string} | void>
+    | {status_code: number; body: string}
+    | void
 }
 
 export type RouteHandler = (req: http.IncomingMessage, res: http.ServerResponse) => void

packages/server/test/Server.test.ts

@@ -172,14 +172,12 @@ describe('Server', () => {
   })
 
   describe('handle', () => {
-    let server: InstanceType<typeof Server<{id: string}>>
+    let server: InstanceType<typeof Server>
     let listener: http.Server
 
     before(() => {
       server = new Server({
         path: '/test/output',
-        createContext: () => ({id: '1234'}),
-        namingFunction: (_, context) => context.id,
         datastore: new FileStore({directory: './test/output'}),
       })
       listener = server.listen()
@@ -551,5 +549,31 @@ describe('Server', () => {
             })
         })
     })
+
+    it('should fire onResponseError hook when an error is thrown', async () => {
+      const spy = sinon.spy()
+      const server = new Server({
+        path: '/test/output',
+        datastore: new FileStore({directory: './test/output'}),
+        onResponseError: () => {
+          spy()
+          return {status_code: 404, body: 'custom-error'}
+        },
+        onUploadFinish() {
+          throw {body: 'no', status_code: 500}
+        },
+      })
+
+      await request(server.listen())
+        .post(server.options.path)
+        .set('Tus-Resumable', TUS_RESUMABLE)
+        .set('Upload-Length', '4')
+        .set('Upload-Offset', '0')
+        .set('Content-Type', 'application/offset+octet-stream')
+        .send('test')
+        .expect(404, 'custom-error')
+
+      assert.equal(spy.calledOnce, true)
+    })
   })
 })