Update app banner state machine to use more states.

chrome/browser/banners/app_banner_manager.h

 // Copyright 2015 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.
 
 #ifndef CHROME_BROWSER_BANNERS_APP_BANNER_MANAGER_H_
 #define CHROME_BROWSER_BANNERS_APP_BANNER_MANAGER_H_
 
 #include <vector>
 
 #include "base/macros.h"
@@ skipping 83 matching lines @@
  protected:
   enum class State {
     // The banner pipeline has not yet been triggered for this page load.
     INACTIVE,
 
     // The banner pipeline is currently running for this page load.
     ACTIVE,
 
     // The banner pipeline is currently waiting for the page manifest to be
     // fetched.
-    PENDING_MANIFEST,
+    FETCHING_MANIFEST,
 
     // The banner pipeline is currently waiting for the installability criteria
-    // to be checked.
+    // to be checked. In this state the pipeline could be paused while waiting
+    // for the site to register a service worker.
     PENDING_INSTALLABLE_CHECK,
 
     // The banner pipeline has finished running, but is waiting for sufficient
     // engagement to trigger the banner.
     PENDING_ENGAGEMENT,
 
-    // The banner pipeline has finished running, but is waiting for an event to
-    // trigger the banner.
-    PENDING_EVENT,
+    // The banner has sent the beforeinstallprompt event and is waiting for the
+    // response to the event.
+    SENDING_EVENT,
+
+    // The banner has sent the beforeinstallprompt, and the web page called
+    // prompt on the event while the event was being handled.
+    SENDING_EVENT_GOT_EARLY_PROMPT,
+
+    // The banner pipeline has finished running, but is waiting for the web page
+    // to call prompt on the event.
+    PENDING_PROMPT,
 
     // The banner pipeline has finished running for this page load and no more
     // processing is to be done.
     COMPLETE,
   };
 
   explicit AppBannerManager(content::WebContents* web_contents);
   ~AppBannerManager() override;
 
   // Returns true if the banner should be shown. Returns false if the banner has
@@ skipping 81 matching lines @@
   void WebContentsDestroyed() override;
 
   // SiteEngagementObserver overrides.
   void OnEngagementIncreased(content::WebContents* web_contents,
                              const GURL& url,
                              double score) override;
 
   // Subclass accessors for private fields which should not be changed outside
   // this class.
   InstallableManager* manager() const { return manager_; }
-  bool is_active() const { return state_ == State::ACTIVE; }
-  bool is_active_or_pending() const {
-    switch (state_) {
-      case State::ACTIVE:
-      case State::PENDING_MANIFEST:
-      case State::PENDING_INSTALLABLE_CHECK:
-      case State::PENDING_ENGAGEMENT:
-      case State::PENDING_EVENT:
-        return true;
-      case State::INACTIVE:
-      case State::COMPLETE:
-        return false;
-    }
-    return false;
-  }
+  bool is_inactive() const { return state_ == State::INACTIVE; }
   bool is_complete() const { return state_ == State::COMPLETE; }
   bool is_pending_engagement() const {
     return state_ == State::PENDING_ENGAGEMENT;
   }
-  bool is_pending_event() const {
-    return state_ == State::PENDING_EVENT || page_requested_prompt_;
-  }
+  bool IsRunning() const;
+  bool IsBlockedOnNetwork() const;

[dominickn, 2017/07/07 06:23:18]

Can we call this IsWaitingForData()? We could be blocked on "network" when
waiting for a service worker to be registered.

[benwells, 2017/07/07 06:29:27]

Done.

 
   // The URL for which the banner check is being conducted.
   GURL validated_url_;
 
   // The URL of the manifest.
   GURL manifest_url_;
 
   // The manifest object.
   content::Manifest manifest_;
 
@@ skipping 46 matching lines @@
   // Mojo bindings and interface pointers.
   mojo::Binding<blink::mojom::AppBannerService> binding_;
   blink::mojom::AppBannerEventPtr event_;
   blink::mojom::AppBannerControllerPtr controller_;
 
   // If a banner is requested before the page has finished loading, defer
   // triggering the pipeline until the load is complete.
   bool has_sufficient_engagement_;
   bool load_finished_;
 
-  // Record whether the page requests for a banner to be shown later on.
-  bool page_requested_prompt_;
-
   // Whether the current flow was begun via devtools.
   bool triggered_by_devtools_;
 
   // Whether the installable status has been logged for this run.
   bool need_to_log_status_;
 
   // The concrete subclasses of this class are expected to have their lifetimes
   // scoped to the WebContents which they are observing. This allows us to use
   // weak pointers for callbacks.
   base::WeakPtrFactory<AppBannerManager> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(AppBannerManager);
 };
 
 }  // namespace banners
 
 #endif  // CHROME_BROWSER_BANNERS_APP_BANNER_MANAGER_H_