Frame manager (fixes #19 and #20)

Author: uuf6429

Diff for: src/Server/Preload.js

@@ -3,6 +3,7 @@
         setExecutionError = remote.getGlobal('setExecutionError'),
         setWindowUnloading = remote.getGlobal('setWindowUnloading'),
         setWindowIdName = remote.getGlobal('setWindowIdName'),
+        getWindowNameFromId = remote.getGlobal('getWindowNameFromId'),
         setFileFromScript = remote.getGlobal('setFileFromScript'),
         DELAY_SCRIPT_RESPONSE = remote.getGlobal('DELAY_SCRIPT_RESPONSE'),
         electronWindow = remote.getCurrentWindow();
@@ -21,15 +22,13 @@
         setWindowIdName(electronWindow.id, null, location.href);
     });
 
-    let oldWndName = window.name || remote.getGlobal('newWindowName');
+    setWindowIdName(electronWindow.id, (window.name || remote.getGlobal('newWindowName')), location.href);
     window.__defineSetter__("name", function (name) {
-        oldWndName = name;
         setWindowIdName(electronWindow.id, name, location.href);
     });
     window.__defineGetter__("name", function () {
-        return oldWndName;
+        return getWindowNameFromId(electronWindow.id);
     });
-    setWindowIdName(electronWindow.id, oldWndName, location.href);
 
     window.Electron = {
         'syn': require('syn'),

Diff for: src/Server/Server.js

@@ -112,6 +112,7 @@ Electron.app.on('ready', function() {
         cookieResponse = null,
         screenshotResponse = null,
         windowWillUnload = false,
+        /** @type {Object.<string, string>} */
         windowIdNameMap = {},
         captureResponse = false,
         bindServerOnce;
@@ -125,6 +126,7 @@ Electron.app.on('ready', function() {
      */
     global.setExecutionError = function (error) {
         Logger.error('Script evaluation failed internally: %s', errorToString(error));
+
         executeResponse = {'error': errorToString(error)};
     };
 
@@ -147,26 +149,36 @@ Electron.app.on('ready', function() {
 
     /**
      *
-     * @param {integer} id
-     * @param {string} name
-     * @param {string} url
+     * @param {Number} id
+     * @param {String} name
+     * @param {String} url
      */
     global.setWindowIdName = function (id, name, url) {
         const sId = id === null ? "" : id.toString();
 
         if (name === '') {
-            name = 'frame-' + sId;
+            name = 'electron_window_' + sId;
         }
 
         if (name === null) {
-            Logger.info('Unlinked window named "%s" from id "%s" for %s.', name, sId, url);
+            Logger.info('Unlinked window named %j from id %j for %j.', name, sId, url);
             if (windowIdNameMap[sId]) delete windowIdNameMap[sId];
         } else {
-            Logger.info('Linked window named "%s" with id "%s" for %s.', name, sId, url);
+            Logger.info('Linked window named %j with id %j for %j.', name, sId, url);
             windowIdNameMap[sId] = name;
         }
     };
 
+    /**
+     *
+     * @param {Number} id
+     */
+    global.getWindowNameFromId = function (id) {
+        const sId = id === null ? "" : id.toString();
+
+        return windowIdNameMap[sId];
+    };
+
     /**
      * Finds window by its window name. Note that this depends on the windows successfully registering it's id and name
      * when created. Since we keep these details in a hash map, we need to be careful about keeping it up to date.
@@ -181,7 +193,7 @@ Electron.app.on('ready', function() {
         }
 
         for (let id in windowIdNameMap) {
-            if (windowIdNameMap[id] === name) {
+            if (windowIdNameMap.hasOwnProperty(id) && windowIdNameMap[id] === name) {
                 const wnd = BrowserWindow.fromId(parseInt(id));
                 if (wnd) result.push(wnd);
             }
@@ -339,6 +351,25 @@ Electron.app.on('ready', function() {
          * @param {Electron.BrowserWindow} window
          */
         function (event, window) {
+            const windowId = window.id;
+
+            Logger.debug('Browser window created with id %j.', windowId);
+
+            window
+                .on('closed', function () { // important: we can't use window anymore in here!
+                    if (windowId) {
+                        Logger.info('Window "%s" (id %d) has been closed.', windowIdNameMap[windowId.toString()] || '', windowId);
+
+                        pageVisited = true;
+                        captureResponse = false;
+                        delete windowIdNameMap[windowId.toString()];
+                        ResponseManager.remove(windowId);
+                    } else {
+                        Logger.warn('Browser window with id %j was closed.', windowId);
+                    }
+                })
+            ;
+
             window.webContents
                 .on('login', function (event, request, authInfo, callback) {
                     if (auth.user !== false) {
@@ -352,10 +383,9 @@ Electron.app.on('ready', function() {
                     global.newWindowName = frameName;
                     setupWindowOptions(options);
                 })
-                .on('closed', function () {
-                    Logger.info('Window "%s" (id %d) has been closed.', windowIdNameMap[window.id] || '', window.id);
-                    delete windowIdNameMap[window.id];
-                    ResponseManager.remove(window.id);
+                .on('will-navigate', function (event, url) {
+                    Logger.debug('Event "will-navigate" triggered for url %j.', url);
+                    global.setWindowUnloading(true);
                 })
                 .on('did-finish-load', function () {
                     if (bindServerOnce) {

Diff for: tests/ElectronConfig.php

@@ -19,7 +19,7 @@ class ElectronConfig extends AbstractConfig
 
     protected function __construct()
     {
-        $this->logger = new ElectronFileLogger(__DIR__ . '/../tmp/output.log');
+        $this->logger = new ElectronFileLogger(__DIR__ . '/../tmp/output.log', false);
     }
 
     /**

Diff for: tests/WebDriverTest.php

@@ -233,13 +233,22 @@ public function testWindowMaximize()
         );
     }
 
-    public function testOpeningNewWindow()
+    public function testNewWindow()
     {
-        $this->assertEquals(['frame-1'], $this->driver->getWindowNames());
+        $this->assertEquals(['electron_window_1'], $this->driver->getWindowNames());
 
         $this->assertSame(9, $this->driver->evaluateScript('4 + 5'));
 
         $this->driver->executeScript('window.open();');
-        $this->assertEquals(['frame-1', 'frame-2'], $this->driver->getWindowNames());
+        $this->assertEquals(['electron_window_1', 'electron_window_2'], $this->driver->getWindowNames());
+
+        $this->driver->switchToWindow('electron_window_2');
+        $this->assertEquals('electron_window_2', $this->driver->getWindowName());
+
+        $this->driver->visit('http://google.com');
+        $this->assertEquals('electron_window_2', $this->driver->getWindowName());
+
+        $this->driver->executeScript('window.close();');
+        $this->assertEquals(['electron_window_1'], $this->driver->getWindowNames());
     }
 }