.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+    extends: '@vimeo/eslint-config-player/es6',
+    env: {
+        node: true,
+        es6: true,
+    },
+    settings: {
+        ecmascript: 6,
+        esnext: true,
+    },
+    parser: 'babel-eslint',
+    globals: {
+        console: false,
+    },
+    rules: {
+        'camelcase': 0,
+        'comma-dangle': [1, 'always-multiline'],
+        'max-nested-callbacks': ['error', 4],
+        'max-params': ['error', 7],
+        'complexity': ['error', 14],
+        'prefer-rest-params': 0,
+        'prefer-spread': 0,
+        'strict': 0,
+        'no-warning-comments': 0,
+    },
+};

.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: monthly

.github/scripts/decrypt_secret.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+# --batch to prevent interactive command --yes to assume "yes" for questions
+gpg --quiet --batch --yes --decrypt --passphrase="$KEYFILE_PASSPHRASE" \
+--output keyfile.json keyfile.json.gpg

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: Node.js CI
+on:
+  push:
+    branches: [ master ]
+  pull_request_target:
+    types: [ opened, synchronize, reopened ]
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+    paths:
+      - .github/workflows/ci.yml
+
+concurrency: ${{ github.workflow }}--${{ github.ref }}
+
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    strategy:
+      # We do not want to run CRUD tests in parallel
+      max-parallel: 1
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.pull_request.head.sha || github.sha }}
+    - name: Decrypt keyfile
+      run: ./.github/scripts/decrypt_secret.sh
+      env:
+        KEYFILE_PASSPHRASE: ${{secrets.KEYFILE_PASSPHRASE}}
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run lint
+    - run: npm run test
+      env:
+        AWS_BUCKET: ${{secrets.AWS_BUCKET}}
+        AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
+        AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
+        AWS_REGION: ${{secrets.AWS_REGION}}

.gitignore

@@ -1,3 +1,7 @@
+.idea
+
+.env
+
 # Logs
 logs
 *.log
@@ -29,13 +33,12 @@ node_modules
 
 # Example local FileStore
 example/files
-files/
+test/output
 
 #OSX
 .DS_Store
 
 *.sublime-workspace
 
-# Keyfile will be decrypted from keyfile.json.enc by travis
-# https://docs.travis-ci.com/user/encrypting-files/
+# Keyfile will be decrypted from keyfile.json.enc by GitHub Actions
 keyfile.json

README.md

@@ -1,8 +1,6 @@
 # tus-node-server
 [![npm version](https://badge.fury.io/js/tus-node-server.svg)](https://badge.fury.io/js/tus-node-server)
-[![Build Status](https://travis-ci.org/tus/tus-node-server.svg?branch=master)](https://travis-ci.org/tus/tus-node-server)
-[![Coverage Status](https://coveralls.io/repos/github/tus/tus-node-server/badge.svg?branch=master)](https://coveralls.io/github/tus/tus-node-server?branch=master)
-[![Dependency Status](https://david-dm.org/tus/tus-node-server.svg)](https://david-dm.org/tus/tus-node-server#info=dependencies)
+[![Build Status](https://github.com/tus/tus-node-server/actions/workflows/ci.yml/badge.svg)](https://github.com/tus/tus-node-server/actions/workflows/ci.yml)
 
 tus is a new open protocol for resumable uploads built on HTTP. This is the [tus protocol 1.0.0](http://tus.io/protocols/resumable-upload.html) node.js server implementation.
 
@@ -17,15 +15,14 @@ $ npm install tus-node-server
 - **Local File Storage**
     ```js
     server.datastore = new tus.FileStore({
-        path: '/files'
+        directory: './files'
     });
     ```
 
 - **Google Cloud Storage**
     ```js
 
     server.datastore = new tus.GCSDataStore({
-        path: '/files',
         projectId: 'project-id',
         keyFilename: 'path/to/your/keyfile.json',
         bucket: 'bucket-name',
@@ -36,13 +33,11 @@ $ npm install tus-node-server
     ```js
 
     server.datastore = new tus.S3Store({
-        path: '/files',
         bucket: 'bucket-name',
         accessKeyId: 'access-key-id',
         secretAccessKey: 'secret-access-key',
         region: 'eu-west-1',
         partSize: 8 * 1024 * 1024, // each uploaded part will have ~8MB,
-        tmpDirPrefix: 'tus-s3-store',
     });
     ```
 
@@ -58,10 +53,8 @@ $ docker run -p 1080:8080 -d bhstahl/tus-node-deploy
 ```js
 const tus = require('tus-node-server');
 
-const server = new tus.Server();
-server.datastore = new tus.FileStore({
-    path: '/files'
-});
+const server = new tus.Server({ path: '/files' });
+server.datastore = new tus.FileStore({ directory: './files' });
 
 const host = '127.0.0.1';
 const port = 1080;
@@ -74,11 +67,10 @@ server.listen({ host, port }, () => {
 
 ```js
 const tus = require('tus-node-server');
-const server = new tus.Server();
-server.datastore = new tus.FileStore({
-    path: '/files'
-});
+const server = new tus.Server({ path: '/files' });
+server.datastore = new tus.FileStore({ directory: './files' });
 
+const express = require('express');
 const app = express();
 const uploadApp = express();
 uploadApp.all('*', server.handle.bind(server));
@@ -96,15 +88,14 @@ const http = require('http');
 const url = require('url');
 const Koa = require('koa')
 const tus = require('tus-node-server');
-const tusServer = new tus.Server();
+
+const tusServer = new tus.Server({ path: '/files' });
+tusServer.datastore = new tus.FileStore({ directory: './files' });
 
 const app = new Koa();
 const appCallback = app.callback();
 const port = 1080;
 
-tusServer.datastore = new tus.FileStore({
-    path: '/files',
-});
 
 const server = http.createServer((req, res) => {
     const urlPath = url.parse(req.url).pathname;
@@ -120,16 +111,57 @@ const server = http.createServer((req, res) => {
 server.listen(port)
 ```
 
+#### Use tus-node-server with [Fastify](https://www.fastify.io)
+
+```js
+const tus = require('tus-node-server');
+const tusServer = new tus.Server({ path: '/files' });
+tusServer.datastore = new tus.FileStore({ directory: './files' });
+
+const fastify = require('fastify')({ logger: true });
+
+/**
+ * add new content-type to fastify forewards request
+ * without any parser to leave body untouched
+ * @see https://www.fastify.io/docs/latest/Reference/ContentTypeParser/
+ */
+fastify.addContentTypeParser(
+    'application/offset+octet-stream', async () => true
+);
+
+/**
+ * let tus handle preparation and filehandling requests
+ * fastify exposes raw nodejs http req/res via .raw property
+ * @see https://www.fastify.io/docs/latest/Reference/Request/
+ * @see https://www.fastify.io/docs/latest/Reference/Reply/#raw
+ */
+fastify.all('/files', (req, res) => {
+    tusServer.handle(req.raw, res.raw);
+});
+fastify.all('/files/*', (req, res) => {
+    tusServer.handle(req.raw, res.raw);
+});
+
+fastify.listen(3000, (err) => {
+    if (err) {
+        fastify.log.error(err);
+        process.exit(1);
+    }
+});
+```
+
 ## Features
 #### Events:
 
 Execute code when lifecycle events happen by adding event handlers to your server.
 
 ```js
-const Server = require('tus-node-server').Server;
+const tus = require('tus-node-server');
 const EVENTS = require('tus-node-server').EVENTS;
 
-const server = new Server();
+const server = new tus.Server({ path: '/files' });
+server.datastore = new tus.FileStore({ directory: './files' });
+
 server.on(EVENTS.EVENT_UPLOAD_COMPLETE, (event) => {
     console.log(`Upload complete for file ${event.file.id}`);
 });
@@ -170,27 +202,45 @@ server.on(EVENTS.EVENT_UPLOAD_COMPLETE, (event) => {
     }
     ```
 
+- `EVENT_FILE_DELETED`: Fired when a `DELETE` request finishes deleting the file
+
+    _Example payload:_
+    ```
+    {
+        file_id: '7b26bf4d22cf7198d3b3706bf0379794'
+
+    }
+    ```
+
 #### Custom `GET` handlers:
 Add custom `GET` handlers to suit your needs, similar to [Express routing](https://expressjs.com/en/guide/routing.html).
 ```js
-const server = new Server();
+const server = new tus.Server({ path: '/files' });
+server.datastore = new tus.FileStore({ directory: './files' });
+
 server.get('/uploads', (req, res) => {
     // Read from your DataStore
-    fs.readdir(server.datastore.path, (err, files) => {
+    fs.readdir(server.datastore.directory, (err, files) => {
         // Format the JSON response and send it
     }
 });
 ```
 
 #### Custom file names:
+
+The default naming of files is a random crypto hex string. When using your own `namingFunction`, make sure to create URL friendly names such as removing spaces.
 ```js
-const fileNameFromUrl = (req) => {
-    return req.url.replace(/\//g, '-');
+const crypto = require('crypto');
+
+// req is http.IncomingMessage
+const randomString = (req) => {
+    // same as the default implementation
+    return crypto.randomBytes(16).toString('hex');
 }
 
-server.datastore = new tus.FileStore({
+const server = new tus.Server({
     path: '/files',
-    namingFunction: fileNameFromUrl
+    namingFunction: randomString,
 });
 ```