Print Preview: Change getPrinterCapabilities to cr.sendWithPromise

chrome/browser/resources/print_preview/native_layer.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.
 
 cr.exportPath('print_preview');
 
 /**
  * @typedef {{selectSaveAsPdfDestination: boolean,
  *            layoutSettings.portrait: boolean,
  *            pageRange: string,
@@ skipping 11 matching lines @@
  *   printerDescription: (string | undefined),
  *   cupsEnterprisePrinter: (boolean | undefined),
  *   printerOptions: (Object | undefined),
  * }}
  */
 print_preview.LocalDestinationInfo;
 
 /**
  * @typedef {{
  *   printerId: string,
+ *   printerName: string,
+ *   printerDescription: string,
+ *   cupsEnterprisePrinter: (boolean | undefined),
+ *   capabilities: print_preview.Cdd,

[dpapad, 2017/06/14 17:19:36]

Should this be !print_preview.Cdd ?

[rbpotter, 2017/06/14 18:28:25]

Done. Needs to be !print_preview.Cdd as it is passed directly to
localizeCapabilities_.

+ * }}
+ */
+print_preview.PrinterCapabilitiesResponse;
+
+/**
+ * @typedef {{
+ *   serviceName: string,
+ *   name: string,
+ *   hasLocalPrinting: boolean,
+ *   isUnregistered: boolean,
+ *   cloudID: string,
+ * }}
+ * @see PrintPreviewHandler::FillPrinterDescription in print_preview_handler.cc
+ */
+print_preview.PrivetPrinterDescription;
+
+/**
+ * @typedef {{
+ *   printer: !print_preview.PrivetPrinterDescription,
+ *   capabilities: !print_preview.Cdd,
+ * }}
+ */
+print_preview.PrivetPrinterCapabilitiesResponse;
+
+/**
+ * @typedef {{
+ *   printerId: string,
  *   success: boolean,
  *   capabilities: Object,
  * }}
 */
 print_preview.PrinterSetupResponse;
 
 cr.define('print_preview', function() {
   'use strict';
 
   /**
    * An interface to the native Chromium printing system layer.
    * @constructor
    */
   function NativeLayer() {
     // Bind global handlers
     global.setUseCloudPrint = this.onSetUseCloudPrint_.bind(this);
-    global.updateWithPrinterCapabilities =
-        this.onUpdateWithPrinterCapabilities_.bind(this);
-    global.failedToGetPrinterCapabilities =
-        this.onFailedToGetPrinterCapabilities_.bind(this);
-    global.failedToGetPrivetPrinterCapabilities =
-      this.onFailedToGetPrivetPrinterCapabilities_.bind(this);
-    global.failedToGetExtensionPrinterCapabilities =
-        this.onFailedToGetExtensionPrinterCapabilities_.bind(this);
     global.reloadPrintersList = this.onReloadPrintersList_.bind(this);
     global.printToCloud = this.onPrintToCloud_.bind(this);
     global.fileSelectionCancelled =
         this.onFileSelectionCancelled_.bind(this);
     global.fileSelectionCompleted =
         this.onFileSelectionCompleted_.bind(this);
     global.printPreviewFailed = this.onPrintPreviewFailed_.bind(this);
     global.invalidPrinterSettings =
         this.onInvalidPrinterSettings_.bind(this);
     global.onDidGetDefaultPageLayout =
         this.onDidGetDefaultPageLayout_.bind(this);
     global.onDidGetPreviewPageCount =
         this.onDidGetPreviewPageCount_.bind(this);
     global.onDidPreviewPage = this.onDidPreviewPage_.bind(this);
     global.updatePrintPreview = this.onUpdatePrintPreview_.bind(this);
     global.onDidGetAccessToken = this.onDidGetAccessToken_.bind(this);
-    global.onPrivetCapabilitiesSet =
-        this.onPrivetCapabilitiesSet_.bind(this);
     global.onPrivetPrintFailed = this.onPrivetPrintFailed_.bind(this);
-    global.onExtensionCapabilitiesSet =
-        this.onExtensionCapabilitiesSet_.bind(this);
     global.onEnableManipulateSettingsForTest =
         this.onEnableManipulateSettingsForTest_.bind(this);
     global.printPresetOptionsFromDocument =
         this.onPrintPresetOptionsFromDocument_.bind(this);
     global.onProvisionalPrinterResolved =
         this.onProvisionalDestinationResolved_.bind(this);
     global.failedToResolveProvisionalPrinter =
         this.failedToResolveProvisionalDestination_.bind(this);
 
     /** @private {!cr.EventTarget} */
@@ skipping 21 matching lines @@
     currentInstance = instance;
   };
 
   /**
    * Event types dispatched from the Chromium native layer.
    * @enum {string}
    * @const
    */
   NativeLayer.EventType = {
     ACCESS_TOKEN_READY: 'print_preview.NativeLayer.ACCESS_TOKEN_READY',
-    CAPABILITIES_SET: 'print_preview.NativeLayer.CAPABILITIES_SET',
     CLOUD_PRINT_ENABLE: 'print_preview.NativeLayer.CLOUD_PRINT_ENABLE',
     DESTINATIONS_RELOAD: 'print_preview.NativeLayer.DESTINATIONS_RELOAD',
     DISABLE_SCALING: 'print_preview.NativeLayer.DISABLE_SCALING',
     FILE_SELECTION_CANCEL: 'print_preview.NativeLayer.FILE_SELECTION_CANCEL',
     FILE_SELECTION_COMPLETE:
         'print_preview.NativeLayer.FILE_SELECTION_COMPLETE',
-    GET_CAPABILITIES_FAIL: 'print_preview.NativeLayer.GET_CAPABILITIES_FAIL',
     MANIPULATE_SETTINGS_FOR_TEST:
         'print_preview.NativeLayer.MANIPULATE_SETTINGS_FOR_TEST',
     PAGE_COUNT_READY: 'print_preview.NativeLayer.PAGE_COUNT_READY',
     PAGE_LAYOUT_READY: 'print_preview.NativeLayer.PAGE_LAYOUT_READY',
     PAGE_PREVIEW_READY: 'print_preview.NativeLayer.PAGE_PREVIEW_READY',
     PREVIEW_GENERATION_DONE:
         'print_preview.NativeLayer.PREVIEW_GENERATION_DONE',
     PREVIEW_GENERATION_FAIL:
         'print_preview.NativeLayer.PREVIEW_GENERATION_FAIL',
     PRINT_TO_CLOUD: 'print_preview.NativeLayer.PRINT_TO_CLOUD',
     SETTINGS_INVALID: 'print_preview.NativeLayer.SETTINGS_INVALID',
-    PRIVET_PRINTER_CHANGED: 'print_preview.NativeLayer.PRIVET_PRINTER_CHANGED',
-    PRIVET_CAPABILITIES_SET:
-        'print_preview.NativeLayer.PRIVET_CAPABILITIES_SET',
     PRIVET_PRINT_FAILED: 'print_preview.NativeLayer.PRIVET_PRINT_FAILED',
-    EXTENSION_CAPABILITIES_SET:
-        'print_preview.NativeLayer.EXTENSION_CAPABILITIES_SET',
     PRINT_PRESET_OPTIONS: 'print_preview.NativeLayer.PRINT_PRESET_OPTIONS',
     PROVISIONAL_DESTINATION_RESOLVED:
         'print_preview.NativeLayer.PROVISIONAL_DESTINATION_RESOLVED'
   };
 
   /**
    * Constant values matching printing::DuplexMode enum.
    * @enum {number}
    */
   NativeLayer.DuplexMode = {
@@ skipping 81 matching lines @@
      * Requests the network's privet print destinations. After this is called,
      * a number of privet-printer-changed events may be fired.
      * @return {!Promise} Resolves when privet printer search is completed.
      *     Rejected if privet printers are not enabled.
      */
     getPrivetPrinters: function() {
       return cr.sendWithPromise('getPrivetPrinters');
     },
 
     /**
-     * Requests the privet destination's printing capabilities. A
-     * PRIVET_CAPABILITIES_SET event will be dispatched in response.
-     * @param {string} destinationId ID of the destination.
-     */
-    startGetPrivetDestinationCapabilities: function(destinationId) {
-      chrome.send('getPrivetPrinterCapabilities', [destinationId]);
-    },
-
-    /**
      * Request a list of extension printers. Printers are reported as they are
      * found by a series of 'extension-printers-added' events.
      * @return {!Promise} Will be resolved when all extension managed printers
      *     have been sent.
      */
     getExtensionPrinters: function() {
       return cr.sendWithPromise('getExtensionPrinters');
     },
 
     /**
-     * Requests an extension destination's printing capabilities. A
-     * EXTENSION_CAPABILITIES_SET event will be dispatched in response.
-     * @param {string} destinationId The ID of the destination whose
-     *     capabilities are requested.
+     * Requests the destination's printing capabilities. Returns a promise that
+     * will be resolved with the capabilities if they are obtained successfully.
+     * @param {string} destinationId ID of the destination.
+     * @return {!Promise<!print_preview.PrinterCapabilitiesResponse>}
      */
-    startGetExtensionDestinationCapabilities: function(destinationId) {
-      chrome.send('getExtensionPrinterCapabilities', [destinationId]);
+    getPrinterCapabilities: function(destinationId) {
+      return cr.sendWithPromise('getPrinterCapabilities', destinationId);
     },
 
     /**
-     * Requests the destination's printing capabilities. A CAPABILITIES_SET
-     * event will be dispatched in response.
+     * Requests the privet destination's printing capabilities. Returns a
+     * promise that will be resolved with capabilities and printer information
+     * if capabilities are obtained successfully.
      * @param {string} destinationId ID of the destination.
+     * @return {!Promise<!print_preview.PrivetPrinterCapabilitiesResponse>}
      */
-    startGetLocalDestinationCapabilities: function(destinationId) {
-      chrome.send('getPrinterCapabilities', [destinationId]);
+    getPrivetPrinterCapabilities: function(destinationId) {
+      return cr.sendWithPromise('getPrivetPrinterCapabilities', destinationId);
     },
 
     /**
+     * Requests the extension destination's printing capabilities. Returns a
+     * promise that will be resolved with the ID and capabilities if
+     * capabilities are obtained successfully.
+     * @param {string} destinationId The ID of the destination whose
+     *     capabilities are requested.
+     * @return {!Promise<!print_preview.Cdd>}
+     */
+    getExtensionPrinterCapabilities: function(destinationId) {
+      return cr.sendWithPromise('getExtensionPrinterCapabilities',
+                                destinationId);
+    },
+
+    /**
      * Requests Chrome to resolve provisional extension destination by granting
      * the provider extension access to the printer. Chrome will respond with
      * the resolved destination properties by calling
      * {@code onProvisionalPrinterResolved}, or in case of an error
      * {@code failedToResolveProvisionalPrinter}
      * @param {string} provisionalDestinationId
      */
     grantExtensionPrinterAccess: function(provisionalDestinationId) {
       chrome.send('grantExtensionPrinterAccess', [provisionalDestinationId]);
     },
@@ skipping 250 matching lines @@
      * @private
      */
     onSetUseCloudPrint_: function(settings) {
       var cloudPrintEnableEvent = new Event(
           NativeLayer.EventType.CLOUD_PRINT_ENABLE);
       cloudPrintEnableEvent.baseCloudPrintUrl = settings['cloudPrintUrl'] || '';
       cloudPrintEnableEvent.appKioskMode = settings['appKioskMode'] || false;
       this.eventTarget_.dispatchEvent(cloudPrintEnableEvent);
     },
 
-    /**
-     * Called when native layer gets settings information for a requested local
-     * destination.
-     * @param {Object} settingsInfo printer setting information.
-     * @private
-     */
-    onUpdateWithPrinterCapabilities_: function(settingsInfo) {
-      assert(settingsInfo.capabilities,
-          'Capabilities update without capabilites');
-      var capsSetEvent = new Event(NativeLayer.EventType.CAPABILITIES_SET);
-      capsSetEvent.settingsInfo = settingsInfo;
-      this.eventTarget_.dispatchEvent(capsSetEvent);
-    },
-
-    /**
-     * Called when native layer gets settings information for a requested local
-     * destination.
-     * @param {string} destinationId Printer affected by error.
-     * @private
-     */
-    onFailedToGetPrinterCapabilities_: function(destinationId) {
-      var getCapsFailEvent = new Event(
-          NativeLayer.EventType.GET_CAPABILITIES_FAIL);
-      getCapsFailEvent.destinationId = destinationId;
-      getCapsFailEvent.destinationOrigin =
-          print_preview.DestinationOrigin.LOCAL;
-      this.eventTarget_.dispatchEvent(getCapsFailEvent);
-    },
-
-    /**
-     * Called when native layer gets settings information for a requested privet
-     * destination.
-     * @param {string} destinationId Printer affected by error.
-     * @private
-     */
-    onFailedToGetPrivetPrinterCapabilities_: function(destinationId) {
-      var getCapsFailEvent = new Event(
-          NativeLayer.EventType.GET_CAPABILITIES_FAIL);
-      getCapsFailEvent.destinationId = destinationId;
-      getCapsFailEvent.destinationOrigin =
-          print_preview.DestinationOrigin.PRIVET;
-      this.eventTarget_.dispatchEvent(getCapsFailEvent);
-    },
-
-    /**
-     * Called when native layer fails to get settings information for a
-     * requested extension destination.
-     * @param {string} destinationId Printer affected by error.
-     * @private
-     */
-    onFailedToGetExtensionPrinterCapabilities_: function(destinationId) {
-      var getCapsFailEvent = new Event(
-          NativeLayer.EventType.GET_CAPABILITIES_FAIL);
-      getCapsFailEvent.destinationId = destinationId;
-      getCapsFailEvent.destinationOrigin =
-          print_preview.DestinationOrigin.EXTENSION;
-      this.eventTarget_.dispatchEvent(getCapsFailEvent);
-    },
-
     /** Reloads the printer list. */
     onReloadPrintersList_: function() {
       cr.dispatchSimpleEvent(this.eventTarget_,
                              NativeLayer.EventType.DESTINATIONS_RELOAD);
     },
 
     /**
      * Called from the C++ layer.
      * Take the PDF data handed to us and submit it to the cloud, closing the
      * print preview dialog once the upload is successful.
@@ skipping 146 matching lines @@
      * @private
      */
     onPrintPresetOptionsFromDocument_: function(options) {
       var printPresetOptionsEvent = new Event(
           NativeLayer.EventType.PRINT_PRESET_OPTIONS);
       printPresetOptionsEvent.optionsFromDocument = options;
       this.eventTarget_.dispatchEvent(printPresetOptionsEvent);
     },
 
     /**
-     * @param {Object} printer Specifies information about the printer that was
-     *    added.
-     * @private
-     */
-    onPrivetCapabilitiesSet_: function(printer, capabilities) {
-      var privetCapabilitiesSetEvent =
-            new Event(NativeLayer.EventType.PRIVET_CAPABILITIES_SET);
-      privetCapabilitiesSetEvent.printer = printer;
-      privetCapabilitiesSetEvent.capabilities = capabilities;
-      this.eventTarget_.dispatchEvent(privetCapabilitiesSetEvent);
-    },
-
-    /**
      * @param {string} http_error The HTTP response code or -1 if not an HTTP
      *    error.
      * @private
      */
     onPrivetPrintFailed_: function(http_error) {
       var privetPrintFailedEvent =
             new Event(NativeLayer.EventType.PRIVET_PRINT_FAILED);
       privetPrintFailedEvent.httpError = http_error;
       this.eventTarget_.dispatchEvent(privetPrintFailedEvent);
     },
 
     /**
-     * Called when an extension responds to a request for an extension printer
-     * capabilities.
-     * @param {string} printerId The printer's ID.
-     * @param {!Object} capabilities The reported printer capabilities.
-     */
-    onExtensionCapabilitiesSet_: function(printerId,
-                                          capabilities) {
-      var event = new Event(NativeLayer.EventType.EXTENSION_CAPABILITIES_SET);
-      event.printerId = printerId;
-      event.capabilities = capabilities;
-      this.eventTarget_.dispatchEvent(event);
-    },
-
-    /**
      * Called when Chrome reports that attempt to resolve a provisional
      * destination failed.
      * @param {string} destinationId The provisional destination ID.
      * @private
      */
     failedToResolveProvisionalDestination_: function(destinationId) {
       var evt = new Event(
           NativeLayer.EventType.PROVISIONAL_DESTINATION_RESOLVED);
       evt.provisionalId = destinationId;
       evt.destination = null;
@@ skipping 247 matching lines @@
       return this.serializedDefaultDestinationSelectionRulesStr_;
     }
   };
 
   // Export
   return {
     NativeInitialSettings: NativeInitialSettings,
     NativeLayer: NativeLayer
   };
 });