VM.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186
  1. /*
  2. * Copyright (c) 2020-2023, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2020-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2021-2022, David Tuin <davidot@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <AK/Array.h>
  9. #include <AK/Debug.h>
  10. #include <AK/LexicalPath.h>
  11. #include <AK/ScopeGuard.h>
  12. #include <AK/String.h>
  13. #include <AK/StringBuilder.h>
  14. #include <LibFileSystem/FileSystem.h>
  15. #include <LibJS/AST.h>
  16. #include <LibJS/Bytecode/Interpreter.h>
  17. #include <LibJS/Interpreter.h>
  18. #include <LibJS/Runtime/AbstractOperations.h>
  19. #include <LibJS/Runtime/Array.h>
  20. #include <LibJS/Runtime/BoundFunction.h>
  21. #include <LibJS/Runtime/Completion.h>
  22. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  23. #include <LibJS/Runtime/Error.h>
  24. #include <LibJS/Runtime/FinalizationRegistry.h>
  25. #include <LibJS/Runtime/FunctionEnvironment.h>
  26. #include <LibJS/Runtime/Iterator.h>
  27. #include <LibJS/Runtime/NativeFunction.h>
  28. #include <LibJS/Runtime/PromiseCapability.h>
  29. #include <LibJS/Runtime/Reference.h>
  30. #include <LibJS/Runtime/Symbol.h>
  31. #include <LibJS/Runtime/VM.h>
  32. #include <LibJS/SourceTextModule.h>
  33. #include <LibJS/SyntheticModule.h>
  34. namespace JS {
  35. ErrorOr<NonnullRefPtr<VM>> VM::create(OwnPtr<CustomData> custom_data)
  36. {
  37. ErrorMessages error_messages {};
  38. error_messages[to_underlying(ErrorMessage::OutOfMemory)] = TRY(String::from_utf8(ErrorType::OutOfMemory.message()));
  39. auto vm = adopt_ref(*new VM(move(custom_data), move(error_messages)));
  40. WellKnownSymbols well_known_symbols {
  41. #define __JS_ENUMERATE(SymbolName, snake_name) \
  42. Symbol::create(*vm, "Symbol." #SymbolName##_string, false),
  43. JS_ENUMERATE_WELL_KNOWN_SYMBOLS
  44. #undef __JS_ENUMERATE
  45. };
  46. vm->set_well_known_symbols(move(well_known_symbols));
  47. return vm;
  48. }
  49. template<u32... code_points>
  50. static constexpr auto make_single_ascii_character_strings(IndexSequence<code_points...>)
  51. {
  52. return AK::Array { (String::from_code_point(code_points))... };
  53. }
  54. static constexpr auto single_ascii_character_strings = make_single_ascii_character_strings(MakeIndexSequence<128>());
  55. VM::VM(OwnPtr<CustomData> custom_data, ErrorMessages error_messages)
  56. : m_heap(*this)
  57. , m_error_messages(move(error_messages))
  58. , m_custom_data(move(custom_data))
  59. {
  60. m_bytecode_interpreter = make<Bytecode::Interpreter>(*this);
  61. m_empty_string = m_heap.allocate_without_realm<PrimitiveString>(String {});
  62. for (size_t i = 0; i < single_ascii_character_strings.size(); ++i)
  63. m_single_ascii_character_strings[i] = m_heap.allocate_without_realm<PrimitiveString>(single_ascii_character_strings[i]);
  64. // Default hook implementations. These can be overridden by the host, for example, LibWeb overrides the default hooks to place promise jobs on the microtask queue.
  65. host_promise_rejection_tracker = [this](Promise& promise, Promise::RejectionOperation operation) {
  66. promise_rejection_tracker(promise, operation);
  67. };
  68. host_call_job_callback = [this](JobCallback& job_callback, Value this_value, MarkedVector<Value> arguments) {
  69. return call_job_callback(*this, job_callback, this_value, move(arguments));
  70. };
  71. host_enqueue_finalization_registry_cleanup_job = [this](FinalizationRegistry& finalization_registry) {
  72. enqueue_finalization_registry_cleanup_job(finalization_registry);
  73. };
  74. host_enqueue_promise_job = [this](Function<ThrowCompletionOr<Value>()> job, Realm* realm) {
  75. enqueue_promise_job(move(job), realm);
  76. };
  77. host_make_job_callback = [](FunctionObject& function_object) {
  78. return make_job_callback(function_object);
  79. };
  80. host_resolve_imported_module = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier) {
  81. return resolve_imported_module(move(referencing_script_or_module), specifier);
  82. };
  83. host_import_module_dynamically = [&](ScriptOrModule, ModuleRequest const&, PromiseCapability const& promise_capability) -> ThrowCompletionOr<void> {
  84. // By default, we throw on dynamic imports this is to prevent arbitrary file access by scripts.
  85. VERIFY(current_realm());
  86. auto& realm = *current_realm();
  87. auto promise = Promise::create(realm);
  88. // If you are here because you want to enable dynamic module importing make sure it won't be a security problem
  89. // by checking the default implementation of HostImportModuleDynamically and creating your own hook or calling
  90. // vm.enable_default_host_import_module_dynamically_hook().
  91. promise->reject(MUST_OR_THROW_OOM(Error::create(realm, ErrorType::DynamicImportNotAllowed.message())));
  92. promise->perform_then(
  93. NativeFunction::create(realm, "", [](auto&) -> ThrowCompletionOr<Value> {
  94. VERIFY_NOT_REACHED();
  95. }),
  96. NativeFunction::create(realm, "", [&promise_capability](auto& vm) -> ThrowCompletionOr<Value> {
  97. auto error = vm.argument(0);
  98. // a. Perform ! Call(promiseCapability.[[Reject]], undefined, « error »).
  99. MUST(call(vm, *promise_capability.reject(), js_undefined(), error));
  100. // b. Return undefined.
  101. return js_undefined();
  102. }),
  103. {});
  104. return {};
  105. };
  106. host_finish_dynamic_import = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier, PromiseCapability const& promise_capability, Promise* promise) {
  107. return finish_dynamic_import(move(referencing_script_or_module), specifier, promise_capability, promise);
  108. };
  109. host_get_import_meta_properties = [&](SourceTextModule const&) -> HashMap<PropertyKey, Value> {
  110. return {};
  111. };
  112. host_finalize_import_meta = [&](Object*, SourceTextModule const&) {
  113. };
  114. host_get_supported_import_assertions = [&] {
  115. return Vector<DeprecatedString> { "type" };
  116. };
  117. // 19.2.1.2 HostEnsureCanCompileStrings ( callerRealm, calleeRealm ), https://tc39.es/ecma262/#sec-hostensurecancompilestrings
  118. host_ensure_can_compile_strings = [](Realm&) -> ThrowCompletionOr<void> {
  119. // The host-defined abstract operation HostEnsureCanCompileStrings takes argument calleeRealm (a Realm Record)
  120. // and returns either a normal completion containing unused or a throw completion.
  121. // It allows host environments to block certain ECMAScript functions which allow developers to compile strings into ECMAScript code.
  122. // An implementation of HostEnsureCanCompileStrings must conform to the following requirements:
  123. // - If the returned Completion Record is a normal completion, it must be a normal completion containing unused.
  124. // The default implementation of HostEnsureCanCompileStrings is to return NormalCompletion(unused).
  125. return {};
  126. };
  127. host_ensure_can_add_private_element = [](Object&) -> ThrowCompletionOr<void> {
  128. // The host-defined abstract operation HostEnsureCanAddPrivateElement takes argument O (an Object)
  129. // and returns either a normal completion containing unused or a throw completion.
  130. // It allows host environments to prevent the addition of private elements to particular host-defined exotic objects.
  131. // An implementation of HostEnsureCanAddPrivateElement must conform to the following requirements:
  132. // - If O is not a host-defined exotic object, this abstract operation must return NormalCompletion(unused) and perform no other steps.
  133. // - Any two calls of this abstract operation with the same argument must return the same kind of Completion Record.
  134. // The default implementation of HostEnsureCanAddPrivateElement is to return NormalCompletion(unused).
  135. return {};
  136. // This abstract operation is only invoked by ECMAScript hosts that are web browsers.
  137. // NOTE: Since LibJS has no way of knowing whether the current environment is a browser we always
  138. // call HostEnsureCanAddPrivateElement when needed.
  139. };
  140. }
  141. VM::~VM() = default;
  142. String const& VM::error_message(ErrorMessage type) const
  143. {
  144. VERIFY(type < ErrorMessage::__Count);
  145. auto const& message = m_error_messages[to_underlying(type)];
  146. VERIFY(!message.is_empty());
  147. return message;
  148. }
  149. void VM::enable_default_host_import_module_dynamically_hook()
  150. {
  151. host_import_module_dynamically = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier, PromiseCapability const& promise_capability) {
  152. return import_module_dynamically(move(referencing_script_or_module), specifier, promise_capability);
  153. };
  154. }
  155. Interpreter& VM::interpreter()
  156. {
  157. VERIFY(!m_interpreters.is_empty());
  158. return *m_interpreters.last();
  159. }
  160. Interpreter* VM::interpreter_if_exists()
  161. {
  162. if (m_interpreters.is_empty())
  163. return nullptr;
  164. return m_interpreters.last();
  165. }
  166. Bytecode::Interpreter& VM::bytecode_interpreter()
  167. {
  168. return *m_bytecode_interpreter;
  169. }
  170. Bytecode::Interpreter* VM::bytecode_interpreter_if_exists()
  171. {
  172. return m_bytecode_interpreter;
  173. }
  174. void VM::push_interpreter(Interpreter& interpreter)
  175. {
  176. m_interpreters.append(&interpreter);
  177. }
  178. void VM::pop_interpreter(Interpreter& interpreter)
  179. {
  180. VERIFY(!m_interpreters.is_empty());
  181. auto* popped_interpreter = m_interpreters.take_last();
  182. VERIFY(popped_interpreter == &interpreter);
  183. }
  184. VM::InterpreterExecutionScope::InterpreterExecutionScope(Interpreter& interpreter)
  185. : m_interpreter(interpreter)
  186. {
  187. m_interpreter.vm().push_interpreter(m_interpreter);
  188. }
  189. VM::InterpreterExecutionScope::~InterpreterExecutionScope()
  190. {
  191. m_interpreter.vm().pop_interpreter(m_interpreter);
  192. }
  193. void VM::gather_roots(HashTable<Cell*>& roots)
  194. {
  195. roots.set(m_empty_string);
  196. for (auto string : m_single_ascii_character_strings)
  197. roots.set(string);
  198. auto gather_roots_from_execution_context_stack = [&roots](Vector<ExecutionContext*> const& stack) {
  199. for (auto& execution_context : stack) {
  200. if (execution_context->this_value.is_cell())
  201. roots.set(&execution_context->this_value.as_cell());
  202. for (auto& argument : execution_context->arguments) {
  203. if (argument.is_cell())
  204. roots.set(&argument.as_cell());
  205. }
  206. roots.set(execution_context->lexical_environment);
  207. roots.set(execution_context->variable_environment);
  208. roots.set(execution_context->private_environment);
  209. if (auto context_owner = execution_context->context_owner)
  210. roots.set(context_owner);
  211. execution_context->script_or_module.visit(
  212. [](Empty) {},
  213. [&](auto& script_or_module) {
  214. roots.set(script_or_module.ptr());
  215. });
  216. }
  217. };
  218. gather_roots_from_execution_context_stack(m_execution_context_stack);
  219. for (auto& saved_stack : m_saved_execution_context_stacks)
  220. gather_roots_from_execution_context_stack(saved_stack);
  221. #define __JS_ENUMERATE(SymbolName, snake_name) \
  222. roots.set(m_well_known_symbols.snake_name);
  223. JS_ENUMERATE_WELL_KNOWN_SYMBOLS
  224. #undef __JS_ENUMERATE
  225. for (auto& symbol : m_global_symbol_registry)
  226. roots.set(symbol.value);
  227. for (auto finalization_registry : m_finalization_registry_cleanup_jobs)
  228. roots.set(finalization_registry);
  229. }
  230. ThrowCompletionOr<Value> VM::named_evaluation_if_anonymous_function(ASTNode const& expression, DeprecatedFlyString const& name)
  231. {
  232. // 8.3.3 Static Semantics: IsAnonymousFunctionDefinition ( expr ), https://tc39.es/ecma262/#sec-isanonymousfunctiondefinition
  233. // And 8.3.5 Runtime Semantics: NamedEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-namedevaluation
  234. if (is<FunctionExpression>(expression)) {
  235. auto& function = static_cast<FunctionExpression const&>(expression);
  236. if (!function.has_name()) {
  237. return function.instantiate_ordinary_function_expression(*this, name);
  238. }
  239. } else if (is<ClassExpression>(expression)) {
  240. auto& class_expression = static_cast<ClassExpression const&>(expression);
  241. if (!class_expression.has_name()) {
  242. return TRY(class_expression.class_definition_evaluation(*this, {}, name));
  243. }
  244. }
  245. return execute_ast_node(expression);
  246. }
  247. // 13.15.5.2 Runtime Semantics: DestructuringAssignmentEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-destructuringassignmentevaluation
  248. ThrowCompletionOr<void> VM::destructuring_assignment_evaluation(NonnullRefPtr<BindingPattern const> const& target, Value value)
  249. {
  250. // Note: DestructuringAssignmentEvaluation is just like BindingInitialization without an environment
  251. // And it allows member expressions. We thus trust the parser to disallow member expressions
  252. // in any non assignment binding and just call BindingInitialization with a nullptr environment
  253. return binding_initialization(target, value, nullptr);
  254. }
  255. // 8.5.2 Runtime Semantics: BindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-bindinginitialization
  256. ThrowCompletionOr<void> VM::binding_initialization(DeprecatedFlyString const& target, Value value, Environment* environment)
  257. {
  258. // 1. Let name be StringValue of Identifier.
  259. // 2. Return ? InitializeBoundName(name, value, environment).
  260. return initialize_bound_name(*this, target, value, environment);
  261. }
  262. // 8.5.2 Runtime Semantics: BindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-bindinginitialization
  263. ThrowCompletionOr<void> VM::binding_initialization(NonnullRefPtr<BindingPattern const> const& target, Value value, Environment* environment)
  264. {
  265. auto& vm = *this;
  266. // BindingPattern : ObjectBindingPattern
  267. if (target->kind == BindingPattern::Kind::Object) {
  268. // 1. Perform ? RequireObjectCoercible(value).
  269. TRY(require_object_coercible(vm, value));
  270. // 2. Return ? BindingInitialization of ObjectBindingPattern with arguments value and environment.
  271. // BindingInitialization of ObjectBindingPattern
  272. // 1. Perform ? PropertyBindingInitialization of BindingPropertyList with arguments value and environment.
  273. TRY(property_binding_initialization(*target, value, environment));
  274. // 2. Return unused.
  275. return {};
  276. }
  277. // BindingPattern : ArrayBindingPattern
  278. else {
  279. // 1. Let iteratorRecord be ? GetIterator(value, sync).
  280. auto iterator_record = TRY(get_iterator(vm, value, IteratorHint::Sync));
  281. // 2. Let result be Completion(IteratorBindingInitialization of ArrayBindingPattern with arguments iteratorRecord and environment).
  282. auto result = iterator_binding_initialization(*target, iterator_record, environment);
  283. // 3. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, result).
  284. if (!iterator_record.done) {
  285. // iterator_close() always returns a Completion, which ThrowCompletionOr will interpret as a throw
  286. // completion. So only return the result of iterator_close() if it is indeed a throw completion.
  287. auto completion = result.is_throw_completion() ? result.release_error() : normal_completion({});
  288. if (completion = iterator_close(vm, iterator_record, move(completion)); completion.is_error())
  289. return completion.release_error();
  290. }
  291. // 4. Return ? result.
  292. return result;
  293. }
  294. }
  295. ThrowCompletionOr<Value> VM::execute_ast_node(ASTNode const& node)
  296. {
  297. if (auto* bytecode_interpreter = bytecode_interpreter_if_exists()) {
  298. auto executable = TRY(Bytecode::compile(*this, node, FunctionKind::Normal, ""sv));
  299. auto result_or_error = bytecode_interpreter->run_and_return_frame(*current_realm(), *executable, nullptr);
  300. if (result_or_error.value.is_error())
  301. return result_or_error.value.release_error();
  302. return result_or_error.frame->registers[0];
  303. }
  304. return TRY(node.execute(interpreter())).value();
  305. }
  306. // 13.15.5.3 Runtime Semantics: PropertyDestructuringAssignmentEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-propertydestructuringassignmentevaluation
  307. // 14.3.3.1 Runtime Semantics: PropertyBindingInitialization, https://tc39.es/ecma262/#sec-destructuring-binding-patterns-runtime-semantics-propertybindinginitialization
  308. ThrowCompletionOr<void> VM::property_binding_initialization(BindingPattern const& binding, Value value, Environment* environment)
  309. {
  310. auto& vm = *this;
  311. auto& realm = *vm.current_realm();
  312. auto object = TRY(value.to_object(vm));
  313. HashTable<PropertyKey> seen_names;
  314. for (auto& property : binding.entries) {
  315. VERIFY(!property.is_elision());
  316. if (property.is_rest) {
  317. Reference assignment_target;
  318. if (auto identifier_ptr = property.name.get_pointer<NonnullRefPtr<Identifier const>>()) {
  319. assignment_target = TRY(resolve_binding((*identifier_ptr)->string(), environment));
  320. } else if (auto member_ptr = property.alias.get_pointer<NonnullRefPtr<MemberExpression const>>()) {
  321. assignment_target = TRY((*member_ptr)->to_reference(interpreter()));
  322. } else {
  323. VERIFY_NOT_REACHED();
  324. }
  325. auto rest_object = Object::create(realm, realm.intrinsics().object_prototype());
  326. VERIFY(rest_object);
  327. TRY(rest_object->copy_data_properties(vm, object, seen_names));
  328. if (!environment)
  329. return assignment_target.put_value(vm, rest_object);
  330. else
  331. return assignment_target.initialize_referenced_binding(vm, rest_object);
  332. }
  333. auto name = TRY(property.name.visit(
  334. [&](Empty) -> ThrowCompletionOr<PropertyKey> { VERIFY_NOT_REACHED(); },
  335. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<PropertyKey> {
  336. return identifier->string();
  337. },
  338. [&](NonnullRefPtr<Expression const> const& expression) -> ThrowCompletionOr<PropertyKey> {
  339. auto result = TRY(execute_ast_node(*expression));
  340. return result.to_property_key(vm);
  341. }));
  342. seen_names.set(name);
  343. if (property.name.has<NonnullRefPtr<Identifier const>>() && property.alias.has<Empty>()) {
  344. // FIXME: this branch and not taking this have a lot in common we might want to unify it more (like it was before).
  345. auto& identifier = *property.name.get<NonnullRefPtr<Identifier const>>();
  346. auto reference = TRY(resolve_binding(identifier.string(), environment));
  347. auto value_to_assign = TRY(object->get(name));
  348. if (property.initializer && value_to_assign.is_undefined()) {
  349. value_to_assign = TRY(named_evaluation_if_anonymous_function(*property.initializer, identifier.string()));
  350. }
  351. if (!environment)
  352. TRY(reference.put_value(vm, value_to_assign));
  353. else
  354. TRY(reference.initialize_referenced_binding(vm, value_to_assign));
  355. continue;
  356. }
  357. auto reference_to_assign_to = TRY(property.alias.visit(
  358. [&](Empty) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  359. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<Optional<Reference>> {
  360. return TRY(resolve_binding(identifier->string(), environment));
  361. },
  362. [&](NonnullRefPtr<BindingPattern const> const&) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  363. [&](NonnullRefPtr<MemberExpression const> const& member_expression) -> ThrowCompletionOr<Optional<Reference>> {
  364. return TRY(member_expression->to_reference(interpreter()));
  365. }));
  366. auto value_to_assign = TRY(object->get(name));
  367. if (property.initializer && value_to_assign.is_undefined()) {
  368. if (auto* identifier_ptr = property.alias.get_pointer<NonnullRefPtr<Identifier const>>())
  369. value_to_assign = TRY(named_evaluation_if_anonymous_function(*property.initializer, (*identifier_ptr)->string()));
  370. else
  371. value_to_assign = TRY(execute_ast_node(*property.initializer));
  372. }
  373. if (auto* binding_ptr = property.alias.get_pointer<NonnullRefPtr<BindingPattern const>>()) {
  374. TRY(binding_initialization(*binding_ptr, value_to_assign, environment));
  375. } else {
  376. VERIFY(reference_to_assign_to.has_value());
  377. if (!environment)
  378. TRY(reference_to_assign_to->put_value(vm, value_to_assign));
  379. else
  380. TRY(reference_to_assign_to->initialize_referenced_binding(vm, value_to_assign));
  381. }
  382. }
  383. return {};
  384. }
  385. // 13.15.5.5 Runtime Semantics: IteratorDestructuringAssignmentEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-iteratordestructuringassignmentevaluation
  386. // 8.5.3 Runtime Semantics: IteratorBindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-iteratorbindinginitialization
  387. ThrowCompletionOr<void> VM::iterator_binding_initialization(BindingPattern const& binding, IteratorRecord& iterator_record, Environment* environment)
  388. {
  389. auto& vm = *this;
  390. auto& realm = *vm.current_realm();
  391. // FIXME: this method is nearly identical to destructuring assignment!
  392. for (size_t i = 0; i < binding.entries.size(); i++) {
  393. auto& entry = binding.entries[i];
  394. Value value;
  395. auto assignment_target = TRY(entry.alias.visit(
  396. [&](Empty) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  397. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<Optional<Reference>> {
  398. return TRY(resolve_binding(identifier->string(), environment));
  399. },
  400. [&](NonnullRefPtr<BindingPattern const> const&) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  401. [&](NonnullRefPtr<MemberExpression const> const& member_expression) -> ThrowCompletionOr<Optional<Reference>> {
  402. return TRY(member_expression->to_reference(interpreter()));
  403. }));
  404. // BindingRestElement : ... BindingIdentifier
  405. // BindingRestElement : ... BindingPattern
  406. if (entry.is_rest) {
  407. VERIFY(i == binding.entries.size() - 1);
  408. // 2. Let A be ! ArrayCreate(0).
  409. auto array = MUST(Array::create(realm, 0));
  410. // 3. Let n be 0.
  411. // 4. Repeat,
  412. while (true) {
  413. ThrowCompletionOr<GCPtr<Object>> next { nullptr };
  414. // a. If iteratorRecord.[[Done]] is false, then
  415. if (!iterator_record.done) {
  416. // i. Let next be Completion(IteratorStep(iteratorRecord)).
  417. next = iterator_step(vm, iterator_record);
  418. // ii. If next is an abrupt completion, set iteratorRecord.[[Done]] to true.
  419. // iii. ReturnIfAbrupt(next).
  420. if (next.is_error()) {
  421. iterator_record.done = true;
  422. return next.release_error();
  423. }
  424. // iv. If next is false, set iteratorRecord.[[Done]] to true.
  425. if (!next.value())
  426. iterator_record.done = true;
  427. }
  428. // b. If iteratorRecord.[[Done]] is true, then
  429. if (iterator_record.done) {
  430. // NOTE: Step i. and ii. are handled below.
  431. break;
  432. }
  433. // c. Let nextValue be Completion(IteratorValue(next)).
  434. auto next_value = iterator_value(vm, *next.value());
  435. // d. If nextValue is an abrupt completion, set iteratorRecord.[[Done]] to true.
  436. // e. ReturnIfAbrupt(nextValue).
  437. if (next_value.is_error()) {
  438. iterator_record.done = true;
  439. return next_value.release_error();
  440. }
  441. // f. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), nextValue).
  442. array->indexed_properties().append(next_value.value());
  443. // g. Set n to n + 1.
  444. }
  445. value = array;
  446. }
  447. // SingleNameBinding : BindingIdentifier Initializer[opt]
  448. // BindingElement : BindingPattern Initializer[opt]
  449. else {
  450. // 1. Let v be undefined.
  451. value = js_undefined();
  452. // 2. If iteratorRecord.[[Done]] is false, then
  453. if (!iterator_record.done) {
  454. // a. Let next be Completion(IteratorStep(iteratorRecord)).
  455. auto next = iterator_step(vm, iterator_record);
  456. // b. If next is an abrupt completion, set iteratorRecord.[[Done]] to true.
  457. // c. ReturnIfAbrupt(next).
  458. if (next.is_error()) {
  459. iterator_record.done = true;
  460. return next.release_error();
  461. }
  462. // d. If next is false, set iteratorRecord.[[Done]] to true.
  463. if (!next.value()) {
  464. iterator_record.done = true;
  465. }
  466. // e. Else,
  467. else {
  468. // i. Set v to Completion(IteratorValue(next)).
  469. auto value_or_error = iterator_value(vm, *next.value());
  470. // ii. If v is an abrupt completion, set iteratorRecord.[[Done]] to true.
  471. // iii. ReturnIfAbrupt(v).
  472. if (value_or_error.is_throw_completion()) {
  473. iterator_record.done = true;
  474. return value_or_error.release_error();
  475. }
  476. value = value_or_error.release_value();
  477. }
  478. }
  479. // NOTE: Step 3. and 4. are handled below.
  480. }
  481. if (value.is_undefined() && entry.initializer) {
  482. VERIFY(!entry.is_rest);
  483. if (auto* identifier_ptr = entry.alias.get_pointer<NonnullRefPtr<Identifier const>>())
  484. value = TRY(named_evaluation_if_anonymous_function(*entry.initializer, (*identifier_ptr)->string()));
  485. else
  486. value = TRY(execute_ast_node(*entry.initializer));
  487. }
  488. if (auto* binding_ptr = entry.alias.get_pointer<NonnullRefPtr<BindingPattern const>>()) {
  489. TRY(binding_initialization(*binding_ptr, value, environment));
  490. } else if (!entry.alias.has<Empty>()) {
  491. VERIFY(assignment_target.has_value());
  492. if (!environment)
  493. TRY(assignment_target->put_value(vm, value));
  494. else
  495. TRY(assignment_target->initialize_referenced_binding(vm, value));
  496. }
  497. }
  498. return {};
  499. }
  500. // 9.1.2.1 GetIdentifierReference ( env, name, strict ), https://tc39.es/ecma262/#sec-getidentifierreference
  501. ThrowCompletionOr<Reference> VM::get_identifier_reference(Environment* environment, DeprecatedFlyString name, bool strict, size_t hops)
  502. {
  503. // 1. If env is the value null, then
  504. if (!environment) {
  505. // a. Return the Reference Record { [[Base]]: unresolvable, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty }.
  506. return Reference { Reference::BaseType::Unresolvable, move(name), strict };
  507. }
  508. // 2. Let exists be ? env.HasBinding(name).
  509. Optional<size_t> index;
  510. auto exists = TRY(environment->has_binding(name, &index));
  511. // Note: This is an optimization for looking up the same reference.
  512. Optional<EnvironmentCoordinate> environment_coordinate;
  513. if (index.has_value()) {
  514. VERIFY(hops <= NumericLimits<u32>::max());
  515. VERIFY(index.value() <= NumericLimits<u32>::max());
  516. environment_coordinate = EnvironmentCoordinate { .hops = static_cast<u32>(hops), .index = static_cast<u32>(index.value()) };
  517. }
  518. // 3. If exists is true, then
  519. if (exists) {
  520. // a. Return the Reference Record { [[Base]]: env, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty }.
  521. return Reference { *environment, move(name), strict, environment_coordinate };
  522. }
  523. // 4. Else,
  524. else {
  525. // a. Let outer be env.[[OuterEnv]].
  526. // b. Return ? GetIdentifierReference(outer, name, strict).
  527. return get_identifier_reference(environment->outer_environment(), move(name), strict, hops + 1);
  528. }
  529. }
  530. // 9.4.2 ResolveBinding ( name [ , env ] ), https://tc39.es/ecma262/#sec-resolvebinding
  531. ThrowCompletionOr<Reference> VM::resolve_binding(DeprecatedFlyString const& name, Environment* environment)
  532. {
  533. // 1. If env is not present or if env is undefined, then
  534. if (!environment) {
  535. // a. Set env to the running execution context's LexicalEnvironment.
  536. environment = running_execution_context().lexical_environment;
  537. }
  538. // 2. Assert: env is an Environment Record.
  539. VERIFY(environment);
  540. // 3. If the source text matched by the syntactic production that is being evaluated is contained in strict mode code, let strict be true; else let strict be false.
  541. bool strict = in_strict_mode();
  542. // 4. Return ? GetIdentifierReference(env, name, strict).
  543. return get_identifier_reference(environment, name, strict);
  544. // NOTE: The spec says:
  545. // Note: The result of ResolveBinding is always a Reference Record whose [[ReferencedName]] field is name.
  546. // But this is not actually correct as GetIdentifierReference (or really the methods it calls) can throw.
  547. }
  548. // 9.4.4 ResolveThisBinding ( ), https://tc39.es/ecma262/#sec-resolvethisbinding
  549. ThrowCompletionOr<Value> VM::resolve_this_binding()
  550. {
  551. auto& vm = *this;
  552. // 1. Let envRec be GetThisEnvironment().
  553. auto environment = get_this_environment(vm);
  554. // 2. Return ? envRec.GetThisBinding().
  555. return TRY(environment->get_this_binding(vm));
  556. }
  557. // 9.4.5 GetNewTarget ( ), https://tc39.es/ecma262/#sec-getnewtarget
  558. Value VM::get_new_target()
  559. {
  560. // 1. Let envRec be GetThisEnvironment().
  561. auto env = get_this_environment(*this);
  562. // 2. Assert: envRec has a [[NewTarget]] field.
  563. // 3. Return envRec.[[NewTarget]].
  564. return verify_cast<FunctionEnvironment>(*env).new_target();
  565. }
  566. // 13.3.12.1 Runtime Semantics: Evaluation, https://tc39.es/ecma262/#sec-meta-properties-runtime-semantics-evaluation
  567. // ImportMeta branch only
  568. Object* VM::get_import_meta()
  569. {
  570. // 1. Let module be GetActiveScriptOrModule().
  571. auto script_or_module = get_active_script_or_module();
  572. // 2. Assert: module is a Source Text Module Record.
  573. auto& module = verify_cast<SourceTextModule>(*script_or_module.get<NonnullGCPtr<Module>>());
  574. // 3. Let importMeta be module.[[ImportMeta]].
  575. auto* import_meta = module.import_meta();
  576. // 4. If importMeta is empty, then
  577. if (import_meta == nullptr) {
  578. // a. Set importMeta to OrdinaryObjectCreate(null).
  579. import_meta = Object::create(*current_realm(), nullptr);
  580. // b. Let importMetaValues be HostGetImportMetaProperties(module).
  581. auto import_meta_values = host_get_import_meta_properties(module);
  582. // c. For each Record { [[Key]], [[Value]] } p of importMetaValues, do
  583. for (auto& entry : import_meta_values) {
  584. // i. Perform ! CreateDataPropertyOrThrow(importMeta, p.[[Key]], p.[[Value]]).
  585. MUST(import_meta->create_data_property_or_throw(entry.key, entry.value));
  586. }
  587. // d. Perform HostFinalizeImportMeta(importMeta, module).
  588. host_finalize_import_meta(import_meta, module);
  589. // e. Set module.[[ImportMeta]] to importMeta.
  590. module.set_import_meta({}, import_meta);
  591. // f. Return importMeta.
  592. return import_meta;
  593. }
  594. // 5. Else,
  595. else {
  596. // a. Assert: Type(importMeta) is Object.
  597. // Note: This is always true by the type.
  598. // b. Return importMeta.
  599. return import_meta;
  600. }
  601. }
  602. // 9.4.5 GetGlobalObject ( ), https://tc39.es/ecma262/#sec-getglobalobject
  603. Object& VM::get_global_object()
  604. {
  605. // 1. Let currentRealm be the current Realm Record.
  606. auto& current_realm = *this->current_realm();
  607. // 2. Return currentRealm.[[GlobalObject]].
  608. return current_realm.global_object();
  609. }
  610. bool VM::in_strict_mode() const
  611. {
  612. if (execution_context_stack().is_empty())
  613. return false;
  614. return running_execution_context().is_strict_mode;
  615. }
  616. void VM::run_queued_promise_jobs()
  617. {
  618. dbgln_if(PROMISE_DEBUG, "Running queued promise jobs");
  619. while (!m_promise_jobs.is_empty()) {
  620. auto job = m_promise_jobs.take_first();
  621. dbgln_if(PROMISE_DEBUG, "Calling promise job function");
  622. [[maybe_unused]] auto result = job();
  623. }
  624. }
  625. // 9.5.4 HostEnqueuePromiseJob ( job, realm ), https://tc39.es/ecma262/#sec-hostenqueuepromisejob
  626. void VM::enqueue_promise_job(Function<ThrowCompletionOr<Value>()> job, Realm*)
  627. {
  628. // An implementation of HostEnqueuePromiseJob must conform to the requirements in 9.5 as well as the following:
  629. // - FIXME: If realm is not null, each time job is invoked the implementation must perform implementation-defined steps such that execution is prepared to evaluate ECMAScript code at the time of job's invocation.
  630. // - FIXME: Let scriptOrModule be GetActiveScriptOrModule() at the time HostEnqueuePromiseJob is invoked. If realm is not null, each time job is invoked the implementation must perform implementation-defined steps
  631. // such that scriptOrModule is the active script or module at the time of job's invocation.
  632. // - Jobs must run in the same order as the HostEnqueuePromiseJob invocations that scheduled them.
  633. m_promise_jobs.append(move(job));
  634. }
  635. void VM::run_queued_finalization_registry_cleanup_jobs()
  636. {
  637. while (!m_finalization_registry_cleanup_jobs.is_empty()) {
  638. auto registry = m_finalization_registry_cleanup_jobs.take_first();
  639. // FIXME: Handle any uncatched exceptions here.
  640. (void)registry->cleanup();
  641. }
  642. }
  643. // 9.10.4.1 HostEnqueueFinalizationRegistryCleanupJob ( finalizationRegistry ), https://tc39.es/ecma262/#sec-host-cleanup-finalization-registry
  644. void VM::enqueue_finalization_registry_cleanup_job(FinalizationRegistry& registry)
  645. {
  646. m_finalization_registry_cleanup_jobs.append(&registry);
  647. }
  648. // 27.2.1.9 HostPromiseRejectionTracker ( promise, operation ), https://tc39.es/ecma262/#sec-host-promise-rejection-tracker
  649. void VM::promise_rejection_tracker(Promise& promise, Promise::RejectionOperation operation) const
  650. {
  651. switch (operation) {
  652. case Promise::RejectionOperation::Reject:
  653. // A promise was rejected without any handlers
  654. if (on_promise_unhandled_rejection)
  655. on_promise_unhandled_rejection(promise);
  656. break;
  657. case Promise::RejectionOperation::Handle:
  658. // A handler was added to an already rejected promise
  659. if (on_promise_rejection_handled)
  660. on_promise_rejection_handled(promise);
  661. break;
  662. default:
  663. VERIFY_NOT_REACHED();
  664. }
  665. }
  666. void VM::dump_backtrace() const
  667. {
  668. for (ssize_t i = m_execution_context_stack.size() - 1; i >= 0; --i) {
  669. auto& frame = m_execution_context_stack[i];
  670. if (frame->source_range.source_code) {
  671. auto source_range = frame->source_range.realize();
  672. dbgln("-> {} @ {}:{},{}", frame->function_name, source_range.filename(), source_range.start.line, source_range.start.column);
  673. } else {
  674. dbgln("-> {}", frame->function_name);
  675. }
  676. }
  677. }
  678. void VM::save_execution_context_stack()
  679. {
  680. m_saved_execution_context_stacks.append(move(m_execution_context_stack));
  681. }
  682. void VM::restore_execution_context_stack()
  683. {
  684. m_execution_context_stack = m_saved_execution_context_stacks.take_last();
  685. }
  686. // 9.4.1 GetActiveScriptOrModule ( ), https://tc39.es/ecma262/#sec-getactivescriptormodule
  687. ScriptOrModule VM::get_active_script_or_module() const
  688. {
  689. // 1. If the execution context stack is empty, return null.
  690. if (m_execution_context_stack.is_empty())
  691. return Empty {};
  692. // 2. Let ec be the topmost execution context on the execution context stack whose ScriptOrModule component is not null.
  693. for (auto i = m_execution_context_stack.size() - 1; i > 0; i--) {
  694. if (!m_execution_context_stack[i]->script_or_module.has<Empty>())
  695. return m_execution_context_stack[i]->script_or_module;
  696. }
  697. // 3. If no such execution context exists, return null. Otherwise, return ec's ScriptOrModule.
  698. // Note: Since it is not empty we have 0 and since we got here all the
  699. // above contexts don't have a non-null ScriptOrModule
  700. return m_execution_context_stack[0]->script_or_module;
  701. }
  702. VM::StoredModule* VM::get_stored_module(ScriptOrModule const&, DeprecatedString const& filename, DeprecatedString const&)
  703. {
  704. // Note the spec says:
  705. // Each time this operation is called with a specific referencingScriptOrModule, specifier pair as arguments
  706. // it must return the same Module Record instance if it completes normally.
  707. // Currently, we ignore the referencing script or module but this might not be correct in all cases.
  708. // Editor's Note from https://tc39.es/proposal-json-modules/#sec-hostresolveimportedmodule
  709. // The above text implies that is recommended but not required that hosts do not use moduleRequest.[[Assertions]]
  710. // as part of the module cache key. In either case, an exception thrown from an import with a given assertion list
  711. // does not rule out success of another import with the same specifier but a different assertion list.
  712. auto end_or_module = m_loaded_modules.find_if([&](StoredModule const& stored_module) {
  713. return stored_module.filename == filename;
  714. });
  715. if (end_or_module.is_end())
  716. return nullptr;
  717. return &(*end_or_module);
  718. }
  719. ThrowCompletionOr<void> VM::link_and_eval_module(Badge<Interpreter>, SourceTextModule& module)
  720. {
  721. return link_and_eval_module(module);
  722. }
  723. ThrowCompletionOr<void> VM::link_and_eval_module(Badge<Bytecode::Interpreter>, SourceTextModule& module)
  724. {
  725. return link_and_eval_module(module);
  726. }
  727. ThrowCompletionOr<void> VM::link_and_eval_module(Module& module)
  728. {
  729. auto filename = module.filename();
  730. auto module_or_end = m_loaded_modules.find_if([&](StoredModule const& stored_module) {
  731. return stored_module.module.ptr() == &module;
  732. });
  733. StoredModule* stored_module;
  734. if (module_or_end.is_end()) {
  735. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Warning introducing module via link_and_eval_module {}", module.filename());
  736. if (m_loaded_modules.size() > 0)
  737. dbgln("Warning: Using multiple modules as entry point can lead to unexpected results");
  738. m_loaded_modules.empend(
  739. NonnullGCPtr(module),
  740. module.filename(),
  741. DeprecatedString {}, // Null type
  742. module,
  743. true);
  744. stored_module = &m_loaded_modules.last();
  745. } else {
  746. stored_module = module_or_end.operator->();
  747. if (stored_module->has_once_started_linking) {
  748. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Module already has started linking once {}", module.filename());
  749. return {};
  750. }
  751. stored_module->has_once_started_linking = true;
  752. }
  753. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Linking module {}", filename);
  754. auto linked_or_error = module.link(*this);
  755. if (linked_or_error.is_error())
  756. return linked_or_error.throw_completion();
  757. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Linking passed, now evaluating module {}", filename);
  758. auto evaluated_or_error = module.evaluate(*this);
  759. if (evaluated_or_error.is_error())
  760. return evaluated_or_error.throw_completion();
  761. auto* evaluated_value = evaluated_or_error.value();
  762. run_queued_promise_jobs();
  763. VERIFY(m_promise_jobs.is_empty());
  764. // FIXME: This will break if we start doing promises actually asynchronously.
  765. VERIFY(evaluated_value->state() != Promise::State::Pending);
  766. if (evaluated_value->state() == Promise::State::Rejected)
  767. return JS::throw_completion(evaluated_value->result());
  768. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Evaluating passed for module {}", module.filename());
  769. return {};
  770. }
  771. static DeprecatedString resolve_module_filename(StringView filename, StringView module_type)
  772. {
  773. auto extensions = Vector<StringView, 2> { "js"sv, "mjs"sv };
  774. if (module_type == "json"sv)
  775. extensions = { "json"sv };
  776. if (!FileSystem::exists(filename)) {
  777. for (auto extension : extensions) {
  778. // import "./foo" -> import "./foo.ext"
  779. auto resolved_filepath = DeprecatedString::formatted("{}.{}", filename, extension);
  780. if (FileSystem::exists(resolved_filepath))
  781. return resolved_filepath;
  782. }
  783. } else if (FileSystem::is_directory(filename)) {
  784. for (auto extension : extensions) {
  785. // import "./foo" -> import "./foo/index.ext"
  786. auto resolved_filepath = LexicalPath::join(filename, DeprecatedString::formatted("index.{}", extension)).string();
  787. if (FileSystem::exists(resolved_filepath))
  788. return resolved_filepath;
  789. }
  790. }
  791. return filename;
  792. }
  793. // 16.2.1.7 HostResolveImportedModule ( referencingScriptOrModule, specifier ), https://tc39.es/ecma262/#sec-hostresolveimportedmodule
  794. ThrowCompletionOr<NonnullGCPtr<Module>> VM::resolve_imported_module(ScriptOrModule referencing_script_or_module, ModuleRequest const& module_request)
  795. {
  796. // An implementation of HostResolveImportedModule must conform to the following requirements:
  797. // - If it completes normally, the [[Value]] slot of the completion must contain an instance of a concrete subclass of Module Record.
  798. // - If a Module Record corresponding to the pair referencingScriptOrModule, moduleRequest does not exist or cannot be created, an exception must be thrown.
  799. // - Each time this operation is called with a specific referencingScriptOrModule, moduleRequest.[[Specifier]], moduleRequest.[[Assertions]] triple
  800. // as arguments it must return the same Module Record instance if it completes normally.
  801. // * It is recommended but not required that implementations additionally conform to the following stronger constraint:
  802. // each time this operation is called with a specific referencingScriptOrModule, moduleRequest.[[Specifier]] pair as arguments it must return the same Module Record instance if it completes normally.
  803. // - moduleRequest.[[Assertions]] must not influence the interpretation of the module or the module specifier;
  804. // instead, it may be used to determine whether the algorithm completes normally or with an abrupt completion.
  805. // Multiple different referencingScriptOrModule, moduleRequest.[[Specifier]] pairs may map to the same Module Record instance.
  806. // The actual mapping semantic is host-defined but typically a normalization process is applied to specifier as part of the mapping process.
  807. // A typical normalization process would include actions such as alphabetic case folding and expansion of relative and abbreviated path specifiers.
  808. // We only allow "type" as a supported assertion so it is the only valid key that should ever arrive here.
  809. VERIFY(module_request.assertions.is_empty() || (module_request.assertions.size() == 1 && module_request.assertions.first().key == "type"));
  810. auto module_type = module_request.assertions.is_empty() ? DeprecatedString {} : module_request.assertions.first().value;
  811. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] module at {} has type {} [is_null={}]", module_request.module_specifier, module_type, module_type.is_null());
  812. StringView base_filename = referencing_script_or_module.visit(
  813. [&](Empty) {
  814. return "."sv;
  815. },
  816. [&](auto& script_or_module) {
  817. return script_or_module->filename();
  818. });
  819. LexicalPath base_path { base_filename };
  820. auto filename = LexicalPath::absolute_path(base_path.dirname(), module_request.module_specifier);
  821. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] base path: '{}'", base_path);
  822. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] initial filename: '{}'", filename);
  823. filename = resolve_module_filename(filename, module_type);
  824. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolved filename: '{}'", filename);
  825. #if JS_MODULE_DEBUG
  826. DeprecatedString referencing_module_string = referencing_script_or_module.visit(
  827. [&](Empty) -> DeprecatedString {
  828. return ".";
  829. },
  830. [&](auto& script_or_module) {
  831. if constexpr (IsSame<Script*, decltype(script_or_module)>) {
  832. return DeprecatedString::formatted("Script @ {}", script_or_module.ptr());
  833. }
  834. return DeprecatedString::formatted("Module @ {}", script_or_module.ptr());
  835. });
  836. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module({}, {})", referencing_module_string, filename);
  837. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolved {} + {} -> {}", base_path, module_request.module_specifier, filename);
  838. #endif
  839. auto* loaded_module_or_end = get_stored_module(referencing_script_or_module, filename, module_type);
  840. if (loaded_module_or_end != nullptr) {
  841. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module({}) already loaded at {}", filename, loaded_module_or_end->module.ptr());
  842. return NonnullGCPtr(*loaded_module_or_end->module);
  843. }
  844. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing module {}", filename);
  845. auto file_or_error = Core::File::open(filename, Core::File::OpenMode::Read);
  846. if (file_or_error.is_error()) {
  847. return throw_completion<SyntaxError>(ErrorType::ModuleNotFound, module_request.module_specifier);
  848. }
  849. // FIXME: Don't read the file in one go.
  850. auto file_content_or_error = file_or_error.value()->read_until_eof();
  851. if (file_content_or_error.is_error()) {
  852. if (file_content_or_error.error().code() == ENOMEM)
  853. return throw_completion<JS::InternalError>(error_message(::JS::VM::ErrorMessage::OutOfMemory));
  854. return throw_completion<SyntaxError>(ErrorType::ModuleNotFound, module_request.module_specifier);
  855. }
  856. StringView const content_view { file_content_or_error.value().bytes() };
  857. auto module = TRY([&]() -> ThrowCompletionOr<NonnullGCPtr<Module>> {
  858. // If assertions has an entry entry such that entry.[[Key]] is "type", let type be entry.[[Value]]. The following requirements apply:
  859. // If type is "json", then this algorithm must either invoke ParseJSONModule and return the resulting Completion Record, or throw an exception.
  860. if (module_type == "json"sv) {
  861. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing JSON module {}", filename);
  862. return parse_json_module(content_view, *current_realm(), filename);
  863. }
  864. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing as SourceTextModule module {}", filename);
  865. // Note: We treat all files as module, so if a script does not have exports it just runs it.
  866. auto module_or_errors = SourceTextModule::parse(content_view, *current_realm(), filename);
  867. if (module_or_errors.is_error()) {
  868. VERIFY(module_or_errors.error().size() > 0);
  869. return throw_completion<SyntaxError>(module_or_errors.error().first().to_deprecated_string());
  870. }
  871. return module_or_errors.release_value();
  872. }());
  873. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module(...) parsed {} to {}", filename, module.ptr());
  874. // We have to set it here already in case it references itself.
  875. m_loaded_modules.empend(
  876. referencing_script_or_module,
  877. filename,
  878. module_type,
  879. *module,
  880. false);
  881. return module;
  882. }
  883. // 16.2.1.8 HostImportModuleDynamically ( referencingScriptOrModule, specifier, promiseCapability ), https://tc39.es/ecma262/#sec-hostimportmoduledynamically
  884. ThrowCompletionOr<void> VM::import_module_dynamically(ScriptOrModule referencing_script_or_module, ModuleRequest module_request, PromiseCapability const& promise_capability)
  885. {
  886. auto& realm = *current_realm();
  887. // Success path:
  888. // - At some future time, the host environment must perform FinishDynamicImport(referencingScriptOrModule, moduleRequest, promiseCapability, promise),
  889. // where promise is a Promise resolved with undefined.
  890. // - Any subsequent call to HostResolveImportedModule after FinishDynamicImport has completed,
  891. // given the arguments referencingScriptOrModule and specifier, must return a normal completion
  892. // containing a module which has already been evaluated, i.e. whose Evaluate concrete method has
  893. // already been called and returned a normal completion.
  894. // Failure path:
  895. // - At some future time, the host environment must perform
  896. // FinishDynamicImport(referencingScriptOrModule, moduleRequest, promiseCapability, promise),
  897. // where promise is a Promise rejected with an error representing the cause of failure.
  898. auto promise = Promise::create(realm);
  899. ScopeGuard finish_dynamic_import = [&] {
  900. host_finish_dynamic_import(referencing_script_or_module, module_request, promise_capability, promise);
  901. };
  902. // Generally within ECMA262 we always get a referencing_script_or_moulde. However, ShadowRealm gives an explicit null.
  903. // To get around this is we attempt to get the active script_or_module otherwise we might start loading "random" files from the working directory.
  904. if (referencing_script_or_module.has<Empty>()) {
  905. referencing_script_or_module = get_active_script_or_module();
  906. // If there is no ScriptOrModule in any of the execution contexts
  907. if (referencing_script_or_module.has<Empty>()) {
  908. // Throw an error for now
  909. promise->reject(InternalError::create(realm, TRY_OR_THROW_OOM(*this, String::formatted(ErrorType::ModuleNotFoundNoReferencingScript.message(), module_request.module_specifier))));
  910. return {};
  911. }
  912. }
  913. // Note: If host_resolve_imported_module returns a module it has been loaded successfully and the next call in finish_dynamic_import will retrieve it again.
  914. auto module_or_error = host_resolve_imported_module(referencing_script_or_module, module_request);
  915. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] HostImportModuleDynamically(..., {}) -> {}", module_request.module_specifier, module_or_error.is_error() ? "failed" : "passed");
  916. if (module_or_error.is_throw_completion()) {
  917. promise->reject(*module_or_error.throw_completion().value());
  918. } else {
  919. auto module = module_or_error.release_value();
  920. auto& source_text_module = static_cast<Module&>(*module);
  921. auto evaluated_or_error = link_and_eval_module(source_text_module);
  922. if (evaluated_or_error.is_throw_completion()) {
  923. promise->reject(*evaluated_or_error.throw_completion().value());
  924. } else {
  925. promise->fulfill(js_undefined());
  926. }
  927. }
  928. // It must return unused.
  929. // Note: Just return void always since the resulting value cannot be accessed by user code.
  930. return {};
  931. }
  932. // 16.2.1.9 FinishDynamicImport ( referencingScriptOrModule, specifier, promiseCapability, innerPromise ), https://tc39.es/ecma262/#sec-finishdynamicimport
  933. void VM::finish_dynamic_import(ScriptOrModule referencing_script_or_module, ModuleRequest module_request, PromiseCapability const& promise_capability, Promise* inner_promise)
  934. {
  935. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] finish_dynamic_import on {}", module_request.module_specifier);
  936. auto& realm = *current_realm();
  937. // 1. Let fulfilledClosure be a new Abstract Closure with parameters (result) that captures referencingScriptOrModule, specifier, and promiseCapability and performs the following steps when called:
  938. auto fulfilled_closure = [referencing_script_or_module = move(referencing_script_or_module), module_request = move(module_request), &promise_capability](VM& vm) -> ThrowCompletionOr<Value> {
  939. auto result = vm.argument(0);
  940. // a. Assert: result is undefined.
  941. VERIFY(result.is_undefined());
  942. // b. Let moduleRecord be ! HostResolveImportedModule(referencingScriptOrModule, specifier).
  943. auto module_record = MUST(vm.host_resolve_imported_module(referencing_script_or_module, module_request));
  944. // c. Assert: Evaluate has already been invoked on moduleRecord and successfully completed.
  945. // Note: If HostResolveImportedModule returns a module evaluate will have been called on it.
  946. // d. Let namespace be Completion(GetModuleNamespace(moduleRecord)).
  947. auto namespace_ = module_record->get_module_namespace(vm);
  948. // e. If namespace is an abrupt completion, then
  949. if (namespace_.is_throw_completion()) {
  950. // i. Perform ! Call(promiseCapability.[[Reject]], undefined, « namespace.[[Value]] »).
  951. MUST(call(vm, *promise_capability.reject(), js_undefined(), *namespace_.throw_completion().value()));
  952. }
  953. // f. Else,
  954. else {
  955. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « namespace.[[Value]] »).
  956. MUST(call(vm, *promise_capability.resolve(), js_undefined(), namespace_.release_value()));
  957. }
  958. // g. Return unused.
  959. // NOTE: We don't support returning an empty/optional/unused value here.
  960. return js_undefined();
  961. };
  962. // 2. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 0, "", « »).
  963. auto on_fulfilled = NativeFunction::create(realm, move(fulfilled_closure), 0, "");
  964. // 3. Let rejectedClosure be a new Abstract Closure with parameters (error) that captures promiseCapability and performs the following steps when called:
  965. auto rejected_closure = [&promise_capability](VM& vm) -> ThrowCompletionOr<Value> {
  966. auto error = vm.argument(0);
  967. // a. Perform ! Call(promiseCapability.[[Reject]], undefined, « error »).
  968. MUST(call(vm, *promise_capability.reject(), js_undefined(), error));
  969. // b. Return unused.
  970. // NOTE: We don't support returning an empty/optional/unused value here.
  971. return js_undefined();
  972. };
  973. // 4. Let onRejected be CreateBuiltinFunction(rejectedClosure, 0, "", « »).
  974. auto on_rejected = NativeFunction::create(realm, move(rejected_closure), 0, "");
  975. // 5. Perform PerformPromiseThen(innerPromise, onFulfilled, onRejected).
  976. inner_promise->perform_then(on_fulfilled, on_rejected, {});
  977. // 6. Return unused.
  978. }
  979. }