Merge pull request #1775 from kchadha/cloud-rename-delete

Cloud rename delete

src/engine/target.js

@@ -241,7 +241,7 @@ class Target extends EventEmitter {
             const newVariable = new Variable(id, name, type, false);
             this.variables[id] = newVariable;
             if (isCloud && this.isStage) {
-                this.runtime.ioDevices.cloud.requestCreateCloudVariable(newVariable);
+                this.runtime.ioDevices.cloud.requestCreateVariable(newVariable);
             }
         }
     }
@@ -285,9 +285,14 @@ class Target extends EventEmitter {
         if (this.variables.hasOwnProperty(id)) {
             const variable = this.variables[id];
             if (variable.id === id) {
+                const oldName = variable.name;
                 variable.name = newName;
 
                 if (this.runtime) {
+                    if (variable.isCloud && this.isStage) {
+                        this.runtime.ioDevices.cloud.requestRenameVariable(oldName, newName);
+                    }
+
                     const blocks = this.runtime.monitorBlocks;
                     blocks.changeBlock({
                         id: id,
@@ -314,8 +319,14 @@ class Target extends EventEmitter {
      */
     deleteVariable (id) {
         if (this.variables.hasOwnProperty(id)) {
+            // Get info about the variable before deleting it
+            const deletedVariableName = this.variables[id].name;
+            const deletedVariableWasCloud = this.variables[id].isCloud;
             delete this.variables[id];
             if (this.runtime) {
+                if (deletedVariableWasCloud && this.isStage) {
+                    this.runtime.ioDevices.cloud.requestDeleteVariable(deletedVariableName);
+                }
                 this.runtime.monitorBlocks.deleteBlock(id);
                 this.runtime.requestRemoveMonitor(id);
             }

src/io/cloud.js

@@ -100,7 +100,7 @@ class Cloud {
         }
     }
 
-    requestCreateCloudVariable (variable) {
+    requestCreateVariable (variable) {
         if (this.runtime.canAddCloudVariable()) {
             if (this.provider) {
                 this.provider.createVariable(variable.name, variable.value);
@@ -123,6 +123,29 @@ class Cloud {
         }
     }
 
+    /**
+     * Request the cloud data provider to rename the variable with the given name
+     * to the given new name. Does nothing if this io device does not have a provider set.
+     * @param {string} oldName The name of the variable to rename
+     * @param {string | number} newName The new name for the variable
+     */
+    requestRenameVariable (oldName, newName) {
+        if (this.provider) {
+            this.provider.renameVariable(oldName, newName);
+        }
+    }
+
+    /**
+     * Request the cloud data provider to delete the variable with the given name
+     * Does nothing if this io device does not have a provider set.
+     * @param {string} name The name of the variable to delete
+     */
+    requestDeleteVariable (name) {
+        if (this.provider) {
+            this.provider.deleteVariable(name);
+        }
+    }
+
     /**
      * Create a cloud variable based on the message
      * received from the cloud provider.

test/unit/engine_target.js

@@ -71,11 +71,11 @@ test('createListVariable creates a list', t => {
     t.end();
 });
 
-test('createVariable calls cloud io device\'s requestCreateCloudVariable', t => {
+test('createVariable calls cloud io device\'s requestCreateVariable', t => {
     const runtime = new Runtime();
-    // Mock the requestCreateCloudVariable function
+    // Mock the requestCreateVariable function
     let requestCreateCloudWasCalled = false;
-    runtime.ioDevices.cloud.requestCreateCloudVariable = () => {
+    runtime.ioDevices.cloud.requestCreateVariable = () => {
         requestCreateCloudWasCalled = true;
     };
 
@@ -97,11 +97,11 @@ test('createVariable calls cloud io device\'s requestCreateCloudVariable', t =>
     t.end();
 });
 
-test('createVariable does not call cloud io device\'s requestCreateCloudVariable if target is not stage', t => {
+test('createVariable does not call cloud io device\'s requestCreateVariable if target is not stage', t => {
     const runtime = new Runtime();
-    // Mock the requestCreateCloudVariable function
+    // Mock the requestCreateVariable function
     let requestCreateCloudWasCalled = false;
-    runtime.ioDevices.cloud.requestCreateCloudVariable = () => {
+    runtime.ioDevices.cloud.requestCreateVariable = () => {
         requestCreateCloudWasCalled = true;
     };
 
@@ -177,6 +177,61 @@ test('renameVariable3', t => {
     t.end();
 });
 
+test('renameVariable calls cloud io device\'s requestRenameVariable function', t => {
+    const runtime = new Runtime();
+
+    let requestRenameVariableWasCalled = false;
+    runtime.ioDevices.cloud.requestRenameVariable = () => {
+        requestRenameVariableWasCalled = true;
+    };
+
+    const target = new Target(runtime);
+    target.isStage = true;
+    const mockCloudVar = new Variable('foo', 'bar', Variable.SCALAR_TYPE, true);
+    target.variables[mockCloudVar.id] = mockCloudVar;
+    runtime.targets.push(target);
+
+    target.renameVariable('foo', 'bar2');
+
+    const variables = target.variables;
+    t.equal(Object.keys(variables).length, 1);
+    const variable = variables[Object.keys(variables)[0]];
+    t.equal(variable.id, 'foo');
+    t.equal(variable.name, 'bar2');
+    t.equal(variable.value, 0);
+    t.equal(variable.isCloud, true);
+    t.equal(requestRenameVariableWasCalled, true);
+
+    t.end();
+});
+
+test('renameVariable does not call cloud io device\'s requestRenameVariable function if target is not stage', t => {
+    const runtime = new Runtime();
+
+    let requestRenameVariableWasCalled = false;
+    runtime.ioDevices.cloud.requestRenameVariable = () => {
+        requestRenameVariableWasCalled = true;
+    };
+
+    const target = new Target(runtime);
+    const mockCloudVar = new Variable('foo', 'bar', Variable.SCALAR_TYPE, true);
+    target.variables[mockCloudVar.id] = mockCloudVar;
+    runtime.targets.push(target);
+
+    target.renameVariable('foo', 'bar2');
+
+    const variables = target.variables;
+    t.equal(Object.keys(variables).length, 1);
+    const variable = variables[Object.keys(variables)[0]];
+    t.equal(variable.id, 'foo');
+    t.equal(variable.name, 'bar2');
+    t.equal(variable.value, 0);
+    t.equal(variable.isCloud, true);
+    t.equal(requestRenameVariableWasCalled, false);
+
+    t.end();
+});
+
 // Delete Variable tests.
 test('deleteVariable', t => {
     const target = new Target();
@@ -200,6 +255,51 @@ test('deleteVariable2', t => {
     t.end();
 });
 
+test('deleteVariable calls cloud io device\'s requestRenameVariable function', t => {
+    const runtime = new Runtime();
+
+    let requestDeleteVariableWasCalled = false;
+    runtime.ioDevices.cloud.requestDeleteVariable = () => {
+        requestDeleteVariableWasCalled = true;
+    };
+
+    const target = new Target(runtime);
+    target.isStage = true;
+    const mockCloudVar = new Variable('foo', 'bar', Variable.SCALAR_TYPE, true);
+    target.variables[mockCloudVar.id] = mockCloudVar;
+    runtime.targets.push(target);
+
+    target.deleteVariable('foo');
+
+    const variables = target.variables;
+    t.equal(Object.keys(variables).length, 0);
+    t.equal(requestDeleteVariableWasCalled, true);
+
+    t.end();
+});
+
+test('deleteVariable calls cloud io device\'s requestRenameVariable function', t => {
+    const runtime = new Runtime();
+
+    let requestDeleteVariableWasCalled = false;
+    runtime.ioDevices.cloud.requestDeleteVariable = () => {
+        requestDeleteVariableWasCalled = true;
+    };
+
+    const target = new Target(runtime);
+    const mockCloudVar = new Variable('foo', 'bar', Variable.SCALAR_TYPE, true);
+    target.variables[mockCloudVar.id] = mockCloudVar;
+    runtime.targets.push(target);
+
+    target.deleteVariable('foo');
+
+    const variables = target.variables;
+    t.equal(Object.keys(variables).length, 0);
+    t.equal(requestDeleteVariableWasCalled, false);
+
+    t.end();
+});
+
 test('duplicateVariable creates a new variable with a new ID by default', t => {
     const target = new Target();
     target.createVariable('a var ID', 'foo', Variable.SCALAR_TYPE);

test/unit/io_cloud.js

@@ -12,7 +12,7 @@ test('spec', t => {
     t.type(cloud.postData, 'function');
     t.type(cloud.requestUpdateVariable, 'function');
     t.type(cloud.updateCloudVariable, 'function');
-    t.type(cloud.requestCreateCloudVariable, 'function');
+    t.type(cloud.requestCreateVariable, 'function');
     t.type(cloud.createCloudVariable, 'function');
     t.type(cloud.setProvider, 'function');
     t.type(cloud.setStage, 'function');
@@ -115,7 +115,7 @@ test('requestUpdateVariable calls provider\'s updateVariable function', t => {
     t.end();
 });
 
-test('requestCreateCloudVariable calls provider\'s createVariable function', t => {
+test('requestCreateVariable calls provider\'s createVariable function', t => {
     let createVariableCalled = false;
     const mockVariable = new Variable('a var id', 'my var', Variable.SCALAR_TYPE, false);
     let mockVarName;
@@ -134,11 +134,58 @@ test('requestCreateCloudVariable calls provider\'s createVariable function', t =
     const runtime = new Runtime();
     const cloud = new Cloud(runtime);
     cloud.setProvider(provider);
-    cloud.requestCreateCloudVariable(mockVariable);
+    cloud.requestCreateVariable(mockVariable);
     t.equals(createVariableCalled, true);
     t.strictEquals(mockVarName, 'my var');
     t.strictEquals(mockVarValue, 0);
-    // Calling requestCreateCloudVariable does not set isCloud flag on variable
+    // Calling requestCreateVariable does not set isCloud flag on variable
     t.strictEquals(mockVariable.isCloud, false);
     t.end();
 });
+
+test('requestRenameVariable calls provider\'s renameVariable function', t => {
+    let renameVariableCalled = false;
+    let mockVarOldName;
+    let mockVarNewName;
+    const mockRenameVariable = (oldName, newName) => {
+        renameVariableCalled = true;
+        mockVarOldName = oldName;
+        mockVarNewName = newName;
+        return;
+    };
+
+    const provider = {
+        renameVariable: mockRenameVariable
+    };
+
+    const runtime = new Runtime();
+    const cloud = new Cloud(runtime);
+    cloud.setProvider(provider);
+    cloud.requestRenameVariable('my var', 'new var name');
+    t.equals(renameVariableCalled, true);
+    t.strictEquals(mockVarOldName, 'my var');
+    t.strictEquals(mockVarNewName, 'new var name');
+    t.end();
+});
+
+test('requestDeleteVariable calls provider\'s deleteVariable function', t => {
+    let deleteVariableCalled = false;
+    let mockVarName;
+    const mockDeleteVariable = name => {
+        deleteVariableCalled = true;
+        mockVarName = name;
+        return;
+    };
+
+    const provider = {
+        deleteVariable: mockDeleteVariable
+    };
+
+    const runtime = new Runtime();
+    const cloud = new Cloud(runtime);
+    cloud.setProvider(provider);
+    cloud.requestDeleteVariable('my var');
+    t.equals(deleteVariableCalled, true);
+    t.strictEquals(mockVarName, 'my var');
+    t.end();
+});