Hangout remote desktop part II - background.html and AppLauncher

remoting/webapp/js_proto/chrome_proto.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file contains various hacks needed to inform JSCompiler of various
 // WebKit- and Chrome-specific properties and methods. It is used only with
 // JSCompiler to verify the type-correctness of our code.
 
 /** @type {Object} */
 var chrome = {};
 
+/** @constructor */
+chrome.Event = function() {
+  this.listeners_ = [];
+};
+
+/** @param {Function} callback */
+chrome.Event.prototype.addListener = function(callback) {
+  this.listeners_.push(callback);

[kelvinp, 2014/08/11 18:37:56]

I provide a simple implementation of chrome.events so that they can be used in
unit-test, as this file is also loaded to provide stubs in unit-test.  If you
think they are better off living in a helper file, I can move them there.

[Jamie, 2014/08/12 02:24:59]

Yes, please do that. Files under js_proto/ should only be used to help the
compile with type-checking. Using it for stubs in unit tests is not ideal, but
does at least mean we're not duplicating stub definitions. However, we shouldn't
be providing actual functionality here.

+};
+
+/** @param {Function} callback */
+chrome.Event.prototype.removeListener = function(callback) {
+  for (var i = 0; i < this.listeners_.length; i++) {
+    if (this.listeners_[i] === callback) {
+      this.listeners_.splice(i, 1);
+      break;
+    }
+  }
+};
+
+  /** @param {*=} data */
+chrome.Event.prototype.mock$fire = function(data) {
+  /** @param {Function} listener */
+  this.listeners_.forEach(function(listener){
+    listener(data);
+  });
+};
 
 /** @type {Object} */
 chrome.app = {};
 
 /** @type {Object} */
 chrome.app.runtime = {
   /** @type {chrome.Event} */
   onLaunched: null
 };
 
 
 /** @type {Object} */
 chrome.app.window = {
   /**
    * @param {string} name
    * @param {Object} parameters
    * @param {function()=} opt_callback
    */
   create: function(name, parameters, opt_callback) {},
   /**
    * @return {AppWindow}
    */
-  current: function() {}
+  current: function() {},
+  /**
+   * @param {string} id
+   * @param {function()=} opt_callback
+   */
+  get: function(id, opt_callback) {}
 };
 
 
 /** @type {Object} */
 chrome.runtime = {
   /** @type {Object} */
   lastError: {
     /** @type {string} */
     message: ''
   },
   /** @return {{version: string, app: {background: Object}}} */
-  getManifest: function() {}
+  getManifest: function() {},
+  /** @type {chrome.Event} */
+  onSuspend: null,
+  /** @type {chrome.Event} */
+  onConnect: null,
+  /** @type {chrome.Event} */
+  onConnectExternal: null,
+  /** @type {chrome.Event} */
+  onMessage: null,
+  /** @type {chrome.Event} */
+  onMessageExternal: null
 };
 
 /**
- * @type {?function(string):chrome.extension.Port}
+ * @type {?function(string):chrome.runtime.Port}
  */
 chrome.runtime.connectNative = function(name) {};
 
 /**
- * @param {{name:string}} connectInfo
- * @return {chrome.extension.Port}
+ * @param {{ name: string}} config
+ * @return {chrome.runtime.Port}
  */
-chrome.runtime.connect = function(connectInfo) {};
+chrome.runtime.connect = function(config) {};
 
 /**
  * @param {string} extensionId
  * @param {*} message
  * @param {Object=} opt_options
  * @param {function(*)=} opt_callback
  */
 chrome.runtime.sendMessage = function(
     extensionId, message, opt_options, opt_callback) {};
 
+/** @constructor */
+chrome.runtime.MessageSender = function () {
+  /** @type {chrome.Tab} */
+  this.tab = null;
+  /** @type {AppWindow} */
+  this.window = null;
+};
+
+/** @constructor */
+chrome.runtime.Port = function() {
+  this.onMessage = new chrome.Event();
+  this.onDisconnect = new chrome.Event();
+
+  /** @type {string} */
+  this.name = '';
+
+  /** @type {chrome.runtime.MessageSender} */
+  this.sender = null;
+};
+
+/** @type {chrome.Event} */
+chrome.runtime.Port.prototype.onMessage = null;
+
+/** @type {chrome.Event} */
+chrome.runtime.Port.prototype.onDisconnect = null;
+
+chrome.runtime.Port.prototype.disconnect = function() {};
+
+/**
+ * @param {Object} message
+ */
+chrome.runtime.Port.prototype.postMessage = function(message) {};
+
+
 /** @type {Object} */
 chrome.extension = {};
 
-/** @constructor */
-chrome.extension.Port = function() {};
-
-/** @type {chrome.Event} */
-chrome.extension.Port.prototype.onMessage;
-
-/** @type {chrome.Event} */
-chrome.extension.Port.prototype.onDisconnect;
-
-/**
- * @param {Object} message
- */
-chrome.extension.Port.prototype.postMessage = function(message) {};
-
 /**
  * @param {*} message
  */
 chrome.extension.sendMessage = function(message) {}
 
 /** @type {chrome.Event} */
 chrome.extension.onMessage;
 
 
 /** @type {Object} */
@@ skipping 45 matching lines @@
  * @return {void}
  */
 chrome.Storage.prototype.clear = function(opt_callback) {};
 
 
 /**
  * @type {Object}
  * src/chrome/common/extensions/api/context_menus.json
  */
 chrome.contextMenus = {};
-/** @type {ChromeEvent} */
+/** @type {chrome.Event} */
 chrome.contextMenus.onClicked;
 /**
  * @param {!Object} createProperties
  * @param {function()=} opt_callback
  */
 chrome.contextMenus.create = function(createProperties, opt_callback) {};
 /**
  * @param {string|number} id
  * @param {!Object} updateProperties
  * @param {function()=} opt_callback
@@ skipping 47 matching lines @@
    * @param {function():void} callback
    */
   removeCachedAuthToken: function(parameters, callback) {},
   /**
    * @param {Object.<string>} parameters
    * @param {function(string):void} callback
    */
   launchWebAuthFlow: function(parameters, callback) {}
 };
 
-// TODO(garykac): Combine chrome.Event and ChromeEvent
-/** @constructor */
-function ChromeEvent() {}
-/** @param {Function} callback */
-ChromeEvent.prototype.addListener = function(callback) {};
-/** @param {Function} callback */
-ChromeEvent.prototype.removeListener = function(callback) {};
-/** @param {Function} callback */
-ChromeEvent.prototype.hasListener = function(callback) {};
-/** @param {Function} callback */
-ChromeEvent.prototype.hasListeners = function(callback) {};
-
-/** @constructor */
-chrome.Event = function() {};
-
-/** @param {function():void} callback */
-chrome.Event.prototype.addListener = function(callback) {};
-
-/** @param {function():void} callback */
-chrome.Event.prototype.removeListener = function(callback) {};
-
 
 /** @type {Object} */
 chrome.permissions = {
   /**
    * @param {Object.<string>} permissions
    * @param {function(boolean):void} callback
    */
   contains: function(permissions, callback) {},
   /**
    * @param {Object.<string>} permissions
    * @param {function(boolean):void} callback
    */
   request: function(permissions, callback) {}
 };
 
 
 /** @type {Object} */
 chrome.tabs = {};
 
 /** @param {function(chrome.Tab):void} callback */
 chrome.tabs.getCurrent = function(callback) {};
 
+/**
+ * @param {Object?} options
+ * @param {function(chrome.Tab)=} opt_callback
+ */
+chrome.tabs.create = function(options, opt_callback) {};
+
+/**
+ * @param {string} id
+ * @param {function(chrome.Tab)} callback
+ */
+chrome.tabs.get = function(id, callback) {};
+
+/**
+ * @param {string} id
+ * @param {function()=} opt_callback
+ */
+chrome.tabs.remove = function(id, opt_callback) {};
+
+
 /** @constructor */
 chrome.Tab = function() {
   /** @type {boolean} */
   this.pinned = false;
   /** @type {number} */
   this.windowId = 0;
+  /** @type {string} */
+  this.id = '';
 };
 
 
 /** @type {Object} */
 chrome.windows = {};
 
 /** @param {number} id
  *  @param {Object?} getInfo
  *  @param {function(chrome.Window):void} callback */
 chrome.windows.get = function(id, getInfo, callback) {};
 
 /** @constructor */
 chrome.Window = function() {
   /** @type {string} */
   this.state = '';
   /** @type {string} */
   this.type = '';
 };
 
 /** @constructor */
 var AppWindow = function() {
   /** @type {Window} */
   this.contentWindow = null;
   /** @type {chrome.Event} */
   this.onRestored = null;
   /** @type {chrome.Event} */
   this.onMaximized = null;
   /** @type {chrome.Event} */
   this.onFullscreened = null;
+  /** @type {string} */
+  this.id = "";
 };
 
 AppWindow.prototype.close = function() {};
 AppWindow.prototype.drawAttention = function() {};
 AppWindow.prototype.maximize = function() {};
 AppWindow.prototype.minimize = function() {};
 AppWindow.prototype.restore = function() {};
 AppWindow.prototype.fullscreen = function() {};
 /** @return {boolean} */
 AppWindow.prototype.isFullscreen = function() {};
@@ skipping 26 matching lines @@
   this.height = 0;
   /** @type {number} */
   this.top = 0;
   /** @type {number} */
   this.bottom = 0;
   /** @type {number} */
   this.left = 0;
   /** @type {number} */
   this.right = 0;
 };