MainThreadVM.cpp 38 KB

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