WebContent: Added IPC calls for initializing JS console and sending input

Author: https://github.com/xeons
Commit: https://github.com/SerenityOS/serenity/commit/51f073ff396
Pull-request: https://github.com/SerenityOS/serenity/pull/5556

Userland/Services/WebContent/CMakeLists.txt

@@ -5,6 +5,7 @@ set(SOURCES
     ClientConnection.cpp
     main.cpp
     PageHost.cpp
+    WebContentConsoleClient.cpp
     WebContentServerEndpoint.h
     WebContentClientEndpoint.h
 )

Userland/Services/WebContent/ClientConnection.cpp

@@ -28,7 +28,10 @@
 #include <AK/Debug.h>
 #include <LibGfx/Bitmap.h>
 #include <LibGfx/SystemTheme.h>
+#include <LibJS/Console.h>
 #include <LibJS/Heap/Heap.h>
+#include <LibJS/Interpreter.h>
+#include <LibJS/Parser.h>
 #include <LibJS/Runtime/VM.h>
 #include <LibWeb/Bindings/MainThreadVM.h>
 #include <LibWeb/DOM/Document.h>
@@ -216,4 +219,23 @@ void ClientConnection::handle(const Messages::WebContentServer::GetSource&)
     }
 }
 
+void ClientConnection::handle(const Messages::WebContentServer::JSConsoleInitialize&)
+{
+    if (auto* document = page().main_frame().document()) {
+        auto interpreter = document->interpreter().make_weak_ptr();
+        if (m_interpreter.ptr() == interpreter.ptr())
+            return;
+
+        m_interpreter = interpreter;
+        m_console_client = make<WebContentConsoleClient>(interpreter->global_object().console(), interpreter, *this);
+        interpreter->global_object().console().set_client(*m_console_client.ptr());
+    }
+}
+
+void ClientConnection::handle(const Messages::WebContentServer::JSConsoleInput& message)
+{
+    if (m_console_client)
+        m_console_client->handle_input(message.js_source());
+}
+
 }

Userland/Services/WebContent/ClientConnection.h

@@ -28,9 +28,11 @@
 
 #include <AK/HashMap.h>
 #include <LibIPC/ClientConnection.h>
+#include <LibJS/Forward.h>
 #include <LibWeb/Forward.h>
 #include <WebContent/Forward.h>
 #include <WebContent/WebContentClientEndpoint.h>
+#include <WebContent/WebContentConsoleClient.h>
 #include <WebContent/WebContentServerEndpoint.h>
 
 namespace WebContent {
@@ -65,11 +67,12 @@ private:
     virtual void handle(const Messages::WebContentServer::RemoveBackingStore&) override;
     virtual void handle(const Messages::WebContentServer::DebugRequest&) override;
     virtual void handle(const Messages::WebContentServer::GetSource&) override;
+    virtual void handle(const Messages::WebContentServer::JSConsoleInitialize&) override;
+    virtual void handle(const Messages::WebContentServer::JSConsoleInput&) override;
 
     void flush_pending_paint_requests();
 
     NonnullOwnPtr<PageHost> m_page_host;
-
     struct PaintRequest {
         Gfx::IntRect content_rect;
         NonnullRefPtr<Gfx::Bitmap> bitmap;
@@ -79,6 +82,9 @@ private:
     RefPtr<Core::Timer> m_paint_flush_timer;
 
     HashMap<i32, NonnullRefPtr<Gfx::Bitmap>> m_backing_stores;
+
+    WeakPtr<JS::Interpreter> m_interpreter;
+    OwnPtr<WebContentConsoleClient> m_console_client;
 };
 
 }

Userland/Services/WebContent/Forward.h

@@ -30,5 +30,6 @@ namespace WebContent {
 
 class ClientConnection;
 class PageHost;
+class WebContentConsoleClient;
 
 }

Userland/Services/WebContent/WebContentClient.ipc

@@ -18,4 +18,5 @@ endpoint WebContentClient = 90
     DidRequestConfirm(String message) => (bool result)
     DidRequestPrompt(String message, String default_) => (String response)
     DidGetSource(URL url, String source) =|
+    DidJSConsoleOutput(String method, String line) =|
 }

Userland/Services/WebContent/WebContentConsoleClient.cpp

@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2021, Brandon Scott <xeon.productions@gmail.com>
+ * Copyright (c) 2020, Hunter Salyer <thefalsehonesty@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "WebContentConsoleClient.h"
+#include <LibJS/Console.h>
+#include <LibJS/Interpreter.h>
+#include <LibJS/MarkupGenerator.h>
+#include <LibJS/Parser.h>
+#include <LibWeb/Bindings/DOMExceptionWrapper.h>
+#include <LibWeb/DOM/DocumentType.h>
+#include <LibWeb/DOM/Text.h>
+#include <LibWeb/DOMTreeModel.h>
+
+namespace WebContent {
+
+void WebContentConsoleClient::handle_input(const String& js_source)
+{
+    auto parser = JS::Parser(JS::Lexer(js_source));
+    auto program = parser.parse_program();
+
+    StringBuilder output_html;
+    if (parser.has_errors()) {
+        auto error = parser.errors()[0];
+        auto hint = error.source_location_hint(js_source);
+        if (!hint.is_empty())
+            output_html.append(String::formatted("<pre>{}</pre>", escape_html_entities(hint)));
+        m_interpreter->vm().throw_exception<JS::SyntaxError>(m_interpreter->global_object(), error.to_string());
+    } else {
+        m_interpreter->run(m_interpreter->global_object(), *program);
+    }
+
+    if (m_interpreter->exception()) {
+        output_html.append("Uncaught exception: ");
+        auto error = m_interpreter->exception()->value();
+        if (error.is_object() && is<Web::Bindings::DOMExceptionWrapper>(error.as_object())) {
+            auto& dom_exception_wrapper = static_cast<Web::Bindings::DOMExceptionWrapper&>(error.as_object());
+            error = JS::Error::create(m_interpreter->global_object(), dom_exception_wrapper.impl().name(), dom_exception_wrapper.impl().message());
+        }
+        output_html.append(JS::MarkupGenerator::html_from_value(error));
+        print_html(output_html.string_view());
+
+        m_interpreter->vm().clear_exception();
+        return;
+    }
+
+    print_html(JS::MarkupGenerator::html_from_value(m_interpreter->vm().last_value()));
+}
+
+void WebContentConsoleClient::print_html(const String& line)
+{
+    m_client.post_message(Messages::WebContentClient::DidJSConsoleOutput("html", line));
+}
+
+void WebContentConsoleClient::clear_output()
+{
+    m_client.post_message(Messages::WebContentClient::DidJSConsoleOutput("clear_output", {}));
+}
+
+JS::Value WebContentConsoleClient::log()
+{
+    print_html(vm().join_arguments());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::info()
+{
+    StringBuilder html;
+    html.append("<span class=\"info\">");
+    html.append("(i) ");
+    html.append(vm().join_arguments());
+    html.append("</span>");
+    print_html(html.string_view());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::debug()
+{
+    StringBuilder html;
+    html.append("<span class=\"debug\">");
+    html.append("(d) ");
+    html.append(vm().join_arguments());
+    html.append("</span>");
+    print_html(html.string_view());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::warn()
+{
+    StringBuilder html;
+    html.append("<span class=\"warn\">");
+    html.append("(w) ");
+    html.append(vm().join_arguments());
+    html.append("</span>");
+    print_html(html.string_view());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::error()
+{
+    StringBuilder html;
+    html.append("<span class=\"error\">");
+    html.append("(e) ");
+    html.append(vm().join_arguments());
+    html.append("</span>");
+    print_html(html.string_view());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::clear()
+{
+    clear_output();
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::trace()
+{
+    StringBuilder html;
+    html.append(vm().join_arguments());
+    auto trace = get_trace();
+    for (auto& function_name : trace) {
+        if (function_name.is_empty())
+            function_name = "&lt;anonymous&gt;";
+        html.appendff(" -> {}<br>", function_name);
+    }
+    print_html(html.string_view());
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::count()
+{
+    auto label = vm().argument_count() ? vm().argument(0).to_string_without_side_effects() : "default";
+    auto counter_value = m_console.counter_increment(label);
+    print_html(String::formatted("{}: {}", label, counter_value));
+    return JS::js_undefined();
+}
+
+JS::Value WebContentConsoleClient::count_reset()
+{
+    auto label = vm().argument_count() ? vm().argument(0).to_string_without_side_effects() : "default";
+    if (m_console.counter_reset(label)) {
+        print_html(String::formatted("{}: 0", label));
+    } else {
+        print_html(String::formatted("\"{}\" doesn't have a count", label));
+    }
+    return JS::js_undefined();
+}
+
+}

Userland/Services/WebContent/WebContentConsoleClient.h

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2021, Brandon Scott <xeon.productions@gmail.com>
+ * Copyright (c) 2020, Hunter Salyer <thefalsehonesty@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include "ClientConnection.h"
+#include <LibJS/Console.h>
+#include <LibJS/Forward.h>
+#include <LibWeb/Forward.h>
+#include <WebContent/Forward.h>
+
+namespace WebContent {
+
+class WebContentConsoleClient final : public JS::ConsoleClient {
+public:
+    WebContentConsoleClient(JS::Console& console, WeakPtr<JS::Interpreter> interpreter, ClientConnection& client)
+        : ConsoleClient(console)
+        , m_client(client)
+        , m_interpreter(interpreter)
+    {
+    }
+
+    void handle_input(const String& js_source);
+
+private:
+    virtual JS::Value log() override;
+    virtual JS::Value info() override;
+    virtual JS::Value debug() override;
+    virtual JS::Value warn() override;
+    virtual JS::Value error() override;
+    virtual JS::Value clear() override;
+    virtual JS::Value trace() override;
+    virtual JS::Value count() override;
+    virtual JS::Value count_reset() override;
+
+    ClientConnection& m_client;
+    WeakPtr<JS::Interpreter> m_interpreter;
+    void clear_output();
+    void print_html(const String& line);
+};
+
+}

Userland/Services/WebContent/WebContentServer.ipc

@@ -22,4 +22,6 @@ endpoint WebContentServer = 89
 
     DebugRequest(String request, String argument) =|
     GetSource() =|
+    JSConsoleInitialize() =|
+    JSConsoleInput(String js_source) =|
 }