[CUPS] Implement the local CUPS printer setup waiting UI.

chrome/browser/resources/print_preview/search/destination_list_item.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.define('print_preview', function() {
   'use strict';
 
   /**
    * Component that renders a destination item in a destination list.
    * @param {!cr.EventTarget} eventTarget Event target to dispatch selection
@@ skipping 35 matching lines @@
      * @private
      */
     this.fedexTos_ = null;
   };
 
   /**
    * Event types dispatched by the destination list item.
    * @enum {string}
    */
   DestinationListItem.EventType = {
+    // Dispatched to check the printer needs to be configured before activation.
+    CONFIGURE_REQUEST: 'print_preview.DestinationListItem.CONFIGURE_REQUEST',
     // Dispatched when the list item is activated.
     SELECT: 'print_preview.DestinationListItem.SELECT',
     REGISTER_PROMO_CLICKED:
         'print_preview.DestinationListItem.REGISTER_PROMO_CLICKED'
   };
 
   DestinationListItem.prototype = {
     __proto__: print_preview.Component.prototype,
 
     /** @override */
@@ skipping 26 matching lines @@
      *     to render.
      * @param {RegExp} query Active filter query.
      */
     update: function(destination, query) {
       this.destination_ = destination;
       this.query_ = query;
       this.updateUi_();
     },
 
     /**
+     * Called if the printer configuration request is accepted. Show the waiting
+     * message to the user as the configuration might take longer than expected.
+     */
+    onConfigureRequestAccepted: function() {
+      // It must be a Chrome OS CUPS printer which hasn't been set up before.
+      assert(
+          this.destination_.origin == print_preview.Destination.Origin.CROS &&
+          !this.destination_.capabilities);
+      setIsVisible(
+          this.getChildElement('.configuring-in-progress-text'), true);
+    },
+
+    /**
+     * Called if the printer configuration request is rejected. The request is
+     * rejected if another printer is setting up in process or the current
+     * printer doesn't need to be setup.
+     * @param {bool} shouldIgnore If true, which indicates another printer is
+     *     setting up in process, the printer should not be activated.
+     */
+    onConfigureRequestRejected: function(shouldIgnore) {
+      if (!shouldIgnore)
+        this.onDestinationActivated_();
+    },
+
+    /**
+     * Called when the printer configuration request is resolved successful or
+     * failed.
+     * @param response {!print_preview.PrinterSetupResponse}
+     */
+    onConfigureResolved: function(response) {
+      assert(response.printerId == this.destination_.id);
+      if (response.success) {
+        setIsVisible(
+            this.getChildElement('.configuring-in-progress-text'), false);
+        this.destination_.capabilities = response.capabilities;
+        this.onDestinationActivated_();
+      } else {
+        setIsVisible(
+            this.getChildElement('.configuring-in-progress-text'), false);
+        setIsVisible(
+            this.getChildElement('.configuring-failed-text'), true);
+      }
+    },
+
+    /**
      * Initializes the element with destination's info.
      * @private
      */
     updateUi_: function() {
       var iconImg = this.getChildElement('.destination-list-item-icon');
       iconImg.src = this.destination_.iconUrl;
 
       var nameEl = this.getChildElement('.destination-list-item-name');
       var textContent = this.destination_.displayName;
       if (this.query_) {
@@ skipping 52 matching lines @@
       this.getElement().classList.toggle('stale', this.destination_.isOffline);
       var offlineStatusEl = this.getChildElement('.offline-status');
       offlineStatusEl.textContent = this.destination_.offlineStatusText;
       setIsVisible(offlineStatusEl, this.destination_.isOffline);
 
       // Initialize registration promo element for Privet unregistered printers.
       setIsVisible(
           this.getChildElement('.register-promo'),
           this.destination_.connectionStatus ==
               print_preview.Destination.ConnectionStatus.UNREGISTERED);
+
+      // Reset the configuring messages for CUPS printers.
+      setIsVisible(
+        this.getChildElement('.configuring-in-progress-text'), false);
+      setIsVisible(
+        this.getChildElement('.configuring-failed-text'), false);
     },
 
     /**
      * Adds text to parent element wrapping search query matches in highlighted
      * spans.
      * @param {!Element} parent Element to build the text in.
      * @param {string} text The text string to highlight segments in.
      * @private
      */
     addTextWithHighlight_: function(parent, text) {
       var sections = text.split(this.query_);
       for (var i = 0; i < sections.length; ++i) {
         if (i % 2 == 0) {
           parent.appendChild(document.createTextNode(sections[i]));
         } else {
           var span = document.createElement('span');
           span.className = 'destination-list-item-query-highlight';
           span.textContent = sections[i];
           parent.appendChild(span);
         }
       }
     },
 
     /**
-     * Called when the destination item is activated. Dispatches a SELECT event
-     * on the given event target.
+     * Called when the destination item is activated. Check if the printer needs
+     * to be set up first before activation.
      * @private
      */
     onActivate_: function() {

[skau, 2017/03/29 20:17:11]

If we're not on ChromeOS, we don't need to check for resolution.  We should
check for cr.isChromeOS and activate the destination if we're not.

[xdai1, 2017/03/30 17:48:19]

If we're not on Chrome OS, the check in line 596 in destination_search.js should
fail and the configuration request should be rejected directly. But I agree with
you that it's better to do a early return here. The original behavior on other
OS doesn't change. 

+      // Check if the printer needs configuration before using. The user is only
+      // allowed to set up one printer at one time.
+      var configureEvt =
+          new Event(DestinationListItem.EventType.CONFIGURE_REQUEST);
+      configureEvt.destination = this.destination_;
+      this.eventTarget_.dispatchEvent(configureEvt);
+    },
+
+    /**
+     * Called when the destination has been resolved successfully and needs to
+     * be activated. Dispatches a SELECT event on the given event target.
+     * @private
+     */
+    onDestinationActivated_: function() {
       if (this.destination_.id ==
               print_preview.Destination.GooglePromotedId.FEDEX &&
           !this.destination_.isTosAccepted) {
         if (!this.fedexTos_) {
           this.fedexTos_ = new print_preview.FedexTos();
           this.fedexTos_.render(this.getElement());
           this.tracker.add(
               this.fedexTos_,
               print_preview.FedexTos.EventType.AGREE,
               this.onTosAgree_.bind(this));
@@ skipping 74 matching lines @@
         return;
       this.onExtensionIconClicked_(event);
     }
   };
 
   // Export
   return {
     DestinationListItem: DestinationListItem
   };
 });