Migrate user script IPC to mojo

Use mojo instead of old IPC, keep current design and use two
interfaces one global and one per frame for now, also use
in both cases associated interface with ipc channel otherwise
script can be added during the page load, which will radomly
brake tests.

This change moves UserDataScript to chromium since mojo binding
generation did not work correctly. Use StructTraits when serializing
the class.

Change-Id: I7073fb831c96849e47864382188300db3c9137d9
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

3 files changed, 82 insertions, 63 deletions

diff --git a/src/core/renderer/render_thread_observer_qt.cpp b/src/core/renderer/render_thread_observer_qt.cpp
index 4912ebfc2..b2ed38f21 100644
--- a/src/core/renderer/render_thread_observer_qt.cpp
+++ b/src/core/renderer/render_thread_observer_qt.cpp
@@ -43,7 +43,7 @@
 // found in the LICENSE file.
 
 #include "renderer/render_thread_observer_qt.h"
-
+#include "user_resource_controller.h"
 #include "third_party/blink/public/common/associated_interfaces/associated_interface_registry.h"
 
 namespace QtWebEngineCore {
@@ -54,11 +54,15 @@ void RenderThreadObserverQt::RegisterMojoInterfaces(blink::AssociatedInterfaceRe
 {
     associated_interfaces->AddInterface(
             base::Bind(&RenderThreadObserverQt::OnRendererConfigurationAssociatedRequest, base::Unretained(this)));
+    associated_interfaces->AddInterface(
+            base::Bind(&UserResourceController::BindReceiver,
+                       base::Unretained(UserResourceController::instance())));
 }
 
 void RenderThreadObserverQt::UnregisterMojoInterfaces(blink::AssociatedInterfaceRegistry *associated_interfaces)
 {
     associated_interfaces->RemoveInterface(qtwebengine::mojom::RendererConfiguration::Name_);
+    associated_interfaces->RemoveInterface(qtwebengine::mojom::UserResourceController::Name_);
 }
 
 void RenderThreadObserverQt::SetInitialConfiguration(bool is_incognito_process)
diff --git a/src/core/renderer/user_resource_controller.cpp b/src/core/renderer/user_resource_controller.cpp
index 5c1bd301f..5f446e3b2 100644
--- a/src/core/renderer/user_resource_controller.cpp
+++ b/src/core/renderer/user_resource_controller.cpp
@@ -52,9 +52,12 @@
 #include "third_party/blink/public/web/web_script_source.h"
 #include "third_party/blink/public/web/web_view.h"
 #include "v8/include/v8.h"
+#include "mojo/public/cpp/bindings/associated_receiver.h"
+#include "third_party/blink/public/common/associated_interfaces/associated_interface_provider.h"
+#include "third_party/blink/public/common/associated_interfaces/associated_interface_registry.h"
 
 #include "common/qt_messages.h"
-#include "common/user_script_data.h"
+#include "qtwebengine/userscript/user_script_data.h"
 #include "type_conversion.h"
 #include "user_script.h"
 
@@ -97,7 +100,7 @@ static bool includeRuleMatchesURL(const std::string &pat, const GURL &url)
     return false;
 }
 
-static bool scriptMatchesURL(const UserScriptData &scriptData, const GURL &url)
+static bool scriptMatchesURL(const QtWebEngineCore::UserScriptData &scriptData, const GURL &url)
 {
     // Logic taken from Chromium (extensions/common/user_script.cc)
     bool matchFound;
@@ -132,10 +135,17 @@ static bool scriptMatchesURL(const UserScriptData &scriptData, const GURL &url)
     return true;
 }
 
-class UserResourceController::RenderFrameObserverHelper : public content::RenderFrameObserver
+// using UserScriptDataPtr = mojo::StructPtr<qtwebengine::mojom::UserScriptData>;
+
+class UserResourceController::RenderFrameObserverHelper
+    : public content::RenderFrameObserver,
+      public qtwebengine::mojom::UserResourceControllerRenderFrame
 {
 public:
     RenderFrameObserverHelper(content::RenderFrame *render_frame);
+    void BindReceiver(
+            mojo::PendingAssociatedReceiver<qtwebengine::mojom::UserResourceControllerRenderFrame>
+                    receiver);
 
 private:
     // RenderFrameObserver implementation.
@@ -144,14 +154,13 @@ private:
     void DidFinishLoad() override;
     void FrameDetached() override;
     void OnDestruct() override;
-    bool OnMessageReceived(const IPC::Message &message) override;
-
-    void onUserScriptAdded(const UserScriptData &);
-    void onUserScriptRemoved(const UserScriptData &);
-    void onScriptsCleared();
+    void AddScript(const QtWebEngineCore::UserScriptData &data) override;
+    void RemoveScript(const QtWebEngineCore::UserScriptData &data) override;
+    void ClearScripts() override;
 
     class Runner;
     QScopedPointer<Runner> m_runner;
+    mojo::AssociatedReceiver<qtwebengine::mojom::UserResourceControllerRenderFrame> m_binding;
 };
 
 // Helper class to create WeakPtrs so the AfterLoad tasks can be canceled and to
@@ -161,7 +170,7 @@ class UserResourceController::RenderFrameObserverHelper::Runner : public base::S
 public:
     explicit Runner(blink::WebLocalFrame *frame) : m_frame(frame) {}
 
-    void run(UserScriptData::InjectionPoint p)
+    void run(QtWebEngineCore::UserScriptData::InjectionPoint p)
     {
         DCHECK_LT(p, m_ran.size());
         if (!m_ran[p]) {
@@ -186,7 +195,8 @@ private:
     void OnDestruct() override;
 };
 
-void UserResourceController::runScripts(UserScriptData::InjectionPoint p, blink::WebLocalFrame *frame)
+void UserResourceController::runScripts(QtWebEngineCore::UserScriptData::InjectionPoint p,
+                                        blink::WebLocalFrame *frame)
 {
     content::RenderFrame *renderFrame = content::RenderFrame::FromWebFrame(frame);
     if (!renderFrame)
@@ -201,7 +211,7 @@ void UserResourceController::runScripts(UserScriptData::InjectionPoint p, blink:
     scriptsToRun.append(m_viewUserScriptMap.value(renderView).toList());
 
     for (uint64_t id : qAsConst(scriptsToRun)) {
-        const UserScriptData &script = m_scripts.value(id);
+        const QtWebEngineCore::UserScriptData &script = m_scripts.value(id);
         if (script.injectionPoint != p || (!script.injectForSubframes && !isMainFrame))
             continue;
         if (!scriptMatchesURL(script, frame->GetDocument().Url()))
@@ -216,17 +226,29 @@ void UserResourceController::runScripts(UserScriptData::InjectionPoint p, blink:
 
 void UserResourceController::RunScriptsAtDocumentEnd(content::RenderFrame *render_frame)
 {
-    runScripts(UserScriptData::DocumentLoadFinished, render_frame->GetWebFrame());
+    runScripts(QtWebEngineCore::UserScriptData::DocumentLoadFinished, render_frame->GetWebFrame());
 }
 
-UserResourceController::RenderFrameObserverHelper::RenderFrameObserverHelper(content::RenderFrame *render_frame)
-    : content::RenderFrameObserver(render_frame)
-{}
+UserResourceController::RenderFrameObserverHelper::RenderFrameObserverHelper(
+        content::RenderFrame *render_frame)
+    : content::RenderFrameObserver(render_frame), m_binding(this)
+{
+    render_frame->GetAssociatedInterfaceRegistry()->AddInterface(
+            base::BindRepeating(&UserResourceController::RenderFrameObserverHelper::BindReceiver,
+                                base::Unretained(this)));
+}
 
 UserResourceController::RenderViewObserverHelper::RenderViewObserverHelper(content::RenderView *render_view)
     : content::RenderViewObserver(render_view)
 {}
 
+void UserResourceController::RenderFrameObserverHelper::BindReceiver(
+        mojo::PendingAssociatedReceiver<qtwebengine::mojom::UserResourceControllerRenderFrame>
+                receiver)
+{
+    m_binding.Bind(std::move(receiver));
+}
+
 void UserResourceController::RenderFrameObserverHelper::DidCommitProvisionalLoad(bool is_same_document_navigation,
                                                                                  ui::PageTransition /*transitionbool*/)
 {
@@ -240,7 +262,9 @@ void UserResourceController::RenderFrameObserverHelper::DidCommitProvisionalLoad
     m_runner.reset(new Runner(render_frame()->GetWebFrame()));
 
     base::ThreadTaskRunnerHandle::Get()->PostTask(
-            FROM_HERE, base::BindOnce(&Runner::run, m_runner->AsWeakPtr(), UserScriptData::DocumentElementCreation));
+            FROM_HERE,
+            base::BindOnce(&Runner::run, m_runner->AsWeakPtr(),
+                           QtWebEngineCore::UserScriptData::DocumentElementCreation));
 }
 
 void UserResourceController::RenderFrameObserverHelper::DidFinishDocumentLoad()
@@ -249,7 +273,9 @@ void UserResourceController::RenderFrameObserverHelper::DidFinishDocumentLoad()
     // called instead of DidCommitProvisionalLoad).
     if (m_runner)
         base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
-                FROM_HERE, base::BindOnce(&Runner::run, m_runner->AsWeakPtr(), UserScriptData::AfterLoad),
+                FROM_HERE,
+                base::BindOnce(&Runner::run, m_runner->AsWeakPtr(),
+                               QtWebEngineCore::UserScriptData::AfterLoad),
                 base::TimeDelta::FromMilliseconds(afterLoadTimeout));
 }
 
@@ -257,7 +283,9 @@ void UserResourceController::RenderFrameObserverHelper::DidFinishLoad()
 {
     if (m_runner)
         base::ThreadTaskRunnerHandle::Get()->PostTask(
-                FROM_HERE, base::BindOnce(&Runner::run, m_runner->AsWeakPtr(), UserScriptData::AfterLoad));
+                FROM_HERE,
+                base::BindOnce(&Runner::run, m_runner->AsWeakPtr(),
+                               QtWebEngineCore::UserScriptData::AfterLoad));
 }
 
 void UserResourceController::RenderFrameObserverHelper::FrameDetached()
@@ -278,33 +306,23 @@ void UserResourceController::RenderViewObserverHelper::OnDestruct()
     delete this;
 }
 
-bool UserResourceController::RenderFrameObserverHelper::OnMessageReceived(const IPC::Message &message)
-{
-    bool handled = true;
-    IPC_BEGIN_MESSAGE_MAP(UserResourceController::RenderFrameObserverHelper, message)
-        IPC_MESSAGE_HANDLER(RenderFrameObserverHelper_AddScript, onUserScriptAdded)
-        IPC_MESSAGE_HANDLER(RenderFrameObserverHelper_RemoveScript, onUserScriptRemoved)
-        IPC_MESSAGE_HANDLER(RenderFrameObserverHelper_ClearScripts, onScriptsCleared)
-        IPC_MESSAGE_UNHANDLED(handled = false)
-    IPC_END_MESSAGE_MAP()
-    return handled;
-}
-
-void UserResourceController::RenderFrameObserverHelper::onUserScriptAdded(const UserScriptData &script)
+void UserResourceController::RenderFrameObserverHelper::AddScript(
+        const QtWebEngineCore::UserScriptData &script)
 {
     if (content::RenderFrame *frame = render_frame())
         if (content::RenderView *view = frame->GetRenderView())
             UserResourceController::instance()->addScriptForView(script, view);
 }
 
-void UserResourceController::RenderFrameObserverHelper::onUserScriptRemoved(const UserScriptData &script)
+void UserResourceController::RenderFrameObserverHelper::RemoveScript(
+        const QtWebEngineCore::UserScriptData &script)
 {
     if (content::RenderFrame *frame = render_frame())
         if (content::RenderView *view = frame->GetRenderView())
             UserResourceController::instance()->removeScriptForView(script, view);
 }
 
-void UserResourceController::RenderFrameObserverHelper::onScriptsCleared()
+void UserResourceController::RenderFrameObserverHelper::ClearScripts()
 {
     if (content::RenderFrame *frame = render_frame())
         if (content::RenderView *view = frame->GetRenderView())
@@ -316,19 +334,13 @@ UserResourceController *UserResourceController::instance()
     return qt_webengine_userResourceController();
 }
 
-bool UserResourceController::OnControlMessageReceived(const IPC::Message &message)
+void UserResourceController::BindReceiver(
+        mojo::PendingAssociatedReceiver<qtwebengine::mojom::UserResourceController> receiver)
 {
-    bool handled = true;
-    IPC_BEGIN_MESSAGE_MAP(UserResourceController, message)
-        IPC_MESSAGE_HANDLER(UserResourceController_AddScript, onAddScript)
-        IPC_MESSAGE_HANDLER(UserResourceController_RemoveScript, onRemoveScript)
-        IPC_MESSAGE_HANDLER(UserResourceController_ClearScripts, onClearScripts)
-        IPC_MESSAGE_UNHANDLED(handled = false)
-    IPC_END_MESSAGE_MAP()
-    return handled;
+    m_binding.Bind(std::move(receiver));
 }
 
-UserResourceController::UserResourceController()
+UserResourceController::UserResourceController() : m_binding(this)
 {
 #if !defined(QT_NO_DEBUG) || defined(QT_FORCE_ASSERTS)
     static bool onlyCalledOnce = true;
@@ -360,7 +372,8 @@ void UserResourceController::renderViewDestroyed(content::RenderView *renderView
     m_viewUserScriptMap.remove(renderView);
 }
 
-void UserResourceController::addScriptForView(const UserScriptData &script, content::RenderView *view)
+void UserResourceController::addScriptForView(const QtWebEngineCore::UserScriptData &script,
+                                              content::RenderView *view)
 {
     ViewUserScriptMap::iterator it = m_viewUserScriptMap.find(view);
     if (it == m_viewUserScriptMap.end())
@@ -370,7 +383,8 @@ void UserResourceController::addScriptForView(const UserScriptData &script, cont
     m_scripts.insert(script.scriptId, script);
 }
 
-void UserResourceController::removeScriptForView(const UserScriptData &script, content::RenderView *view)
+void UserResourceController::removeScriptForView(const QtWebEngineCore::UserScriptData &script,
+                                                 content::RenderView *view)
 {
     ViewUserScriptMap::iterator it = m_viewUserScriptMap.find(view);
     if (it == m_viewUserScriptMap.end())
@@ -391,17 +405,17 @@ void UserResourceController::clearScriptsForView(content::RenderView *view)
     m_viewUserScriptMap.remove(view);
 }
 
-void UserResourceController::onAddScript(const UserScriptData &script)
+void UserResourceController::AddScript(const QtWebEngineCore::UserScriptData &script)
 {
     addScriptForView(script, globalScriptsIndex);
 }
 
-void UserResourceController::onRemoveScript(const UserScriptData &script)
+void UserResourceController::RemoveScript(const QtWebEngineCore::UserScriptData &script)
 {
     removeScriptForView(script, globalScriptsIndex);
 }
 
-void UserResourceController::onClearScripts()
+void UserResourceController::ClearScripts()
 {
     clearScriptsForView(globalScriptsIndex);
 }
diff --git a/src/core/renderer/user_resource_controller.h b/src/core/renderer/user_resource_controller.h
index 3a493b9b7..9350c9591 100644
--- a/src/core/renderer/user_resource_controller.h
+++ b/src/core/renderer/user_resource_controller.h
@@ -41,8 +41,9 @@
 #define USER_RESOURCE_CONTROLLER_H
 
 #include "content/public/renderer/render_thread_observer.h"
-
-#include "common/user_script_data.h"
+#include "qtwebengine/userscript/userscript.mojom.h"
+#include "qtwebengine/userscript/user_script_data.h"
+#include "mojo/public/cpp/bindings/associated_receiver.h"
 
 #include <QtCore/QHash>
 #include <QtCore/QSet>
@@ -56,7 +57,8 @@ class RenderFrame;
 class RenderView;
 }
 
-class UserResourceController : public content::RenderThreadObserver
+class UserResourceController : public content::RenderThreadObserver,
+                               qtwebengine::mojom::UserResourceController
 {
 
 public:
@@ -65,11 +67,13 @@ public:
     void renderFrameCreated(content::RenderFrame *);
     void renderViewCreated(content::RenderView *);
     void renderViewDestroyed(content::RenderView *renderView);
-    void addScriptForView(const UserScriptData &, content::RenderView *);
-    void removeScriptForView(const UserScriptData &, content::RenderView *);
+    void addScriptForView(const QtWebEngineCore::UserScriptData &, content::RenderView *);
+    void removeScriptForView(const QtWebEngineCore::UserScriptData &, content::RenderView *);
     void clearScriptsForView(content::RenderView *);
 
     void RunScriptsAtDocumentEnd(content::RenderFrame *render_frame);
+    void BindReceiver(
+            mojo::PendingAssociatedReceiver<qtwebengine::mojom::UserResourceController> receiver);
 
 private:
     Q_DISABLE_COPY(UserResourceController)
@@ -77,20 +81,17 @@ private:
     class RenderFrameObserverHelper;
     class RenderViewObserverHelper;
 
-    // RenderProcessObserver implementation.
-    bool OnControlMessageReceived(const IPC::Message &message) override;
-
-    void onAddScript(const UserScriptData &);
-    void onRemoveScript(const UserScriptData &);
-    void onClearScripts();
+    void AddScript(const QtWebEngineCore::UserScriptData &data) override;
+    void RemoveScript(const QtWebEngineCore::UserScriptData &data) override;
+    void ClearScripts() override;
 
-    void runScripts(UserScriptData::InjectionPoint, blink::WebLocalFrame *);
+    void runScripts(QtWebEngineCore::UserScriptData::InjectionPoint, blink::WebLocalFrame *);
 
     typedef QSet<uint64_t> UserScriptSet;
     typedef QHash<const content::RenderView *, UserScriptSet> ViewUserScriptMap;
     ViewUserScriptMap m_viewUserScriptMap;
-    QHash<uint64_t, UserScriptData> m_scripts;
-
+    QHash<uint64_t, QtWebEngineCore::UserScriptData> m_scripts;
+    mojo::AssociatedReceiver<qtwebengine::mojom::UserResourceController> m_binding;
     friend class RenderFrameObserverHelper;
 };