Add support for termination in FileStore (#200)

Co-authored-by: Jack Langston <[email protected]>

Author: Murderlon

.gitignore

@@ -1,3 +1,5 @@
+.idea
+
 # Logs
 logs
 *.log

README.md

@@ -173,6 +173,16 @@ 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).

lib/Server.js

@@ -15,6 +15,7 @@ const HeadHandler = require('./handlers/HeadHandler');
 const OptionsHandler = require('./handlers/OptionsHandler');
 const PatchHandler = require('./handlers/PatchHandler');
 const PostHandler = require('./handlers/PostHandler');
+const DeleteHandler = require('./handlers/DeleteHandler');
 const RequestValidator = require('./validators/RequestValidator');
 const EXPOSED_HEADERS = require('./constants').EXPOSED_HEADERS;
 const REQUEST_METHODS = require('./constants').REQUEST_METHODS;
@@ -84,6 +85,7 @@ class TusServer extends EventEmitter {
             OPTIONS: new OptionsHandler(store),
             PATCH: new PatchHandler(store),
             POST: new PostHandler(store),
+            DELETE: new DeleteHandler(store),
         };
     }
 

lib/constants.js

@@ -63,11 +63,13 @@ const ERRORS = {
 const EVENT_ENDPOINT_CREATED = 'EVENT_ENDPOINT_CREATED';
 const EVENT_FILE_CREATED = 'EVENT_FILE_CREATED';
 const EVENT_UPLOAD_COMPLETE = 'EVENT_UPLOAD_COMPLETE';
+const EVENT_FILE_DELETED = 'EVENT_FILE_DELETED';
 
 const EVENTS = {
     EVENT_ENDPOINT_CREATED,
     EVENT_FILE_CREATED,
     EVENT_UPLOAD_COMPLETE,
+    EVENT_FILE_DELETED,
 };
 
 module.exports = {

lib/handlers/DeleteHandler.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const BaseHandler = require('./BaseHandler');
+const ERRORS = require('../constants').ERRORS;
+
+class DeleteHandler extends BaseHandler {
+    /**
+     * Removes a file in the DataStore.
+     *
+     * @param  {object} req http.incomingMessage
+     * @param  {object} res http.ServerResponse
+     * @return {function}
+     */
+    send(req, res) {
+        const file_id = this.getFileIdFromRequest(req);
+        if (!file_id) {
+            console.warn('[DeleteHandler]: not a valid path');
+            return Promise.resolve(super.send(res, 404, {}, 'Invalid path name\n'));
+        }
+        req.file_id = file_id;
+        return this.store.remove(req)
+            .then(() => {
+                return super.send(res, 204, {});
+            })
+            .catch((error) => {
+                const status_code = error.status_code || ERRORS.UNKNOWN_ERROR.status_code;
+                const body = error.body || `${ERRORS.UNKNOWN_ERROR.body}${error.message || ''}\n`;
+                return super.send(res, status_code, {}, body);
+            });
+    }
+}
+
+module.exports = DeleteHandler;

lib/stores/DataStore.js

@@ -69,6 +69,22 @@ class DataStore extends EventEmitter {
         });
     }
 
+    /**
+     * Called in DELETE requests. This method just deletes the file from the store.
+     * http://tus.io/protocols/resumable-upload.html#termination
+     *
+     * @param  {object} req http.incomingMessage
+     * @return {Promise}
+     */
+    remove(req) {
+        return new Promise((resolve, reject) => {
+            const file_id = req.file_id;
+            this.emit(EVENTS.EVENT_FILE_DELETED, { file_id });
+            return resolve();
+        });
+    }
+
+
     /**
      * Called in PATCH requests. This method should write data
      * to the DataStore file, and possibly implement the

lib/stores/FileStore.js

@@ -23,7 +23,6 @@ const log = debug('tus-node-server:stores:filestore');
 class FileStore extends DataStore {
     constructor(options) {
         super(options);
-
         this.directory = options.directory || options.path.replace(/^\//, '');
 
         this.extensions = ['creation', 'creation-with-upload', 'creation-defer-length'];
@@ -69,7 +68,6 @@ class FileStore extends DataStore {
             }
 
             const file = new File(file_id, upload_length, upload_defer_length, upload_metadata);
-
             return fs.open(`${this.directory}/${file.id}`, 'w', (err, fd) => {
                 if (err) {
                     log('[FileStore] create: Error', err);
@@ -102,6 +100,27 @@ class FileStore extends DataStore {
         return fs.createReadStream(path);
     }
 
+    /**
+     * Deletes a file.
+     *
+     * @param  {object} req http.incomingMessage
+     * @return {Promise}
+     */
+    remove(req) {
+        return new Promise((resolve, reject) => {
+            const file_id = req.file_id;
+            return fs.unlink(`${this.directory}/${file_id}`, (err, fd) => {
+                if (err) {
+                    console.warn('[FileStore] delete: Error', err);
+                    return reject(ERRORS.FILE_NOT_FOUND);
+                }
+                this.emit(EVENTS.EVENT_FILE_DELETED, { file_id });
+                this.configstore.delete(file_id);
+                return resolve();
+            });
+        });
+    }
+
     /**
      * Write to the file, starting at the provided offset
      *

package.json

@@ -33,7 +33,7 @@
   ],
   "main": "index.js",
   "scripts": {
-    "test": "cross-env NODE_ENV=test mocha --timeout 5000",
+    "test": "cross-env NODE_ENV=test mocha --exit",
     "coverage": "nyc npm test",
     "demo": "node demo/server.js",
     "gcs_demo": "cross-env DATA_STORE=GCSDataStore node demo/server.js",

test/Test-DataStore.js

@@ -47,6 +47,12 @@ describe('DataStore', () => {
         done();
     });
 
+    it('must have a remove method', (done) => {
+        datastore.should.have.property('remove');
+        datastore.remove();
+        done();
+    });
+
     it('must have a write method', (done) => {
         datastore.should.have.property('write');
         datastore.write.should.be.type('function');

test/Test-DeleteHandler.js

@@ -0,0 +1,56 @@
+/* eslint-env node, mocha */
+'use strict';
+
+const assert = require('assert');
+const http = require('http');
+const fs = require('fs');
+const FileStore = require('../lib/stores/FileStore');
+const DeleteHandler = require('../lib/handlers/DeleteHandler');
+
+describe('DeleteHandler', () => {
+    let res = null;
+    const path = '/files';
+    const pathClean = path.replace(/^\//, '');
+    const namingFunction = (req) => req.url.replace(/\//g, '-');
+    const store = new FileStore({ path, namingFunction});
+    const handler = new DeleteHandler(store);
+    const filePath = "/1234";
+    const req = { headers: {}, url: path+filePath};
+
+    beforeEach((done) => {
+        res = new http.ServerResponse({ method: 'DELETE' });
+        done();
+    });
+
+    describe('send()', () => {
+        it('must be 404 if no file found', (done) => {
+            handler.send(req, res)
+                   .then(() => {
+                        assert.equal(res.statusCode, 404);
+                        return done();
+                    })
+                    .catch(done);
+        });
+
+        it('must be 404 if invalid path', (done) => {
+            let new_req = Object.assign({}, req);
+            new_req.url = '/test/should/not/work/1234';
+            handler.send(new_req, res)
+                   .then(() => {
+                       assert.equal(res.statusCode, 404);
+                       return done();
+                   })
+                   .catch(done);
+        });
+
+        it('must acknowledge successful DELETE requests with the 204', (done) => {
+            fs.closeSync(fs.openSync(pathClean+filePath, 'w'));
+            handler.send(req, res)
+                   .then(() => {
+                       assert.equal(res.statusCode, 204);
+                       return done();
+                   })
+                   .catch(done);
+        });
+    });
+});