Convert Web Store Inline Install IPCs to mojo

chrome/browser/extensions/tab_helper.h

 // 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.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_TAB_HELPER_H_
 #define CHROME_BROWSER_EXTENSIONS_TAB_HELPER_H_
 
 #include <memory>
 #include <set>
 #include <string>
 
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/scoped_observer.h"
 #include "chrome/browser/extensions/active_tab_permission_granter.h"
 #include "chrome/browser/extensions/extension_reenabler.h"
+#include "chrome/common/extensions/mojo/inline_install.mojom.h"
 #include "chrome/common/extensions/webstore_install_result.h"
 #include "chrome/common/web_application_info.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
+#include "content/public/browser/web_contents_binding_set.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 #include "extensions/browser/extension_function_dispatcher.h"
 #include "extensions/browser/extension_registry_observer.h"
 #include "extensions/browser/script_execution_observer.h"
 #include "extensions/browser/script_executor.h"
 #include "extensions/common/extension_id.h"
 #include "extensions/common/stack_frame.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 
 namespace gfx {
 class Image;
 }
 
 namespace extensions {
 class ExtensionActionRunner;
 class BookmarkAppHelper;
 class Extension;
 class WebstoreInlineInstallerFactory;
 
 // Per-tab extension helper. Also handles non-extension apps.
 class TabHelper : public content::WebContentsObserver,
                   public ExtensionFunctionDispatcher::Delegate,
                   public ExtensionRegistryObserver,
                   public content::NotificationObserver,
-                  public content::WebContentsUserData<TabHelper> {
+                  public content::WebContentsUserData<TabHelper>,
+                  public mojom::InlineInstaller {
  public:
   ~TabHelper() override;
 
   void CreateHostedAppFromWebContents();
   bool CanCreateBookmarkApp() const;
 
   void UpdateShortcutOnLoadComplete() {
     update_shortcut_on_load_complete_ = true;
   }
 
@@ skipping 62 matching lines @@
 
   // Different types of action when web app info is available.
   // OnDidGetApplicationInfo uses this to dispatch calls.
   enum WebAppAction {
     NONE,               // No action at all.
     CREATE_HOSTED_APP,  // Create and install a hosted app.
     UPDATE_SHORTCUT     // Update icon for app shortcut.
   };
 
   explicit TabHelper(content::WebContents* web_contents);
+
   friend class content::WebContentsUserData<TabHelper>;
 
   // Displays UI for completion of creating a bookmark hosted app.
   void FinishCreateBookmarkApp(const extensions::Extension* extension,
                                const WebApplicationInfo& web_app_info);
 
   // content::WebContentsObserver overrides.
   void RenderFrameCreated(content::RenderFrameHost* host) override;
   void DidFinishNavigation(
       content::NavigationHandle* navigation_handle) override;
   bool OnMessageReceived(const IPC::Message& message) override;
   bool OnMessageReceived(const IPC::Message& message,
                          content::RenderFrameHost* render_frame_host) override;
   void DidCloneToNewWebContents(
       content::WebContents* old_web_contents,
       content::WebContents* new_web_contents) override;
 
   // extensions::ExtensionFunctionDispatcher::Delegate overrides.
   extensions::WindowController* GetExtensionWindowController() const override;
   content::WebContents* GetAssociatedWebContents() const override;
 
   // ExtensionRegistryObserver:
   void OnExtensionUnloaded(content::BrowserContext* browser_context,
                            const Extension* extension,
                            UnloadedExtensionInfo::Reason reason) override;
 
+  // mojom::InlineInstall:
+  void DoInlineInstall(int install_id,
+                       const std::string& webstore_item_id,
+                       int listeners_mask,
+                       extensions::mojom::InlineInstallProgressListenerPtr
+                           install_progress_listener) override;
+
   // Message handlers.
   void OnDidGetWebApplicationInfo(const WebApplicationInfo& info);
-  void OnInlineWebstoreInstall(content::RenderFrameHost* host,
-                               int install_id,
-                               int return_route_id,
-                               const std::string& webstore_item_id,
-                               int listeners_mask);
   void OnGetAppInstallState(content::RenderFrameHost* host,
                             const GURL& requestor_url,
                             int return_route_id,
                             int callback_id);
   void OnContentScriptsExecuting(
       content::RenderFrameHost* host,
       const ScriptExecutionObserver::ExecutingScriptsMap& extension_ids,
       const GURL& on_url);
 
   // App extensions related methods:
 
   // Resets app_icon_ and if |extension| is non-null uses ImageLoader to load
   // the extension's image asynchronously.
   void UpdateExtensionAppIcon(const Extension* extension);
 
   const Extension* GetExtension(const ExtensionId& extension_app_id);
 
   void OnImageLoaded(const gfx::Image& image);
 
   // WebstoreStandaloneInstaller::Callback.
   void OnInlineInstallComplete(int install_id,
-                               int return_route_id,
                                const ExtensionId& extension_id,
                                bool success,
                                const std::string& error,
                                webstore_install::Result result);
 
   // ExtensionReenabler::Callback.
   void OnReenableComplete(int install_id,
-                          int return_route_id,
                           const ExtensionId& extension_id,
                           ExtensionReenabler::ReenableResult result);
 
   // content::NotificationObserver.
   void Observe(int type,
                const content::NotificationSource& source,
                const content::NotificationDetails& details) override;
 
   // Requests application info for the specified page. This is an asynchronous
   // request. The delegate is notified by way of OnDidGetApplicationInfo when
@@ skipping 52 matching lines @@
       registry_observer_;
 
   // Map of InlineInstallObservers for inline installations that have progress
   // listeners.
   std::map<ExtensionId, std::unique_ptr<InlineInstallObserver>>
       install_observers_;
 
   // The set of extension ids that are currently being installed.
   std::set<ExtensionId> pending_inline_installations_;
 
+  content::WebContentsFrameBindingSet<extensions::mojom::InlineInstaller>
+      bindings_;
+
+  extensions::mojom::InlineInstallProgressListenerPtr

[Devlin, 2017/05/03 14:18:29]

remember, no need for extensions:: prefix inside the extensions namespace.

[catmullings, 2017/05/04 03:00:03]

Done.

+      inline_install_progress_listener_;

[Devlin, 2017/05/03 14:18:29]

The problem with having the TabHelper own this directly is that there could,
potentially, be multiple inline installations** for a single tab helper, in
which case this could be wrong.

There are two reasonable options here:
1. We already have the mapping of ExtensionId -> InlineInstallObserver above,
which handles this gracefully.  I think it'd be better to have the
InlineInstallProgressListenerPtr owned by the InlineInstallObserver.  See also
note in the .cc.
2. We could have a second map of <ExtensionId,
InlineInstallProgressListenerPtr>.

**In practice, this is unlikely since we restrict to the main frame.  But
if/when we address that, it should be in a separate CL, since the reorganization
of the class is non-trivial.

[catmullings, 2017/05/04 03:00:03]

Documentation: Opted for approach #2.

[catmullings, 2017/05/04 03:00:03]

Done.

+
   // Vend weak pointers that can be invalidated to stop in-progress loads.
   base::WeakPtrFactory<TabHelper> image_loader_ptr_factory_;
 
   // Generic weak ptr factory for posting callbacks.
   base::WeakPtrFactory<TabHelper> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(TabHelper);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_TAB_HELPER_H_