MainThreadVM.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
  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, 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/Heap/DeferGC.h>
  10. #include <LibJS/Module.h>
  11. #include <LibJS/Runtime/Array.h>
  12. #include <LibJS/Runtime/Environment.h>
  13. #include <LibJS/Runtime/FinalizationRegistry.h>
  14. #include <LibJS/Runtime/ModuleRequest.h>
  15. #include <LibJS/Runtime/NativeFunction.h>
  16. #include <LibJS/Runtime/VM.h>
  17. #include <LibJS/SourceTextModule.h>
  18. #include <LibWeb/Bindings/ExceptionOrUtils.h>
  19. #include <LibWeb/Bindings/Intrinsics.h>
  20. #include <LibWeb/Bindings/MainThreadVM.h>
  21. #include <LibWeb/Bindings/WindowExposedInterfaces.h>
  22. #include <LibWeb/DOM/Document.h>
  23. #include <LibWeb/DOM/MutationType.h>
  24. #include <LibWeb/HTML/AttributeNames.h>
  25. #include <LibWeb/HTML/CustomElements/CustomElementDefinition.h>
  26. #include <LibWeb/HTML/CustomElements/CustomElementReactionNames.h>
  27. #include <LibWeb/HTML/EventNames.h>
  28. #include <LibWeb/HTML/Location.h>
  29. #include <LibWeb/HTML/PromiseRejectionEvent.h>
  30. #include <LibWeb/HTML/Scripting/ClassicScript.h>
  31. #include <LibWeb/HTML/Scripting/Environments.h>
  32. #include <LibWeb/HTML/Scripting/ExceptionReporter.h>
  33. #include <LibWeb/HTML/Scripting/Fetching.h>
  34. #include <LibWeb/HTML/Scripting/Script.h>
  35. #include <LibWeb/HTML/TagNames.h>
  36. #include <LibWeb/HTML/Window.h>
  37. #include <LibWeb/HTML/WindowProxy.h>
  38. #include <LibWeb/MathML/TagNames.h>
  39. #include <LibWeb/Namespace.h>
  40. #include <LibWeb/NavigationTiming/EntryNames.h>
  41. #include <LibWeb/PerformanceTimeline/EntryTypes.h>
  42. #include <LibWeb/Platform/EventLoopPlugin.h>
  43. #include <LibWeb/SVG/AttributeNames.h>
  44. #include <LibWeb/SVG/TagNames.h>
  45. #include <LibWeb/UIEvents/EventNames.h>
  46. #include <LibWeb/WebGL/EventNames.h>
  47. #include <LibWeb/WebIDL/AbstractOperations.h>
  48. #include <LibWeb/XHR/EventNames.h>
  49. namespace Web::Bindings {
  50. static RefPtr<JS::VM> s_main_thread_vm;
  51. // https://html.spec.whatwg.org/multipage/webappapis.html#active-script
  52. HTML::Script* active_script()
  53. {
  54. // 1. Let record be GetActiveScriptOrModule().
  55. auto record = main_thread_vm().get_active_script_or_module();
  56. // 2. If record is null, return null.
  57. // 3. Return record.[[HostDefined]].
  58. return record.visit(
  59. [](JS::NonnullGCPtr<JS::Script>& js_script) -> HTML::Script* {
  60. return verify_cast<HTML::ClassicScript>(js_script->host_defined());
  61. },
  62. [](JS::NonnullGCPtr<JS::Module>& js_module) -> HTML::Script* {
  63. return verify_cast<HTML::ModuleScript>(js_module->host_defined());
  64. },
  65. [](Empty) -> HTML::Script* {
  66. return nullptr;
  67. });
  68. }
  69. ErrorOr<void> initialize_main_thread_vm()
  70. {
  71. VERIFY(!s_main_thread_vm);
  72. s_main_thread_vm = TRY(JS::VM::create(make<WebEngineCustomData>()));
  73. // NOTE: We intentionally leak the main thread JavaScript VM.
  74. // This avoids doing an exhaustive garbage collection on process exit.
  75. s_main_thread_vm->ref();
  76. // These strings could potentially live on the VM similar to CommonPropertyNames.
  77. DOM::MutationType::initialize_strings();
  78. HTML::AttributeNames::initialize_strings();
  79. HTML::CustomElementReactionNames::initialize_strings();
  80. HTML::EventNames::initialize_strings();
  81. HTML::TagNames::initialize_strings();
  82. MathML::TagNames::initialize_strings();
  83. Namespace::initialize_strings();
  84. NavigationTiming::EntryNames::initialize_strings();
  85. PerformanceTimeline::EntryTypes::initialize_strings();
  86. SVG::AttributeNames::initialize_strings();
  87. SVG::TagNames::initialize_strings();
  88. UIEvents::EventNames::initialize_strings();
  89. WebGL::EventNames::initialize_strings();
  90. XHR::EventNames::initialize_strings();
  91. static_cast<WebEngineCustomData*>(s_main_thread_vm->custom_data())->event_loop.set_vm(*s_main_thread_vm);
  92. // 8.1.5.1 HostEnsureCanAddPrivateElement(O), https://html.spec.whatwg.org/multipage/webappapis.html#the-hostensurecanaddprivateelement-implementation
  93. s_main_thread_vm->host_ensure_can_add_private_element = [](JS::Object const& object) -> JS::ThrowCompletionOr<void> {
  94. // 1. If O is a WindowProxy object, or implements Location, then return Completion { [[Type]]: throw, [[Value]]: a new TypeError }.
  95. if (is<HTML::WindowProxy>(object) || is<HTML::Location>(object))
  96. return s_main_thread_vm->throw_completion<JS::TypeError>("Cannot add private elements to window or location object"sv);
  97. // 2. Return NormalCompletion(unused).
  98. return {};
  99. };
  100. // FIXME: Implement 8.1.5.2 HostEnsureCanCompileStrings(callerRealm, calleeRealm), https://html.spec.whatwg.org/multipage/webappapis.html#hostensurecancompilestrings(callerrealm,-calleerealm)
  101. // 8.1.5.3 HostPromiseRejectionTracker(promise, operation), https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
  102. s_main_thread_vm->host_promise_rejection_tracker = [](JS::Promise& promise, JS::Promise::RejectionOperation operation) {
  103. // 1. Let script be the running script.
  104. // The running script is the script in the [[HostDefined]] field in the ScriptOrModule component of the running JavaScript execution context.
  105. HTML::Script* script { nullptr };
  106. s_main_thread_vm->running_execution_context().script_or_module.visit(
  107. [&script](JS::NonnullGCPtr<JS::Script>& js_script) {
  108. script = verify_cast<HTML::ClassicScript>(js_script->host_defined());
  109. },
  110. [&script](JS::NonnullGCPtr<JS::Module>& js_module) {
  111. script = verify_cast<HTML::ModuleScript>(js_module->host_defined());
  112. },
  113. [](Empty) {
  114. });
  115. // 2. If script is a classic script and script's muted errors is true, then return.
  116. // NOTE: is<T>() returns false if nullptr is passed.
  117. if (is<HTML::ClassicScript>(script)) {
  118. auto const& classic_script = static_cast<HTML::ClassicScript const&>(*script);
  119. if (classic_script.muted_errors() == HTML::ClassicScript::MutedErrors::Yes)
  120. return;
  121. }
  122. // 3. Let settings object be the current settings object.
  123. // 4. If script is not null, then set settings object to script's settings object.
  124. auto& settings_object = script ? script->settings_object() : HTML::current_settings_object();
  125. switch (operation) {
  126. case JS::Promise::RejectionOperation::Reject:
  127. // 4. If operation is "reject",
  128. // 1. Add promise to settings object's about-to-be-notified rejected promises list.
  129. settings_object.push_onto_about_to_be_notified_rejected_promises_list(promise);
  130. break;
  131. case JS::Promise::RejectionOperation::Handle: {
  132. // 5. If operation is "handle",
  133. // 1. If settings object's about-to-be-notified rejected promises list contains promise, then remove promise from that list and return.
  134. bool removed_about_to_be_notified_rejected_promise = settings_object.remove_from_about_to_be_notified_rejected_promises_list(promise);
  135. if (removed_about_to_be_notified_rejected_promise)
  136. return;
  137. // 3. Remove promise from settings object's outstanding rejected promises weak set.
  138. bool removed_outstanding_rejected_promise = settings_object.remove_from_outstanding_rejected_promises_weak_set(&promise);
  139. // 2. If settings object's outstanding rejected promises weak set does not contain promise, then return.
  140. // 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.
  141. if (!removed_outstanding_rejected_promise)
  142. return;
  143. // 4. Let global be settings object's global object.
  144. auto& global = settings_object.global_object();
  145. // 5. Queue a global task on the DOM manipulation task source given global to fire an event named rejectionhandled at global, using PromiseRejectionEvent,
  146. // with the promise attribute initialized to promise, and the reason attribute initialized to the value of promise's [[PromiseResult]] internal slot.
  147. HTML::queue_global_task(HTML::Task::Source::DOMManipulation, global, [&global, &promise] {
  148. // FIXME: This currently assumes that global is a WindowObject.
  149. auto& window = verify_cast<HTML::Window>(global);
  150. HTML::PromiseRejectionEventInit event_init {
  151. {}, // Initialize the inherited DOM::EventInit
  152. /* .promise = */ promise,
  153. /* .reason = */ promise.result(),
  154. };
  155. auto promise_rejection_event = HTML::PromiseRejectionEvent::create(HTML::relevant_realm(global), HTML::EventNames::rejectionhandled, event_init);
  156. window.dispatch_event(promise_rejection_event);
  157. });
  158. break;
  159. }
  160. default:
  161. VERIFY_NOT_REACHED();
  162. }
  163. };
  164. // 8.1.5.4.1 HostCallJobCallback(callback, V, argumentsList), https://html.spec.whatwg.org/multipage/webappapis.html#hostcalljobcallback
  165. s_main_thread_vm->host_call_job_callback = [](JS::JobCallback& callback, JS::Value this_value, JS::MarkedVector<JS::Value> arguments_list) {
  166. auto& callback_host_defined = verify_cast<WebEngineCustomJobCallbackData>(*callback.custom_data);
  167. // 1. Let incumbent settings be callback.[[HostDefined]].[[IncumbentSettings]]. (NOTE: Not necessary)
  168. // 2. Let script execution context be callback.[[HostDefined]].[[ActiveScriptContext]]. (NOTE: Not necessary)
  169. // 3. Prepare to run a callback with incumbent settings.
  170. callback_host_defined.incumbent_settings->prepare_to_run_callback();
  171. // 4. If script execution context is not null, then push script execution context onto the JavaScript execution context stack.
  172. if (callback_host_defined.active_script_context)
  173. s_main_thread_vm->push_execution_context(*callback_host_defined.active_script_context);
  174. // 5. Let result be Call(callback.[[Callback]], V, argumentsList).
  175. auto result = JS::call(*s_main_thread_vm, *callback.callback.cell(), this_value, move(arguments_list));
  176. // 6. If script execution context is not null, then pop script execution context from the JavaScript execution context stack.
  177. if (callback_host_defined.active_script_context) {
  178. VERIFY(&s_main_thread_vm->running_execution_context() == callback_host_defined.active_script_context.ptr());
  179. s_main_thread_vm->pop_execution_context();
  180. }
  181. // 7. Clean up after running a callback with incumbent settings.
  182. callback_host_defined.incumbent_settings->clean_up_after_running_callback();
  183. // 8. Return result.
  184. return result;
  185. };
  186. // 8.1.5.4.2 HostEnqueueFinalizationRegistryCleanupJob(finalizationRegistry), https://html.spec.whatwg.org/multipage/webappapis.html#hostenqueuefinalizationregistrycleanupjob
  187. s_main_thread_vm->host_enqueue_finalization_registry_cleanup_job = [](JS::FinalizationRegistry& finalization_registry) {
  188. // 1. Let global be finalizationRegistry.[[Realm]]'s global object.
  189. auto& global = finalization_registry.realm().global_object();
  190. // 2. Queue a global task on the JavaScript engine task source given global to perform the following steps:
  191. HTML::queue_global_task(HTML::Task::Source::JavaScriptEngine, global, [&finalization_registry] {
  192. // 1. Let entry be finalizationRegistry.[[CleanupCallback]].[[Callback]].[[Realm]]'s environment settings object.
  193. auto& entry = host_defined_environment_settings_object(*finalization_registry.cleanup_callback().callback.cell()->realm());
  194. // 2. Check if we can run script with entry. If this returns "do not run", then return.
  195. if (entry.can_run_script() == HTML::RunScriptDecision::DoNotRun)
  196. return;
  197. // 3. Prepare to run script with entry.
  198. entry.prepare_to_run_script();
  199. // 4. Let result be the result of performing CleanupFinalizationRegistry(finalizationRegistry).
  200. auto result = finalization_registry.cleanup();
  201. // 5. Clean up after running script with entry.
  202. entry.clean_up_after_running_script();
  203. // 6. If result is an abrupt completion, then report the exception given by result.[[Value]].
  204. if (result.is_error())
  205. HTML::report_exception(result, finalization_registry.realm());
  206. });
  207. };
  208. // 8.1.5.4.3 HostEnqueuePromiseJob(job, realm), https://html.spec.whatwg.org/multipage/webappapis.html#hostenqueuepromisejob
  209. s_main_thread_vm->host_enqueue_promise_job = [](Function<JS::ThrowCompletionOr<JS::Value>()> job, JS::Realm* realm) {
  210. // 1. If realm is not null, then let job settings be the settings object for realm. Otherwise, let job settings be null.
  211. HTML::EnvironmentSettingsObject* job_settings { nullptr };
  212. if (realm)
  213. job_settings = &host_defined_environment_settings_object(*realm);
  214. // 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
  215. // also be the active script or module of the job at the time of its invocation.
  216. // This means taking it here now and passing it through to the lambda.
  217. auto script_or_module = s_main_thread_vm->get_active_script_or_module();
  218. // 2. Queue a microtask on the surrounding agent's event loop to perform the following steps:
  219. // 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."
  220. // 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
  221. auto* script = active_script();
  222. // NOTE: This keeps job_settings alive by keeping realm alive, which is holding onto job_settings.
  223. HTML::queue_a_microtask(script ? script->settings_object().responsible_document().ptr() : nullptr, [job_settings, job = move(job), script_or_module = move(script_or_module)] {
  224. // The dummy execution context has to be kept up here to keep it alive for the duration of the function.
  225. Optional<JS::ExecutionContext> dummy_execution_context;
  226. if (job_settings) {
  227. // 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.
  228. if (job_settings->can_run_script() == HTML::RunScriptDecision::DoNotRun)
  229. return;
  230. // 2. If job settings is not null, then prepare to run script with job settings.
  231. job_settings->prepare_to_run_script();
  232. // IMPLEMENTATION DEFINED: Additionally to preparing to run a script, we also prepare to run a callback here. This matches WebIDL's
  233. // invoke_callback() / call_user_object_operation() functions, and prevents a crash in host_make_job_callback()
  234. // when getting the incumbent settings object.
  235. job_settings->prepare_to_run_callback();
  236. // IMPLEMENTATION DEFINED: Per the previous "implementation defined" comment, we must now make the script or module the active script or module.
  237. // Since the only active execution context currently is the realm execution context of job settings, lets attach it here.
  238. job_settings->realm_execution_context().script_or_module = script_or_module;
  239. } else {
  240. // FIXME: We need to setup a dummy execution context in case a JS::NativeFunction is called when processing the job.
  241. // 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.
  242. // 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
  243. dummy_execution_context = JS::ExecutionContext { s_main_thread_vm->heap() };
  244. dummy_execution_context->script_or_module = script_or_module;
  245. s_main_thread_vm->push_execution_context(dummy_execution_context.value());
  246. }
  247. // 3. Let result be job().
  248. [[maybe_unused]] auto result = job();
  249. // 4. If job settings is not null, then clean up after running script with job settings.
  250. if (job_settings) {
  251. // IMPLEMENTATION DEFINED: Disassociate the realm execution context from the script or module.
  252. job_settings->realm_execution_context().script_or_module = Empty {};
  253. // IMPLEMENTATION DEFINED: See comment above, we need to clean up the non-standard prepare_to_run_callback() call.
  254. job_settings->clean_up_after_running_callback();
  255. job_settings->clean_up_after_running_script();
  256. } else {
  257. // Pop off the dummy execution context. See the above FIXME block about why this is done.
  258. s_main_thread_vm->pop_execution_context();
  259. }
  260. // 5. If result is an abrupt completion, then report the exception given by result.[[Value]].
  261. if (result.is_error())
  262. HTML::report_exception(result, job_settings->realm());
  263. });
  264. };
  265. // 8.1.5.4.4 HostMakeJobCallback(callable), https://html.spec.whatwg.org/multipage/webappapis.html#hostmakejobcallback
  266. s_main_thread_vm->host_make_job_callback = [](JS::FunctionObject& callable) -> JS::JobCallback {
  267. // 1. Let incumbent settings be the incumbent settings object.
  268. auto& incumbent_settings = HTML::incumbent_settings_object();
  269. // 2. Let active script be the active script.
  270. auto* script = active_script();
  271. // 3. Let script execution context be null.
  272. OwnPtr<JS::ExecutionContext> script_execution_context;
  273. // 4. If active script is not null, set script execution context to a new JavaScript execution context, with its Function field set to null,
  274. // its Realm field set to active script's settings object's Realm, and its ScriptOrModule set to active script's record.
  275. if (script) {
  276. script_execution_context = adopt_own(*new JS::ExecutionContext(s_main_thread_vm->heap()));
  277. script_execution_context->function = nullptr;
  278. script_execution_context->realm = &script->settings_object().realm();
  279. if (is<HTML::ClassicScript>(script)) {
  280. script_execution_context->script_or_module = JS::NonnullGCPtr<JS::Script>(*verify_cast<HTML::ClassicScript>(script)->script_record());
  281. } else if (is<HTML::ModuleScript>(script)) {
  282. if (is<HTML::JavaScriptModuleScript>(script)) {
  283. script_execution_context->script_or_module = JS::NonnullGCPtr<JS::Module>(*verify_cast<HTML::JavaScriptModuleScript>(script)->record());
  284. } else {
  285. // NOTE: Handle CSS and JSON module scripts once we have those.
  286. VERIFY_NOT_REACHED();
  287. }
  288. } else {
  289. VERIFY_NOT_REACHED();
  290. }
  291. }
  292. // 5. Return the JobCallback Record { [[Callback]]: callable, [[HostDefined]]: { [[IncumbentSettings]]: incumbent settings, [[ActiveScriptContext]]: script execution context } }.
  293. auto host_defined = adopt_own(*new WebEngineCustomJobCallbackData(incumbent_settings, move(script_execution_context)));
  294. return { JS::make_handle(&callable), move(host_defined) };
  295. };
  296. // 8.1.5.5.1 HostGetImportMetaProperties(moduleRecord), https://html.spec.whatwg.org/multipage/webappapis.html#hostgetimportmetaproperties
  297. s_main_thread_vm->host_get_import_meta_properties = [](JS::SourceTextModule& module_record) {
  298. auto& realm = module_record.realm();
  299. auto& vm = realm.vm();
  300. // 1. Let moduleScript be moduleRecord.[[HostDefined]].
  301. auto& module_script = *verify_cast<HTML::Script>(module_record.host_defined());
  302. // 2. Assert: moduleScript's base URL is not null, as moduleScript is a JavaScript module script.
  303. VERIFY(module_script.base_url().is_valid());
  304. // 3. Let urlString be moduleScript's base URL, serialized.
  305. auto url_string = module_script.base_url().serialize();
  306. // 4. Let steps be the following steps, given the argument specifier:
  307. auto steps = [module_script = JS::NonnullGCPtr { module_script }](JS::VM& vm) -> JS::ThrowCompletionOr<JS::Value> {
  308. auto specifier = vm.argument(0);
  309. // 1. Set specifier to ? ToString(specifier).
  310. auto specifier_string = TRY(specifier.to_string(vm));
  311. // 2. Let url be the result of resolving a module specifier given moduleScript and specifier.
  312. auto url = TRY(Bindings::throw_dom_exception_if_needed(vm, [&] {
  313. return HTML::resolve_module_specifier(*module_script, specifier_string.to_deprecated_string());
  314. }));
  315. // 3. Return the serialization of url.
  316. return JS::PrimitiveString::create(vm, url.serialize());
  317. };
  318. // 4. Let resolveFunction be ! CreateBuiltinFunction(steps, 1, "resolve", « »).
  319. auto resolve_function = JS::NativeFunction::create(realm, move(steps), 1, vm.names.resolve);
  320. // 5. Return « Record { [[Key]]: "url", [[Value]]: urlString }, Record { [[Key]]: "resolve", [[Value]]: resolveFunction } ».
  321. HashMap<JS::PropertyKey, JS::Value> meta;
  322. meta.set("url", JS::PrimitiveString::create(vm, move(url_string)));
  323. meta.set("resolve", resolve_function);
  324. return meta;
  325. };
  326. // FIXME: Implement 8.1.5.5.2 HostImportModuleDynamically(referencingScriptOrModule, moduleRequest, promiseCapability), https://html.spec.whatwg.org/multipage/webappapis.html#hostimportmoduledynamically(referencingscriptormodule,-modulerequest,-promisecapability)
  327. // FIXME: Implement 8.1.5.5.3 HostResolveImportedModule(referencingScriptOrModule, moduleRequest), https://html.spec.whatwg.org/multipage/webappapis.html#hostresolveimportedmodule(referencingscriptormodule,-modulerequest)
  328. // 8.1.5.5.4 HostGetSupportedImportAssertions(), https://html.spec.whatwg.org/multipage/webappapis.html#hostgetsupportedimportassertions
  329. s_main_thread_vm->host_get_supported_import_assertions = []() -> Vector<DeprecatedString> {
  330. // 1. Return « "type" ».
  331. return { "type"sv };
  332. };
  333. // 8.1.6.5.3 HostResolveImportedModule(referencingScriptOrModule, moduleRequest), https://html.spec.whatwg.org/multipage/webappapis.html#hostresolveimportedmodule(referencingscriptormodule,-modulerequest)
  334. s_main_thread_vm->host_resolve_imported_module = [](JS::ScriptOrModule const& referencing_string_or_module, JS::ModuleRequest const& module_request) -> JS::ThrowCompletionOr<JS::NonnullGCPtr<JS::Module>> {
  335. // 1. Let moduleMap and referencingScript be null.
  336. Optional<HTML::ModuleMap&> module_map;
  337. Optional<HTML::Script&> referencing_script;
  338. // 2. If referencingScriptOrModule is not null, then:
  339. if (!referencing_string_or_module.has<Empty>()) {
  340. // 1. Set referencingScript to referencingScriptOrModule.[[HostDefined]].
  341. referencing_script = verify_cast<HTML::Script>(referencing_string_or_module.has<JS::NonnullGCPtr<JS::Script>>() ? *referencing_string_or_module.get<JS::NonnullGCPtr<JS::Script>>()->host_defined() : *referencing_string_or_module.get<JS::NonnullGCPtr<JS::Module>>()->host_defined());
  342. // 2. Set moduleMap to referencingScript's settings object's module map.
  343. module_map = referencing_script->settings_object().module_map();
  344. }
  345. // 3. Otherwise:
  346. else {
  347. // 1. Assert: there is a current settings object.
  348. // NOTE: This is handled by the HTML::current_settings_object() accessor.
  349. // 2. Set moduleMap to the current settings object's module map.
  350. module_map = HTML::current_settings_object().module_map();
  351. }
  352. // 4. Let url be the result of resolving a module specifier given referencingScript and moduleRequest.[[Specifier]].
  353. auto url = MUST(HTML::resolve_module_specifier(referencing_script, module_request.module_specifier));
  354. // 5. Assert: the previous step never throws an exception, because resolving a module specifier must have been previously successful
  355. // with these same two arguments (either while creating the corresponding module script, or in fetch an import() module script graph).
  356. // NOTE: Handled by MUST above.
  357. // 6. Let moduleType be the result of running the module type from module request steps given moduleRequest.
  358. auto module_type = HTML::module_type_from_module_request(module_request);
  359. // 7. Let resolvedModuleScript be moduleMap[(url, moduleType)]. (This entry must exist for us to have gotten to this point.)
  360. auto resolved_module_script = module_map->get(url, module_type).value();
  361. // 8. Assert: resolvedModuleScript is a module script (i.e., is not null or "fetching").
  362. VERIFY(resolved_module_script.type == HTML::ModuleMap::EntryType::ModuleScript);
  363. // 9. Assert: resolvedModuleScript's record is not null.
  364. VERIFY(resolved_module_script.module_script->record());
  365. // 10. Return resolvedModuleScript's record.
  366. return JS::NonnullGCPtr(*resolved_module_script.module_script->record());
  367. };
  368. return {};
  369. }
  370. JS::VM& main_thread_vm()
  371. {
  372. VERIFY(s_main_thread_vm);
  373. return *s_main_thread_vm;
  374. }
  375. // https://dom.spec.whatwg.org/#queue-a-mutation-observer-compound-microtask
  376. void queue_mutation_observer_microtask(DOM::Document const& document)
  377. {
  378. auto& vm = main_thread_vm();
  379. auto& custom_data = verify_cast<WebEngineCustomData>(*vm.custom_data());
  380. // 1. If the surrounding agent’s mutation observer microtask queued is true, then return.
  381. if (custom_data.mutation_observer_microtask_queued)
  382. return;
  383. // 2. Set the surrounding agent’s mutation observer microtask queued to true.
  384. custom_data.mutation_observer_microtask_queued = true;
  385. // 3. Queue a microtask to notify mutation observers.
  386. // 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.
  387. // FIXME: Is it safe to pass custom_data through?
  388. HTML::queue_a_microtask(&document, [&custom_data]() {
  389. // 1. Set the surrounding agent’s mutation observer microtask queued to false.
  390. custom_data.mutation_observer_microtask_queued = false;
  391. // 2. Let notifySet be a clone of the surrounding agent’s mutation observers.
  392. auto notify_set = custom_data.mutation_observers;
  393. // FIXME: 3. Let signalSet be a clone of the surrounding agent’s signal slots.
  394. // FIXME: 4. Empty the surrounding agent’s signal slots.
  395. // 5. For each mo of notifySet:
  396. for (auto& mutation_observer : notify_set) {
  397. // 1. Let records be a clone of mo’s record queue.
  398. // 2. Empty mo’s record queue.
  399. auto records = mutation_observer->take_records();
  400. // 3. For each node of mo’s node list, remove all transient registered observers whose observer is mo from node’s registered observer list.
  401. for (auto& node : mutation_observer->node_list()) {
  402. // FIXME: Is this correct?
  403. if (node.is_null())
  404. continue;
  405. node->registered_observers_list().remove_all_matching([&mutation_observer](DOM::RegisteredObserver& registered_observer) {
  406. return is<DOM::TransientRegisteredObserver>(registered_observer) && static_cast<DOM::TransientRegisteredObserver&>(registered_observer).observer().ptr() == mutation_observer.ptr();
  407. });
  408. }
  409. // 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.
  410. if (!records.is_empty()) {
  411. auto& callback = mutation_observer->callback();
  412. auto& realm = callback.callback_context->realm();
  413. auto wrapped_records = MUST(JS::Array::create(realm, 0));
  414. for (size_t i = 0; i < records.size(); ++i) {
  415. auto& record = records.at(i);
  416. auto property_index = JS::PropertyKey { i };
  417. MUST(wrapped_records->create_data_property(property_index, record.ptr()));
  418. }
  419. auto result = WebIDL::invoke_callback(callback, mutation_observer.ptr(), wrapped_records, mutation_observer.ptr());
  420. if (result.is_abrupt())
  421. HTML::report_exception(result, realm);
  422. }
  423. }
  424. // FIXME: 6. For each slot of signalSet, fire an event named slotchange, with its bubbles attribute set to true, at slot.
  425. });
  426. }
  427. // https://html.spec.whatwg.org/multipage/webappapis.html#creating-a-new-javascript-realm
  428. 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)
  429. {
  430. // 1. Perform InitializeHostDefinedRealm() with the provided customizations for creating the global object and the global this binding.
  431. // 2. Let realm execution context be the running JavaScript execution context.
  432. auto realm_execution_context = MUST(JS::Realm::initialize_host_defined_realm(vm, move(create_global_object), move(create_global_this_value)));
  433. // 3. Remove realm execution context from the JavaScript execution context stack.
  434. vm.execution_context_stack().remove_first_matching([&realm_execution_context](auto execution_context) {
  435. return execution_context == realm_execution_context.ptr();
  436. });
  437. // NO-OP: 4. Let realm be realm execution context's Realm component.
  438. // NO-OP: 5. Set realm's agent to agent.
  439. // FIXME: 6. If agent's agent cluster's cross-origin isolation mode is "none", then:
  440. // 1. Let global be realm's global object.
  441. // 2. Let status be ! global.[[Delete]]("SharedArrayBuffer").
  442. // 3. Assert: status is true.
  443. // 7. Return realm execution context.
  444. return realm_execution_context;
  445. }
  446. void WebEngineCustomData::spin_event_loop_until(JS::SafeFunction<bool()> goal_condition)
  447. {
  448. Platform::EventLoopPlugin::the().spin_until(move(goal_condition));
  449. }
  450. // https://html.spec.whatwg.org/multipage/custom-elements.html#invoke-custom-element-reactions
  451. void invoke_custom_element_reactions(Vector<JS::Handle<DOM::Element>>& element_queue)
  452. {
  453. // 1. While queue is not empty:
  454. while (!element_queue.is_empty()) {
  455. // 1. Let element be the result of dequeuing from queue.
  456. auto element = element_queue.take_first();
  457. // 2. Let reactions be element's custom element reaction queue.
  458. auto& reactions = element->custom_element_reaction_queue();
  459. // 3. Repeat until reactions is empty:
  460. while (!reactions.is_empty()) {
  461. // 1. Remove the first element of reactions, and let reaction be that element. Switch on reaction's type:
  462. auto reaction = reactions.take_first();
  463. auto maybe_exception = reaction.visit(
  464. [&](DOM::CustomElementUpgradeReaction const& custom_element_upgrade_reaction) -> JS::ThrowCompletionOr<void> {
  465. // -> upgrade reaction
  466. // Upgrade element using reaction's custom element definition.
  467. return element->upgrade_element(*custom_element_upgrade_reaction.custom_element_definition);
  468. },
  469. [&](DOM::CustomElementCallbackReaction& custom_element_callback_reaction) -> JS::ThrowCompletionOr<void> {
  470. // -> callback reaction
  471. // Invoke reaction's callback function with reaction's arguments, and with element as the callback this value.
  472. auto result = WebIDL::invoke_callback(*custom_element_callback_reaction.callback, element.ptr(), custom_element_callback_reaction.arguments);
  473. if (result.is_abrupt())
  474. return result.release_error();
  475. return {};
  476. });
  477. // If this throws an exception, catch it, and report the exception.
  478. if (maybe_exception.is_throw_completion())
  479. HTML::report_exception(maybe_exception, element->realm());
  480. }
  481. }
  482. }
  483. }