MainThreadVM.cpp 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  1. /*
  2. * Copyright (c) 2021-2022, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021-2023, Luke Wilde <lukew@serenityos.org>
  4. * Copyright (c) 2022-2023, networkException <networkexception@serenityos.org>
  5. * Copyright (c) 2022-2023, Linus Groh <linusg@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <LibJS/AST.h>
  10. #include <LibJS/Heap/DeferGC.h>
  11. #include <LibJS/Module.h>
  12. #include <LibJS/Runtime/Array.h>
  13. #include <LibJS/Runtime/Environment.h>
  14. #include <LibJS/Runtime/FinalizationRegistry.h>
  15. #include <LibJS/Runtime/ModuleRequest.h>
  16. #include <LibJS/Runtime/NativeFunction.h>
  17. #include <LibJS/Runtime/VM.h>
  18. #include <LibJS/SourceTextModule.h>
  19. #include <LibWeb/Bindings/ExceptionOrUtils.h>
  20. #include <LibWeb/Bindings/Intrinsics.h>
  21. #include <LibWeb/Bindings/MainThreadVM.h>
  22. #include <LibWeb/Bindings/WindowExposedInterfaces.h>
  23. #include <LibWeb/DOM/Document.h>
  24. #include <LibWeb/DOM/MutationType.h>
  25. #include <LibWeb/HTML/AttributeNames.h>
  26. #include <LibWeb/HTML/CustomElements/CustomElementDefinition.h>
  27. #include <LibWeb/HTML/CustomElements/CustomElementReactionNames.h>
  28. #include <LibWeb/HTML/EventNames.h>
  29. #include <LibWeb/HTML/Location.h>
  30. #include <LibWeb/HTML/PromiseRejectionEvent.h>
  31. #include <LibWeb/HTML/Scripting/ClassicScript.h>
  32. #include <LibWeb/HTML/Scripting/Environments.h>
  33. #include <LibWeb/HTML/Scripting/ExceptionReporter.h>
  34. #include <LibWeb/HTML/Scripting/Fetching.h>
  35. #include <LibWeb/HTML/Scripting/ModuleScript.h>
  36. #include <LibWeb/HTML/Scripting/Script.h>
  37. #include <LibWeb/HTML/Scripting/TemporaryExecutionContext.h>
  38. #include <LibWeb/HTML/TagNames.h>
  39. #include <LibWeb/HTML/Window.h>
  40. #include <LibWeb/HTML/WindowProxy.h>
  41. #include <LibWeb/MathML/TagNames.h>
  42. #include <LibWeb/Namespace.h>
  43. #include <LibWeb/NavigationTiming/EntryNames.h>
  44. #include <LibWeb/PerformanceTimeline/EntryTypes.h>
  45. #include <LibWeb/Platform/EventLoopPlugin.h>
  46. #include <LibWeb/SVG/AttributeNames.h>
  47. #include <LibWeb/SVG/TagNames.h>
  48. #include <LibWeb/UIEvents/EventNames.h>
  49. #include <LibWeb/WebGL/EventNames.h>
  50. #include <LibWeb/WebIDL/AbstractOperations.h>
  51. #include <LibWeb/XHR/EventNames.h>
  52. #include <LibWeb/XLink/AttributeNames.h>
  53. namespace Web::Bindings {
  54. static RefPtr<JS::VM> s_main_thread_vm;
  55. // https://html.spec.whatwg.org/multipage/webappapis.html#active-script
  56. HTML::Script* active_script()
  57. {
  58. // 1. Let record be GetActiveScriptOrModule().
  59. auto record = main_thread_vm().get_active_script_or_module();
  60. // 2. If record is null, return null.
  61. // 3. Return record.[[HostDefined]].
  62. return record.visit(
  63. [](JS::NonnullGCPtr<JS::Script>& js_script) -> HTML::Script* {
  64. return verify_cast<HTML::ClassicScript>(js_script->host_defined());
  65. },
  66. [](JS::NonnullGCPtr<JS::Module>& js_module) -> HTML::Script* {
  67. return verify_cast<HTML::ModuleScript>(js_module->host_defined());
  68. },
  69. [](Empty) -> HTML::Script* {
  70. return nullptr;
  71. });
  72. }
  73. ErrorOr<void> initialize_main_thread_vm(HTML::EventLoop::Type type)
  74. {
  75. VERIFY(!s_main_thread_vm);
  76. s_main_thread_vm = TRY(JS::VM::create(make<WebEngineCustomData>()));
  77. s_main_thread_vm->on_unimplemented_property_access = [](auto const& object, auto const& property_key) {
  78. dbgln("FIXME: Unimplemented IDL interface: '{}.{}'", object.class_name(), property_key.to_string());
  79. };
  80. // NOTE: We intentionally leak the main thread JavaScript VM.
  81. // This avoids doing an exhaustive garbage collection on process exit.
  82. s_main_thread_vm->ref();
  83. auto& custom_data = verify_cast<WebEngineCustomData>(*s_main_thread_vm->custom_data());
  84. custom_data.event_loop = s_main_thread_vm->heap().allocate_without_realm<HTML::EventLoop>(type);
  85. // These strings could potentially live on the VM similar to CommonPropertyNames.
  86. DOM::MutationType::initialize_strings();
  87. HTML::AttributeNames::initialize_strings();
  88. HTML::CustomElementReactionNames::initialize_strings();
  89. HTML::EventNames::initialize_strings();
  90. HTML::TagNames::initialize_strings();
  91. MathML::TagNames::initialize_strings();
  92. Namespace::initialize_strings();
  93. NavigationTiming::EntryNames::initialize_strings();
  94. PerformanceTimeline::EntryTypes::initialize_strings();
  95. SVG::AttributeNames::initialize_strings();
  96. SVG::TagNames::initialize_strings();
  97. UIEvents::EventNames::initialize_strings();
  98. WebGL::EventNames::initialize_strings();
  99. XHR::EventNames::initialize_strings();
  100. XLink::AttributeNames::initialize_strings();
  101. // 8.1.5.1 HostEnsureCanAddPrivateElement(O), https://html.spec.whatwg.org/multipage/webappapis.html#the-hostensurecanaddprivateelement-implementation
  102. s_main_thread_vm->host_ensure_can_add_private_element = [](JS::Object const& object) -> JS::ThrowCompletionOr<void> {
  103. // 1. If O is a WindowProxy object, or implements Location, then return Completion { [[Type]]: throw, [[Value]]: a new TypeError }.
  104. if (is<HTML::WindowProxy>(object) || is<HTML::Location>(object))
  105. return s_main_thread_vm->throw_completion<JS::TypeError>("Cannot add private elements to window or location object"sv);
  106. // 2. Return NormalCompletion(unused).
  107. return {};
  108. };
  109. // FIXME: Implement 8.1.5.2 HostEnsureCanCompileStrings(callerRealm, calleeRealm), https://html.spec.whatwg.org/multipage/webappapis.html#hostensurecancompilestrings(callerrealm,-calleerealm)
  110. // 8.1.5.3 HostPromiseRejectionTracker(promise, operation), https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
  111. s_main_thread_vm->host_promise_rejection_tracker = [](JS::Promise& promise, JS::Promise::RejectionOperation operation) {
  112. // 1. Let script be the running script.
  113. // The running script is the script in the [[HostDefined]] field in the ScriptOrModule component of the running JavaScript execution context.
  114. HTML::Script* script { nullptr };
  115. s_main_thread_vm->running_execution_context().script_or_module.visit(
  116. [&script](JS::NonnullGCPtr<JS::Script>& js_script) {
  117. script = verify_cast<HTML::ClassicScript>(js_script->host_defined());
  118. },
  119. [&script](JS::NonnullGCPtr<JS::Module>& js_module) {
  120. script = verify_cast<HTML::ModuleScript>(js_module->host_defined());
  121. },
  122. [](Empty) {
  123. });
  124. // 2. If script is a classic script and script's muted errors is true, then return.
  125. // NOTE: is<T>() returns false if nullptr is passed.
  126. if (is<HTML::ClassicScript>(script)) {
  127. auto const& classic_script = static_cast<HTML::ClassicScript const&>(*script);
  128. if (classic_script.muted_errors() == HTML::ClassicScript::MutedErrors::Yes)
  129. return;
  130. }
  131. // 3. Let settings object be the current settings object.
  132. // 4. If script is not null, then set settings object to script's settings object.
  133. auto& settings_object = script ? script->settings_object() : HTML::current_settings_object();
  134. switch (operation) {
  135. case JS::Promise::RejectionOperation::Reject:
  136. // 4. If operation is "reject",
  137. // 1. Add promise to settings object's about-to-be-notified rejected promises list.
  138. settings_object.push_onto_about_to_be_notified_rejected_promises_list(promise);
  139. break;
  140. case JS::Promise::RejectionOperation::Handle: {
  141. // 5. If operation is "handle",
  142. // 1. If settings object's about-to-be-notified rejected promises list contains promise, then remove promise from that list and return.
  143. bool removed_about_to_be_notified_rejected_promise = settings_object.remove_from_about_to_be_notified_rejected_promises_list(promise);
  144. if (removed_about_to_be_notified_rejected_promise)
  145. return;
  146. // 3. Remove promise from settings object's outstanding rejected promises weak set.
  147. bool removed_outstanding_rejected_promise = settings_object.remove_from_outstanding_rejected_promises_weak_set(&promise);
  148. // 2. If settings object's outstanding rejected promises weak set does not contain promise, then return.
  149. // NOTE: This is done out of order because removed_outstanding_rejected_promise will be false if the promise wasn't in the set or true if it was and got removed.
  150. if (!removed_outstanding_rejected_promise)
  151. return;
  152. // 4. Let global be settings object's global object.
  153. auto& global = settings_object.global_object();
  154. // 5. Queue a global task on the DOM manipulation task source given global to fire an event named rejectionhandled at global, using PromiseRejectionEvent,
  155. // with the promise attribute initialized to promise, and the reason attribute initialized to the value of promise's [[PromiseResult]] internal slot.
  156. HTML::queue_global_task(HTML::Task::Source::DOMManipulation, global, JS::create_heap_function(s_main_thread_vm->heap(), [&global, &promise] {
  157. // FIXME: This currently assumes that global is a WindowObject.
  158. auto& window = verify_cast<HTML::Window>(global);
  159. HTML::PromiseRejectionEventInit event_init {
  160. {}, // Initialize the inherited DOM::EventInit
  161. /* .promise = */ promise,
  162. /* .reason = */ promise.result(),
  163. };
  164. auto promise_rejection_event = HTML::PromiseRejectionEvent::create(HTML::relevant_realm(global), HTML::EventNames::rejectionhandled, event_init);
  165. window.dispatch_event(promise_rejection_event);
  166. }));
  167. break;
  168. }
  169. default:
  170. VERIFY_NOT_REACHED();
  171. }
  172. };
  173. // 8.1.5.4.1 HostCallJobCallback(callback, V, argumentsList), https://html.spec.whatwg.org/multipage/webappapis.html#hostcalljobcallback
  174. s_main_thread_vm->host_call_job_callback = [](JS::JobCallback& callback, JS::Value this_value, ReadonlySpan<JS::Value> arguments_list) {
  175. auto& callback_host_defined = verify_cast<WebEngineCustomJobCallbackData>(*callback.custom_data());
  176. // 1. Let incumbent settings be callback.[[HostDefined]].[[IncumbentSettings]]. (NOTE: Not necessary)
  177. // 2. Let script execution context be callback.[[HostDefined]].[[ActiveScriptContext]]. (NOTE: Not necessary)
  178. // 3. Prepare to run a callback with incumbent settings.
  179. callback_host_defined.incumbent_settings->prepare_to_run_callback();
  180. // 4. If script execution context is not null, then push script execution context onto the JavaScript execution context stack.
  181. if (callback_host_defined.active_script_context)
  182. s_main_thread_vm->push_execution_context(*callback_host_defined.active_script_context);
  183. // 5. Let result be Call(callback.[[Callback]], V, argumentsList).
  184. auto result = JS::call(*s_main_thread_vm, callback.callback(), this_value, arguments_list);
  185. // 6. If script execution context is not null, then pop script execution context from the JavaScript execution context stack.
  186. if (callback_host_defined.active_script_context) {
  187. VERIFY(&s_main_thread_vm->running_execution_context() == callback_host_defined.active_script_context.ptr());
  188. s_main_thread_vm->pop_execution_context();
  189. }
  190. // 7. Clean up after running a callback with incumbent settings.
  191. callback_host_defined.incumbent_settings->clean_up_after_running_callback();
  192. // 8. Return result.
  193. return result;
  194. };
  195. // 8.1.5.4.2 HostEnqueueFinalizationRegistryCleanupJob(finalizationRegistry), https://html.spec.whatwg.org/multipage/webappapis.html#hostenqueuefinalizationregistrycleanupjob
  196. s_main_thread_vm->host_enqueue_finalization_registry_cleanup_job = [](JS::FinalizationRegistry& finalization_registry) {
  197. // 1. Let global be finalizationRegistry.[[Realm]]'s global object.
  198. auto& global = finalization_registry.realm().global_object();
  199. // 2. Queue a global task on the JavaScript engine task source given global to perform the following steps:
  200. HTML::queue_global_task(HTML::Task::Source::JavaScriptEngine, global, JS::create_heap_function(s_main_thread_vm->heap(), [&finalization_registry] {
  201. // 1. Let entry be finalizationRegistry.[[CleanupCallback]].[[Callback]].[[Realm]]'s environment settings object.
  202. auto& entry = host_defined_environment_settings_object(*finalization_registry.cleanup_callback().callback().realm());
  203. // 2. Check if we can run script with entry. If this returns "do not run", then return.
  204. if (entry.can_run_script() == HTML::RunScriptDecision::DoNotRun)
  205. return;
  206. // 3. Prepare to run script with entry.
  207. entry.prepare_to_run_script();
  208. // 4. Let result be the result of performing CleanupFinalizationRegistry(finalizationRegistry).
  209. auto result = finalization_registry.cleanup();
  210. // 5. Clean up after running script with entry.
  211. entry.clean_up_after_running_script();
  212. // 6. If result is an abrupt completion, then report the exception given by result.[[Value]].
  213. if (result.is_error())
  214. HTML::report_exception(result, finalization_registry.realm());
  215. }));
  216. };
  217. // 8.1.5.4.3 HostEnqueuePromiseJob(job, realm), https://html.spec.whatwg.org/multipage/webappapis.html#hostenqueuepromisejob
  218. s_main_thread_vm->host_enqueue_promise_job = [](JS::NonnullGCPtr<JS::HeapFunction<JS::ThrowCompletionOr<JS::Value>()>> job, JS::Realm* realm) {
  219. // 1. If realm is not null, then let job settings be the settings object for realm. Otherwise, let job settings be null.
  220. HTML::EnvironmentSettingsObject* job_settings { nullptr };
  221. if (realm)
  222. job_settings = &host_defined_environment_settings_object(*realm);
  223. // IMPLEMENTATION DEFINED: The JS spec says we must take implementation defined steps to make the currently active script or module at the time of HostEnqueuePromiseJob being invoked
  224. // also be the active script or module of the job at the time of its invocation.
  225. // This means taking it here now and passing it through to the lambda.
  226. auto script_or_module = s_main_thread_vm->get_active_script_or_module();
  227. // 2. Queue a microtask on the surrounding agent's event loop to perform the following steps:
  228. // This instance of "queue a microtask" uses the "implied document". The best fit for "implied document" here is "If the task is being queued by or for a script, then return the script's settings object's responsible document."
  229. // Do note that "implied document" from the spec is handwavy and the spec authors are trying to get rid of it: https://github.com/whatwg/html/issues/4980
  230. auto* script = active_script();
  231. auto& heap = realm ? realm->heap() : s_main_thread_vm->heap();
  232. // NOTE: This keeps job_settings alive by keeping realm alive, which is holding onto job_settings.
  233. HTML::queue_a_microtask(script ? script->settings_object().responsible_document().ptr() : nullptr, JS::create_heap_function(heap, [job_settings, job = move(job), script_or_module = move(script_or_module)] {
  234. // The dummy execution context has to be kept up here to keep it alive for the duration of the function.
  235. OwnPtr<JS::ExecutionContext> dummy_execution_context;
  236. if (job_settings) {
  237. // 1. If job settings is not null, then check if we can run script with job settings. If this returns "do not run" then return.
  238. if (job_settings->can_run_script() == HTML::RunScriptDecision::DoNotRun)
  239. return;
  240. // 2. If job settings is not null, then prepare to run script with job settings.
  241. job_settings->prepare_to_run_script();
  242. // IMPLEMENTATION DEFINED: Additionally to preparing to run a script, we also prepare to run a callback here. This matches WebIDL's
  243. // invoke_callback() / call_user_object_operation() functions, and prevents a crash in host_make_job_callback()
  244. // when getting the incumbent settings object.
  245. job_settings->prepare_to_run_callback();
  246. // IMPLEMENTATION DEFINED: Per the previous "implementation defined" comment, we must now make the script or module the active script or module.
  247. // Since the only active execution context currently is the realm execution context of job settings, lets attach it here.
  248. job_settings->realm_execution_context().script_or_module = script_or_module;
  249. } else {
  250. // FIXME: We need to setup a dummy execution context in case a JS::NativeFunction is called when processing the job.
  251. // This is because JS::NativeFunction::call excepts something to be on the execution context stack to be able to get the caller context to initialize the environment.
  252. // Do note that the JS spec gives _no_ guarantee that the execution context stack has something on it if HostEnqueuePromiseJob was called with a null realm: https://tc39.es/ecma262/#job-preparedtoevaluatecode
  253. dummy_execution_context = JS::ExecutionContext::create();
  254. dummy_execution_context->script_or_module = script_or_module;
  255. s_main_thread_vm->push_execution_context(*dummy_execution_context);
  256. }
  257. // 3. Let result be job().
  258. auto result = job->function()();
  259. // 4. If job settings is not null, then clean up after running script with job settings.
  260. if (job_settings) {
  261. // IMPLEMENTATION DEFINED: Disassociate the realm execution context from the script or module.
  262. job_settings->realm_execution_context().script_or_module = Empty {};
  263. // IMPLEMENTATION DEFINED: See comment above, we need to clean up the non-standard prepare_to_run_callback() call.
  264. job_settings->clean_up_after_running_callback();
  265. job_settings->clean_up_after_running_script();
  266. } else {
  267. // Pop off the dummy execution context. See the above FIXME block about why this is done.
  268. s_main_thread_vm->pop_execution_context();
  269. }
  270. // 5. If result is an abrupt completion, then report the exception given by result.[[Value]].
  271. if (result.is_error())
  272. HTML::report_exception(result, job_settings->realm());
  273. }));
  274. };
  275. // 8.1.5.4.4 HostMakeJobCallback(callable), https://html.spec.whatwg.org/multipage/webappapis.html#hostmakejobcallback
  276. s_main_thread_vm->host_make_job_callback = [](JS::FunctionObject& callable) -> JS::NonnullGCPtr<JS::JobCallback> {
  277. // 1. Let incumbent settings be the incumbent settings object.
  278. auto& incumbent_settings = HTML::incumbent_settings_object();
  279. // 2. Let active script be the active script.
  280. auto* script = active_script();
  281. // 3. Let script execution context be null.
  282. OwnPtr<JS::ExecutionContext> script_execution_context;
  283. // 4. If active script is not null, set script execution context to a new JavaScript execution context, with its Function field set to null,
  284. // its Realm field set to active script's settings object's Realm, and its ScriptOrModule set to active script's record.
  285. if (script) {
  286. script_execution_context = JS::ExecutionContext::create();
  287. script_execution_context->function = nullptr;
  288. script_execution_context->realm = &script->settings_object().realm();
  289. if (is<HTML::ClassicScript>(script)) {
  290. script_execution_context->script_or_module = JS::NonnullGCPtr<JS::Script>(*verify_cast<HTML::ClassicScript>(script)->script_record());
  291. } else if (is<HTML::ModuleScript>(script)) {
  292. if (is<HTML::JavaScriptModuleScript>(script)) {
  293. script_execution_context->script_or_module = JS::NonnullGCPtr<JS::Module>(*verify_cast<HTML::JavaScriptModuleScript>(script)->record());
  294. } else {
  295. // NOTE: Handle CSS and JSON module scripts once we have those.
  296. VERIFY_NOT_REACHED();
  297. }
  298. } else {
  299. VERIFY_NOT_REACHED();
  300. }
  301. }
  302. // 5. Return the JobCallback Record { [[Callback]]: callable, [[HostDefined]]: { [[IncumbentSettings]]: incumbent settings, [[ActiveScriptContext]]: script execution context } }.
  303. auto host_defined = adopt_own(*new WebEngineCustomJobCallbackData(incumbent_settings, move(script_execution_context)));
  304. return JS::JobCallback::create(*s_main_thread_vm, callable, move(host_defined));
  305. };
  306. // 8.1.5.5.1 HostGetImportMetaProperties(moduleRecord), https://html.spec.whatwg.org/multipage/webappapis.html#hostgetimportmetaproperties
  307. s_main_thread_vm->host_get_import_meta_properties = [](JS::SourceTextModule& module_record) {
  308. auto& realm = module_record.realm();
  309. auto& vm = realm.vm();
  310. // 1. Let moduleScript be moduleRecord.[[HostDefined]].
  311. auto& module_script = *verify_cast<HTML::Script>(module_record.host_defined());
  312. // 2. Assert: moduleScript's base URL is not null, as moduleScript is a JavaScript module script.
  313. VERIFY(module_script.base_url().is_valid());
  314. // 3. Let urlString be moduleScript's base URL, serialized.
  315. auto url_string = module_script.base_url().serialize();
  316. // 4. Let steps be the following steps, given the argument specifier:
  317. auto steps = [module_script = JS::NonnullGCPtr { module_script }](JS::VM& vm) -> JS::ThrowCompletionOr<JS::Value> {
  318. auto specifier = vm.argument(0);
  319. // 1. Set specifier to ? ToString(specifier).
  320. auto specifier_string = TRY(specifier.to_string(vm));
  321. // 2. Let url be the result of resolving a module specifier given moduleScript and specifier.
  322. auto url = TRY(Bindings::throw_dom_exception_if_needed(vm, [&] {
  323. return HTML::resolve_module_specifier(*module_script, specifier_string.to_byte_string());
  324. }));
  325. // 3. Return the serialization of url.
  326. return JS::PrimitiveString::create(vm, url.serialize());
  327. };
  328. // 4. Let resolveFunction be ! CreateBuiltinFunction(steps, 1, "resolve", « »).
  329. auto resolve_function = JS::NativeFunction::create(realm, move(steps), 1, vm.names.resolve);
  330. // 5. Return « Record { [[Key]]: "url", [[Value]]: urlString }, Record { [[Key]]: "resolve", [[Value]]: resolveFunction } ».
  331. HashMap<JS::PropertyKey, JS::Value> meta;
  332. meta.set("url", JS::PrimitiveString::create(vm, move(url_string)));
  333. meta.set("resolve", resolve_function);
  334. return meta;
  335. };
  336. // FIXME: Implement 8.1.5.5.2 HostImportModuleDynamically(referencingScriptOrModule, moduleRequest, promiseCapability), https://html.spec.whatwg.org/multipage/webappapis.html#hostimportmoduledynamically(referencingscriptormodule,-modulerequest,-promisecapability)
  337. // FIXME: Implement 8.1.5.5.3 HostResolveImportedModule(referencingScriptOrModule, moduleRequest), https://html.spec.whatwg.org/multipage/webappapis.html#hostresolveimportedmodule(referencingscriptormodule,-modulerequest)
  338. // 8.1.6.5.2 HostGetSupportedImportAttributes(), https://html.spec.whatwg.org/multipage/webappapis.html#hostgetsupportedimportassertions
  339. s_main_thread_vm->host_get_supported_import_attributes = []() -> Vector<ByteString> {
  340. // 1. Return « "type" ».
  341. return { "type"sv };
  342. };
  343. // 8.1.6.5.3 HostLoadImportedModule(referrer, moduleRequest, loadState, payload), https://html.spec.whatwg.org/multipage/webappapis.html#hostloadimportedmodule
  344. s_main_thread_vm->host_load_imported_module = [](JS::ImportedModuleReferrer referrer, JS::ModuleRequest const& module_request, JS::GCPtr<JS::GraphLoadingState::HostDefined> load_state, JS::ImportedModulePayload payload) -> void {
  345. auto& vm = *s_main_thread_vm;
  346. auto& realm = *vm.current_realm();
  347. // 1. Let settingsObject be the current settings object.
  348. Optional<HTML::EnvironmentSettingsObject&> settings_object = HTML::current_settings_object();
  349. // FIXME: 2. If settingsObject's global object implements WorkletGlobalScope or ServiceWorkerGlobalScope and loadState is undefined, then:
  350. // 3. Let referencingScript be null.
  351. Optional<HTML::Script&> referencing_script;
  352. // 4. Let originalFetchOptions be the default classic script fetch options.
  353. auto original_fetch_options = HTML::default_classic_script_fetch_options();
  354. // 5. Let fetchReferrer be "client".
  355. Fetch::Infrastructure::Request::ReferrerType fetch_referrer = Fetch::Infrastructure::Request::Referrer::Client;
  356. // 6. If referrer is a Script Record or a Module Record, then:
  357. if (referrer.has<JS::NonnullGCPtr<JS::Script>>() || referrer.has<JS::NonnullGCPtr<JS::CyclicModule>>()) {
  358. // 1. Set referencingScript to referrer.[[HostDefined]].
  359. referencing_script = verify_cast<HTML::Script>(referrer.has<JS::NonnullGCPtr<JS::Script>>() ? *referrer.get<JS::NonnullGCPtr<JS::Script>>()->host_defined() : *referrer.get<JS::NonnullGCPtr<JS::CyclicModule>>()->host_defined());
  360. // 2. Set settingsObject to referencingScript's settings object.
  361. settings_object = referencing_script->settings_object();
  362. // 3. Set fetchReferrer to referencingScript's base URL.
  363. fetch_referrer = referencing_script->base_url();
  364. // FIXME: 4. Set originalFetchOptions to referencingScript's fetch options.
  365. }
  366. // 7. Disallow further import maps given settingsObject.
  367. settings_object->disallow_further_import_maps();
  368. // 8. Let url be the result of resolving a module specifier given referencingScript and moduleRequest.[[Specifier]],
  369. // catching any exceptions. If they throw an exception, let resolutionError be the thrown exception.
  370. auto url = HTML::resolve_module_specifier(referencing_script, module_request.module_specifier);
  371. // 9. If the previous step threw an exception, then:
  372. if (url.is_exception()) {
  373. // 1. Let completion be Completion Record { [[Type]]: throw, [[Value]]: resolutionError, [[Target]]: empty }.
  374. auto completion = dom_exception_to_throw_completion(main_thread_vm(), url.exception());
  375. // 2. Perform FinishLoadingImportedModule(referrer, moduleRequest, payload, completion).
  376. HTML::TemporaryExecutionContext context { host_defined_environment_settings_object(realm) };
  377. JS::finish_loading_imported_module(referrer, module_request, payload, completion);
  378. // 3. Return.
  379. return;
  380. }
  381. // 10. Let fetchOptions be the result of getting the descendant script fetch options given originalFetchOptions, url, and settingsObject.
  382. auto fetch_options = MUST(HTML::get_descendant_script_fetch_options(original_fetch_options, url.value(), *settings_object));
  383. // 11. Let destination be "script".
  384. auto destination = Fetch::Infrastructure::Request::Destination::Script;
  385. // 12. Let fetchClient be settingsObject.
  386. JS::NonnullGCPtr fetch_client { *settings_object };
  387. // 13. If loadState is not undefined, then:
  388. HTML::PerformTheFetchHook perform_fetch;
  389. if (load_state) {
  390. auto& fetch_context = static_cast<HTML::FetchContext&>(*load_state);
  391. // 1. Set destination to loadState.[[Destination]].
  392. destination = fetch_context.destination;
  393. // 2. Set fetchClient loadState.[[FetchClient]].
  394. fetch_client = fetch_context.fetch_client;
  395. // For step 13
  396. perform_fetch = fetch_context.perform_fetch;
  397. }
  398. auto on_single_fetch_complete = HTML::create_on_fetch_script_complete(realm.heap(), [referrer, &realm, load_state, module_request, payload](JS::GCPtr<HTML::Script> const& module_script) -> void {
  399. // onSingleFetchComplete given moduleScript is the following algorithm:
  400. // 1. Let completion be null.
  401. // NOTE: Our JS::Completion does not support non JS::Value types for its [[Value]], a such we
  402. // use JS::ThrowCompletionOr here.
  403. auto& vm = realm.vm();
  404. JS::GCPtr<JS::Module> module = nullptr;
  405. auto completion = [&]() -> JS::ThrowCompletionOr<JS::NonnullGCPtr<JS::Module>> {
  406. // 2. If moduleScript is null, then set completion to Completion Record { [[Type]]: throw, [[Value]]: a new TypeError, [[Target]]: empty }.
  407. if (!module_script) {
  408. return JS::throw_completion(JS::TypeError::create(realm, ByteString::formatted("Loading imported module '{}' failed.", module_request.module_specifier)));
  409. }
  410. // 3. Otherwise, if moduleScript's parse error is not null, then:
  411. else if (!module_script->parse_error().is_null()) {
  412. // 1. Let parseError be moduleScript's parse error.
  413. auto parse_error = module_script->parse_error();
  414. // 2. Set completion to Completion Record { [[Type]]: throw, [[Value]]: parseError, [[Target]]: empty }.
  415. auto completion = JS::throw_completion(parse_error);
  416. // 3. If loadState is not undefined and loadState.[[ParseError]] is null, set loadState.[[ParseError]] to parseError.
  417. if (load_state) {
  418. auto& load_state_as_fetch_context = static_cast<HTML::FetchContext&>(*load_state);
  419. if (load_state_as_fetch_context.parse_error.is_null()) {
  420. load_state_as_fetch_context.parse_error = parse_error;
  421. }
  422. }
  423. return completion;
  424. }
  425. // 4. Otherwise, set completion to Completion Record { [[Type]]: normal, [[Value]]: result's record, [[Target]]: empty }.
  426. else {
  427. module = static_cast<HTML::JavaScriptModuleScript&>(*module_script).record();
  428. return JS::ThrowCompletionOr<JS::NonnullGCPtr<JS::Module>>(*module);
  429. }
  430. }();
  431. // 5. Perform FinishLoadingImportedModule(referrer, moduleRequest, payload, completion).
  432. // NON-STANDARD: To ensure that LibJS can find the module on the stack, we push a new execution context.
  433. auto module_execution_context = JS::ExecutionContext::create();
  434. module_execution_context->realm = realm;
  435. if (module)
  436. module_execution_context->script_or_module = JS::NonnullGCPtr { *module };
  437. vm.push_execution_context(*module_execution_context);
  438. JS::finish_loading_imported_module(referrer, module_request, payload, completion);
  439. vm.pop_execution_context();
  440. });
  441. // 14. Fetch a single imported module script given url, fetchClient, destination, fetchOptions, settingsObject, fetchReferrer,
  442. // moduleRequest, and onSingleFetchComplete as defined below.
  443. // If loadState is not undefined and loadState.[[PerformFetch]] is not null, pass loadState.[[PerformFetch]] along as well.
  444. HTML::fetch_single_imported_module_script(realm, url.release_value(), *fetch_client, destination, fetch_options, *settings_object, fetch_referrer, module_request, perform_fetch, on_single_fetch_complete);
  445. };
  446. s_main_thread_vm->host_unrecognized_date_string = [](StringView date) {
  447. dbgln("Unable to parse date string: \"{}\"", date);
  448. };
  449. return {};
  450. }
  451. JS::VM& main_thread_vm()
  452. {
  453. VERIFY(s_main_thread_vm);
  454. return *s_main_thread_vm;
  455. }
  456. // https://dom.spec.whatwg.org/#queue-a-mutation-observer-compound-microtask
  457. void queue_mutation_observer_microtask(DOM::Document const& document)
  458. {
  459. auto& vm = main_thread_vm();
  460. auto& custom_data = verify_cast<WebEngineCustomData>(*vm.custom_data());
  461. // 1. If the surrounding agent’s mutation observer microtask queued is true, then return.
  462. if (custom_data.mutation_observer_microtask_queued)
  463. return;
  464. // 2. Set the surrounding agent’s mutation observer microtask queued to true.
  465. custom_data.mutation_observer_microtask_queued = true;
  466. // 3. Queue a microtask to notify mutation observers.
  467. // NOTE: This uses the implied document concept. In the case of mutation observers, it is always done in a node context, so document should be that node's document.
  468. // FIXME: Is it safe to pass custom_data through?
  469. HTML::queue_a_microtask(&document, JS::create_heap_function(vm.heap(), [&custom_data, &heap = document.heap()]() {
  470. // 1. Set the surrounding agent’s mutation observer microtask queued to false.
  471. custom_data.mutation_observer_microtask_queued = false;
  472. // 2. Let notifySet be a clone of the surrounding agent’s mutation observers.
  473. JS::MarkedVector<DOM::MutationObserver*> notify_set(heap);
  474. for (auto& observer : custom_data.mutation_observers)
  475. notify_set.append(observer);
  476. // FIXME: 3. Let signalSet be a clone of the surrounding agent’s signal slots.
  477. // FIXME: 4. Empty the surrounding agent’s signal slots.
  478. // 5. For each mo of notifySet:
  479. for (auto& mutation_observer : notify_set) {
  480. // 1. Let records be a clone of mo’s record queue.
  481. // 2. Empty mo’s record queue.
  482. auto records = mutation_observer->take_records();
  483. // 3. For each node of mo’s node list, remove all transient registered observers whose observer is mo from node’s registered observer list.
  484. for (auto& node : mutation_observer->node_list()) {
  485. // FIXME: Is this correct?
  486. if (node.is_null())
  487. continue;
  488. if (node->registered_observer_list()) {
  489. node->registered_observer_list()->remove_all_matching([&mutation_observer](DOM::RegisteredObserver& registered_observer) {
  490. return is<DOM::TransientRegisteredObserver>(registered_observer) && static_cast<DOM::TransientRegisteredObserver&>(registered_observer).observer().ptr() == mutation_observer;
  491. });
  492. }
  493. }
  494. // 4. If records is not empty, then invoke mo’s callback with « records, mo », and mo. If this throws an exception, catch it, and report the exception.
  495. if (!records.is_empty()) {
  496. auto& callback = mutation_observer->callback();
  497. auto& realm = callback.callback_context->realm();
  498. auto wrapped_records = MUST(JS::Array::create(realm, 0));
  499. for (size_t i = 0; i < records.size(); ++i) {
  500. auto& record = records.at(i);
  501. auto property_index = JS::PropertyKey { i };
  502. MUST(wrapped_records->create_data_property(property_index, record.ptr()));
  503. }
  504. auto result = WebIDL::invoke_callback(callback, mutation_observer, wrapped_records, mutation_observer);
  505. if (result.is_abrupt())
  506. HTML::report_exception(result, realm);
  507. }
  508. }
  509. // FIXME: 6. For each slot of signalSet, fire an event named slotchange, with its bubbles attribute set to true, at slot.
  510. }));
  511. }
  512. // https://html.spec.whatwg.org/multipage/webappapis.html#creating-a-new-javascript-realm
  513. NonnullOwnPtr<JS::ExecutionContext> create_a_new_javascript_realm(JS::VM& vm, Function<JS::Object*(JS::Realm&)> create_global_object, Function<JS::Object*(JS::Realm&)> create_global_this_value)
  514. {
  515. // 1. Perform InitializeHostDefinedRealm() with the provided customizations for creating the global object and the global this binding.
  516. // 2. Let realm execution context be the running JavaScript execution context.
  517. auto realm_execution_context = MUST(JS::Realm::initialize_host_defined_realm(vm, move(create_global_object), move(create_global_this_value)));
  518. // 3. Remove realm execution context from the JavaScript execution context stack.
  519. vm.execution_context_stack().remove_first_matching([&realm_execution_context](auto execution_context) {
  520. return execution_context == realm_execution_context.ptr();
  521. });
  522. // NO-OP: 4. Let realm be realm execution context's Realm component.
  523. // NO-OP: 5. Set realm's agent to agent.
  524. // FIXME: 6. If agent's agent cluster's cross-origin isolation mode is "none", then:
  525. // 1. Let global be realm's global object.
  526. // 2. Let status be ! global.[[Delete]]("SharedArrayBuffer").
  527. // 3. Assert: status is true.
  528. // 7. Return realm execution context.
  529. return realm_execution_context;
  530. }
  531. void WebEngineCustomData::spin_event_loop_until(JS::SafeFunction<bool()> goal_condition)
  532. {
  533. Platform::EventLoopPlugin::the().spin_until(move(goal_condition));
  534. }
  535. // https://html.spec.whatwg.org/multipage/custom-elements.html#invoke-custom-element-reactions
  536. void invoke_custom_element_reactions(Vector<JS::Handle<DOM::Element>>& element_queue)
  537. {
  538. // 1. While queue is not empty:
  539. while (!element_queue.is_empty()) {
  540. // 1. Let element be the result of dequeuing from queue.
  541. auto element = element_queue.take_first();
  542. // 2. Let reactions be element's custom element reaction queue.
  543. auto* reactions = element->custom_element_reaction_queue();
  544. // 3. Repeat until reactions is empty:
  545. if (!reactions)
  546. continue;
  547. while (!reactions->is_empty()) {
  548. // 1. Remove the first element of reactions, and let reaction be that element. Switch on reaction's type:
  549. auto reaction = reactions->take_first();
  550. auto maybe_exception = reaction.visit(
  551. [&](DOM::CustomElementUpgradeReaction const& custom_element_upgrade_reaction) -> JS::ThrowCompletionOr<void> {
  552. // -> upgrade reaction
  553. // Upgrade element using reaction's custom element definition.
  554. return element->upgrade_element(*custom_element_upgrade_reaction.custom_element_definition);
  555. },
  556. [&](DOM::CustomElementCallbackReaction& custom_element_callback_reaction) -> JS::ThrowCompletionOr<void> {
  557. // -> callback reaction
  558. // Invoke reaction's callback function with reaction's arguments, and with element as the callback this value.
  559. auto result = WebIDL::invoke_callback(*custom_element_callback_reaction.callback, element.ptr(), custom_element_callback_reaction.arguments);
  560. if (result.is_abrupt())
  561. return result.release_error();
  562. return {};
  563. });
  564. // If this throws an exception, catch it, and report the exception.
  565. if (maybe_exception.is_throw_completion())
  566. HTML::report_exception(maybe_exception, element->realm());
  567. }
  568. }
  569. }
  570. }