[Chromoting] Change Application.Delegate to proper subclass of Application.

remoting/webapp/app_remoting/js/app_remoting.js

 // Copyright 2014 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.
 
 /**
  * @fileoverview
  * This class implements the functionality that is specific to application
  * remoting ("AppRemoting" or AR).
  */
 
 'use strict';
 
 /** @suppress {duplicate} */
 var remoting = remoting || {};
 
 /**
- * @param {remoting.Application} app The main app that owns this delegate.
+ * @param {Array<string>} appCapabilities Array of application capabilities.
  * @constructor
- * @implements {remoting.Application.Delegate}
+ * @implements {remoting.ApplicationInterface}
  * @implements {remoting.ProtocolExtension}
+ * @extends {remoting.Application}
  */
-remoting.AppRemoting = function(app) {
-  app.setDelegate(this);
+remoting.AppRemoting = function(appCapabilities) {
+  base.inherits(this, remoting.Application, appCapabilities);
 
   /** @private {remoting.ApplicationContextMenu} */
   this.contextMenu_ = null;
 
   /** @private {remoting.KeyboardLayoutsMenu} */
   this.keyboardLayoutsMenu_ = null;
 
   /** @private {remoting.WindowActivationMenu} */
   this.windowActivationMenu_ = null;
 
@@ skipping 19 matching lines @@
 
   this.host = {
     /** @type {string} */
     applicationId: '',
 
     /** @type {string} */
     hostId: ''};
 };
 
 /**
- * Initialize the application. This is called before an OAuth token is requested
- * and should be used for tasks such as initializing the DOM, registering event
- * handlers, etc.
+ * @return {string} Application product name to be used in UI.
+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.init = function() {
+remoting.AppRemoting.prototype.getApplicationName = function() {
+  var manifest = chrome.runtime.getManifest();
+  return manifest.name;
+};
+
+/**
+ * @param {!remoting.Error} error The failure reason.
+ * @override {remoting.ApplicationInterface}
+ */
+remoting.AppRemoting.prototype.signInFailed_ = function(error) {
+  this.onError_(error);
+};
+
+/**
+ * @override {remoting.ApplicationInterface}
+ */
+remoting.AppRemoting.prototype.initApplication_ = function() {
   // TODO(jamiewalch): Remove ClientSession's dependency on remoting.fullscreen
   // so that this is no longer required.
   remoting.fullscreen = new remoting.FullscreenAppsV2();
 
   var restoreHostWindows = function() {
     if (remoting.clientSession) {
       remoting.clientSession.sendClientMessage('restoreAllWindows', '');
     }
   };
   chrome.app.window.current().onRestored.addListener(restoreHostWindows);
 
   remoting.windowShape.updateClientWindowShape();
 
   // Initialize the context menus.
   if (remoting.platformIsChromeOS()) {
     var adapter = new remoting.ContextMenuChrome();
   } else {
     var adapter = new remoting.ContextMenuDom(
         document.getElementById('context-menu'));
   }
   this.contextMenu_ = new remoting.ApplicationContextMenu(adapter);
   this.keyboardLayoutsMenu_ = new remoting.KeyboardLayoutsMenu(adapter);
   this.windowActivationMenu_ = new remoting.WindowActivationMenu(adapter);
 
   remoting.LoadingWindow.show();
 };
 
 /**
- * Start the application. Once start() is called, the delegate can assume that
- * the user has consented to all permissions specified in the manifest.
- *
- * @param {remoting.SessionConnector} connector
- * @param {string} token An OAuth access token. The delegate should not cache
- *     this token, but can assume that it will remain valid during application
- *     start-up.
+ * @param {string} token An OAuth access token.
+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.start = function(connector, token) {
+remoting.AppRemoting.prototype.startApplication_ = function(token) {
   /** @type {remoting.AppRemoting} */
   var that = this;
 
   /** @param {!remoting.Xhr.Response} xhrResponse */
   var parseAppHostResponse = function(xhrResponse) {
     if (xhrResponse.status == 200) {
       var response = /** @type {remoting.AppRemoting.AppHostResponse} */
           (base.jsonParseSafe(xhrResponse.getText()));
       if (response &&
           response.status &&
@@ skipping 25 matching lines @@
          * @param {function(string, string):void} onThirdPartyTokenFetched
          *     Callback.
          */
         var fetchThirdPartyToken = function(
             tokenUrl, hostPublicKey, scope, onThirdPartyTokenFetched) {
           // Use the authentication tokens returned by the app-remoting server.
           onThirdPartyTokenFetched(host['authorizationCode'],
                                    host['sharedSecret']);
         };
 
-        connector.connectMe2App(host, fetchThirdPartyToken);
+        that.sessionConnector_.connectMe2App(host, fetchThirdPartyToken);
       } else if (response && response.status == 'pending') {
-        that.handleError(new remoting.Error(
+        that.onError_(new remoting.Error(
             remoting.Error.Tag.SERVICE_UNAVAILABLE));
       }
     } else {
       console.error('Invalid "runApplication" response from server.');
       // TODO(garykac) Start using remoting.Error.fromHttpStatus once it has
       // been updated to properly report 'unknown' errors (rather than
       // reporting them as AUTHENTICATION_FAILED).
       if (xhrResponse.status == 0) {
-        that.handleError(new remoting.Error(
+        that.onError_(new remoting.Error(
             remoting.Error.Tag.NETWORK_FAILURE));
       } else if (xhrResponse.status == 401) {
-        that.handleError(new remoting.Error(
+        that.onError_(new remoting.Error(
             remoting.Error.Tag.AUTHENTICATION_FAILED));
       } else if (xhrResponse.status == 403) {
-        that.handleError(new remoting.Error(
+        that.onError_(new remoting.Error(
             remoting.Error.Tag.APP_NOT_AUTHORIZED));
       } else if (xhrResponse.status == 502 || xhrResponse.status == 503) {
-        that.handleError(new remoting.Error(
+        that.onError_(new remoting.Error(
             remoting.Error.Tag.SERVICE_UNAVAILABLE));
       } else {
-        that.handleError(remoting.Error.unexpected());
+        that.onError_(remoting.Error.unexpected());
       }
     }
   };
 
   new remoting.Xhr({
     method: 'POST',
-    url: that.runApplicationUrl(),
+    url: that.runApplicationUrl_(),
     oauthToken: token
   }).start().then(parseAppHostResponse);
 };
 
 /**
- * Report an authentication error to the user. This is called in lieu of start()
- * if the user cannot be authenticated or if they decline the app permissions.
- *
- * @param {!remoting.Error} error The failure reason.
+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.signInFailed = function(error) {
-  this.handleError(error);
+remoting.AppRemoting.prototype.exitApplication_ = function() {
+  remoting.LoadingWindow.close();
+  this.exit_();
 };
 
 /**
- * @return {string} Application product name to be used in UI.
+ * @param {remoting.ConnectionInfo} connectionInfo

[Jamie, 2015/03/26 01:54:30]

Do you need the @param declarating? I thought @override had the effect of
importing all the type declarations from the parent class?

Also other instances in this file.

[garykac, 2015/03/26 16:38:11]

@param is still required and jscompile will verify that the signature matches
the base class signature.

Curiously, @return is optional and will be taken from the base class method if
not provided.

These type checks happen whether or not @override is specified.

+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.getApplicationName = function() {
-  var manifest = chrome.runtime.getManifest();
-  return manifest.name;
-};
+remoting.AppRemoting.prototype.onConnected_ = function(connectionInfo) {
+  this.initSession_(connectionInfo);
 
-/** @return {string} */
-remoting.AppRemoting.prototype.runApplicationUrl = function() {
-  return remoting.settings.APP_REMOTING_API_BASE_URL + '/applications/' +
-      remoting.settings.getAppRemotingApplicationId() + '/run';
-};
-
-/**
- * Called when a new session has been connected.
- *
- * @param {remoting.ConnectionInfo} connectionInfo
- * @return {void} Nothing.
- */
-remoting.AppRemoting.prototype.handleConnected = function(connectionInfo) {
   remoting.identity.getUserInfo().then(
       function(userInfo) {
         remoting.clientSession.sendClientMessage(
             'setUserDisplayInfo',
             JSON.stringify({fullName: userInfo.name}));
       });
 
-  remoting.app.getSessionConnector().registerProtocolExtension(this);
+  this.sessionConnector_.registerProtocolExtension(this);
 
   this.connectedView_ = new remoting.AppConnectedView(
       document.getElementById('client-container'), connectionInfo);
 
   // Map Cmd to Ctrl on Mac since hosts typically use Ctrl for keyboard
   // shortcuts, but we want them to act as natively as possible.
   if (remoting.platformIsMac()) {
     connectionInfo.plugin().setRemapKeys('0x0700e3>0x0700e0,0x0700e7>0x0700e4');
   }
 };
 
 /**
- * Called when the current session has been disconnected.
- *
- * @return {void} Nothing.
+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.handleDisconnected = function() {
+remoting.AppRemoting.prototype.onDisconnected_ = function() {
   base.dispose(this.connectedView_);
   this.connectedView_ = null;
 
   chrome.app.window.current().close();
 };
 
 /**
- * Called when the current session's connection has failed.
- *
- * @param {remoting.SessionConnector} connector
  * @param {!remoting.Error} error
- * @return {void} Nothing.
+ * @override {remoting.ApplicationInterface}
  */
-remoting.AppRemoting.prototype.handleConnectionFailed = function(
-    connector, error) {
-  this.handleError(error);
+remoting.AppRemoting.prototype.onConnectionFailed_ = function(error) {
+  this.onError_(error);
 };
 
-/** @return {Array<string>} */
+/**
+ * @param {!remoting.Error} error The error to be localized and displayed.
+ * @override {remoting.ApplicationInterface}
+ */
+remoting.AppRemoting.prototype.onError_ = function(error) {
+  console.error('Connection failed: ' + error.toString());
+  remoting.LoadingWindow.close();
+  remoting.MessageWindow.showErrorMessage(
+      chrome.i18n.getMessage(/*i18n-content*/'CONNECTION_FAILED'),
+      chrome.i18n.getMessage(error.getTag()));
+};
+
+
+/**
+ * @return {Array<string>}
+ * @override {remoting.ProtocolExtension}
+ */
 remoting.AppRemoting.prototype.getExtensionTypes = function() {
   return ['openURL', 'onWindowRemoved', 'onWindowAdded',
           'onAllWindowsMinimized', 'setKeyboardLayouts', 'pingResponse'];
 };
 
 /**
  * @param {function(string,string)} sendMessageToHost Callback to send a message
  *     to the host.
+ * @override {remoting.ProtocolExtension}
  */
 remoting.AppRemoting.prototype.startExtension = function(sendMessageToHost) {
 };
 
 /**
  * @param {string} type The message type.
  * @param {Object} message The parsed extension message data.
+ * @override {remoting.ProtocolExtension}
  */
 remoting.AppRemoting.prototype.onExtensionMessage = function(type, message) {
   switch (type) {
 
     case 'openURL':
       // URL requests from the hosted app are untrusted, so disallow anything
       // other than HTTP or HTTPS.
       var url = base.getStringAttr(message, 'url');
       if (url.indexOf('http:') != 0 && url.indexOf('https:') != 0) {
         console.error('Bad URL: ' + url);
@@ skipping 29 matching lines @@
       var then = base.getNumberAttr(message, 'timestamp');
       var now = new Date().getTime();
       this.contextMenu_.updateConnectionRTT(now - then);
       return true;
   }
 
   return false;
 };
 
 /**
- * Called when an error needs to be displayed to the user.
- *
- * @param {!remoting.Error} error The error to be localized and displayed.
- * @return {void} Nothing.
+ * @return {string}
+ * @private
  */
-remoting.AppRemoting.prototype.handleError = function(error) {
-  console.error('Connection failed: ' + error.toString());
-  remoting.LoadingWindow.close();
-  remoting.MessageWindow.showErrorMessage(
-      chrome.i18n.getMessage(/*i18n-content*/'CONNECTION_FAILED'),
-      chrome.i18n.getMessage(error.getTag()));
+remoting.AppRemoting.prototype.runApplicationUrl_ = function() {
+  return remoting.settings.APP_REMOTING_API_BASE_URL + '/applications/' +
+      remoting.settings.getAppRemotingApplicationId() + '/run';
 };
-
-/**
- * Close the loading window before exiting.
- */
-remoting.AppRemoting.prototype.handleExit = function() {
-  remoting.LoadingWindow.close();
-};