LibWeb: Add stub of ServiceWorker interface

Author: https://github.com/ADKaster
Commit: a0c07d1bb2
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/1404
Reviewed-by: https://github.com/tcl3 ✅

Tests/LibWeb/Text/expected/all-window-properties.txt

@@ -321,6 +321,7 @@ SVGUseElement
 Screen
 ScreenOrientation
 Selection
+ServiceWorker
 ServiceWorkerContainer
 ServiceWorkerRegistration
 Set

Userland/Libraries/LibWeb/CMakeLists.txt

@@ -447,6 +447,7 @@ set(SOURCES
     HTML/Scripting/SerializedEnvironmentSettingsObject.cpp
     HTML/SelectedFile.cpp
     HTML/SelectItem.cpp
+    HTML/ServiceWorker.cpp
     HTML/ServiceWorkerContainer.cpp
     HTML/ServiceWorkerRegistration.cpp
     HTML/SessionHistoryEntry.cpp

Userland/Libraries/LibWeb/HTML/ServiceWorker.cpp

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2024, Andrew Kaster <andrew@ladybird.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibJS/Heap/Heap.h>
+#include <LibJS/Runtime/Realm.h>
+#include <LibWeb/Bindings/Intrinsics.h>
+#include <LibWeb/HTML/EventNames.h>
+#include <LibWeb/HTML/ServiceWorker.h>
+
+namespace Web::HTML {
+
+ServiceWorker::ServiceWorker(JS::Realm& realm, String script_url)
+    : DOM::EventTarget(realm)
+    , m_script_url(move(script_url))
+{
+}
+
+ServiceWorker::~ServiceWorker() = default;
+
+JS::NonnullGCPtr<ServiceWorker> ServiceWorker::create(JS::Realm& realm)
+{
+    return realm.heap().allocate<ServiceWorker>(realm, realm, ""_string);
+}
+
+void ServiceWorker::initialize(JS::Realm& realm)
+{
+    Base::initialize(realm);
+    WEB_SET_PROTOTYPE_FOR_INTERFACE(ServiceWorker);
+}
+
+#undef __ENUMERATE
+#define __ENUMERATE(attribute_name, event_name)                           \
+    void ServiceWorker::set_##attribute_name(WebIDL::CallbackType* value) \
+    {                                                                     \
+        set_event_handler_attribute(event_name, value);                   \
+    }                                                                     \
+    WebIDL::CallbackType* ServiceWorker::attribute_name()                 \
+    {                                                                     \
+        return event_handler_attribute(event_name);                       \
+    }
+ENUMERATE_SERVICE_WORKER_EVENT_HANDLERS(__ENUMERATE)
+#undef __ENUMERATE
+
+}

Userland/Libraries/LibWeb/HTML/ServiceWorker.h

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2024, Andrew Kaster <andrew@ladybird.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <LibWeb/Bindings/ServiceWorkerPrototype.h>
+#include <LibWeb/DOM/EventTarget.h>
+#include <LibWeb/HTML/MessagePort.h>
+
+#define ENUMERATE_SERVICE_WORKER_EVENT_HANDLERS(E)  \
+    E(onstatechange, HTML::EventNames::statechange) \
+    E(onerror, HTML::EventNames::error)
+
+namespace Web::HTML {
+
+class ServiceWorker : public DOM::EventTarget {
+    WEB_PLATFORM_OBJECT(ServiceWorker, DOM::EventTarget);
+
+public:
+    [[nodiscard]] static JS::NonnullGCPtr<ServiceWorker> create(JS::Realm& realm);
+
+    virtual ~ServiceWorker() override;
+
+    String script_url() const { return m_script_url; }
+    Bindings::ServiceWorkerState service_worker_state() const { return m_state; }
+
+#undef __ENUMERATE
+#define __ENUMERATE(attribute_name, event_name)       \
+    void set_##attribute_name(WebIDL::CallbackType*); \
+    WebIDL::CallbackType* attribute_name();
+    ENUMERATE_SERVICE_WORKER_EVENT_HANDLERS(__ENUMERATE)
+#undef __ENUMERATE
+
+private:
+    ServiceWorker(JS::Realm&, String script_url);
+
+    virtual void initialize(JS::Realm&) override;
+
+    String m_script_url;
+    Bindings::ServiceWorkerState m_state { Bindings::ServiceWorkerState::Parsed };
+};
+
+}

Userland/Libraries/LibWeb/HTML/ServiceWorker.idl

@@ -0,0 +1,29 @@
+#import <DOM/EventTarget.idl>
+#import <DOM/EventHandler.idl>
+#import <HTML/AbstractWorker.idl>
+#import <HTML/MessagePort.idl>
+
+// https://w3c.github.io/ServiceWorker/#serviceworker-interface
+[SecureContext, Exposed=(Window,Worker)]
+interface ServiceWorker : EventTarget {
+    readonly attribute USVString scriptURL;
+    [ImplementedAs=service_worker_state] readonly attribute ServiceWorkerState state;
+
+    // FIXME: IDL overload issue here
+    // FIXME: undefined postMessage(any message, sequence<object> transfer);
+    [FIXME] undefined postMessage(any message, optional StructuredSerializeOptions options = {});
+
+    // event
+    attribute EventHandler onstatechange;
+};
+
+ServiceWorker includes AbstractWorker;
+
+enum ServiceWorkerState {
+    "parsed",
+    "installing",
+    "installed",
+    "activating",
+    "activated",
+    "redundant"
+};

Userland/Libraries/LibWeb/idl_files.cmake

@@ -215,6 +215,7 @@ libweb_js_bindings(HTML/Plugin)
 libweb_js_bindings(HTML/PluginArray)
 libweb_js_bindings(HTML/PopStateEvent)
 libweb_js_bindings(HTML/PromiseRejectionEvent)
+libweb_js_bindings(HTML/ServiceWorker)
 libweb_js_bindings(HTML/ServiceWorkerContainer)
 libweb_js_bindings(HTML/ServiceWorkerRegistration)
 libweb_js_bindings(HTML/Storage)