Lazy installation of NavigatorContentUtils on Supplement

NavigatorContentUtils has been installed by
ModulesInitialized::InstallSupplements while a frame is
created. But, it's also possible to install NavigatorContentUtils
when it's real functions are called like other Supplements.

The lazy installation is a typical use case of Supplement as
well as it helps to occupy less memory if not used.

Bug: 987080
Change-Id: If22d7c992b987e59dd326546663bb4c5a16d7959
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1715167Reviewed-by: Kentaro Hara <haraken@chromium.org>
Commit-Queue: Gyuyoung Kim <gyuyoung@igalia.com>
Cr-Commit-Position: refs/heads/master@{#680310}

third_party/blink/renderer/modules/modules_initializer.cc

@@ -63,8 +63,6 @@
 #include "third_party/blink/renderer/modules/media_controls/media_controls_impl.h"
 #include "third_party/blink/renderer/modules/mediastream/user_media_client.h"
 #include "third_party/blink/renderer/modules/mediastream/user_media_controller.h"
-#include "third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils.h"
-#include "third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils_client.h"
 #include "third_party/blink/renderer/modules/picture_in_picture/picture_in_picture_controller_impl.h"
 #include "third_party/blink/renderer/modules/presentation/presentation_controller.h"
 #include "third_party/blink/renderer/modules/presentation/presentation_receiver.h"
@@ -188,9 +186,6 @@ void ModulesInitializer::InstallSupplements(LocalFrame& frame) const {
       frame, std::make_unique<UserMediaClient>(client->UserMediaClient()));
   ProvideIndexedDBClientTo(frame, MakeGarbageCollected<IndexedDBClient>(frame));
   ProvideLocalFileSystemTo(frame, std::make_unique<LocalFileSystemClient>());
-  NavigatorContentUtils::ProvideTo(
-      *frame.DomWindow()->navigator(),
-      MakeGarbageCollected<NavigatorContentUtilsClient>(web_frame));
 
   ScreenOrientationControllerImpl::ProvideTo(frame);
   if (RuntimeEnabledFeatures::PresentationEnabled())

third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils.cc

@@ -29,6 +29,8 @@
 #include "base/stl_util.h"
 #include "third_party/blink/renderer/core/dom/document.h"
 #include "third_party/blink/renderer/core/frame/local_frame.h"
+#include "third_party/blink/renderer/core/frame/web_local_frame_impl.h"
+#include "third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils_client.h"
 #include "third_party/blink/renderer/platform/bindings/exception_state.h"
 #include "third_party/blink/renderer/platform/instrumentation/use_counter.h"
 #include "third_party/blink/renderer/platform/weborigin/security_origin.h"
@@ -37,6 +39,8 @@
 
 namespace blink {
 
+const char NavigatorContentUtils::kSupplementName[] = "NavigatorContentUtils";
+
 static const HashSet<String>& SupportedSchemes() {
   DEFINE_STATIC_LOCAL(
       HashSet<String>, supported_schemes,
@@ -117,8 +121,18 @@ static bool VerifyCustomHandlerScheme(const String& scheme,
   return false;
 }
 
-NavigatorContentUtils* NavigatorContentUtils::From(Navigator& navigator) {
-  return Supplement<Navigator>::From<NavigatorContentUtils>(navigator);
+NavigatorContentUtils& NavigatorContentUtils::From(Navigator& navigator,
+                                                   LocalFrame& frame) {
+  NavigatorContentUtils* navigator_content_utils =
+      Supplement<Navigator>::From<NavigatorContentUtils>(navigator);
+  if (!navigator_content_utils) {
+    WebLocalFrameImpl* web_frame = WebLocalFrameImpl::FromFrame(&frame);
+    navigator_content_utils = MakeGarbageCollected<NavigatorContentUtils>(
+        navigator,
+        MakeGarbageCollected<NavigatorContentUtilsClient>(web_frame));
+    ProvideTo(navigator, navigator_content_utils);
+  }
+  return *navigator_content_utils;
 }
 
 NavigatorContentUtils::~NavigatorContentUtils() = default;
@@ -129,10 +143,10 @@ void NavigatorContentUtils::registerProtocolHandler(
     const String& url,
     const String& title,
     ExceptionState& exception_state) {
-  if (!navigator.GetFrame())
+  LocalFrame* frame = navigator.GetFrame();
+  if (!frame)
     return;
-
-  Document* document = navigator.GetFrame()->GetDocument();
+  Document* document = frame->GetDocument();
   DCHECK(document);
 
   if (!VerifyCustomHandlerURL(*document, url, exception_state))
@@ -147,8 +161,9 @@ void NavigatorContentUtils::registerProtocolHandler(
                         ? WebFeature::kRegisterProtocolHandlerSecureOrigin
                         : WebFeature::kRegisterProtocolHandlerInsecureOrigin);
 
-  NavigatorContentUtils::From(navigator)->Client()->RegisterProtocolHandler(
-      scheme, document->CompleteURL(url), title);
+  NavigatorContentUtils::From(navigator, *frame)
+      .Client()
+      ->RegisterProtocolHandler(scheme, document->CompleteURL(url), title);
 }
 
 void NavigatorContentUtils::unregisterProtocolHandler(
@@ -156,10 +171,10 @@ void NavigatorContentUtils::unregisterProtocolHandler(
     const String& scheme,
     const String& url,
     ExceptionState& exception_state) {
-  if (!navigator.GetFrame())
+  LocalFrame* frame = navigator.GetFrame();
+  if (!frame)
     return;
-
-  Document* document = navigator.GetFrame()->GetDocument();
+  Document* document = frame->GetDocument();
   DCHECK(document);
 
   if (!VerifyCustomHandlerURL(*document, url, exception_state))
@@ -168,8 +183,9 @@ void NavigatorContentUtils::unregisterProtocolHandler(
   if (!VerifyCustomHandlerScheme(scheme, exception_state))
     return;
 
-  NavigatorContentUtils::From(navigator)->Client()->UnregisterProtocolHandler(
-      scheme, document->CompleteURL(url));
+  NavigatorContentUtils::From(navigator, *frame)
+      .Client()
+      ->UnregisterProtocolHandler(scheme, document->CompleteURL(url));
 }
 
 void NavigatorContentUtils::Trace(blink::Visitor* visitor) {
@@ -177,13 +193,4 @@ void NavigatorContentUtils::Trace(blink::Visitor* visitor) {
   Supplement<Navigator>::Trace(visitor);
 }
 
-const char NavigatorContentUtils::kSupplementName[] = "NavigatorContentUtils";
-
-void NavigatorContentUtils::ProvideTo(Navigator& navigator,
-                                      NavigatorContentUtilsClient* client) {
-  Supplement<Navigator>::ProvideTo(
-      navigator,
-      MakeGarbageCollected<NavigatorContentUtils>(navigator, client));
-}
-
 }  // namespace blink

third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils.h

@@ -29,7 +29,6 @@
 
 #include "third_party/blink/renderer/core/frame/navigator.h"
 #include "third_party/blink/renderer/modules/modules_export.h"
-#include "third_party/blink/renderer/modules/navigatorcontentutils/navigator_content_utils_client.h"
 #include "third_party/blink/renderer/platform/heap/handle.h"
 #include "third_party/blink/renderer/platform/supplementable.h"
 #include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
@@ -37,7 +36,10 @@
 namespace blink {
 
 class ExceptionState;
+class NavigatorContentUtilsClient;
 
+// It is owned by Navigator, and an instance is created lazily by calling
+// NavigatorContentUtils::From() via [register/unregister]ProtocolHandler.
 class MODULES_EXPORT NavigatorContentUtils final
     : public GarbageCollectedFinalized<NavigatorContentUtils>,
       public Supplement<Navigator> {
@@ -51,8 +53,6 @@ class MODULES_EXPORT NavigatorContentUtils final
       : Supplement<Navigator>(navigator), client_(client) {}
   virtual ~NavigatorContentUtils();
 
-  static NavigatorContentUtils* From(Navigator&);
-
   static void registerProtocolHandler(Navigator&,
                                       const String& scheme,
                                       const String& url,
@@ -63,8 +63,6 @@ class MODULES_EXPORT NavigatorContentUtils final
                                         const String& url,
                                         ExceptionState&);
 
-  static void ProvideTo(Navigator&, NavigatorContentUtilsClient*);
-
   void Trace(blink::Visitor*) override;
 
   void SetClientForTest(NavigatorContentUtilsClient* client) {
@@ -72,6 +70,8 @@ class MODULES_EXPORT NavigatorContentUtils final
   }
 
  private:
+  static NavigatorContentUtils& From(Navigator&, LocalFrame& frame);
+
   NavigatorContentUtilsClient* Client() { return client_.Get(); }
 
   Member<NavigatorContentUtilsClient> client_;