Print Preview: Change getPrinterCapabilities to cr.sendWithPromise

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

 // Copyright 2017 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', function() {
   /**
   * Test version of the native layer.
   * @constructor
   * @extends {TestBrowserProxy}
   */
   function NativeLayerStub() {
     TestBrowserProxy.call(this, [
         'getInitialSettings',
         'getPrinters',
         'getExtensionPrinters',
         'getPrivetPrinters',
+        'getPrinterCapabilities',
         'setupPrinter'
       ]);
 
     /**
      * @private {!cr.EventTarget} The event target used for dispatching and
      *     receiving events.
      */
     this.eventTarget_ = new cr.EventTarget();
 
     /** @private {boolean} Whether the native layer has sent a print message. */
@@ skipping 12 matching lines @@
     this.initialSettings_ = null;
 
     /**
      *
      * @private {!Array<!print_preview.LocalDestinationInfo>} Local destination
      *     list to be used for the response to |getPrinters|.
      */
     this.localDestinationInfos_ = [];
 
     /**
+     * @private {!Map<string,
+     *                {response: !print_preview.PrinterCapabilitiesResponse,
+     *                 reject: boolean}>}
+     *     A map from destination IDs to the responses to be sent when
+     *     |getPrinterCapabilities| is called for the ID.
+     */
+    this.localDestinationCapabilities_ = new Map();
+
+    /**
      * @private {!print_preview.PrinterSetupResponse} The response to be sent
      *     on a |setupPrinter| call.
      */
     this.setupPrinterResponse_ = null;
 
     /**
      * @private {boolean} Whether the printer setup request should be rejected.
      */
     this.shouldRejectPrinterSetup_ = false;
-
-    /**
-     * @private {string} The destination id to watch for counting calls to
-     *     |getLocalDestinationCapabilities|.
-     */
-    this.destinationToWatch_ = '';
-
-    /**
-     * @private {number} The number of calls to
-     *     |getLocalDestinationCapabilities| with id = |destinationToWatch_|.
-     */
-    this.getLocalDestinationCapabilitiesCallCount_ = 0;
   }
 
   NativeLayerStub.prototype = {
     __proto__: TestBrowserProxy.prototype,
 
     /** @override */
     getInitialSettings: function() {
       this.methodCalled('getInitialSettings');
       return Promise.resolve(this.initialSettings_);
     },
@@ skipping 10 matching lines @@
       return Promise.resolve(true);
     },
 
     /** @override */
     getPrivetPrinters: function() {
       this.methodCalled('getPrivetPrinters');
       return Promise.resolve(true);
     },
 
     /** @override */
+    getPrinterCapabilities: function(printerId) {
+      this.methodCalled('getPrinterCapabilities', printerId);
+      var responseAndReject = this.localDestinationCapabilities_.get(printerId);
+      if (responseAndReject && !responseAndReject.reject) {
+        return Promise.resolve(responseAndReject.response);
+      } else {
+        return Promise.reject(printerId);
+      }
+    },
+
+    /** @override */
     setupPrinter: function(printerId) {
       this.methodCalled('setupPrinter', printerId);
       return this.shouldRejectPrinterSetup_ ?
           Promise.reject(this.setupPrinterResponse_) :
           Promise.resolve(this.setupPrinterResponse_);
     },
 
     /** Stubs for |print_preview.NativeLayer| methods that call C++ handlers. */
     previewReadyForTest: function() {},
-    startGetLocalDestinationCapabilities: function(destinationId) {
-      if (destinationId == this.destinationToWatch_)
-        this.getLocalDestinationCapabilitiesCallCount_++;
-    },
+
     startGetPreview: function(destination, printTicketStore, documentInfo,
                               generateDraft, requestId) {
       this.generateDraft_ = generateDraft;
     },
     startPrint: function () { this.printStarted_ = true; },
     startHideDialog: function () {},
 
     /** @return {!cr.EventTarget} The native layer event target. */
     getEventTarget: function() { return this.eventTarget_; },
 
     /** @param {!cr.EventTarget} eventTarget The event target to use. */
     setEventTarget: function(eventTarget) {
       this.eventTarget_ = eventTarget;
     },
 
-    /**
-     * @return {boolean} Whether capabilities have been requested exactly once
-     *     for |destinationToWatch_|.
-     */
-    didGetCapabilitiesOnce: function(destinationId) {
-      return (destinationId == this.destinationToWatch_ &&
-              this.getLocalDestinationCapabilitiesCallCount_ == 1);
-    },
-
     /** @return {boolean} Whether a new draft was requested for preview. */
     generateDraft: function() { return this.generateDraft_; },
 
     /** @return {boolean} Whether a print request has been issued. */
     isPrintStarted: function() { return this.printStarted_; },
 
     /**
-     * @param {string} destinationId The destination ID to watch for
-     *     |getLocalDestinationCapabilities| calls.
-     * Resets |getLocalDestinationCapabilitiesCallCount_|.
-     */
-    setDestinationToWatch: function(destinationId) {
-      this.destinationToWatch_ = destinationId;
-      this.getLocalDestinationCapabilitiesCallCount_ = 0;
-    },
-
-    /**
      * @param {!print_preview.NativeInitialSettings} settings The settings
      *     to return as a response to |getInitialSettings|.
      */
     setInitialSettings: function(settings) {
       this.initialSettings_ = settings;
     },
 
     /**
      * @param {!Array<!print_preview.LocalDestinationInfo>} localDestinations
      *     The local destinations to return as a response to |getPrinters|.
      */
     setLocalDestinations: function(localDestinations) {
       this.localDestinationInfos_ = localDestinations;
     },
 
     /**
+     * @param {!print_preview.PrinterCapabilitiesResponse>} localDestinations
+     *     The local destinations to return as a response to
+     *     |getPrinters(printerId)|.
+     * @param {boolean | undefined} reject Whether to reject the callback for

[dpapad, 2017/06/09 17:59:11]

The proper way to define optional parameters is as follows:

@param {boolean?} opt_reject

[rbpotter, 2017/06/14 03:55:08]

Done.

+     *     this destination. Defaults to false (will resolve callback) if not
+     *     provided.
+     */
+    setLocalDestinationCapabilities: function(capabilities, reject) {
+      reject = reject || false;
+      this.localDestinationCapabilities_.set(capabilities.printerId,
+          {"response": capabilities, "reject": reject});

[dpapad, 2017/06/09 17:59:11]

Can we directly pass the Promise to be eventually returned to callers here?

localDestinationCapabilities_.set(
     capabilities.printerId,
     opt_reject ?
         Promise.resolve(capabilities) :
         Promise.reject(capabilities.printerId));

Then, inside the stub simply do:

getPrinterCapabilities: function(printerId) {
  this.methodCalled('getPrinterCapabilities', printerId);
  return this.localDestinationCapabilities_.get(printerId);
}

This reduces unnecessary intermediate data structures.

[rbpotter, 2017/06/14 03:55:08]

Done.

+    },
+
+    /**
      * @param {boolean} reject Whether printSetup requests should be rejected.
      * @param {!print_preview.PrinterSetupResponse} The response to send when
      *     |setupPrinter| is called.
      */
     setSetupPrinterResponse: function(reject, response) {
       this.shouldRejectPrinterSetup_ = reject;
       this.setupPrinterResponse_ = response;
     },
   };
 
   return {
     NativeLayerStub: NativeLayerStub,
   };
 });