Client now notifies server when ending

Server now exposes a callback for the client to notifies it when finished. This
allows the server to clean up the registry.

Careful, this introduces #65 when debugging.

client/robot/robot.js

@@ -203,6 +203,12 @@ robot = {
     robot.isDisconnected = true;
     robotController.disconnect();
     robot.clearConnection();
+    robot.notifyEndToServer();
+  },
+
+  // This function will be overridden by a server callback
+  notifyEndToServer: () => {
+    console.error('`notifyEndToServer`: Server has not registered a callback!');
   }
 };
 

lib/controller.js

@@ -35,6 +35,29 @@ const create = (runner, modules, config) => {
                                              config.visio.url,
                                              room,
                                              config.client);
+
+      // Add callback for client to inform when it leaves the room
+      controller.registry[room]
+        .timeouts('script', 2147483000) // We need big timeouts here (here ~600h)
+        .executeAsync(done => {
+          // Note that this code is executed in the selenium-driven browser
+          /* eslint-disable no-undef */
+          robot.notifyEndToServer = () => {
+            done('finished');
+            console.log('notified server I finished');
+          };
+          /* eslint-enable */
+        }).then(() => {
+          delete controller.registry[room];
+          console.log('client for room', room, 'finished');
+        }).catch(err => {
+          console.log('got error', err);
+          // Careful, there is a bug here with chomedriver; if we open the
+          // console of the selenium-driven browser, an exception is thrown.
+          // This means that this part may break in dev (but not in prod).
+          // See issue #65 for more details.
+        });
+
       return controller.registry[room];
     },
 

lib/controller.test.js

@@ -25,11 +25,27 @@ const {create} = require('./controller.js');
 // Here are some needed mocks
 
 const functionRunnerMock = {
+
+  callbacks: [],
+
+  catch() {
+    return functionRunnerMock;
+  },
+  end() {
+    return functionRunnerMock;
+  },
   execute() {
-    return {
-      end() {
-      }
-    };
+    return functionRunnerMock;
+  },
+  executeAsync() {
+    return functionRunnerMock;
+  },
+  timeouts() {
+    return functionRunnerMock;
+  },
+  then(callback) {
+    functionRunnerMock.callbacks.push(callback);
+    return functionRunnerMock;
   }
 };
 
@@ -49,6 +65,7 @@ let controller;
 describe('controller', () => {
   beforeEach(() => {
     controller = create(runnerMock, [], configMock);
+    functionRunnerMock.callbacks = [];
   });
 
   test('should allow to create a client to a new room', () => {
@@ -84,4 +101,16 @@ describe('controller', () => {
     controller.forceDisconnect('test1');
     expect(controller.registry).toHaveProperty('test2', client2);
   });
+
+  test('should have registered a finish callback to the client', () => {
+    controller.client('test');
+    expect(functionRunnerMock.callbacks.length).toBe(1);
+  });
+
+  test('should clean registry on client finish callback', () => {
+    controller.client('test');
+    expect(controller.registry).toHaveProperty('test');
+    functionRunnerMock.callbacks[0]();
+    expect(controller.registry).not.toHaveProperty('test');
+  });
 });