How to implement TUS on AdonisJS

[Sukaato]

To begin with, you must choose a Key-Value Stores.

You can see which store you need here
For this cookbook, we will use @tus/file-store

Install

npm install @tus/server @tus/file-store

TUS server

Create a file to manage the TUS server

// tus-server.ts
import { FileStore } from '@tus/file-store';
import { Server } from '@tus/server';
import { tmpdir } from 'node:os';
import { join } from 'node:path';

export const DATA_STORE = new FileStore({
  directory: join(tmpdir(), 'upload'), // Where the files will be stored
  expirationPeriodInMilliseconds: 60 * 60 * 1000, // 60 minutes
});

export const TUS_UPLOAD_PATH = '/public/v1/upload';
export const TUS_UPLOAD_PATHS = [TUS_VOD_PATH, `${TUS_VOD_PATH}/:uploadId`];

export const TUS_UPLOAD_SERVER = new Server({
  path: TUS_VOD_PATH,
  allowedOrigins: ['*'], // Authorize everything, we'll let Adonis CORS do the work
  datastore: DATA_STORE,
  respectForwardedHeaders: true, // Only if you have a reverse proxy
  async onIncomingRequest() {
    await DATA_STORE.deleteExpired();
  },
  onUploadFinish: async (req, upload) => {
    // Do something here when the file download is complete.
  },
});

Controller

We can create our UploadController.

// controllers/upload_controller.ts

import type { HttpContext } from '@adonisjs/core/http';
import { TUS_UPLOAD_SERVER } from '#app/tus-server.js'

export default class UploadController {
  async handle({ request, response}: HttpContext) {
    // You can perform any bouncer checks here before submitting the request to TUS.

    return TUS_UPLOAD_SERVER.handle(request.request, response.response);
  }
}

Router

Define the upload routes

// start/routes.ts
const UploadController = () => import('#controllers/upload_controller.js')

router.group(() => {
  router.any('', [UploadController, 'handle']);
  router.any(':uploadId', [UploadController, 'handle']);
}).prefix('/publiv/v1/upload'); // ⚠️ Must be the same path defined in the TUS_UPLOAD_PATH constant.

Bodyparser

Adonis will try to read the body, and we don't want that, otherwise TUS won't be able to do its job.

// config/bodyparser.ts

import { TUS_UPLOAD_PATHS } from '#app/tus-server.js'

//... rest of the config
multipart: {
  autoProcess: true,
  convertEmptyStringsToNull: true,
  processManually: [
    // let @tus/server process the body
    ...TUS_UPLOAD_PATHS ,
  ],
  types: ['multipart/form-data'],
},

CORS

To enable resumable downloads, we need to update the CORS configuration and expose certain headers.

// config/cors.ts

const corsConfig = defineConfig({
  enabled: true,
  origin: origins,
  methods: ['GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE'],
  headers: true,
  exposeHeaders: ['Upload-Offset'],
  credentials: true,
  maxAge: 90,
});

🎉 Happy file uploading!