Add onShouldRetry as option to @uppy/tus

e2e/clients/dashboard-tus/app.js

@@ -10,7 +10,7 @@ import '@uppy/dashboard/dist/style.css'
 const companionUrl = 'http://localhost:3020'
 const uppy = new Uppy()
   .use(Dashboard, { target: '#app', inline: true })
-  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files', retryStatusCodes: [429, 401] })
+  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files' })
   .use(Url, { target: Dashboard, companionUrl })
   .use(Unsplash, { target: Dashboard, companionUrl })
 

e2e/cypress/integration/dashboard-tus.spec.ts

@@ -16,6 +16,29 @@ describe('Dashboard with Tus', () => {
     cy.intercept('http://localhost:3020/search/unsplash/*').as('unsplash')
   })
 
+  it('should emit `error` and `upload-error` events on failed POST request', () => {
+    cy.get('@file-input').attachFile(['images/traffic.jpg'])
+
+    const error = cy.spy()
+    const uploadError = cy.spy()
+    cy.window().then(({ uppy }) => {
+      uppy.on('upload-error', uploadError)
+      uppy.on('error', error)
+    })
+
+    cy.get('.uppy-StatusBar-actionBtn--upload').click()
+
+    cy.intercept(
+      { method: 'POST', url: 'https://tusd.tusdemo.net/*', times: 1 },
+      { statusCode: 401, body: { code: 401, message: 'Expired JWT Token' } },
+    ).as('post')
+
+    cy.wait('@post').then(() =>  {
+      expect(error).to.be.called
+      expect(uploadError).to.be.called
+    })
+  })
+
   it('should upload cat image successfully', () => {
     cy.get('@file-input').attachFile('images/cat.jpg')
     cy.get('.uppy-StatusBar-actionBtn--upload').click()
@@ -25,7 +48,7 @@ describe('Dashboard with Tus', () => {
     cy.get('.uppy-StatusBar-statusPrimary').should('contain', 'Complete')
   })
 
-  it('should start exponential backoff on HTTP 429 from `retryStatusCodes`', () => {
+  it('should start exponential backoff when receiving HTTP 429', () => {
     cy.get('@file-input').attachFile(['images/baboon.png'])
     cy.get('.uppy-StatusBar-actionBtn--upload').click()
 
@@ -45,7 +68,7 @@ describe('Dashboard with Tus', () => {
 
   it('should upload remote image with URL plugin', () => {
     cy.get('[data-cy="Url"]').click()
-    cy.get('.uppy-Url-input').type('https://github.com/transloadit/uppy/raw/main/e2e/cypress/fixtures/images/cat.jpg')
+    cy.get('.uppy-Url-input').type('https://raw.githubusercontent.com/transloadit/uppy/main/e2e/cypress/fixtures/images/cat.jpg')
     cy.get('.uppy-Url-importButton').click()
     cy.get('.uppy-StatusBar-actionBtn--upload').click()
     cy.wait('@url')

packages/@uppy/tus/src/index.js

@@ -72,7 +72,6 @@ export default class Tus extends BasePlugin {
       useFastRemoteRetry: true,
       limit: 20,
       retryDelays: tusDefaultOptions.retryDelays,
-      retryStatusCodes: [429],
       withCredentials: false,
     }
 
@@ -278,10 +277,16 @@ export default class Tus extends BasePlugin {
         resolve(upload)
       }
 
-      uploadOptions.onShouldRetry = (err) => {
+      if (this.opts.onShouldRetry !== null) {
+        uploadOptions.onShouldRetry = (err) => opts.onShouldRetry(err, defaultOnShouldRetry)
+      } else {
+        uploadOptions.onShouldRetry = defaultOnShouldRetry
+      }
+
+      function defaultOnShouldRetry (err) {
         const status = err?.originalResponse?.getStatus()
 
-        if (this.opts.retryStatusCodes.includes(status)) {
+        if (status === 429) {
           // HTTP 429 Too Many Requests => to avoid the whole download to fail, pause all requests.
           if (!this.requests.isPaused) {
             const next = this.#retryDelayIterator?.next()

packages/@uppy/tus/types/index.d.ts

@@ -1,23 +1,26 @@
 import type { PluginOptions, BasePlugin } from '@uppy/core'
 import type { UploadOptions } from 'tus-js-client'
 
-  type TusUploadOptions = Pick<UploadOptions, Exclude<keyof UploadOptions,
-    | 'fingerprint'
-    | 'metadata'
-    | 'onProgress'
-    | 'onChunkComplete'
-    | 'onSuccess'
-    | 'onError'
-    | 'uploadUrl'
-    | 'uploadSize'
-  >>
+type TusUploadOptions = Pick<UploadOptions, Exclude<keyof UploadOptions,
+  | 'fingerprint'
+  | 'metadata'
+  | 'onProgress'
+  | 'onChunkComplete'
+  | 'onShouldRetry'
+  | 'onSuccess'
+  | 'onError'
+  | 'uploadUrl'
+  | 'uploadSize'
+>>
+
+type Next = (err: Error) => boolean
 
 export interface TusOptions extends PluginOptions, TusUploadOptions {
     metaFields?: string[] | null
     limit?: number
     useFastRemoteRetry?: boolean
     withCredentials?: boolean
-    retryStatusCodes: Array<number>
+    onShouldRetry: (err: Error, next: Next) => boolean
   }
 
 declare class Tus extends BasePlugin<TusOptions> {}

website/src/docs/tus.md

@@ -87,9 +87,29 @@ When uploading a chunk fails, automatically try again after the millisecond inte
 
 Set to `null` to disable automatic retries, and fail instantly if any chunk fails to upload.
 
-### `retryStatusCodes: [429]`
+### `onShouldRetry: (err, next) => next(err)`
 
-Tus can retry with [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) when receiving 429 (Too Many Requests), or other configured status codes. This can be useful to retry when you hit an API rate limit or when your authentication token is expired.
+When an upload fails `onShouldRetry` is called with the error and the default retry logic as the second argument. The default retry logic is an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) algorithm triggered on HTTP 429 (Too Many Requests) errors. Meaning if your server (or proxy) returns HTTP 429 because it’s being overloaded, @uppy/tus will find the ideal sweet spot to keep uploading without overloading.
+
+If you want to extend this functionality, for instance to retry on unauthorized requests (to retrieve a new authentication token):
+
+```js
+import Uppy from '@uppy/core'
+import Tus from '@uppy/tus'
+
+const uppy = new Uppy().use(Tus, { endpoint: '', onShouldRetry })
+
+async function onShouldRetry (err) {
+  if (err?.originalResponse?.getStatus() === 401) {
+    return true
+  }
+  return next(err)
+}
+```
+
+### `onBeforeRequest: (req) => void`
+
+See [`onBeforeRequest`](https://github.com/tus/tus-js-client/blob/master/docs/api.md#onbeforerequest) from `tus-js-client`.
 
 ### `metaFields: null`