INT-833 Make help window a singleton, change window size

Squashed:
INT-833 help window not clicking element bug fix
INT-833 code cleanup
INT-833 fix nom run check
INT-833 redundant code
INT-833 use loadURL instead of executeJS
send message instead of loadURL, much faster

Author: WaleyChen

src/app.js

@@ -28,7 +28,6 @@ var MongoDBInstance = require('./models/mongodb-instance');
 var User = require('./models/user');
 var Router = require('./router');
 var Statusbar = require('./statusbar');
-var Help = require('./help');
 var $ = require('jquery');
 
 var debug = require('debug')('scout:app');
@@ -126,7 +125,7 @@ var Application = View.extend({
   },
   onHelpClicked: function(evt) {
     var id = $(evt.target).attr('data-hook');
-    Help.open(id);
+    app.sendMessage('show help window', id);
   },
   onClientReady: function() {
     debug('Client ready! Took %dms to become readable',
@@ -291,12 +290,12 @@ app.extend({
   setFeature: function(id, bool) {
     FEATURES[id] = bool;
   },
-  sendMessage: function(msg, arg1) {
-    ipc.send('message', msg, arg1);
+  sendMessage: function(msg, arg) {
+    ipc.send('message', msg, arg);
   },
-  onMessageReceived: function(msg) {
-    debug('message received from main process:', msg);
-    this.trigger(msg);
+  onMessageReceived: function(msg, arg) {
+    debug('message received from main process:', msg, arg);
+    this.trigger(msg, arg);
   },
   metrics: metrics,
   init: function() {

src/electron/menu.js

@@ -1,21 +1,22 @@
 // based off of https://github.com/atom/atom/blob/master/src/browser/application-menu.coffee
 // use js2.coffee to convert it to JS
 
-var _ = require('lodash');
-var app = require('app');
 var BrowserWindow = require('browser-window');
-var debug = require('debug')('electron:menu');
 var Menu = require('menu');
 var State = require('ampersand-state');
 
+var _ = require('lodash');
+var app = require('app');
+var debug = require('debug')('electron:menu');
+
 // submenu related
 function separator() {
   return {
     type: 'separator'
   };
 }
 
-function quitSubMenu(label) {
+function quitSubMenuItem(label) {
   return {
     label: label,
     accelerator: 'CmdOrCtrl+Q',
@@ -25,7 +26,7 @@ function quitSubMenu(label) {
   };
 }
 
-function compassOverviewSubMenu() {
+function compassOverviewSubMenuItem() {
   return {
     label: 'Compass Overview',
     click: function() {
@@ -58,7 +59,7 @@ function darwinCompassSubMenu() {
         selector: 'unhideAllApplications:'
       },
       separator(),
-      quitSubMenu('Quit')
+      quitSubMenuItem('Quit')
     ]
   };
 }
@@ -126,7 +127,7 @@ function editSubMenu() {
   };
 }
 
-function nonDarwinAboutSubMenu() {
+function nonDarwinAboutSubMenuItem() {
   return {
     label: 'About Compass',
     click: function() {
@@ -135,18 +136,27 @@ function nonDarwinAboutSubMenu() {
   };
 }
 
+function helpWindowSubMenuItem() {
+  return {
+    label: 'Help',
+    accelerator: 'CmdOrCtrl+H',
+    click: function() {
+      app.emit('show help window');
+    }
+  };
+}
+
 function helpSubMenu(showCompassOverview) {
   var subMenu = [];
-  if (showCompassOverview) {
-    subMenu.push(compassOverviewSubMenu());
+  subMenu.push(helpWindowSubMenuItem());
 
-    if (process.platform !== 'darwin') {
-      subMenu.push(separator());
-    }
+  if (showCompassOverview) {
+    subMenu.push(compassOverviewSubMenuItem());
   }
 
   if (process.platform !== 'darwin') {
-    subMenu.push(nonDarwinAboutSubMenu());
+    subMenu.push(separator());
+    subMenu.push(nonDarwinAboutSubMenuItem());
   }
 
   return {
@@ -155,6 +165,15 @@ function helpSubMenu(showCompassOverview) {
   };
 }
 
+function nonDarwinCompassSubMenuItem() {
+  return {
+    label: 'MongoDB Compass',
+    submenu: [
+      quitSubMenuItem('Exit')
+    ]
+  };
+}
+
 function shareSubMenu() {
   return {
     label: 'Share',
@@ -230,20 +249,19 @@ function darwinMenu(menuState) {
   }
 
   menu.push(windowSubMenu());
-
-  if (menuState.showCompassOverview) {
-    menu.push(helpSubMenu(menuState.showCompassOverview));
-  }
+  menu.push(helpSubMenu(menuState.showCompassOverview));
 
   return menu;
 }
 
 function nonDarwinMenu(menuState) {
   var menu = [
-    connectSubMenu(true),
-    viewSubMenu()
+    nonDarwinCompassSubMenuItem()
   ];
 
+  menu.push(connectSubMenu());
+  menu.push(viewSubMenu());
+
   if (menuState.showShare) {
     menu.push(shareSubMenu());
   }
@@ -297,10 +315,6 @@ var AppMenu = (function() {
     getTemplate: function(winID) {
       var menuState = this.windowTemplates.get(winID);
 
-      debug('WINDOW\'s ' + winID + ' Menu State');
-      debug('showCompassOverview: ' + menuState.showCompassOverview);
-      debug('showShare: ' + menuState.showShare);
-
       if (process.platform === 'darwin') {
         return darwinMenu(menuState);
       }
@@ -339,7 +353,6 @@ var AppMenu = (function() {
       Menu.setApplicationMenu(menu);
     },
 
-    // share/hide submenu fns
     hideShare: function() {
       this.updateMenu('showShare', false);
     },

src/electron/window-manager.js

@@ -3,36 +3,36 @@
  * [BrowserWindow](https://github.com/atom/electron/blob/master/docs/api/browser-window.md)
  * class
  */
-
 var AppMenu = require('./menu');
 var BrowserWindow = require('browser-window');
 var Notifier = require('node-notifier');
-var Path = require('path');
 
 var _ = require('lodash');
 var app = require('app');
 var config = require('./config');
 var debug = require('debug')('scout-electron:window-manager');
 var dialog = require('dialog');
+var path = require('path');
 
 /**
  * When running in electron, we're in `RESOURCES/src/electron`.
  */
-var RESOURCES = Path.resolve(__dirname, '../../');
-var SCOUT_ICON_PATH = RESOURCES + '/images/scout.png';
+var RESOURCES = path.resolve(__dirname, '../../');
 
 /**
  * The app's HTML shell which is the output of `./src/index.jade`
  * created by the `build:pages` gulp task.
  */
-var DEFAULT_URL = 'file://' + Path.join(RESOURCES, 'index.html#connect');
+var DEFAULT_URL = 'file://' + path.join(RESOURCES, 'index.html#connect');
+var HELP_URL = 'file://' + path.join(RESOURCES, 'index.html#help');
 
 /**
- * We want the Connect dialog window to be special
- * and for there to ever only be one instance of it
- * so we'll use scope to essentially make it a Singleton.
+ * We want the Connect and Help window to be special
+ * and for there to ever only be one instance of each of them
+ * so we'll use scope to essentially make each of them a Singleton.
  */
 var connectWindow;
+var helpWindow;
 
 // @todo (imlucas): Removed in setup branch as we dont need to do this anymore
 // as a `all-windows-closed` event has been added to the `app` event api
@@ -136,11 +136,6 @@ function createWindow(opts, url) {
   return module.exports.create(opts);
 }
 
-app.on('close connect', function() {
-  connectWindow.close();
-  connectWindow = null;
-});
-
 app.on('show about dialog', function() {
   dialog.showMessageBox({
     type: 'info',
@@ -156,9 +151,29 @@ app.on('show connect dialog', function() {
   }
 
   connectWindow = createWindow({}, DEFAULT_URL);
-  connectWindow.on('focus', function() {
-    debug('connect window focused.');
-    connectWindow.webContents.send('message', 'connect-window-focused');
+  connectWindow.on('closed', function() {
+    debug('connect window closed.');
+    connectWindow = null;
+  });
+});
+
+app.on('show help window', function(id) {
+  if (helpWindow) {
+    helpWindow.focus();
+    if (_.isString(id)) {
+      helpWindow.webContents.send('message', 'show-help-entry', id);
+    }
+    return;
+  }
+
+  var url = HELP_URL;
+  if (_.isString(id)) {
+    url += '/' + id;
+  }
+
+  helpWindow = createWindow({}, url);
+  helpWindow.on('closed', function() {
+    helpWindow = null;
   });
 });
 
@@ -203,7 +218,7 @@ app.on('ready', function() {
 });
 
 var ipc = require('ipc');
-ipc.on('message', function(event, msg, arg1) {
-  debug('message received in main process', msg);
-  app.emit(msg, arg1);
+ipc.on('message', function(event, msg, arg) {
+  debug('message received in main process', msg, arg);
+  app.emit(msg, arg, event);
 });

src/help/index.js

@@ -69,6 +69,8 @@ var HelpPage = View.extend({
         this.show(this.entryId);
       }
     });
+
+    this.listenTo(app, 'show-help-entry', this.show.bind(this));
   },
   show: function(entryId) {
     debug('show `%s`', entryId);
@@ -145,21 +147,4 @@ var HelpPage = View.extend({
   }
 });
 
-/**
- * Convenience to open the help window if needed and show an item.
- *
- * @param {String} [entryId] - Optional filename to show from `./items/#{entryId}.jade`.
- *
- * @todo (imlucas) Add helper to `./src/electron/window-manager.js` so this works
- * like connect window (singleton w/ custom dimensions).
- */
-HelpPage.open = function(entryId) {
-  var url = format('%s?#help', window.location.origin);
-  if (entryId) {
-    url += '/' + entryId;
-  }
-  debug('Opening item `%s`', entryId);
-  window.open(url);
-};
-
 module.exports = HelpPage;

src/home/index.js

@@ -49,7 +49,6 @@ var HomeView = View.extend({
     this.once('change:rendered', this.onRendered);
     debug('fetching instance model...');
     app.instance.fetch();
-
     app.sendMessage('show compass overview submenu');
   },
   render: function() {