History Web UI: Use TestBrowserProxy

Bug: 1022212
Change-Id: I72a0ed7cf5d998199d720b5af1659e05082c0b22
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1938831
Commit-Queue: Rebekah Potter <rbpotter@chromium.org>
Reviewed-by: Demetrios Papadopoulos <dpapad@chromium.org>
Cr-Commit-Position: refs/heads/master@{#720680}

chrome/browser/resources/history/browser_service.js

@@ -109,11 +109,8 @@ cr.define('history', function() {
       chrome.send('metricsHandler:recordTime', [histogram, time]);
     }
 
-    /**
-     * @param {boolean} successful
-     * @private
-     */
-    resolveDelete_(successful) {
+    /** @param {boolean} successful */
+    resolveDelete(successful) {
       if (this.pendingDeleteItems_ == null ||
           this.pendingDeletePromise_ == null) {
         return;
@@ -171,12 +168,12 @@ cr.define('history', function() {
  * Called by the history backend when deletion was succesful.
  */
 function deleteComplete() {
-  history.BrowserService.getInstance().resolveDelete_(true);
+  history.BrowserService.getInstance().resolveDelete(true);
 }
 
 /**
  * Called by the history backend when the deletion failed.
  */
 function deleteFailed() {
-  history.BrowserService.getInstance().resolveDelete_(false);
+  history.BrowserService.getInstance().resolveDelete(false);
 }

chrome/test/data/webui/history/history_browsertest.js

@@ -102,6 +102,9 @@ HistoryListTest.prototype = {
   __proto__: HistoryBrowserTest.prototype,
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '//ui/webui/resources/js/promise_resolver.js',
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_list_test.js',
   ]),
 };
@@ -124,6 +127,8 @@ HistoryMetricsTest.prototype = {
   __proto__: HistoryBrowserTest.prototype,
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_metrics_test.js',
   ]),
 };
@@ -152,6 +157,8 @@ HistoryRoutingTest.prototype = {
   __proto__: HistoryBrowserTest.prototype,
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_routing_test.js',
   ]),
 };
@@ -200,6 +207,8 @@ HistorySyncedTabsTest.prototype = {
   __proto__: HistoryBrowserTest.prototype,
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_synced_tabs_test.js',
   ]),
 };
@@ -220,17 +229,19 @@ HistorySupervisedUserTest.prototype = {
   },
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_supervised_user_test.js',
   ]),
 };
 
 GEN('#if defined(OS_MACOSX)');
-GEN('#define MAYBE_AllTest DISABLED_AllTest');
+GEN('#define MAYBE_AllSupervised DISABLED_All');
 GEN('#else');
-GEN('#define MAYBE_AllTest AllTest');
+GEN('#define MAYBE_AllSupervised All');
 GEN('#endif');
 
-TEST_F('HistorySupervisedUserTest', 'MAYBE_AllTest', function() {
+TEST_F('HistorySupervisedUserTest', 'MAYBE_AllSupervised', function() {
   mocha.run();
 });
 
@@ -240,6 +251,8 @@ HistoryToolbarTest.prototype = {
   __proto__: HistoryBrowserTest.prototype,
 
   extraLibraries: HistoryBrowserTest.prototype.extraLibraries.concat([
+    '../test_browser_proxy.js',
+    'test_browser_service.js',
     'history_toolbar_test.js',
   ]),
 };

chrome/test/data/webui/history/history_list_test.js

@@ -6,11 +6,9 @@ suite('<history-list>', function() {
   let app;
   let element;
   let toolbar;
-  let TEST_HISTORY_RESULTS;
-  let ADDITIONAL_RESULTS;
+  let testService;
 
-  suiteSetup(function() {
-    TEST_HISTORY_RESULTS = [
+  const TEST_HISTORY_RESULTS = [
     createHistoryEntry('2016-03-15', 'https://www.google.com'),
     createHistoryEntry('2016-03-14 10:00', 'https://www.example.com'),
     createHistoryEntry('2016-03-14 9:00', 'https://www.google.com'),
@@ -18,16 +16,22 @@ suite('<history-list>', function() {
   ];
   TEST_HISTORY_RESULTS[2].starred = true;
 
-    ADDITIONAL_RESULTS = [
+  const ADDITIONAL_RESULTS = [
     createHistoryEntry('2016-03-13 10:00', 'https://en.wikipedia.org'),
     createHistoryEntry('2016-03-13 9:50', 'https://www.youtube.com'),
     createHistoryEntry('2016-03-11', 'https://www.google.com'),
     createHistoryEntry('2016-03-10', 'https://www.example.com')
   ];
-  });
 
   setup(function() {
-    app = replaceApp();
+    window.history.replaceState({}, '', '/');
+    PolymerTest.clearBody();
+    testService = new TestBrowserService();
+    history.BrowserService.instance_ = testService;
+
+    app = document.createElement('history-app');
+    document.body.appendChild(app);
+
     element = app.$.history;
     toolbar = app.$.toolbar;
     app.queryState_.incremental = true;
@@ -53,12 +57,12 @@ suite('<history-list>', function() {
           toolbar.deleteSelectedItems();
           return test_util.flushTasks();
         })
-        .then(() => new Promise(resolve => {
-                registerMessageCallback('removeVisits', this, resolve);
+        .then(function() {
           const dialog = element.$.dialog.get();
           assertTrue(dialog.open);
           element.$$('.action-button').click();
-              }))
+          return testService.whenCalled('deleteItems');
+        })
         .then(test_util.flushTasks)
         .then(function() {
           deleteComplete();
@@ -304,17 +308,15 @@ suite('<history-list>', function() {
     let items;
     return test_util.flushTasks()
         .then(function() {
-          return new Promise(resolve => {
-            registerMessageCallback('queryHistory', this, resolve);
           Polymer.dom.flush();
           items = polymerSelectAll(element, 'history-item');
           items[0].$['menu-button'].click();
           element.$.sharedMenu.get();
           element.$$('#menuMoreButton').click();
-          });
+          return testService.whenCalled('queryHistory');
         })
-        .then(function(info) {
-          assertEquals('www.google.com', info[0]);
+        .then(function(query) {
+          assertEquals('www.google.com', query);
           app.historyResult(
               createHistoryInfo('www.google.com'), TEST_HISTORY_RESULTS);
 
@@ -395,20 +397,20 @@ suite('<history-list>', function() {
           toolbar.deleteSelectedItems();
           return test_util.flushTasks();
         })
-        .then(() => new Promise(resolve => {
-                registerMessageCallback('removeVisits', this, resolve);
-
+        .then(function() {
+          testService.resetResolver('deleteItems');
           // Confirmation dialog should appear.
           assertTrue(dialog.open);
           element.$$('.action-button').click();
-              }))
+          return testService.whenCalled('deleteItems');
+        })
         .then(test_util.flushTasks)
         .then(function() {
           deleteComplete();
           return test_util.flushTasks();
         })
         .then(function() {
-          assertEquals(element.historyData_.length, 5);
+          assertEquals(5, element.historyData_.length);
           assertEquals(element.historyData_[0].dateRelativeDay, '2016-03-15');
           assertEquals(element.historyData_[2].dateRelativeDay, '2016-03-13');
           assertEquals(element.historyData_[4].dateRelativeDay, '2016-03-11');
@@ -433,15 +435,12 @@ suite('<history-list>', function() {
         .then(function() {
           Polymer.dom.flush();
           items = polymerSelectAll(element, 'history-item');
-          return new Promise(resolve => {
-            registerMessageCallback('removeVisits', this, resolve);
-
           items[1].$.checkbox.click();
           items[3].$.checkbox.click();
           items[1].$['menu-button'].click();
           element.$.sharedMenu.get();
           element.$$('#menuRemoveButton').click();
-          });
+          return testService.whenCalled('deleteItems');
         })
         .then(test_util.flushTasks)
         .then(function() {
@@ -501,11 +500,8 @@ suite('<history-list>', function() {
         })
         .then(function() {
           assertTrue(dialog.open);
-
-          return new Promise(resolve => {
-            registerMessageCallback('removeVisits', this, resolve);
           element.$$('.action-button').click();
-          });
+          return testService.whenCalled('deleteItems');
         })
         .then(function(toRemove) {
           assertEquals('https://www.example.com', toRemove[0].url);
@@ -559,21 +555,15 @@ suite('<history-list>', function() {
         .then(function() {
           Polymer.dom.flush();
           const items = polymerSelectAll(element, 'history-item');
-
-          return new Promise(resolve => {
-            registerMessageCallback('navigateToUrl', this, resolve);
           items[0].$.link.click();
-          });
+          return testService.whenCalled('navigateToUrl');
         })
-        .then(function(info) {
-          assertEquals(fileURL, info[0]);
+        .then(function(url) {
+          assertEquals(fileURL, url);
         });
   });
 
   teardown(function() {
-    registerMessageCallback('removeVisits', this, undefined);
-    registerMessageCallback('queryHistory', this, function() {});
-    registerMessageCallback('navigateToUrl', this, undefined);
     app.fire('change-query', {search: ''});
   });
 });

chrome/test/data/webui/history/history_metrics_test.js

@@ -12,54 +12,21 @@ const TestMetricsBrowserService = function() {
 };
 
 suite('Metrics', function() {
-  let service;
+  let testService;
   let app;
   let histogramMap;
   let actionMap;
 
   suiteSetup(function() {
     disableLinkClicks();
-
-    TestMetricsBrowserService.prototype = {
-      __proto__: history.BrowserService.prototype,
-
-      /** @override */
-      recordHistogram: function(histogram, value, max) {
-        assertTrue(value < max);
-
-        if (!(histogram in this.histogramMap)) {
-          this.histogramMap[histogram] = {};
-        }
-
-        if (!(value in this.histogramMap[histogram])) {
-          this.histogramMap[histogram][value] = 0;
-        }
-
-        this.histogramMap[histogram][value]++;
-      },
-
-      /** @override */
-      recordAction: function(action) {
-        if (!(action in this.actionMap)) {
-          this.actionMap[action] = 0;
-        }
-
-        this.actionMap[action]++;
-      },
-
-      /** @override */
-      deleteItems: function() {
-        return test_util.flushTasks();
-      }
-    };
   });
 
   setup(function() {
-    history.BrowserService.instance_ = new TestMetricsBrowserService();
-    service = history.BrowserService.getInstance();
+    history.BrowserService.instance_ = new TestBrowserService();
+    testService = history.BrowserService.getInstance();
 
-    actionMap = service.actionMap;
-    histogramMap = service.histogramMap;
+    actionMap = testService.actionMap;
+    histogramMap = testService.histogramMap;
 
     app = replaceApp();
     updateSignInState(false);
@@ -158,6 +125,10 @@ suite('Metrics', function() {
         })
         .then(() => {
           MockInteractions.tap(app.$.history.$$('#menuRemoveButton'));
+          return testService.whenCalled('deleteItems');
+        })
+        .then(() => {
+          deleteComplete();
           return test_util.flushTasks();
         })
         .then(() => {

chrome/test/data/webui/history/history_routing_test.js

@@ -91,30 +91,33 @@ cr.define('history.history_routing_test_with_query_param', function() {
       let app;
       let toolbar;
       let expectedQuery;
+      let testService;
 
       suiteSetup(function() {
+        testService = new TestBrowserService();
+        history.BrowserService.instance_ = testService;
         app = $('history-app');
         toolbar = app.$['toolbar'];
         expectedQuery = 'query';
       });
 
-      test('search initiated on load', function(done) {
+      test('search initiated on load', function() {
         const verifyFunction = function(info) {
           assertEquals(expectedQuery, info[0]);
-          test_util.flushTasks().then(function() {
+          return test_util.flushTasks().then(function() {
             assertEquals(
                 expectedQuery,
                 toolbar.$['main-toolbar'].getSearchField().getValue());
-            done();
           });
         };
 
         if (window.historyQueryInfo) {
-          verifyFunction(window.historyQueryInfo);
-          return;
+          return verifyFunction(window.historyQueryInfo);
+        } else {
+          return testService.whenCalled('queryHistory').then(query => {
+            return verifyFunction([query]);
+          });
         }
-
-        registerMessageCallback('queryHistory', this, verifyFunction);
       });
     });
   }

chrome/test/data/webui/history/history_supervised_user_test.js

@@ -6,15 +6,18 @@ suite('history-list supervised-user', function() {
   let app;
   let historyList;
   let toolbar;
-  let TEST_HISTORY_RESULTS;
-
-  suiteSetup(function() {
-    TEST_HISTORY_RESULTS =
+  let testService;
+  const TEST_HISTORY_RESULTS =
       [createHistoryEntry('2016-03-15', 'https://www.google.com')];
-  });
 
   setup(function() {
-    app = replaceApp();
+    PolymerTest.clearBody();
+    testService = new TestBrowserService();
+    history.BrowserService.instance_ = testService;
+
+    app = document.createElement('history-app');
+    document.body.appendChild(app);
+
     historyList = app.$.history;
     toolbar = app.$.toolbar;
     app.historyResult(createHistoryInfo(), TEST_HISTORY_RESULTS);
@@ -32,12 +35,9 @@ suite('history-list supervised-user', function() {
 
   test('deletion disabled for supervised user', function() {
     // Make sure that removeVisits is not being called.
-    registerMessageCallback('removeVisits', this, function(toBeRemoved) {
-      assertNotReached();
-    });
-
     historyList.historyData_[0].selected = true;
     toolbar.deleteSelectedItems();
+    assertEquals(0, testService.getCallCount('deleteItems'));
   });
 
   test('remove history menu button disabled', function() {

chrome/test/data/webui/history/history_synced_tabs_test.js

@@ -18,19 +18,25 @@ function assertNoSyncedTabsMessageShown(manager, stringID) {
 
 suite('<history-synced-device-manager>', function() {
   let element;
+  let testService;
 
   const setForeignSessions = function(sessions) {
     element.sessionList = sessions;
   };
 
   setup(function() {
+    PolymerTest.clearBody();
+    window.history.replaceState({}, '', '/');
+    testService = new TestBrowserService();
+    history.BrowserService.instance_ = testService;
+
     element = document.createElement('history-synced-device-manager');
     // |signInState| is generally set after |searchTerm| in Polymer 2. Set in
     // the same order in tests, in order to catch regressions like
     // https://crbug.com/915641.
     element.searchTerm = '';
     element.signInState = true;
-    replaceBody(element);
+    document.body.appendChild(element);
   });
 
   test('single card, single window', function() {
@@ -169,7 +175,7 @@ suite('<history-synced-device-manager>', function() {
         });
   });
 
-  test('delete a session', function(done) {
+  test('delete a session', function() {
     const sessionList = [
       createSession('Nexus 5', [createWindow(['http://www.example.com'])]),
       createSession('Pixel C', [createWindow(['http://www.badssl.com'])]),
@@ -177,7 +183,7 @@ suite('<history-synced-device-manager>', function() {
 
     setForeignSessions(sessionList);
 
-    test_util.flushTasks()
+    return test_util.flushTasks()
         .then(function() {
           const cards = getCards(element);
           assertEquals(2, cards.length);
@@ -186,21 +192,21 @@ suite('<history-synced-device-manager>', function() {
           return test_util.flushTasks();
         })
         .then(function() {
-          registerMessageCallback('deleteForeignSession', this, function(args) {
-            assertEquals('Nexus 5', args[0]);
+          MockInteractions.tap(element.$$('#menuDeleteButton'));
+          return testService.whenCalled('deleteForeignSession');
+        })
+        .then(args => {
+          assertEquals('Nexus 5', args);
 
           // Simulate deleting the first device.
           setForeignSessions([sessionList[1]]);
 
-            test_util.flushTasks().then(function() {
+          return test_util.flushTasks();
+        })
+        .then(function() {
           cards = getCards(element);
           assertEquals(1, cards.length);
           assertEquals('http://www.badssl.com', cards[0].tabs[0].title);
-              done();
-            });
-          });
-
-          MockInteractions.tap(element.$$('#menuDeleteButton'));
         });
   });
 
@@ -227,25 +233,24 @@ suite('<history-synced-device-manager>', function() {
         });
   });
 
-  test('click synced tab', function(done) {
+  test('click synced tab', function() {
     setForeignSessions(
         [createSession('Chromebook', [createWindow(['https://example.com'])])]);
-
-    registerMessageCallback('openForeignSession', this, function(args) {
-      assertEquals('Chromebook', args[0], 'sessionTag is correct');
-      assertEquals('123', args[1], 'windowId is correct');
-      assertEquals('456', args[2], 'tabId is correct');
-      assertFalse(args[4], 'altKey is defined');
-      assertFalse(args[5], 'ctrlKey is defined');
-      assertFalse(args[6], 'metaKey is defined');
-      assertFalse(args[7], 'shiftKey is defined');
-      done();
-    });
-
-    test_util.flushTasks().then(function() {
+    return test_util.flushTasks()
+        .then(function() {
           const cards = getCards(element);
           const anchor = cards[0].root.querySelector('a');
           MockInteractions.tap(anchor);
+          return testService.whenCalled('openForeignSessionTab');
+        })
+        .then(args => {
+          assertEquals('Chromebook', args.sessionTag, 'sessionTag is correct');
+          assertEquals('123', args.windowId, 'windowId is correct');
+          assertEquals(456, args.tabId, 'tabId is correct');
+          assertFalse(args.e.altKey, 'altKey is defined');
+          assertFalse(args.e.ctrlKey, 'ctrlKey is defined');
+          assertFalse(args.e.metaKey, 'metaKey is defined');
+          assertFalse(args.e.shiftKey, 'shiftKey is defined');
         });
   });
 
@@ -343,9 +348,4 @@ suite('<history-synced-device-manager>', function() {
           assertEquals(0, cards.length);
         });
   });
-
-  teardown(function() {
-    registerMessageCallback('openForeignSession', this, undefined);
-    registerMessageCallback('deleteForeignSession', this, undefined);
-  });
 });

chrome/test/data/webui/history/history_toolbar_test.js

@@ -6,15 +6,17 @@ suite('history-toolbar', function() {
   let app;
   let element;
   let toolbar;
-  let TEST_HISTORY_RESULTS;
-
-  suiteSetup(function() {
-    TEST_HISTORY_RESULTS =
+  let testService;
+  const TEST_HISTORY_RESULTS =
       [createHistoryEntry('2016-03-15', 'https://google.com')];
-  });
 
   setup(function() {
-    app = replaceApp();
+    PolymerTest.clearBody();
+    testService = new TestBrowserService();
+    history.BrowserService.instance_ = testService;
+
+    app = document.createElement('history-app');
+    document.body.appendChild(app);
     element = app.$.history;
     toolbar = app.$.toolbar;
     return test_util.flushTasks();
@@ -44,29 +46,25 @@ suite('history-toolbar', function() {
     });
   });
 
-  test('search term gathered correctly from toolbar', function(done) {
+  test('search term gathered correctly from toolbar', function() {
     app.queryState_.queryingDisabled = false;
-    registerMessageCallback('queryHistory', this, function(info) {
-      assertEquals('Test', info[0]);
+    toolbar.$$('cr-toolbar').fire('search-changed', 'Test');
+    return testService.whenCalled('queryHistory').then(query => {
+      assertEquals('Test', query);
       app.historyResult(createHistoryInfo(), TEST_HISTORY_RESULTS);
-      done();
     });
-
-    toolbar.$$('cr-toolbar').fire('search-changed', 'Test');
   });
 
-  test('spinner is active on search', function(done) {
+  test('spinner is active on search', function() {
     app.queryState_.queryingDisabled = false;
-    registerMessageCallback('queryHistory', this, function(info) {
-      test_util.flushTasks().then(function() {
+    toolbar.$$('cr-toolbar').fire('search-changed', 'Test2');
+    return testService.whenCalled('queryHistory')
+        .then(test_util.flushTasks)
+        .then(() => {
           assertTrue(toolbar.spinnerActive);
           app.historyResult(createHistoryInfo(), TEST_HISTORY_RESULTS);
           assertFalse(toolbar.spinnerActive);
-        done();
-      });
         });
-
-    toolbar.$$('cr-toolbar').fire('search-changed', 'Test2');
   });
 
   test('menu promo hides when drawer is opened', function() {
@@ -76,8 +74,4 @@ suite('history-toolbar', function() {
     MockInteractions.tap(toolbar.$['main-toolbar'].$$('#menuButton'));
     assertFalse(app.showMenuPromo_);
   });
-
-  teardown(function() {
-    registerMessageCallback('queryHistory', this, function() {});
-  });
 });

chrome/test/data/webui/history/test_browser_service.js

+// Copyright 2019 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.
+
+class TestBrowserService extends TestBrowserProxy {
+  constructor() {
+    super([
+      'deleteForeignSession',
+      'deleteItems',
+      'navigateToUrl',
+      'openForeignSessionTab',
+      'recordHistogram',
+      'queryHistory',
+    ]);
+    this.histogramMap = {};
+    this.actionMap = {};
+    this.pendingDeletePromise_ = null;
+    this.deleted_ = null;
+  }
+
+  /** @override */
+  deleteForeignSession(sessionTag) {
+    this.methodCalled('deleteForeignSession', sessionTag);
+  }
+
+  /** @override */
+  deleteItems(items) {
+    this.deleted_ = items;
+    this.pendingDeletePromise_ = new PromiseResolver();
+    this.methodCalled('deleteItems', items.map(item => {
+      return {
+        url: item.url,
+        timestamps: item.allTimestamps,
+      };
+    }));
+
+    return this.pendingDeletePromise_.promise;
+  }
+
+  /** @override */
+  historyLoaded() {}
+
+  /** @override */
+  menuPromoShown() {}
+
+  /** @override */
+  navigateToUrl(url, target, e) {
+    this.methodCalled('navigateToUrl', url);
+  }
+
+  /** @override */
+  openClearBrowsingData() {}
+
+  /** @override */
+  openForeignSessionAllTabs() {}
+
+  /** @override */
+  openForeignSessionTab(sessionTag, windowId, tabId, e) {
+    this.methodCalled('openForeignSessionTab', {
+      sessionTag: sessionTag,
+      windowId: windowId,
+      tabId: tabId,
+      e: e,
+    });
+  }
+
+  /** @override */
+  otherDevicesInitialized() {}
+
+  /** @override */
+  queryHistory(searchTerm) {
+    this.methodCalled('queryHistory', searchTerm);
+  }
+
+  /** @override */
+  queryHistoryContinuation() {}
+
+  /** @override */
+  recordAction(action) {
+    if (!(action in this.actionMap)) {
+      this.actionMap[action] = 0;
+    }
+
+    this.actionMap[action]++;
+  }
+
+  /** @override */
+  recordHistogram(histogram, value, max) {
+    assertTrue(value <= max);
+
+    if (!(histogram in this.histogramMap)) {
+      this.histogramMap[histogram] = {};
+    }
+
+    if (!(value in this.histogramMap[histogram])) {
+      this.histogramMap[histogram][value] = 0;
+    }
+
+    this.histogramMap[histogram][value]++;
+    this.methodCalled('recordHistogram');
+  }
+
+  /** @override */
+  recordTime() {}
+
+  /** @override */
+  removeBookmark() {}
+
+  /** @override */
+  resolveDelete(successful) {
+    if (successful) {
+      this.pendingDeletePromise_.resolve(this.deleted_);
+    } else {
+      this.pendingDeletePromise_.reject(this.deleted_);
+    }
+  }
+}