Print Preview: change getPreview to cr.sendWithPromise

chrome/test/data/webui/print_preview/print_preview_tests.js

 // Copyright 2016 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.
 
 cr.define('print_preview_test', function() {
   /**
    * Index of the "Save as PDF" printer.
    * @type {number}
    * @const
    */
@@ skipping 256 matching lines @@
       CloudPrintInterfaceStub.prototype = {
         __proto__: cr.EventTarget.prototype,
         search: function(isRecent) {}
       };
       var oldCpInterfaceEventType = cloudprint.CloudPrintInterfaceEventType;
       cloudprint.CloudPrintInterface = CloudPrintInterfaceStub;
       cloudprint.CloudPrintInterfaceEventType = oldCpInterfaceEventType;
 
       print_preview.PreviewArea.prototype.checkPluginCompatibility_ =
           function() {
-        return false;
+        return true;
       };
     });
 
     setup(function() {
       initialSettings = new print_preview.NativeInitialSettings(
         false /*isInKioskAutoPrintMode*/,
         false /*isInAppKioskMode*/,
         ',' /*thousandsDelimeter*/,
         '.' /*decimalDelimeter*/,
         1 /*unitType*/,
         true /*isDocumentModifiable*/,
         'title' /*documentTitle*/,
         true /*documentHasSelection*/,
         false /*selectionOnly*/,
         'FooDevice' /*systemDefaultDestinationId*/,
         null /*serializedAppStateStr*/,
         null /*serializedDefaultDestinationSelectionRulesStr*/);
 
       localDestinationInfos = [
         { printerName: 'FooName', deviceName: 'FooDevice' },
         { printerName: 'BarName', deviceName: 'BarDevice' },
       ];
 
       nativeLayer = new print_preview.NativeLayerStub();
       print_preview.NativeLayer.setInstance(nativeLayer);
       printPreview = new print_preview.PrintPreview();
       previewArea = printPreview.getPreviewArea();
+      previewArea.setIsBrowserTest(true);
     });
 
     // Test some basic assumptions about the print preview WebUI.
     test('PrinterList', function() {
       return setupSettingsAndDestinationsWithCapabilities().then(function() {
         var recentList =
             $('destination-search').querySelector('.recent-list ul');
         var localList =
             $('destination-search').querySelector('.local-list ul');
         assertNotEquals(null, recentList);
@@ skipping 757 matching lines @@
         // Now it should be visible.
         checkSectionVisible(otherOptions, true);
         expectTrue(otherOptions.querySelector('#duplex-container').hidden);
 
         return whenAnimationDone('more-settings');
       });
     });
 
     // Test that changing the selected printer updates the preview.
     test('PrinterChangeUpdatesPreview', function() {
-      return setupSettingsAndDestinationsWithCapabilities().then(function() {
-        var previewGenerator = mock(print_preview.PreviewGenerator);
-        previewArea.previewGenerator_ = previewGenerator.proxy();
-
-        // The number of settings that can change due to a change in the
-        // destination that will therefore dispatch ticket item change events.
-        previewGenerator.expects(exactly(9)).requestPreview();
+      return Promise.all([
+          setupSettingsAndDestinationsWithCapabilities(),
+          nativeLayer.whenCalled('getPreview'),
+      ]).then(function(args) {
+        expectEquals(0, args[1].requestId);
+        expectEquals('FooDevice', args[1].destination.id);
+        nativeLayer.resetResolver('getPrinterCapabilities');
+        nativeLayer.resetResolver('getPreview');
 
         // Setup capabilities for BarDevice.
         var device = getCddTemplate('BarDevice');
         device.capabilities.printer.color = {
           'option': [
             {'is_default': true, 'type': 'STANDARD_MONOCHROME'}
           ]
         };
         nativeLayer.setLocalDestinationCapabilities(device);
-
         // Select BarDevice
         var barDestination =
             printPreview.destinationStore_.destinations().find(
                 function(d) {
                   return d.id == 'BarDevice';
                 });
         printPreview.destinationStore_.selectDestination(barDestination);
-        return nativeLayer.whenCalled('getPrinterCapabilities', 'BarDevice');
-      }).then(function(){
-        return whenAnimationDone('more-settings');
+        return Promise.all([
+            nativeLayer.whenCalled('getPrinterCapabilities'),
+            nativeLayer.whenCalled('getPreview'),
+        ]);
+      }).then(function(args) {
+        expectEquals(1, args[1].requestId);
+        expectEquals('BarDevice', args[1].destination.id);
       });
     });
 
     // Test that error message is displayed when plugin doesn't exist.
     test('NoPDFPluginErrorMessage', function() {
+      previewArea.checkPluginCompatibility_ = function() {
+        return false;
+      }
       nativeLayer.setLocalDestinationCapabilities(getCddTemplate('FooDevice'));
       setInitialSettings();
       return nativeLayer.whenCalled('getInitialSettings').then(function() {
         var previewAreaEl = $('preview-area');
 
         var loadingMessageEl =
             previewAreaEl.
             getElementsByClassName('preview-area-loading-message')[0];
         expectTrue(loadingMessageEl.hidden);
 
@@ skipping 116 matching lines @@
             extensionId: '', extensionName: ''
           };
         }),
       });
 
       // Ensure all capabilities are available for fetch.
       nativeLayer.setLocalDestinationCapabilities(getCddTemplate('ID1'));
       nativeLayer.setLocalDestinationCapabilities(getCddTemplate('ID2'))
       nativeLayer.setLocalDestinationCapabilities(getCddTemplate('ID3'));
 
-      // Use a real preview generator.
-      previewArea.previewGenerator_ =
-          new print_preview.PreviewGenerator(printPreview.destinationStore_,
-            printPreview.printTicketStore_, nativeLayer,
-            printPreview.documentInfo_);
-
-      // Preview generator starts out with inFlightRequestId_ == -1. The id
-      // increments by 1 for each startGetPreview call it makes. It should only
-      // make one such call during initialization or there will be a race; see
-      // crbug.com/666595
-      expectEquals(-1, previewArea.previewGenerator_.inFlightRequestId_);
+      // For crbug.com/666595. If multiple destinations are fetched there may
+      // be multiple preview requests. This verifies the first fetch is for
+      // ID1, which ensures no other destinations are fetched earlier. The last
+      // destination retrieved before timeout will end up in the preview
+      // request. Ensure this is also ID1.
       setInitialSettings();
-      return nativeLayer.whenCalled('getInitialSettings').then(function() {
-        return nativeLayer.whenCalled('getPrinterCapabilities', 'ID1');
-      }).then(function() {
-        expectEquals(0, previewArea.previewGenerator_.inFlightRequestId_);
+      var initialSettingsSet = nativeLayer.whenCalled('getInitialSettings');
+      return initialSettingsSet.then(function() {
+        return nativeLayer.whenCalled('getPrinterCapabilities');
+      }).then(function(id) {
+        expectEquals('ID1', id);
+        return nativeLayer.whenCalled('getPreview');
+      }).then(function(previewArgs) {
+        expectEquals(0, previewArgs.requestId);
+        expectEquals('ID1', previewArgs.destination.id);
       });
     });
 
     // Test that invalid settings errors disable the print preview and display
     // an error and that the preview dialog can be recovered by selecting a
     // new destination.
     test('InvalidSettingsError', function() {
-      return setupSettingsAndDestinationsWithCapabilities().then(function() {
-        // Manually enable the print header. This is needed since there is no
-        // plugin during test, so it will be set as disabled normally.
-        printPreview.printHeader_.isEnabled = true;
-
+      var barDevice = getCddTemplate('BarDevice');
+      nativeLayer.setLocalDestinationCapabilities(barDevice);
+      nativeLayer.setInvalidPrinterId('FooDevice');

[dpapad, 2017/06/29 23:28:31]

Nit: Maybe add a comment that "FooDevice" is the currently selected or default
printer.

[rbpotter, 2017/06/30 18:46:24]

Done.

+      return Promise.all([
+          setupSettingsAndDestinationsWithCapabilities(),
+          nativeLayer.whenCalled('getPreview'),
+      ]).then(function() {
         // There will be an error message in the preview area since the plugin
         // is not running. However, it should not be the invalid settings

[dpapad, 2017/06/29 23:28:31]

I think the 2nd sentence is no longer accurate.

[rbpotter, 2017/06/30 18:46:24]

Done.

         // error.
         var previewAreaEl = $('preview-area');
         var customMessageEl =
             previewAreaEl.
             getElementsByClassName('preview-area-custom-message')[0];
         expectFalse(customMessageEl.hidden);
         var expectedMessageStart = 'The selected printer is not available or '
             + 'not installed correctly.'
-        expectFalse(customMessageEl.textContent.includes(
+        expectTrue(customMessageEl.textContent.includes(
             expectedMessageStart));
 
-        // Verify that the print button is enabled.
-        var printHeader = $('print-header');
-        var printButton = printHeader.querySelector('button.print');
+        // Verify that the print button is disabled
+        var printButton = $('print-header').querySelector('button.print');
         checkElementDisplayed(printButton, true);
-        expectFalse(printButton.disabled);
+        expectTrue(printButton.disabled);
 
-        // Report invalid settings error.
-        var invalidSettingsEvent =
-            new Event(print_preview.NativeLayer.EventType.SETTINGS_INVALID);
-        nativeLayer.getEventTarget().dispatchEvent(invalidSettingsEvent);
-
-        // Should be in an error state, print button disabled, invalid custom
-        // error message shown.
-        expectFalse(customMessageEl.hidden);
-        expectTrue(customMessageEl.textContent.includes(
-            expectedMessageStart));
-        expectTrue(printButton.disabled);
+        // Reset
+        nativeLayer.resetResolver('getPrinterCapabilities');
+        nativeLayer.resetResolver('getPreview');
 
         // Select a new destination
         var barDestination =
             printPreview.destinationStore_.destinations().find(
                 function(d) {
                   return d.id == 'BarDevice';
                 });
-
-        var barDevice = getCddTemplate('BarDevice');
-        nativeLayer.setLocalDestinationCapabilities(barDevice);
         printPreview.destinationStore_.selectDestination(barDestination);
-
-        return nativeLayer.whenCalled('getPrinterCapabilities', 'BarDevice')
-            .then(function() {
-              // Dispatch event indicating new preview has loaded.
-              var previewDoneEvent = new Event(
-                  print_preview.PreviewArea.EventType.PREVIEW_GENERATION_DONE);
-              previewArea.dispatchEvent(previewDoneEvent);
-
-              // Has active print button and successfully 'prints', indicating
-              // recovery from error state.
-              expectFalse(printButton.disabled);
-              printButton.click();
-              // This should result in a call to print.
-              return nativeLayer.whenCalled('print').then(
-                  /**
-                   * @param {{destination: !print_preview.Destination,
-                   *          printTicketStore: !print_preview.PrintTicketStore,
-                   *          cloudPrintInterface: print_preview
-                   *                                  .CloudPrintInterface,
-                   *          documentInfo: print_preview.DocumentInfo}} args
-                   *      The arguments that print() was called with.
-                   */
-                  function(args) {
-                    // Sanity check some printing argument values.
-                    var printTicketStore = args.printTicketStore;
-                    expectEquals(barDevice.printerId, args.destination.id);
-                    expectEquals(
-                        getDefaultOrientation(barDevice) == 'LANDSCAPE',
-                        printTicketStore.landscape.getValue());
-                    expectEquals(1, printTicketStore.copies.getValueAsNumber());
-                    var mediaDefault = getDefaultMediaSize(barDevice);
-                    expectEquals(
-                        mediaDefault.width_microns,
-                        printTicketStore.mediaSize.getValue().width_microns);
-                    expectEquals(
-                        mediaDefault.height_microns,
-                        printTicketStore.mediaSize.getValue().height_microns);
-                  });
-            });
-      });
+        return Promise.all([
+            nativeLayer.whenCalled('getPrinterCapabilities'),
+            nativeLayer.whenCalled('getPreview'),
+        ]);
+      }).then(function() {
+        // Has active print button and successfully 'prints', indicating
+        // recovery from error state.
+        var printButton = $('print-header').querySelector('button.print');
+        expectFalse(printButton.disabled);
+        printButton.click();
+        // This should result in a call to print.
+        return nativeLayer.whenCalled('print');
+      }).then(
+          /**
+           * @param {{destination: !print_preview.Destination,
+           *          printTicketStore: !print_preview.PrintTicketStore,
+           *          cloudPrintInterface: print_preview
+           *                                  .CloudPrintInterface,
+           *          documentInfo: print_preview.DocumentInfo}} args
+           *      The arguments that print() was called with.
+           */
+          function(args) {
+            // Sanity check some printing argument values.
+            var printTicketStore = args.printTicketStore;
+            expectEquals(barDevice.printerId, args.destination.id);
+            expectEquals(
+                getDefaultOrientation(barDevice) == 'LANDSCAPE',
+                printTicketStore.landscape.getValue());
+            expectEquals(1, printTicketStore.copies.getValueAsNumber());
+            var mediaDefault = getDefaultMediaSize(barDevice);
+            expectEquals(
+                mediaDefault.width_microns,
+                printTicketStore.mediaSize.getValue().width_microns);
+            expectEquals(
+                mediaDefault.height_microns,
+                printTicketStore.mediaSize.getValue().height_microns);
+          });
     });
 
     // Test the preview generator to make sure the generate draft parameter is
     // set correctly. It should be false if the only change is the page range.
     test('GenerateDraft', function() {
-      // Use a real preview generator.
-      previewArea.previewGenerator_ =
-          new print_preview.PreviewGenerator(printPreview.destinationStore_,
-              printPreview.printTicketStore_, nativeLayer,
-              printPreview.documentInfo_);
-      return setupSettingsAndDestinationsWithCapabilities().then(function() {
+      return Promise.all([
+          setupSettingsAndDestinationsWithCapabilities(),
+          nativeLayer.whenCalled('getPreview'),
+      ]).then(function(args) {
         // The first request should generate draft because there was no
         // previous print preview draft.
-        expectTrue(nativeLayer.generateDraft());
+        expectTrue(args[1].generateDraft);
+        expectEquals(0, args[1].requestId);
+        nativeLayer.resetResolver('getPreview');
 
         // Change the page range - no new draft needed.
         printPreview.printTicketStore_.pageRange.updateValue('2');
-        expectFalse(nativeLayer.generateDraft());
+        return nativeLayer.whenCalled('getPreview');
+      }).then(function(args) {
+        expectFalse(args.generateDraft);
+        expectEquals(1, args.requestId);
+        nativeLayer.resetResolver('getPreview');
 
         // Change the margin type - need to regenerate again.
         printPreview.printTicketStore_.marginsType.updateValue(
             print_preview.ticket_items.MarginsTypeValue.NO_MARGINS);
-        expectTrue(nativeLayer.generateDraft());
+        return nativeLayer.whenCalled('getPreview');
+      }).then(function(args) {
+        expectTrue(args.generateDraft);
+        expectEquals(2, args.requestId);
       });
     });
 
     // Test that the policy to use the system default printer by default
     // instead of the most recently used destination works.
     test('SystemDefaultPrinterPolicy', function() {
       // Add recent destination.
       initialSettings.serializedAppStateStr_ = JSON.stringify({
         version: 2,
         recentDestinations: [
@@ skipping 20 matching lines @@
       return setupSettingsAndDestinationsWithCapabilities().then(function() {
         // The system default destination should be used instead of the
         // most recent destination.
         assertEquals(
             'FooDevice',
             printPreview.destinationStore_.selectedDestination.id);
       });
     });
   });
 });