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

remoting/webapp/crd/js/desktop_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 desktop
  * remoting ("Chromoting" or CRD).
  */
 
 '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}
+ * @extends {remoting.Application}
  */
-remoting.DesktopRemoting = function(app) {
-  /**
-   * TODO(garykac): Remove this reference to the Application. It's only
-   * needed to get the current mode when reporting errors. So we should be
-   * able to refactor and remove this reference cycle.
-   *
-   * @private {remoting.Application}
-   */
-  this.app_ = app;
-  app.setDelegate(this);
+remoting.DesktopRemoting = function(appCapabilities) {
+  base.inherits(this, remoting.Application, appCapabilities);
 
   /**
    * Whether to refresh the JID and retry the connection if the current JID
    * is offline.
    *
    * @private {boolean}
    */
   this.refreshHostJidIfOffline_ = true;
 
   /** @private {remoting.DesktopConnectedView} */
   this.connectedView_ = null;
 
   remoting.desktopDelegateForTesting = this;
 };
 
 /**
- * Initialize the application and register all event handlers. After this
- * is called, the app is running and waiting for user events.
+ * Required for remoting.ApplicationInterface interface.

[Jamie, 2015/03/25 20:00:39]

I don't think you need this annotation on every method--it's implied by
@override (though it would be nice if the syntax was something like @override
{remoting.ApplicationInterface} to make it explicit).

[garykac, 2015/03/26 01:41:57]

@override {type} works, but the type isn't validated by jscompile. However, it
does look better and is more concise.

  *
- * @return {void} Nothing.
+ * @return {string} Application product name to be used in UI.
+ * @override
  */
-remoting.DesktopRemoting.prototype.init = function() {
+remoting.DesktopRemoting.prototype.getApplicationName = function() {
+  return chrome.i18n.getMessage(/*i18n-content*/'PRODUCT_NAME');
+};
+
+/**
+ * Required for remoting.ApplicationInterface interface.
+ *
+ * @param {!remoting.Error} error The failure reason.
+ * @override
+ */
+remoting.DesktopRemoting.prototype.signInFailed = function(error) {
+  remoting.showErrorMessage(error);
+};
+
+/**
+ * Required for remoting.ApplicationInterface interface.
+ *
+ * @override
+ */
+remoting.DesktopRemoting.prototype.initApplication = function() {
   remoting.initElementEventHandlers();
 
   if (base.isAppsV2()) {
     remoting.windowFrame = new remoting.WindowFrame(
         document.getElementById('title-bar'));
     remoting.optionsMenu = remoting.windowFrame.createOptionsMenu();
 
     var START_FULLSCREEN = 'start-fullscreen';
     remoting.fullscreen = new remoting.FullscreenAppsV2();
     remoting.fullscreen.addListener(function(isFullscreen) {
@@ skipping 52 matching lines @@
         document.getElementById('startup-mode-box-it2me').hidden = false;
       }
     };
     this.isWindowed_(onIsWindowed);
   }
 
   remoting.ClientPlugin.factory.preloadPlugin();
 };
 
 /**
- * Start the application. Once start() is called, the delegate can assume that
- * the user has consented to all permissions specified in the manifest.
+ * Required for remoting.ApplicationInterface interface.
  *
- * @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.DesktopRemoting.prototype.start = function(connector, token) {
+remoting.DesktopRemoting.prototype.startApplication = function(token) {
   remoting.identity.getEmail().then(
       function(/** string */ email) {
         document.getElementById('current-email').innerText = email;
         document.getElementById('get-started-it2me').disabled = false;
         document.getElementById('get-started-me2me').disabled = false;
       });
 };
 
 /**
- * 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.
- */
-remoting.DesktopRemoting.prototype.signInFailed = function(error) {
-  remoting.showErrorMessage(error);
-};
-
-/**
- * @return {string} Application product name to be used in UI.
- */
-remoting.DesktopRemoting.prototype.getApplicationName = function() {

[garykac, 2015/03/23 18:44:22]

These were moved earlier in the file so to match the order specified in the
ApplicationInterface (with getters and simple methods first).

-  return chrome.i18n.getMessage(/*i18n-content*/'PRODUCT_NAME');
-};
-
-/**
  * Called when a new session has been connected.
  *
  * @param {remoting.ConnectionInfo} connectionInfo
  * @return {void} Nothing.
  */
-remoting.DesktopRemoting.prototype.handleConnected = function(connectionInfo) {
+remoting.DesktopRemoting.prototype.onConnected = function(connectionInfo) {
+  remoting.Application.prototype.onConnected.call(this, connectionInfo);
+
   // Set the text on the buttons shown under the error message so that they are
   // easy to understand in the case where a successful connection failed, as
   // opposed to the case where a connection never succeeded.
   // TODO(garykac): Investigate to see if these need to be reverted to their
   // original values in the onDisconnected method.
   var button1 = document.getElementById('client-reconnect-button');
   l10n.localizeElementFromTag(button1, /*i18n-content*/'RECONNECT');
   button1.removeAttribute('autofocus');
   var button2 = document.getElementById('client-finished-me2me-button');
   l10n.localizeElementFromTag(button2, /*i18n-content*/'OK');
@@ skipping 12 matching lines @@
   this.connectedView_ = new remoting.DesktopConnectedView(
       document.getElementById('client-container'), connectionInfo);
 
   // By default, under ChromeOS, remap the right Control key to the right
   // Win / Cmd key.
   if (remoting.platformIsChromeOS()) {
     connectionInfo.plugin().setRemapKeys('0x0700e4>0x0700e7');
   }
 
   if (connectionInfo.mode() === remoting.DesktopConnectedView.Mode.ME2ME) {
-    var sessionConnector = remoting.app.getSessionConnector();
     if (remoting.app.hasCapability(remoting.ClientSession.Capability.CAST)) {
-      sessionConnector.registerProtocolExtension(
+      this.sessionConnector_.registerProtocolExtension(
           new remoting.CastExtensionHandler());
     }
-    sessionConnector.registerProtocolExtension(
+    this.sessionConnector_.registerProtocolExtension(
         new remoting.GnubbyAuthHandler());
   }
 
   if (remoting.pairingRequested) {
+    var that = this;
     /**
      * @param {string} clientId
      * @param {string} sharedSecret
      */
     var onPairingComplete = function(clientId, sharedSecret) {
-      var connector = remoting.app.getSessionConnector();
+      var connector = that.sessionConnector_;
       var host = remoting.hostList.getHostForId(connector.getHostId());
       host.options.pairingInfo.clientId = clientId;
       host.options.pairingInfo.sharedSecret = sharedSecret;
       host.options.save();
       connector.updatePairingInfo(clientId, sharedSecret);
     };
     // Use the platform name as a proxy for the local computer name.
     // TODO(jamiewalch): Use a descriptive name for the local computer, for
     // example, its Chrome Sync name.
     var clientName = '';
@@ skipping 11 matching lines @@
     }
     connectionInfo.session().requestPairing(clientName, onPairingComplete);
   }
 };
 
 /**
  * Called when the current session has been disconnected.
  *
  * @return {void} Nothing.
  */
-remoting.DesktopRemoting.prototype.handleDisconnected = function() {
+remoting.DesktopRemoting.prototype.onDisconnected = function() {
+  remoting.Application.prototype.onDisconnected.call(this);
+
   var mode = this.connectedView_.getMode();
   if (mode === remoting.DesktopConnectedView.Mode.IT2ME) {
     remoting.setMode(remoting.AppMode.CLIENT_SESSION_FINISHED_IT2ME);
   } else {
     remoting.setMode(remoting.AppMode.CLIENT_SESSION_FINISHED_ME2ME);
   }
   base.dispose(this.connectedView_);
   this.connectedView_ = null;
 };
 
 /**
  * Called when the current session's connection has failed.
  *
- * @param {remoting.SessionConnector} connector
  * @param {!remoting.Error} error
  * @return {void} Nothing.
  */
-remoting.DesktopRemoting.prototype.handleConnectionFailed = function(
-    connector, error) {
+remoting.DesktopRemoting.prototype.onConnectionFailed = function(error) {
+  remoting.Application.prototype.onConnectionFailed.call(this, error);
+
   var that = this;
   var onHostListRefresh = function(/** boolean */ success) {
     if (success) {
+      var connector = that.sessionConnector_;
       var host = remoting.hostList.getHostForId(connector.getHostId());
       if (host) {
         connector.retryConnectMe2Me(host);
         return;
       }
     }
-    that.handleError(error);
+    that.onError(error);
   };
 
-  var mode = this.app_.getSessionConnector().getConnectionMode();
+  var mode = this.sessionConnector_.getConnectionMode();
   if (error.hasTag(remoting.Error.Tag.HOST_IS_OFFLINE) &&
       mode === remoting.DesktopConnectedView.Mode.ME2ME &&
       this.refreshHostJidIfOffline_) {
     this.refreshHostJidIfOffline_ = false;
 
     // The plugin will be re-created when the host finished refreshing
     remoting.hostList.refresh(onHostListRefresh);
   } else {
-    this.handleError(error);
+    this.onError(error);
   }
 };
 
 /**
  * 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.
  */
-remoting.DesktopRemoting.prototype.handleError = function(error) {
+remoting.DesktopRemoting.prototype.onError = function(error) {
+  remoting.Application.prototype.onError.call(this, error);
+
   console.error('Connection failed: ' + error.toString());
   var mode = this.connectedView_ ? this.connectedView_.getMode()
-      : this.app_.getSessionConnector().getConnectionMode();
+      : this.sessionConnector_.getConnectionMode();
   base.dispose(this.connectedView_);
   this.connectedView_ = null;
 
   if (error.hasTag(remoting.Error.Tag.AUTHENTICATION_FAILED)) {
     remoting.setMode(remoting.AppMode.HOME);
     remoting.handleAuthFailureAndRelaunch();
     return;
   }
 
   // Reset the refresh flag so that the next connection will retry if needed.
   this.refreshHostJidIfOffline_ = true;
 
   var errorDiv = document.getElementById('connect-error-message');
   l10n.localizeElementFromTag(errorDiv, error.getTag());
 
   if (mode == remoting.DesktopConnectedView.Mode.IT2ME) {
     remoting.setMode(remoting.AppMode.CLIENT_CONNECT_FAILED_IT2ME);
   } else {
     remoting.setMode(remoting.AppMode.CLIENT_CONNECT_FAILED_ME2ME);
   }
 };
 
 /**
- * No cleanup required for desktop remoting.
- */
-remoting.DesktopRemoting.prototype.handleExit = function() {
-};
-
-/**
  * Determine whether or not the app is running in a window.
  * @param {function(boolean):void} callback Callback to receive whether or not
  *     the current tab is running in windowed mode.
  * @private
  */
 remoting.DesktopRemoting.prototype.isWindowed_ = function(callback) {
   /** @param {chrome.Window} win The current window. */
   var windowCallback = function(win) {
     callback(win.type == 'popup');
   };
@@ skipping 12 matching lines @@
   }
 }
 
 /**
  * If an IT2Me client or host is active then prompt the user before closing.
  * If a Me2Me client is active then don't bother, since closing the window is
  * the more intuitive way to end a Me2Me session, and re-connecting is easy.
  * @private
  */
 remoting.DesktopRemoting.prototype.promptClose_ = function() {
-  var sessionConnector = remoting.app.getSessionConnector();
+  var sessionConnector = this.sessionConnector_;
   if (sessionConnector &&
       sessionConnector.getConnectionMode() ==
           remoting.DesktopConnectedView.Mode.IT2ME) {
     switch (remoting.currentMode) {
       case remoting.AppMode.CLIENT_CONNECTING:
       case remoting.AppMode.HOST_WAITING_FOR_CODE:
       case remoting.AppMode.HOST_WAITING_FOR_CONNECTION:
       case remoting.AppMode.HOST_SHARED:
       case remoting.AppMode.IN_SESSION:
         return chrome.i18n.getMessage(/*i18n-content*/'CLOSE_PROMPT');
       default:
         return null;
     }
   }
 };
 
 /** @returns {remoting.DesktopConnectedView} */
 remoting.DesktopRemoting.prototype.getConnectedViewForTesting = function() {
   return this.connectedView_;
 };
-
-/**
- * Global instance of remoting.DesktopRemoting used for testing.
- * @type {remoting.DesktopRemoting}
- */
-remoting.desktopDelegateForTesting = null;

[garykac, 2015/03/23 18:44:22]

No need for this anymore. We can simply use remoting.app and cast it.