@tus/server: add lockDrainTimeout option (#603)

* @tus/server: add `lockDrainTimeout` option * Add changeset
tus · Apr 25, 2024 · 0449056 · 0449056
1 parent 7f0c368
commit 0449056
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/.changeset/serious-mangos-wait.md b/.changeset/serious-mangos-wait.md
@@ -0,0 +1,5 @@
+---
+'@tus/server': minor
+---
+
+Add `lockDrainTimeout` option
diff --git a/packages/server/src/server.ts b/packages/server/src/server.ts
@@ -92,6 +92,10 @@ export class Server extends EventEmitter {
       options.locker = new MemoryLocker()
     }
 
+    if (!options.lockDrainTimeout) {
+      options.lockDrainTimeout = 3000
+    }
+
     const {datastore, ...rest} = options
     this.options = rest as ServerOptions
     this.datastore = datastore
@@ -288,7 +292,7 @@ export class Server extends EventEmitter {
       abortWithDelayController.signal.removeEventListener('abort', onDelayedAbort)
       setTimeout(() => {
         requestAbortController.abort(err)
-      }, 3000)
+      }, this.options.lockDrainTimeout)
     }
     abortWithDelayController.signal.addEventListener('abort', onDelayedAbort)
 

diff --git a/packages/server/src/types.ts b/packages/server/src/types.ts
@@ -71,6 +71,11 @@ export type ServerOptions = {
     | Promise<Locker>
     | ((req: http.IncomingMessage) => Locker | Promise<Locker>)
 
+  /**
+   * This timeout controls how long the server will wait a cancelled lock to do its cleanup.
+   */
+  lockDrainTimeout?: number
+
   /**
    * Disallow termination for finished uploads.
    */