MainThreadVM.cpp 28 KB

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