Allow InstallableManager to fetch optional badge icon

chrome/browser/installable/installable_manager.h

 // 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.
 
 #ifndef CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_
 #define CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_
 
 #include <map>
 #include <memory>
+#include <tuple>
 #include <utility>
 #include <vector>
 
 #include "base/callback_forward.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "chrome/browser/installable/installable_logging.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 #include "content/public/common/manifest.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "url/gurl.h"
 
 // This struct specifies the work to be done by the InstallableManager.
 // Data is cached and fetched in the order specified in this struct. A web app
 // manifest will always be fetched first.
 struct InstallableParams {
+  // Check whether the site is installable. That is, it has a manifest valid for
+  // a web app and a service worker controlling the manifest start URL and the
+  // current URL.

[dominickn, 2017/01/27 06:40:43]

The bools are last so that this struct will be laid out in memory more
optimally.

Can you please reorganise this such that the three bools are last?

[F, 2017/01/27 20:11:17]

Done. Thanks for the explanation.

+  bool check_installable = false;
+
   // The ideal primary icon size to fetch. Used only if
   // |fetch_valid_primary_icon| is true.
   int ideal_primary_icon_size_in_px = -1;
 
   // The minimum primary icon size to fetch. Used only if
   // |fetch_valid_primary_icon| is true.
   int minimum_primary_icon_size_in_px = -1;
 
-  // Check whether the site is installable. That is, it has a manifest valid for
-  // a web app and a service worker controlling the manifest start URL and the
-  // current URL.
-  bool check_installable = false;
-
   // Check whether there is a fetchable, non-empty icon in the manifest
   // conforming to the primary icon size parameters.
   bool fetch_valid_primary_icon = false;
+
+  // The ideal badge icon size to fetch. Used only if
+  // |fetch_valid_badge_icon| is true.
+  int ideal_badge_icon_size_in_px = -1;
+
+  // The minimum badge icon size to fetch. Used only if
+  // |fetch_valid_badge_icon| is true.
+  int minimum_badge_icon_size_in_px = -1;
+
+  // Check whether there is a fetchable, non-empty icon in the manifest
+  // conforming to the badge icon size parameters.
+  bool fetch_valid_badge_icon = false;
 };
 
 // This struct is passed to an InstallableCallback when the InstallableManager
 // has finished working. Each reference is owned by InstallableManager, and
 // callers should copy any objects which they wish to use later. Non-requested
 // fields will be set to null, empty, or false.
 struct InstallableData {
   // NO_ERROR_DETECTED if there were no issues.
   const InstallableStatusCode error_code;
 
   // Empty if the site has no <link rel="manifest"> tag.
   const GURL& manifest_url;
 
   // Empty if the site has an unparseable manifest.
   const content::Manifest& manifest;
 
   // Empty if no primary_icon was requested.
   const GURL& primary_icon_url;
 
   // nullptr if the most appropriate primary icon couldn't be determined or
   // downloaded. The underlying primary icon is owned by the InstallableManager;
   // clients must copy the bitmap if they want to to use it. If
   // fetch_valid_primary_icon was true and a primary icon could not be
   // retrieved, the reason will be in error_code.
   const SkBitmap* primary_icon;
 
+  // Empty if no badge_icon was requested.
+  const GURL& badge_icon_url;
+
+  // nullptr if the most appropriate badge icon couldn't be determined or
+  // downloaded. The underlying badge icon is owned by the InstallableManager;
+  // clients must copy the bitmap if they want to to use it. If
+  // fetch_valid_badge_icon was true and a badge icon could not be retrieved,

[dominickn, 2017/01/27 06:40:42]

I don't think this comment is accurate - the badge icon is optional so there's
never an error code for it.

[F, 2017/01/27 20:11:17]

Done.

+  // the reason will be in error_code.
+  const SkBitmap* badge_icon;
+
   // true if the site has a service worker and a viable web app manifest. If
   // check_installable was true and the site isn't installable, the reason will
   // be in error_code.
   const bool is_installable;
 };
 
 using InstallableCallback = base::Callback<void(const InstallableData&)>;
 
 // This class is responsible for fetching the resources required to check and
 // install a site.
@@ skipping 23 matching lines @@
   virtual void GetData(const InstallableParams& params,
                        const InstallableCallback& callback);
 
  private:
   friend class InstallableManagerUnitTest;
   FRIEND_TEST_ALL_PREFIXES(InstallableManagerBrowserTest,
                            ManagerBeginsInEmptyState);
   FRIEND_TEST_ALL_PREFIXES(InstallableManagerBrowserTest, CheckWebapp);
 
   using Task = std::pair<InstallableParams, InstallableCallback>;
-  using IconParams = std::pair<int, int>;
+  using IconParams = std::tuple<int, int, content::Manifest::Icon::IconPurpose>;
 
   struct ManifestProperty;
   struct InstallableProperty;
   struct IconProperty;
 
-  // Returns the IconProperty matching |params|. Creates if it doesn't exist.
-  IconProperty& GetIcon(const InstallableParams& params);
+  // Returns an IconParams object that queries for a primary icon conforming to
+  // the primary icon size parameters in |params|.
+  IconParams ParamsForPrimaryIcon(const InstallableParams& params) const;
+  // Returns an IconParams object that queries for a badge icon conforming to
+  // the badge icon size parameters in |params|.
+  IconParams ParamsForBadgeIcon(const InstallableParams& params) const;
 
-  // Returns true if the icon sizes in |params| matches any fetched icon. false
-  // if no icon has been requested yet or there is no match.
-  bool IsIconFetched(const InstallableParams& params) const;
+  // Returns true if |params| matches any fetched icon, or false if no icon has
+  // been requested yet or there is no match.
+  bool IsIconFetched(const IconParams& params) const;
 
-  // Sets the icon parameters in |params| as being fetched.
-  void SetIconFetched(const InstallableParams& params);
+  // Sets the icon matching |params| as fetched.
+  void SetIconFetched(const IconParams& params);
 
   // Returns the error code associated with the resources requested in |params|,
   // or NO_ERROR_DETECTED if there is no error.
   InstallableStatusCode GetErrorCode(const InstallableParams& params);
 
   // Gets/sets parts of particular properties. Exposed for testing.
   InstallableStatusCode manifest_error() const;
   InstallableStatusCode installable_error() const;
   void set_installable_error(InstallableStatusCode error_code);
   InstallableStatusCode icon_error(const IconParams& icon_params);
@@ skipping 24 matching lines @@
   // Data retrieval methods.
   void FetchManifest();
   void OnDidGetManifest(const GURL& manifest_url,
                         const content::Manifest& manifest);
 
   void CheckInstallable();
   bool IsManifestValidForWebApp(const content::Manifest& manifest);
   void CheckServiceWorker();
   void OnDidCheckHasServiceWorker(bool has_service_worker);
 
-  void CheckAndFetchBestIcon();
-  void OnAppIconFetched(const GURL icon_url, const SkBitmap& bitmap);
+  void CheckAndFetchBestIcon(const IconParams& params);
+  void OnAppIconFetched(

[dominickn, 2017/01/27 06:40:43]

Rename to OnIconFetched.

[F, 2017/01/27 20:11:17]

Done.

+      const GURL icon_url, const IconParams& params, const SkBitmap& bitmap);
 
   // content::WebContentsObserver overrides
   void DidFinishNavigation(content::NavigationHandle* handle) override;
   void WebContentsDestroyed() override;
 
   const GURL& manifest_url() const;
   const content::Manifest& manifest() const;
   bool is_installable() const;
 
   // The list of <params, callback> pairs that have come from a call to GetData.
   std::vector<Task> tasks_;
 
   // Installable properties cached on this object.
   std::unique_ptr<ManifestProperty> manifest_;
   std::unique_ptr<InstallableProperty> installable_;
   std::map<IconParams, IconProperty> icons_;
 
   bool is_active_;
 
   base::WeakPtrFactory<InstallableManager> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(InstallableManager);
 };
 
 #endif  // CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_