/* * Copyright (c) 2023, Andrew Kaster * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace WebWorker { WorkerHost::WorkerHost(URL::URL url, Web::Bindings::WorkerType type, String name) : m_url(move(url)) , m_type(type) , m_name(move(name)) { } WorkerHost::~WorkerHost() = default; // https://html.spec.whatwg.org/multipage/workers.html#relevant-owner-to-add static Web::HTML::WorkerGlobalScope::Owner relevant_owner_to_add(Web::HTML::SerializedEnvironmentSettingsObject const& outside_settings) { // Given an environment settings object o when creating or obtaining a worker, the relevant owner to add depends on the type of global object specified by o. return outside_settings.global.visit( // If o's global object is a WorkerGlobalScope object (i.e., if we are creating a nested dedicated worker), then the relevant owner is that global object. [](Web::HTML::SerializedWorkerGlobalScope const& worker) -> Web::HTML::WorkerGlobalScope::Owner { return worker; }, // Otherwise, o's global object is a Window object, and the relevant owner is that Window's associated Document. [](Web::HTML::SerializedWindow const& window) -> Web::HTML::WorkerGlobalScope::Owner { return window.associated_document; }); } // https://html.spec.whatwg.org/multipage/workers.html#run-a-worker void WorkerHost::run(GC::Ref page, Web::HTML::TransferDataEncoder message_port_data, Web::HTML::SerializedEnvironmentSettingsObject const& outside_settings_snapshot, Web::Bindings::RequestCredentials credentials, bool is_shared) { // 1. Let is shared be true if worker is a SharedWorker object, and false otherwise. // 2. Let owner be the relevant owner to add given outside settings. auto owner = relevant_owner_to_add(outside_settings_snapshot); // 3. Let unsafeWorkerCreationTime be the unsafe shared current time. auto unsafe_worker_creation_time = Web::HighResolutionTime::unsafe_shared_current_time(); // 5. Let realm execution context be the result of creating a new realm given agent and the following customizations: auto realm_execution_context = Web::Bindings::create_a_new_javascript_realm( Web::Bindings::main_thread_vm(), [page, is_shared](JS::Realm& realm) -> JS::Object* { // For the global object, if is shared is true, create a new SharedWorkerGlobalScope object. if (is_shared) return realm.heap().allocate(realm, page); // Otherwise, create a new DedicatedWorkerGlobalScope object. return realm.heap().allocate(realm, page); }, nullptr); // 6. Let worker global scope be the global object of realm execution context's Realm component. // NOTE: This is the DedicatedWorkerGlobalScope or SharedWorkerGlobalScope object created in the previous step. GC::Ref worker_global_scope = as(realm_execution_context->realm->global_object()); // AD-HOC: The spec assumes when setting up the worker environment settings object that the URL is already set on // the worker global scope. This is not the case. This URL is only known after performing the fetch, and in // particular after redirects. See spec issue: https://github.com/whatwg/html/issues/11340. The main part // which will need some rework to fix in a nice way is setting up a temporary environment for use in // performing the initial fetch. // // As a workaround for now, set the URL here before setting up the environment settings object. worker_global_scope->set_url(m_url); // 9. Append owner to worker global scope's owner set. // AD-HOC: We need to do this slightly out of order compared to the spec. We initialize // web interfaces as part of step 7, which checks SecureContext for interface // exposure which itself requires owner set to be populated. worker_global_scope->owner_set().append(owner); // 7. Set up a worker environment settings object with realm execution context, outside settings, and // unsafeWorkerCreationTime, and let inside settings be the result. auto inside_settings = Web::HTML::WorkerEnvironmentSettingsObject::setup(page, move(realm_execution_context), outside_settings_snapshot, unsafe_worker_creation_time); // AD-HOC: Create a console object for the worker. auto& console_object = *inside_settings->realm().intrinsics().console_object(); m_console = console_object.heap().allocate(console_object.console()); VERIFY(m_console); console_object.console().set_client(*m_console); // 8. Set worker global scope's name to options["name"]. worker_global_scope->set_name(m_name); // IMPLEMENTATION DEFINED: We need an object to represent the fetch response's client auto outside_settings = inside_settings->realm().create(inside_settings->realm(), inside_settings->realm_execution_context().copy(), outside_settings_snapshot); // HACK: The environment settings object used for the worker script fetch should have a Window as its global scope, // but the EnvironmentSettingsSnapshot used here has a WorkerGlobalScope (we don't have access to a Window). // This causes the Referrer-Policy spec's "determine request's referrer" algorithm to read the ESO's creation // URL, whereas it would normally read the document's URL. To hack around this, we overwrite the creation URL // (which is only used in the initial worker script fetch). if (auto const* window = outside_settings_snapshot.global.get_pointer()) outside_settings->creation_url = window->associated_document.url; // 10. If is shared is true, then: if (is_shared) { auto& shared_global_scope = static_cast(*worker_global_scope); // 1. Set worker global scope's constructor origin to outside settings's origin. shared_global_scope.set_constructor_origin(outside_settings->origin()); // 2. Set worker global scope's constructor URL to url. shared_global_scope.set_constructor_url(m_url); // 3. Set worker global scope's type to options["type"]. shared_global_scope.set_type(m_type); // 4. Set worker global scope's credentials to options["credentials"]. shared_global_scope.set_credentials(Web::Fetch::from_bindings_enum(credentials)); } // 11. Let destination be "sharedworker" if is shared is true, and "worker" otherwise. auto destination = is_shared ? Web::Fetch::Infrastructure::Request::Destination::SharedWorker : Web::Fetch::Infrastructure::Request::Destination::Worker; // In both cases, let performFetch be the following perform the fetch hook given request, isTopLevel, and processCustomFetchResponse: auto perform_fetch_function = [inside_settings, worker_global_scope, is_shared](GC::Ref request, Web::HTML::TopLevelModule is_top_level, Web::Fetch::Infrastructure::FetchAlgorithms::ProcessResponseConsumeBodyFunction process_custom_fetch_response) -> Web::WebIDL::ExceptionOr { auto& realm = inside_settings->realm(); auto& vm = realm.vm(); Web::Fetch::Infrastructure::FetchAlgorithms::Input fetch_algorithms_input {}; // 1. If isTopLevel is false, fetch request with processResponseConsumeBody set to processCustomFetchResponse, // and abort these steps. if (is_top_level == Web::HTML::TopLevelModule::No) { fetch_algorithms_input.process_response_consume_body = move(process_custom_fetch_response); Web::Fetch::Fetching::fetch(realm, request, Web::Fetch::Infrastructure::FetchAlgorithms::create(vm, move(fetch_algorithms_input))); return {}; } // 2. Set request's reserved client to inside settings. request->set_reserved_client(GC::Ptr(inside_settings)); // NB: We need to store the process custom fetch response function on the heap here, because we're storing it // in another heap function auto process_custom_fetch_response_function = GC::create_function(vm.heap(), move(process_custom_fetch_response)); // 3. Fetch request with processResponseConsumeBody set to the following steps given response response and // null, failure, or a byte sequence bodyBytes: fetch_algorithms_input.process_response_consume_body = [worker_global_scope, process_custom_fetch_response_function, inside_settings, is_shared](auto response, auto body_bytes) { auto& vm = inside_settings->vm(); // 1. Set worker global scope's url to response's url. worker_global_scope->set_url(response->url().value_or({})); // 2. Set inside settings's creation URL to response's url. inside_settings->creation_url = worker_global_scope->url(); // 3. Initialize worker global scope's policy container given worker global scope, response, and inside // settings. worker_global_scope->initialize_policy_container(response, inside_settings); // 4. If the Run CSP initialization for a global object algorithm returns "Blocked" when executed upon // worker global scope, set response to a network error. [CSP] if (worker_global_scope->run_csp_initialization() == Web::ContentSecurityPolicy::Directives::Directive::Result::Blocked) { response = Web::Fetch::Infrastructure::Response::network_error(vm, "Blocked by Content Security Policy"_string); } // FIXME: Use worker global scope's policy container's embedder policy // FIXME: 5. If worker global scope's embedder policy's value is compatible with cross-origin isolation and is shared is true, // then set agent's agent cluster's cross-origin isolation mode to "logical" or "concrete". // The one chosen is implementation-defined. // FIXME: 6. If the result of checking a global object's embedder policy with worker global scope, outside settings, // and response is false, then set response to a network error. // FIXME: 7. Set worker global scope's cross-origin isolated capability to true if agent's agent cluster's cross-origin // isolation mode is "concrete". if (!is_shared) { // FIXME: 8. If is shared is false and owner's cross-origin isolated capability is false, then set worker // global scope's cross-origin isolated capability to false. // FIXME: 9. If is shared is false and response's url's scheme is "data", then set worker global scope's // cross-origin isolated capability to false. } // 10. Run processCustomFetchResponse with response and bodyBytes. process_custom_fetch_response_function->function()(response, body_bytes); }; Web::Fetch::Fetching::fetch(realm, request, Web::Fetch::Infrastructure::FetchAlgorithms::create(vm, move(fetch_algorithms_input))); return {}; }; auto perform_fetch = Web::HTML::create_perform_the_fetch_hook(inside_settings->heap(), move(perform_fetch_function)); // In both cases, let onComplete given script be the following steps: auto on_complete_function = [page, inside_settings, worker_global_scope, message_port_data = move(message_port_data), url = m_url, is_shared](GC::Ptr script) mutable { auto& realm = inside_settings->realm(); // 1. If script is null or if script's error to rethrow is non-null, then: if (!script || !script->error_to_rethrow().is_null()) { // 1. Queue a global task on the DOM manipulation task source given worker's relevant global object to fire an event named error at worker. as(page->client()).did_fail_loading_worker_script(); // 2. Run the environment discarding steps for inside settings. inside_settings->discard_environment(); // 3. Abort these steps. dbgln("DedicatedWorkerHost: Unable to fetch script {} because {}", url, script ? script->error_to_rethrow().to_string_without_side_effects() : "script was null"_string); return; } // FIXME: 2. Associate worker with worker global scope. // What does this even mean? // 3. Let inside port be a new MessagePort object in inside settings's realm. auto inside_port = Web::HTML::MessagePort::create(realm); // 4. If is shared is false, then: if (!is_shared) { // FIXME: 1. Set inside port's message event target to worker global scope. // 2. Set worker global scope's inside port to inside port. worker_global_scope->set_internal_port(inside_port); } // 5. Entangle outside port and inside port. Web::HTML::TransferDataDecoder decoder { move(message_port_data) }; MUST(inside_port->transfer_receiving_steps(decoder)); // 6. Create a new WorkerLocation object and associate it with worker global scope. worker_global_scope->set_location(realm.create(*worker_global_scope)); // FIXME: 7. Closing orphan workers: Start monitoring the worker such that no sooner than it // stops being a protected worker, and no later than it stops being a permissible worker, // worker global scope's closing flag is set to true. // FIXME: 8. Suspending workers: Start monitoring the worker, such that whenever worker global scope's // closing flag is false and the worker is a suspendable worker, the user agent suspends // execution of script in that worker until such time as either the closing flag switches to // true or the worker stops being a suspendable worker // 9. Set inside settings's execution ready flag. inside_settings->execution_ready = true; // 10. If script is a classic script, then run the classic script script. // Otherwise, it is a module script; run the module script script. if (auto* classic_script = as_if(*script)) (void)classic_script->run(); else (void)as(*script).run(); as(page->client()).did_finish_loading_worker_script(); // FIXME: 11. Enable outside port's port message queue. // 12. If is shared is false, enable the port message queue of the worker's implicit port. if (!is_shared) { inside_port->enable(); } // 13. If is shared is true, then queue a global task on the DOM manipulation task source given worker // global scope to fire an event named connect at worker global scope, using MessageEvent, // with the data attribute initialized to the empty string, the ports attribute initialized // to a new frozen array containing inside port, and the source attribute initialized to inside port. if (is_shared) { Web::HTML::queue_global_task(Web::HTML::Task::Source::DOMManipulation, *worker_global_scope, GC::create_function(realm.heap(), [worker_global_scope, inside_port] { auto& realm = worker_global_scope->realm(); auto& vm = realm.vm(); Web::HTML::TemporaryExecutionContext const context(realm); Web::HTML::MessageEventInit event_init {}; event_init.data = GC::Ref { vm.empty_string() }; event_init.ports = { inside_port }; event_init.source = Web::HTML::NullableMessageEventSource { inside_port }; auto message_event = Web::HTML::MessageEvent::create(realm, Web::HTML::EventNames::connect, event_init); worker_global_scope->dispatch_event(message_event); })); } // FIXME: 14. Enable the client message queue of the ServiceWorkerContainer object whose associated service // worker client is worker global scope's relevant settings object. // 15. Event loop: Run the responsible event loop specified by inside settings until it is destroyed. inside_settings->responsible_event_loop().schedule(); // FIXME: We need to react to the closing flag being set on the responsible event loop // And use that to shutdown the WorkerHost // FIXME: 16. Clear the worker global scope's map of active timers. // FIXME: 17. Disentangle all the ports in the list of the worker's ports. // FIXME: 18. Empty worker global scope's owner set. }; auto on_complete = Web::HTML::create_on_fetch_script_complete(inside_settings->vm().heap(), move(on_complete_function)); // 12. Obtain script by switching on the value of options's type member: if (m_type == Web::Bindings::WorkerType::Classic) { // -> "classic": // Fetch a classic worker script given url, outside settings, destination, inside settings, and with // onComplete and performFetch as defined below. if (auto err = Web::HTML::fetch_classic_worker_script(m_url, outside_settings, destination, inside_settings, perform_fetch, on_complete); err.is_error()) { dbgln("Failed to run worker script"); // FIXME: Abort the worker properly TODO(); } } else { // -> "module": // Fetch a module worker script graph given url, outside settings, destination, the value of the credentials // member of options, inside settings, and with onComplete and performFetch as defined below. VERIFY(m_type == Web::Bindings::WorkerType::Module); // FIXME: Pass credentials if (auto err = Web::HTML::fetch_module_worker_script_graph(m_url, outside_settings, destination, inside_settings, perform_fetch, on_complete); err.is_error()) { dbgln("Failed to run worker script"); // FIXME: Abort the worker properly TODO(); } } } }