Add removeFile to interactive compute sessions. Closes #1844

deepforge-dev · Aug 6, 2020 · e4382f8 · e4382f8
1 parent 38119f0
commit e4382f8
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 1 deletion.
diff --git a/src/common/compute/interactive/message.js b/src/common/compute/interactive/message.js
@@ -9,7 +9,7 @@
     }
 }(this, function() {
     const Constants = makeEnum('STDOUT', 'STDERR', 'RUN', 'ADD_ARTIFACT',
-        'ADD_FILE', 'ADD_USER_DATA', 'COMPLETE', 'ERROR', 'SET_ENV');
+        'ADD_FILE', 'REMOVE_FILE', 'ADD_USER_DATA', 'COMPLETE', 'ERROR', 'SET_ENV');
 
     function makeEnum() {
         const names = Array.prototype.slice.call(arguments);

diff --git a/src/common/compute/interactive/session.js b/src/common/compute/interactive/session.js
@@ -141,6 +141,13 @@ define([
             await this.runTask(task);
         }
 
+        async removeFile(filepath) {
+            this.ensureIdle('remove file');
+            const msg = new Message(Message.REMOVE_FILE, [filepath]);
+            const task = new Task(this.ws, msg);
+            await this.runTask(task);
+        }
+
         async setEnvVar(name, value) {
             this.ensureIdle('set env var');
             const msg = new Message(Message.SET_ENV, [name, value]);

diff --git a/src/routers/InteractiveCompute/job-files/start.js b/src/routers/InteractiveCompute/job-files/start.js
@@ -57,13 +57,33 @@ class InteractiveClient {
         } else if (msg.type === Message.ADD_FILE) {
             this.runTask(() => {
                 const [filepath, content] = msg.data;
+                this.ensureValidPath(filepath);
                 this.writeFile(filepath, content);
             });
         } else if (msg.type === Message.SET_ENV) {
             this.runTask(() => {
                 const [name, value] = msg.data;
                 process.env[name] = value;
             });
+        } else if (msg.type === Message.REMOVE_FILE) {
+            this.runTask(async () => {
+                const [filepath] = msg.data;
+                this.ensureValidPath(filepath);
+                await fsp.unlink(filepath);
+            });
+        } else {
+            this.sendMessage(Message.COMPLETE, 2);
+        }
+    }
+
+    ensureValidPath(filepath) {
+        const isOutsideWorkspace = path.relative(
+            path.resolve(__dirname),
+            path.resolve(filepath)
+        ).startsWith('..');
+
+        if (isOutsideWorkspace) {
+            throw new Error('Cannot edit files outside workspace: ' + filepath);
         }
     }
 

diff --git a/test/integration/InteractiveCompute.js b/test/integration/InteractiveCompute.js
@@ -42,4 +42,15 @@ describe('InteractiveCompute', function() {
         const {stdout} = await session.exec('cat test.txt');
         assert.equal(stdout, 'hello world');
     });
+
+    it('should remove file', async function() {
+        try {
+            await session.addFile('test.txt', 'hello world');
+            await session.removeFile('test.txt');
+            const {stdout} = await session.exec('cat test.txt');
+            assert(false);
+        } catch (err) {
+            assert(err.jobResult.stderr.includes('No such file'));
+        }
+    });
 });