Interfaceify ClientPlugin in preparation for mocking it.

remoting/webapp/client_session.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.
 
 /**
  * @fileoverview
  * Class handling creation and teardown of a remoting client session.
  *
  * The ClientSession class controls lifetime of the client plugin
  * object and provides the plugin with the functionality it needs to
@@ skipping 216 matching lines @@
  * TODO(jamiewalch): crbug.com/252796: Remove this once crbug.com/240772 is
  * fixed.
  */
 remoting.ClientSession.prototype.updateScrollbarVisibility = function() {
   var needsVerticalScroll = false;
   var needsHorizontalScroll = false;
   if (!this.shrinkToFit_) {
     // Determine whether or not horizontal or vertical scrollbars are
     // required, taking into account their width.
     var clientArea = this.getClientArea_();
-    needsVerticalScroll = clientArea.height < this.plugin_.desktopHeight;
-    needsHorizontalScroll = clientArea.width < this.plugin_.desktopWidth;
+    needsVerticalScroll = clientArea.height < this.plugin_.getDesktopHeight();
+    needsHorizontalScroll = clientArea.width < this.plugin_.getDesktopWidth();
     var kScrollBarWidth = 16;
     if (needsHorizontalScroll && !needsVerticalScroll) {
       needsVerticalScroll =
-          clientArea.height - kScrollBarWidth < this.plugin_.desktopHeight;
+          clientArea.height - kScrollBarWidth < this.plugin_.getDesktopHeight();
     } else if (!needsHorizontalScroll && needsVerticalScroll) {
       needsHorizontalScroll =
-          clientArea.width - kScrollBarWidth < this.plugin_.desktopWidth;
+          clientArea.width - kScrollBarWidth < this.plugin_.getDesktopWidth();
     }
   }
 
   var scroller = document.getElementById('scroller');
   if (needsHorizontalScroll) {
     scroller.classList.remove('no-horizontal-scroll');
   } else {
     scroller.classList.add('no-horizontal-scroll');
   }
   if (needsVerticalScroll) {
@@ skipping 184 matching lines @@
 
 /**
  * Adds <embed> element to |container| and readies the sesion object.
  *
  * @param {function(string, string):boolean} onExtensionMessage The handler for
  *     protocol extension messages. Returns true if a message is recognized;
  *     false otherwise.
  */
 remoting.ClientSession.prototype.createPluginAndConnect =
     function(onExtensionMessage) {
-  this.plugin_ = new remoting.ClientPlugin(
+  this.plugin_ = remoting.ClientPlugin.factory.createPlugin(
       this.container_.querySelector('.client-plugin-container'),
       onExtensionMessage);
   remoting.HostSettings.load(this.hostId_,
                              this.onHostSettingsLoaded_.bind(this));
 };
 
 /**
  * @param {Object.<string>} options The current options for the host, or {}
  *     if this client has no saved settings for the host.
  * @private
@@ skipping 32 matching lines @@
   this.plugin_.element().addEventListener(
       'blur', this.callPluginLostFocus_, false);
   this.plugin_.element().focus();
 };
 
 /**
  * @param {remoting.Error} error
  */
 remoting.ClientSession.prototype.resetWithError_ = function(error) {
   this.signalStrategy_.setIncomingStanzaCallback(null);
-  this.plugin_.cleanup();
+  this.plugin_.dispose();
   this.plugin_ = null;
   this.error_ = error;
   this.setState_(remoting.ClientSession.State.FAILED);
 }
 
 /**
  * @param {boolean} initialized
  */
 remoting.ClientSession.prototype.onPluginInitialized_ = function(initialized) {
   if (!initialized) {
@@ skipping 36 matching lines @@
     this.video_.style.width = '0px';
     this.video_.style.height = '0px';
 
     var renderer = new remoting.MediaSourceRenderer(this.video_);
     this.plugin_.enableMediaSourceRendering(renderer);
     this.container_.classList.add('mediasource-rendering');
   } else {
     this.container_.classList.remove('mediasource-rendering');
   }
 
-  /** @param {string} msg The IQ stanza to send. */
-  this.plugin_.onOutgoingIqHandler = this.sendIq_.bind(this);
-  /** @param {string} msg The message to log. */
-  this.plugin_.onDebugMessageHandler = function(msg) {
-    console.log('plugin: ' + msg.trimRight());
-  };
+  this.plugin_.setOnOutgoingIqHandler(this.sendIq_.bind(this));
+  this.plugin_.setOnDebugMessageHandler(
+      /** @param {string} msg */
+      function(msg) {
+        console.log('plugin: ' + msg.trimRight());
+      });
 
-  this.plugin_.onConnectionStatusUpdateHandler =
-      this.onConnectionStatusUpdate_.bind(this);
-  this.plugin_.onConnectionReadyHandler = this.onConnectionReady_.bind(this);
-  this.plugin_.onDesktopSizeUpdateHandler =
-      this.onDesktopSizeChanged_.bind(this);
-  this.plugin_.onSetCapabilitiesHandler = this.onSetCapabilities_.bind(this);
-  this.plugin_.onGnubbyAuthHandler = this.processGnubbyAuthMessage_.bind(this);
-  this.plugin_.updateMouseCursorImage = this.updateMouseCursorImage_.bind(this);
-  this.plugin_.onCastExtensionHandler =
-      this.processCastExtensionMessage_.bind(this);
+  this.plugin_.setConnectionStatusUpdateHandler(
+      this.onConnectionStatusUpdate_.bind(this));
+  this.plugin_.setConnectionReadyHandler(this.onConnectionReady_.bind(this));
+  this.plugin_.setDesktopSizeUpdateHandler(
+      this.onDesktopSizeChanged_.bind(this));
+  this.plugin_.setCapabilitiesHandler(this.onSetCapabilities_.bind(this));
+  this.plugin_.setGnubbyAuthHandler(
+      this.processGnubbyAuthMessage_.bind(this));
+  this.plugin_.setMouseCursorHandler(this.updateMouseCursorImage_.bind(this));
+  this.plugin_.setCastExtensionHandler(
+      this.processCastExtensionMessage_.bind(this));
   this.initiateConnection_();
 };
 
 /**
  * Deletes the <embed> element from the container, without sending a
  * session_terminate request.  This is to be called when the session was
  * disconnected by the Host.
  *
  * @return {void} Nothing.
  */
 remoting.ClientSession.prototype.removePlugin = function() {
   if (this.plugin_) {
     this.plugin_.element().removeEventListener(
         'focus', this.callPluginGotFocus_, false);
     this.plugin_.element().removeEventListener(
         'blur', this.callPluginLostFocus_, false);
-    this.plugin_.cleanup();
+    this.plugin_.dispose();
     this.plugin_ = null;
   }
 
   // Delete event handlers that aren't relevent when not connected.
   this.fullScreenButton_.removeEventListener(
       'click', this.callToggleFullScreen_, false);
 
   // Leave full-screen mode, and stop listening for related events.
   var listener = this.callOnFullScreenChanged_;
   remoting.fullscreen.activate(
@@ skipping 306 matching lines @@
 remoting.ClientSession.prototype.getSharedSecret_ = function(callback) {
   /** @type remoting.ClientSession */
   var that = this;
   if (this.plugin_.hasFeature(remoting.ClientPlugin.Feature.THIRD_PARTY_AUTH)) {
     /** @type{function(string, string, string): void} */
     var fetchThirdPartyToken = function(tokenUrl, hostPublicKey, scope) {
       that.fetchThirdPartyToken_(
           tokenUrl, hostPublicKey, scope,
           that.plugin_.onThirdPartyTokenFetched.bind(that.plugin_));
     };
-    this.plugin_.fetchThirdPartyTokenHandler = fetchThirdPartyToken;
+    this.plugin_.setFetchThirdPartyTokenHandler(fetchThirdPartyToken);
   }
   if (this.accessCode_) {
     // Shared secret was already supplied before connecting (It2Me case).
     callback(this.accessCode_);
   } else if (this.plugin_.hasFeature(
       remoting.ClientPlugin.Feature.ASYNC_PIN)) {
     // Plugin supports asynchronously asking for the PIN.
     this.plugin_.useAsyncPinDialog();
     /** @param {boolean} pairingSupported */
     var fetchPin = function(pairingSupported) {
       that.fetchPin_(pairingSupported,
                      that.plugin_.onPinFetched.bind(that.plugin_));
     };
-    this.plugin_.fetchPinHandler = fetchPin;
+    this.plugin_.setFetchPinHandler(fetchPin);
     callback('');
   } else {
     // Clients that don't support asking for a PIN asynchronously also don't
     // support pairing, so request the PIN now without offering to remember it.
     this.fetchPin_(false, callback);
   }
 };
 
 /**
  * Callback that the plugin invokes to indicate that the connection
@@ skipping 195 matching lines @@
 
 /**
  * This is a callback that gets called when the plugin notifies us of a change
  * in the size of the remote desktop.
  *
  * @private
  * @return {void} Nothing.
  */
 remoting.ClientSession.prototype.onDesktopSizeChanged_ = function() {
   console.log('desktop size changed: ' +
-              this.plugin_.desktopWidth + 'x' +
-              this.plugin_.desktopHeight +' @ ' +
-              this.plugin_.desktopXDpi + 'x' +
-              this.plugin_.desktopYDpi + ' DPI');
+              this.plugin_.getDesktopWidth() + 'x' +
+              this.plugin_.getDesktopHeight() +' @ ' +
+              this.plugin_.getDesktopXDpi() + 'x' +
+              this.plugin_.getDesktopYDpi() + ' DPI');
   this.updateDimensions();
   this.updateScrollbarVisibility();
 };
 
 /**
  * Refreshes the plugin's dimensions, taking into account the sizes of the
  * remote desktop and client window, and the current scale-to-fit setting.
  *
  * @return {void} Nothing.
  */
 remoting.ClientSession.prototype.updateDimensions = function() {
-  if (this.plugin_.desktopWidth == 0 ||
-      this.plugin_.desktopHeight == 0) {
+  if (this.plugin_.getDesktopWidth() == 0 ||
+      this.plugin_.getDesktopHeight() == 0) {
     return;
   }
 
   var clientArea = this.getClientArea_();
-  var desktopWidth = this.plugin_.desktopWidth;
-  var desktopHeight = this.plugin_.desktopHeight;
+  var desktopWidth = this.plugin_.getDesktopWidth();
+  var desktopHeight = this.plugin_.getDesktopHeight();
 
   // When configured to display a host at its original size, we aim to display
   // it as close to its physical size as possible, without losing data:
   // - If client and host have matching DPI, render the host pixel-for-pixel.
   // - If the host has higher DPI then still render pixel-for-pixel.
   // - If the host has lower DPI then let Chrome up-scale it to natural size.
 
   // We specify the plugin dimensions in Density-Independent Pixels, so to
   // render pixel-for-pixel we need to down-scale the host dimensions by the
   // devicePixelRatio of the client. To match the host pixel density, we choose
   // an initial scale factor based on the client devicePixelRatio and host DPI.
 
   // Determine the effective device pixel ratio of the host, based on DPI.
-  var hostPixelRatioX = Math.ceil(this.plugin_.desktopXDpi / 96);
-  var hostPixelRatioY = Math.ceil(this.plugin_.desktopYDpi / 96);
+  var hostPixelRatioX = Math.ceil(this.plugin_.getDesktopXDpi() / 96);
+  var hostPixelRatioY = Math.ceil(this.plugin_.getDesktopYDpi() / 96);
   var hostPixelRatio = Math.min(hostPixelRatioX, hostPixelRatioY);
 
   // Down-scale by the smaller of the client and host ratios.
   var scale = 1.0 / Math.min(window.devicePixelRatio, hostPixelRatio);
 
   if (this.shrinkToFit_) {
     // Reduce the scale, if necessary, to fit the whole desktop in the window.
     var scaleFitWidth = Math.min(scale, 1.0 * clientArea.width / desktopWidth);
     var scaleFitHeight =
         Math.min(scale, 1.0 * clientArea.height / desktopHeight);
@@ skipping 411 matching lines @@
  * @param {string} data Contents of the extension message.
  * @return {boolean} True if the message was recognized, false otherwise.
  */
 remoting.ClientSession.prototype.handleExtensionMessage =
     function(type, data) {
   if (this.videoFrameRecorder_) {
     return this.videoFrameRecorder_.handleMessage(type, data);
   }
   return false;
 }