VM.cpp 54 KB

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