CRD Viewport Management refactor

remoting/webapp/browser_test/bump_scroll_browser_test.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
  * @suppress {checkTypes}
  * Browser test for the scenario below:
  * 1. Enter full-screen mode
  * 2. Move the mouse to each edge; verify that the desktop bump-scrolls.
  */
 
 'use strict';
 
 /** @constructor */
-browserTest.FakeDesktopConnectedView = function() {
+browserTest.FakeDesktopViewport = function() {
   this.pluginPosition = {
     top: 0,
     left: 0
   };
-  this.defineEvents(Object.keys(remoting.DesktopConnectedView.Events));
+  this.bumpScroller = new base.EventSourceImpl();
+  this.bumpScroller.defineEvents(Object.keys(remoting.BumpScroller.Events));
 };
 
-base.extend(browserTest.FakeDesktopConnectedView, base.EventSourceImpl);
-
-browserTest.FakeDesktopConnectedView.prototype.getPluginPositionForTesting =
+browserTest.FakeDesktopViewport.prototype.getPluginPositionForTesting =
     function() {
   return this.pluginPosition;
 };
 
+browserTest.FakeDesktopViewport.prototype.getBumpScrollerForTesting =
+    function() {
+  return this.bumpScroller;
+};
+
+browserTest.FakeDesktopViewport.prototype.raiseEvent =
+    function() {
+  return this.bumpScroller.raiseEvent.apply(this.bumpScroller, arguments);
+};
+
 
 /** @constructor */
 browserTest.Bump_Scroll = function() {
   // To aviod dependencies on the actual host desktop size, we simulate a
   // desktop larger or smaller than the client window. The exact value is
   // arbitrary, but must be positive.
   this.kHostDesktopSizeDelta = 10;
 };
 
 browserTest.Bump_Scroll.prototype.run = function(data) {
@@ skipping 31 matching lines @@
       return browserTest.pass(value);
     },
     function(error) {
       browserTest.disconnect();
       return browserTest.fail(error);
     }
   );
 };
 
 browserTest.Bump_Scroll.prototype.noScrollWindowed = function() {
-  remoting.desktopConnectedView.pluginWidthForBumpScrollTesting =
+  var viewport = remoting.desktopConnectedView.getViewportForTesting();
+  viewport.pluginWidthForBumpScrollTesting =
       window.innerWidth + this.kHostDesktopSizeDelta;
-  remoting.desktopConnectedView.pluginHeightForBumpScrollTesting =
+  viewport.pluginHeightForBumpScrollTesting =
       window.innerHeight + this.kHostDesktopSizeDelta;
   this.moveMouseTo(0, 0);
   return this.verifyScroll(undefined, undefined);
 };
 
 browserTest.Bump_Scroll.prototype.noScrollSmaller = function() {
-  remoting.desktopConnectedView.pluginWidthForBumpScrollTesting =
+  var viewport = remoting.desktopConnectedView.getViewportForTesting();
+  viewport.pluginWidthForBumpScrollTesting =
       window.innerWidth - this.kHostDesktopSizeDelta;
-  remoting.desktopConnectedView.pluginHeightForBumpScrollTesting =
+  viewport.pluginHeightForBumpScrollTesting =
       window.innerHeight - this.kHostDesktopSizeDelta;
   this.moveMouseTo(0, 0);
   return this.verifyScroll(undefined, undefined);
 };
 
 browserTest.Bump_Scroll.prototype.scrollDirection =
     function(widthFraction, heightFraction) {
-  remoting.desktopConnectedView.pluginWidthForBumpScrollTesting =
+  var viewport = remoting.desktopConnectedView.getViewportForTesting();
+  viewport.pluginWidthForBumpScrollTesting =
       screen.width + this.kHostDesktopSizeDelta;
-  remoting.desktopConnectedView.pluginHeightForBumpScrollTesting =
+  viewport.pluginHeightForBumpScrollTesting =
       screen.height + this.kHostDesktopSizeDelta;
   var expectedTop = heightFraction == 0.0 ? 0 :
                     heightFraction == 1.0 ? -this.kHostDesktopSizeDelta :
                     undefined;
   var expectedLeft = widthFraction == 0.0 ? 0 :
                      widthFraction == 1.0 ? -this.kHostDesktopSizeDelta :
                      undefined;
   var result = this.verifyScroll(expectedTop, expectedLeft);
   this.moveMouseTo(widthFraction * screen.width,
                    heightFraction * screen.height);
@@ skipping 35 matching lines @@
   event.initMouseEvent('mousemove',
                        e.bubbles, e.cancelable, e.view, e.detail,
                        e.screenX, e.screenY, e.clientX, e.clientY,
                        e.ctrlKey, e.altKey, e.shiftKey, e.metaKey,
                        e.button, document.documentElement);
   document.documentElement.dispatchEvent(event);
 };
 
 // verifyScroll is complicated enough to warrant a test
 browserTest.Bump_Scroll.prototype.testVerifyScroll = function() {
-  var STARTED = remoting.DesktopConnectedView.Events.bumpScrollStarted;
-  var STOPPED = remoting.DesktopConnectedView.Events.bumpScrollStopped;
-  var fakeSession = new browserTest.FakeDesktopConnectedView;
+  var STARTED = remoting.BumpScroller.Events.bumpScrollStarted;
+  var STOPPED = remoting.BumpScroller.Events.bumpScrollStopped;
+  var fakeViewport = new browserTest.FakeDesktopViewport;
   var that = this;
 
   // No events raised (e.g. windowed mode).
-  var result = this.verifyScroll(undefined, undefined, fakeSession)
+  var result = this.verifyScroll(undefined, undefined, fakeViewport)
 
   .then(function() {
     // Start and end events raised, but no scrolling (e.g. full-screen mode
     // with host desktop <= window size).
-    fakeSession = new browserTest.FakeDesktopConnectedView;
-    var result = that.verifyScroll(undefined, undefined, fakeSession);
-    fakeSession.raiseEvent(STARTED, {});
-    fakeSession.raiseEvent(STOPPED, {});
+    fakeViewport = new browserTest.FakeDesktopViewport;
+    var result = that.verifyScroll(undefined, undefined, fakeViewport);
+    fakeViewport.raiseEvent(STARTED, {});
+    fakeViewport.raiseEvent(STOPPED, {});
     return result;
 
   }).then(function() {
     // Start and end events raised, with incorrect scrolling.
-    fakeSession = new browserTest.FakeDesktopConnectedView;
+    fakeViewport = new browserTest.FakeDesktopViewport;
     var result = base.Promise.negate(
-        that.verifyScroll(2, 2, fakeSession));
-    fakeSession.raiseEvent(STARTED, {});
-    fakeSession.pluginPosition.top = 1;
-    fakeSession.pluginPosition.left = 1;
-    fakeSession.raiseEvent(STOPPED, {});
+        that.verifyScroll(2, 2, fakeViewport));
+    fakeViewport.raiseEvent(STARTED, {});
+    fakeViewport.pluginPosition.top = 1;
+    fakeViewport.pluginPosition.left = 1;
+    fakeViewport.raiseEvent(STOPPED, {});
     return result;
 
   }).then(function() {
     // Start event raised, but not end event.
-    fakeSession = new browserTest.FakeDesktopConnectedView;
+    fakeViewport = new browserTest.FakeDesktopViewport;
     var result = base.Promise.negate(
-        that.verifyScroll(2, 2, fakeSession));
-    fakeSession.raiseEvent(STARTED, {});
-    fakeSession.pluginPosition.top = 2;
-    fakeSession.pluginPosition.left = 2;
+        that.verifyScroll(2, 2, fakeViewport));
+    fakeViewport.raiseEvent(STARTED, {});
+    fakeViewport.pluginPosition.top = 2;
+    fakeViewport.pluginPosition.left = 2;
     return result;
 
   }).then(function() {
     // Start and end events raised, with correct scrolling.
-    fakeSession = new browserTest.FakeDesktopConnectedView;
-    var result = that.verifyScroll(2, 2, fakeSession);
-    fakeSession.raiseEvent(STARTED, {});
-    fakeSession.pluginPosition.top = 2;
-    fakeSession.pluginPosition.left = 2;
-    fakeSession.raiseEvent(STOPPED, {});
+    fakeViewport = new browserTest.FakeDesktopViewport;
+    var result = that.verifyScroll(2, 2, fakeViewport);
+    fakeViewport.raiseEvent(STARTED, {});
+    fakeViewport.pluginPosition.top = 2;
+    fakeViewport.pluginPosition.left = 2;
+    fakeViewport.raiseEvent(STOPPED, {});
     return result;
   });
 
   return result;
 };
 
 /**
  * Verify that a bump scroll operation takes place and that the top-left corner
  * of the plugin is as expected when it completes.
  * @param {number|undefined} expectedTop The expected vertical position of the
  *    plugin, or undefined if it is not expected to change.
  * @param {number|undefined} expectedLeft The expected horizontal position of
  *    the plugin, or undefined if it is not expected to change.
- * @param {browserTest.FakeDesktopConnectedView=} opt_desktopConnectedView
- *     DesktopConnectedView fake, for testing.
+ * @param {browserTest.FakeDesktopViewport=} opt_desktopViewport
+ *     DesktopViewport fake, for testing.
  */
 browserTest.Bump_Scroll.prototype.verifyScroll =
-    function (expectedTop, expectedLeft, opt_desktopConnectedView) {
-  var desktopConnectedView = opt_desktopConnectedView ||
-      remoting.desktopConnectedView;
-  base.debug.assert(desktopConnectedView != null);
-  var STARTED = remoting.DesktopConnectedView.Events.bumpScrollStarted;
-  var STOPPED = remoting.DesktopConnectedView.Events.bumpScrollStopped;
+    function (expectedTop, expectedLeft, opt_desktopViewport) {
+  var desktopViewport = opt_desktopViewport ||
+      remoting.desktopConnectedView.getViewportForTesting();
+  base.debug.assert(desktopViewport != null);
+  var STARTED = remoting.BumpScroller.Events.bumpScrollStarted;
+  var STOPPED = remoting.BumpScroller.Events.bumpScrollStopped;
 
-  var initialPosition = desktopConnectedView.getPluginPositionForTesting();
+  var initialPosition = desktopViewport.getPluginPositionForTesting();
   var initialTop = initialPosition.top;
   var initialLeft = initialPosition.left;
 
   var verifyPluginPosition = function() {
-    var position = desktopConnectedView.getPluginPositionForTesting();
+    var position = desktopViewport.getPluginPositionForTesting();
     if (expectedLeft === undefined) {
       expectedLeft = initialLeft;
     }
     if (expectedTop === undefined) {
       expectedTop = initialTop;
     }
     if (position.top != expectedTop || position.left != expectedLeft) {
       return Promise.reject(
           new Error('No or incorrect scroll detected: (' +
                     position.left + ',' + position.top + ' instead of ' +
                     expectedLeft + ',' + expectedTop + ')'));
     } else {
       return Promise.resolve();
     }
   };
 
-  var started = browserTest.expectEvent(desktopConnectedView, STARTED, 1000);
-  var stopped = browserTest.expectEvent(desktopConnectedView, STOPPED, 5000);
-  return started.then(function() {
-    return stopped.then(function() {
-      return verifyPluginPosition();
-    });
+  var bumpScroller = desktopViewport.getBumpScrollerForTesting();
+  var started = browserTest.expectEvent(bumpScroller, STARTED, 1000);
+  var stopped = browserTest.expectEvent(bumpScroller, STOPPED, 5000);
+  return Promise.all([started, stopped]).then(function() {

[Jamie, 2015/02/18 00:33:10]

Promise.all is not order-dependent, right? So I think this change introduces the
possibility of false-positive if STOPPED fires before STARTED. Since it doesn't
simplify the code significantly, I'd prefer to leave it as it was.

[kelvinp, 2015/02/20 23:24:16]

Done.

+    return verifyPluginPosition();
   }, function() {
     // If no started event is raised, the test might still pass if it asserted
     // no scrolling.
-    if (expectedTop == undefined && expectedLeft == undefined) {
+    if (expectedTop === undefined && expectedLeft === undefined) {
       return Promise.resolve();
     } else {
       return Promise.reject(
           new Error('Scroll expected but no start event fired.'));
     }
   });
 };