ladybird/Libraries/LibWeb/HTML/Scripting/WorkerEnvironmentSettingsObject.cpp

/*
 * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
 * Copyright (c) 2024, Tim Ledbetter <timledbetter@gmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <LibWeb/Bindings/PrincipalHostDefined.h>
#include <LibWeb/HTML/DedicatedWorkerGlobalScope.h>
#include <LibWeb/HTML/Scripting/WorkerEnvironmentSettingsObject.h>
#include <LibWeb/HTML/WorkerGlobalScope.h>
#include <LibWeb/HighResolutionTime/TimeOrigin.h>

namespace Web::HTML {

GC_DEFINE_ALLOCATOR(WorkerEnvironmentSettingsObject);

// https://html.spec.whatwg.org/multipage/workers.html#set-up-a-worker-environment-settings-object
GC::Ref<WorkerEnvironmentSettingsObject> WorkerEnvironmentSettingsObject::setup(GC::Ref<Page> page, NonnullOwnPtr<JS::ExecutionContext> execution_context, SerializedEnvironmentSettingsObject const& outside_settings, HighResolutionTime::DOMHighResTimeStamp unsafe_worker_creation_time)
{
    // 1. Let realm be the value of execution context's Realm component.
    auto realm = execution_context->realm;
    VERIFY(realm);

    // 2. Let worker global scope be realm's global object.
    auto& worker = as<HTML::WorkerGlobalScope>(realm->global_object());

    // 3. Let origin be a unique opaque origin if worker global scope's url's scheme is "data"; otherwise outside settings's origin.
    auto origin = worker.url().scheme() == "data" ? URL::Origin::create_opaque() : outside_settings.origin;

    // 4. Let settings object be a new environment settings object whose algorithms are defined as follows:
    // NOTE: See the functions defined for this class.
    // FIXME: Is it enough to cache the has_cross_site_ancestor of outside_settings, or do we need to check the live object somehow?
    auto settings_object = realm->create<WorkerEnvironmentSettingsObject>(move(execution_context), worker, move(origin), outside_settings.has_cross_site_ancestor, unsafe_worker_creation_time);
    settings_object->target_browsing_context = nullptr;

    // FIXME: 5. Set settings object's id to a new unique opaque string, creation URL to worker global scope's url, top-level creation URL to null, target browsing context to null, and active service worker to null.

    // 6. If worker global scope is a DedicatedWorkerGlobalScope object, then set settings object's top-level origin to
    //    outside settings's top-level origin.
    if (is<DedicatedWorkerGlobalScope>(worker)) {
        settings_object->top_level_origin = outside_settings.top_level_origin;
    }
    // 7. Otherwise, set settings object's top-level origin to an implementation-defined value.
    else {
        // FIXME: We set this to the same top-level origin as DedicatedWorkerGlobalScope objects for now, as this needs
        //        to be non-null for determining network partition keys. The spec notes:
        //
        //        See Client-Side Storage Partitioning for the latest on properly defining this.
        //        https://privacycg.github.io/storage-partitioning/
        settings_object->top_level_origin = outside_settings.top_level_origin;
    }

    // 8. Set realm's [[HostDefined]] field to settings object.
    auto intrinsics = realm->create<Bindings::Intrinsics>(*realm);
    auto host_defined = make<Bindings::PrincipalHostDefined>(settings_object, intrinsics, page);
    realm->set_host_defined(move(host_defined));

    // Non-Standard: We cannot fully initialize worker object until *after* the we set up
    //    the realm's [[HostDefined]] internal slot as the internal slot contains the web platform intrinsics
    worker.initialize_web_interfaces({});

    // 9. Return settings object.
    return settings_object;
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:api-base-url
URL::URL WorkerEnvironmentSettingsObject::api_base_url() const
{
    // Return worker global scope's url.
    return m_global_scope->url();
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:concept-settings-object-origin-2
URL::Origin WorkerEnvironmentSettingsObject::origin() const
{
    // Return origin.
    return m_origin;
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:concept-settings-object-has-cross-site-ancestor
bool WorkerEnvironmentSettingsObject::has_cross_site_ancestor() const
{
    // 1. If outside settings's has cross-site ancestor is true, then return true.
    if (m_outside_settings_has_cross_site_ancestor)
        return true;

    // 2. If worker global scope's url's scheme is "data", then return true.
    if (m_global_scope->url().scheme() == "data"sv)
        return true;

    // 3. Return false.
    return false;
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:concept-settings-object-policy-container
GC::Ref<PolicyContainer> WorkerEnvironmentSettingsObject::policy_container() const
{
    // Return worker global scope's policy container.
    return m_global_scope->policy_container();
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:concept-settings-object-cross-origin-isolated-capability
CanUseCrossOriginIsolatedAPIs WorkerEnvironmentSettingsObject::cross_origin_isolated_capability() const
{
    // FIXME: Return worker global scope's cross-origin isolated capability.
    return CanUseCrossOriginIsolatedAPIs::No;
}

// https://html.spec.whatwg.org/multipage/workers.html#script-settings-for-workers:concept-settings-object-time-origin
double WorkerEnvironmentSettingsObject::time_origin() const
{
    // Return the result of coarsening unsafeWorkerCreationTime with worker global scope's cross-origin isolated capability.
    return HighResolutionTime::coarsen_time(m_unsafe_worker_creation_time, cross_origin_isolated_capability() == CanUseCrossOriginIsolatedAPIs::Yes);
}

void WorkerEnvironmentSettingsObject::visit_edges(JS::Cell::Visitor& visitor)
{
    Base::visit_edges(visitor);
    visitor.visit(m_global_scope);
}

}