PromiseConstructor.cpp 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. /*
  2. * Copyright (c) 2021, Linus Groh <linusg@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Function.h>
  7. #include <LibJS/Interpreter.h>
  8. #include <LibJS/Runtime/AbstractOperations.h>
  9. #include <LibJS/Runtime/AggregateError.h>
  10. #include <LibJS/Runtime/Array.h>
  11. #include <LibJS/Runtime/Error.h>
  12. #include <LibJS/Runtime/FunctionObject.h>
  13. #include <LibJS/Runtime/GlobalObject.h>
  14. #include <LibJS/Runtime/IteratorOperations.h>
  15. #include <LibJS/Runtime/Promise.h>
  16. #include <LibJS/Runtime/PromiseConstructor.h>
  17. #include <LibJS/Runtime/PromiseReaction.h>
  18. #include <LibJS/Runtime/PromiseResolvingElementFunctions.h>
  19. #include <LibJS/Runtime/TemporaryClearException.h>
  20. namespace JS {
  21. // 27.2.4.1.1 GetPromiseResolve ( promiseConstructor ), https://tc39.es/ecma262/#sec-getpromiseresolve
  22. static Value get_promise_resolve(GlobalObject& global_object, Value constructor)
  23. {
  24. VERIFY(constructor.is_constructor());
  25. auto& vm = global_object.vm();
  26. auto promise_resolve = TRY_OR_DISCARD(constructor.get(global_object, vm.names.resolve));
  27. if (!promise_resolve.is_function()) {
  28. vm.throw_exception<TypeError>(global_object, ErrorType::NotAFunction, promise_resolve.to_string_without_side_effects());
  29. return {};
  30. }
  31. return promise_resolve;
  32. }
  33. // 27.2.1.1.1 IfAbruptRejectPromise ( value, capability ), https://tc39.es/ecma262/#sec-ifabruptrejectpromise
  34. static Optional<Value> if_abrupt_reject_promise(GlobalObject& global_object, Value, PromiseCapability capability)
  35. {
  36. auto& vm = global_object.vm();
  37. if (auto* exception = vm.exception()) {
  38. vm.clear_exception();
  39. vm.stop_unwind();
  40. (void)vm.call(*capability.reject, js_undefined(), exception->value());
  41. return capability.promise;
  42. }
  43. return {};
  44. }
  45. static bool iterator_record_is_complete(GlobalObject& global_object, Object& iterator_record)
  46. {
  47. auto& vm = global_object.vm();
  48. // FIXME: Create a native iterator structure with the [[Done]] internal slot. For now, temporarily clear
  49. // the exception so we can access the "done" property on the iterator object.
  50. TemporaryClearException clear_exception(vm);
  51. return iterator_complete(global_object, iterator_record);
  52. }
  53. static void set_iterator_record_complete(GlobalObject& global_object, Object& iterator_record)
  54. {
  55. auto& vm = global_object.vm();
  56. // FIXME: Create a native iterator structure with the [[Done]] internal slot. For now, temporarily clear
  57. // the exception so we can access the "done" property on the iterator object.
  58. TemporaryClearException clear_exception(vm);
  59. MUST(iterator_record.set(vm.names.done, Value(true), Object::ShouldThrowExceptions::No));
  60. }
  61. using EndOfElementsCallback = Function<Value(PromiseValueList&)>;
  62. using InvokeElementFunctionCallback = Function<void(PromiseValueList&, RemainingElements&, Value, size_t)>;
  63. static Value perform_promise_common(GlobalObject& global_object, Object& iterator_record, Value constructor, PromiseCapability result_capability, Value promise_resolve, EndOfElementsCallback end_of_list, InvokeElementFunctionCallback invoke_element_function)
  64. {
  65. auto& vm = global_object.vm();
  66. VERIFY(constructor.is_constructor());
  67. VERIFY(promise_resolve.is_function());
  68. auto* values = vm.heap().allocate_without_global_object<PromiseValueList>();
  69. auto* remaining_elements_count = vm.heap().allocate_without_global_object<RemainingElements>(1);
  70. size_t index = 0;
  71. while (true) {
  72. auto* next = iterator_step(global_object, iterator_record);
  73. if (vm.exception()) {
  74. set_iterator_record_complete(global_object, iterator_record);
  75. return {};
  76. }
  77. if (!next) {
  78. set_iterator_record_complete(global_object, iterator_record);
  79. if (vm.exception())
  80. return {};
  81. if (--remaining_elements_count->value == 0)
  82. return end_of_list(*values);
  83. return result_capability.promise;
  84. }
  85. auto next_value = iterator_value(global_object, *next);
  86. if (vm.exception()) {
  87. set_iterator_record_complete(global_object, iterator_record);
  88. return {};
  89. }
  90. values->values().append(js_undefined());
  91. auto next_promise = TRY_OR_DISCARD(vm.call(promise_resolve.as_function(), constructor, next_value));
  92. ++remaining_elements_count->value;
  93. invoke_element_function(*values, *remaining_elements_count, next_promise, index);
  94. if (vm.exception())
  95. return {};
  96. ++index;
  97. }
  98. }
  99. // 27.2.4.1.2 PerformPromiseAll ( iteratorRecord, constructor, resultCapability, promiseResolve ), https://tc39.es/ecma262/#sec-performpromiseall
  100. static Value perform_promise_all(GlobalObject& global_object, Object& iterator_record, Value constructor, PromiseCapability result_capability, Value promise_resolve)
  101. {
  102. auto& vm = global_object.vm();
  103. return perform_promise_common(
  104. global_object, iterator_record, constructor, result_capability, promise_resolve,
  105. [&](PromiseValueList& values) -> Value {
  106. auto values_array = Array::create_from(global_object, values.values());
  107. (void)vm.call(*result_capability.resolve, js_undefined(), values_array);
  108. if (vm.exception())
  109. return {};
  110. return result_capability.promise;
  111. },
  112. [&](PromiseValueList& values, RemainingElements& remaining_elements_count, Value next_promise, size_t index) {
  113. auto* on_fulfilled = PromiseAllResolveElementFunction::create(global_object, index, values, result_capability, remaining_elements_count);
  114. on_fulfilled->define_direct_property(vm.names.name, js_string(vm, String::empty()), Attribute::Configurable);
  115. (void)next_promise.invoke(global_object, vm.names.then, on_fulfilled, result_capability.reject);
  116. });
  117. }
  118. // 27.2.4.2.1 PerformPromiseAllSettled ( iteratorRecord, constructor, resultCapability, promiseResolve ), https://tc39.es/ecma262/#sec-performpromiseallsettled
  119. static Value perform_promise_all_settled(GlobalObject& global_object, Object& iterator_record, Value constructor, PromiseCapability result_capability, Value promise_resolve)
  120. {
  121. auto& vm = global_object.vm();
  122. return perform_promise_common(
  123. global_object, iterator_record, constructor, result_capability, promise_resolve,
  124. [&](PromiseValueList& values) -> Value {
  125. auto values_array = Array::create_from(global_object, values.values());
  126. (void)vm.call(*result_capability.resolve, js_undefined(), values_array);
  127. if (vm.exception())
  128. return {};
  129. return result_capability.promise;
  130. },
  131. [&](PromiseValueList& values, RemainingElements& remaining_elements_count, Value next_promise, size_t index) {
  132. auto* on_fulfilled = PromiseAllSettledResolveElementFunction::create(global_object, index, values, result_capability, remaining_elements_count);
  133. on_fulfilled->define_direct_property(vm.names.name, js_string(vm, String::empty()), Attribute::Configurable);
  134. auto* on_rejected = PromiseAllSettledRejectElementFunction::create(global_object, index, values, result_capability, remaining_elements_count);
  135. on_rejected->define_direct_property(vm.names.name, js_string(vm, String::empty()), Attribute::Configurable);
  136. (void)next_promise.invoke(global_object, vm.names.then, on_fulfilled, on_rejected);
  137. });
  138. }
  139. // 27.2.4.3.1 PerformPromiseAny ( iteratorRecord, constructor, resultCapability, promiseResolve ), https://tc39.es/ecma262/#sec-performpromiseany
  140. static Value perform_promise_any(GlobalObject& global_object, Object& iterator_record, Value constructor, PromiseCapability result_capability, Value promise_resolve)
  141. {
  142. auto& vm = global_object.vm();
  143. return perform_promise_common(
  144. global_object, iterator_record, constructor, result_capability, promise_resolve,
  145. [&](PromiseValueList& errors) -> Value {
  146. auto errors_array = Array::create_from(global_object, errors.values());
  147. auto* error = AggregateError::create(global_object);
  148. MUST(error->define_property_or_throw(vm.names.errors, { .value = errors_array, .writable = true, .enumerable = false, .configurable = true }));
  149. vm.throw_exception(global_object, error);
  150. return {};
  151. },
  152. [&](PromiseValueList& errors, RemainingElements& remaining_elements_count, Value next_promise, size_t index) {
  153. auto* on_rejected = PromiseAnyRejectElementFunction::create(global_object, index, errors, result_capability, remaining_elements_count);
  154. on_rejected->define_direct_property(vm.names.name, js_string(vm, String::empty()), Attribute::Configurable);
  155. (void)next_promise.invoke(global_object, vm.names.then, result_capability.resolve, on_rejected);
  156. });
  157. }
  158. // 27.2.4.5.1 PerformPromiseRace ( iteratorRecord, constructor, resultCapability, promiseResolve ), https://tc39.es/ecma262/#sec-performpromiserace
  159. static Value perform_promise_race(GlobalObject& global_object, Object& iterator_record, Value constructor, PromiseCapability result_capability, Value promise_resolve)
  160. {
  161. auto& vm = global_object.vm();
  162. return perform_promise_common(
  163. global_object, iterator_record, constructor, result_capability, promise_resolve,
  164. [&](PromiseValueList&) -> Value {
  165. return result_capability.promise;
  166. },
  167. [&](PromiseValueList&, RemainingElements&, Value next_promise, size_t) {
  168. (void)next_promise.invoke(global_object, vm.names.then, result_capability.resolve, result_capability.reject);
  169. });
  170. }
  171. PromiseConstructor::PromiseConstructor(GlobalObject& global_object)
  172. : NativeFunction(vm().names.Promise.as_string(), *global_object.function_prototype())
  173. {
  174. }
  175. void PromiseConstructor::initialize(GlobalObject& global_object)
  176. {
  177. auto& vm = this->vm();
  178. NativeFunction::initialize(global_object);
  179. // 27.2.4.4 Promise.prototype, https://tc39.es/ecma262/#sec-promise.prototype
  180. define_direct_property(vm.names.prototype, global_object.promise_prototype(), 0);
  181. u8 attr = Attribute::Writable | Attribute::Configurable;
  182. define_native_function(vm.names.all, all, 1, attr);
  183. define_native_function(vm.names.allSettled, all_settled, 1, attr);
  184. define_native_function(vm.names.any, any, 1, attr);
  185. define_native_function(vm.names.race, race, 1, attr);
  186. define_native_function(vm.names.reject, reject, 1, attr);
  187. define_native_function(vm.names.resolve, resolve, 1, attr);
  188. define_native_accessor(*vm.well_known_symbol_species(), symbol_species_getter, {}, Attribute::Configurable);
  189. define_direct_property(vm.names.length, Value(1), Attribute::Configurable);
  190. }
  191. // 27.2.3.1 Promise ( executor ), https://tc39.es/ecma262/#sec-promise-executor
  192. Value PromiseConstructor::call()
  193. {
  194. auto& vm = this->vm();
  195. vm.throw_exception<TypeError>(global_object(), ErrorType::ConstructorWithoutNew, vm.names.Promise);
  196. return {};
  197. }
  198. // 27.2.3.1 Promise ( executor ), https://tc39.es/ecma262/#sec-promise-executor
  199. Value PromiseConstructor::construct(FunctionObject& new_target)
  200. {
  201. auto& vm = this->vm();
  202. auto& global_object = this->global_object();
  203. auto executor = vm.argument(0);
  204. if (!executor.is_function()) {
  205. vm.throw_exception<TypeError>(global_object, ErrorType::PromiseExecutorNotAFunction);
  206. return {};
  207. }
  208. auto* promise = TRY_OR_DISCARD(ordinary_create_from_constructor<Promise>(global_object, new_target, &GlobalObject::promise_prototype));
  209. auto [resolve_function, reject_function] = promise->create_resolving_functions();
  210. (void)vm.call(executor.as_function(), js_undefined(), &resolve_function, &reject_function);
  211. if (auto* exception = vm.exception()) {
  212. vm.clear_exception();
  213. vm.stop_unwind();
  214. (void)vm.call(reject_function, js_undefined(), exception->value());
  215. }
  216. return promise;
  217. }
  218. // 27.2.4.1 Promise.all ( iterable ), https://tc39.es/ecma262/#sec-promise.all
  219. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::all)
  220. {
  221. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  222. auto promise_capability = new_promise_capability(global_object, constructor);
  223. if (vm.exception())
  224. return {};
  225. auto promise_resolve = get_promise_resolve(global_object, constructor);
  226. if (auto abrupt = if_abrupt_reject_promise(global_object, promise_resolve, promise_capability); abrupt.has_value())
  227. return abrupt.value();
  228. auto iterator_record = get_iterator(global_object, vm.argument(0));
  229. if (auto abrupt = if_abrupt_reject_promise(global_object, iterator_record, promise_capability); abrupt.has_value())
  230. return abrupt.value();
  231. auto result = perform_promise_all(global_object, *iterator_record, constructor, promise_capability, promise_resolve);
  232. if (vm.exception()) {
  233. if (!iterator_record_is_complete(global_object, *iterator_record))
  234. iterator_close(*iterator_record);
  235. auto abrupt = if_abrupt_reject_promise(global_object, result, promise_capability);
  236. return abrupt.value();
  237. }
  238. return result;
  239. }
  240. // 27.2.4.2 Promise.allSettled ( iterable ), https://tc39.es/ecma262/#sec-promise.allsettled
  241. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::all_settled)
  242. {
  243. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  244. auto promise_capability = new_promise_capability(global_object, constructor);
  245. if (vm.exception())
  246. return {};
  247. auto promise_resolve = get_promise_resolve(global_object, constructor);
  248. if (auto abrupt = if_abrupt_reject_promise(global_object, promise_resolve, promise_capability); abrupt.has_value())
  249. return abrupt.value();
  250. auto iterator_record = get_iterator(global_object, vm.argument(0));
  251. if (auto abrupt = if_abrupt_reject_promise(global_object, iterator_record, promise_capability); abrupt.has_value())
  252. return abrupt.value();
  253. auto result = perform_promise_all_settled(global_object, *iterator_record, constructor, promise_capability, promise_resolve);
  254. if (vm.exception()) {
  255. if (!iterator_record_is_complete(global_object, *iterator_record))
  256. iterator_close(*iterator_record);
  257. auto abrupt = if_abrupt_reject_promise(global_object, result, promise_capability);
  258. return abrupt.value();
  259. }
  260. return result;
  261. }
  262. // 27.2.4.3 Promise.any ( iterable ), https://tc39.es/ecma262/#sec-promise.any
  263. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::any)
  264. {
  265. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  266. auto promise_capability = new_promise_capability(global_object, constructor);
  267. if (vm.exception())
  268. return {};
  269. auto promise_resolve = get_promise_resolve(global_object, constructor);
  270. if (auto abrupt = if_abrupt_reject_promise(global_object, promise_resolve, promise_capability); abrupt.has_value())
  271. return abrupt.value();
  272. auto iterator_record = get_iterator(global_object, vm.argument(0));
  273. if (auto abrupt = if_abrupt_reject_promise(global_object, iterator_record, promise_capability); abrupt.has_value())
  274. return abrupt.value();
  275. auto result = perform_promise_any(global_object, *iterator_record, constructor, promise_capability, promise_resolve);
  276. if (vm.exception()) {
  277. if (!iterator_record_is_complete(global_object, *iterator_record))
  278. iterator_close(*iterator_record);
  279. auto abrupt = if_abrupt_reject_promise(global_object, result, promise_capability);
  280. return abrupt.value();
  281. }
  282. return result;
  283. }
  284. // 27.2.4.5 Promise.race ( iterable ), https://tc39.es/ecma262/#sec-promise.race
  285. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::race)
  286. {
  287. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  288. auto promise_capability = new_promise_capability(global_object, constructor);
  289. if (vm.exception())
  290. return {};
  291. auto promise_resolve = get_promise_resolve(global_object, constructor);
  292. if (auto abrupt = if_abrupt_reject_promise(global_object, promise_resolve, promise_capability); abrupt.has_value())
  293. return abrupt.value();
  294. auto iterator_record = get_iterator(global_object, vm.argument(0));
  295. if (auto abrupt = if_abrupt_reject_promise(global_object, iterator_record, promise_capability); abrupt.has_value())
  296. return abrupt.value();
  297. auto result = perform_promise_race(global_object, *iterator_record, constructor, promise_capability, promise_resolve);
  298. if (vm.exception()) {
  299. if (!iterator_record_is_complete(global_object, *iterator_record))
  300. iterator_close(*iterator_record);
  301. auto abrupt = if_abrupt_reject_promise(global_object, result, promise_capability);
  302. return abrupt.value();
  303. }
  304. return result;
  305. }
  306. // 27.2.4.6 Promise.reject ( r ), https://tc39.es/ecma262/#sec-promise.reject
  307. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::reject)
  308. {
  309. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  310. auto promise_capability = new_promise_capability(global_object, constructor);
  311. if (vm.exception())
  312. return {};
  313. auto reason = vm.argument(0);
  314. [[maybe_unused]] auto result = TRY_OR_DISCARD(vm.call(*promise_capability.reject, js_undefined(), reason));
  315. return promise_capability.promise;
  316. }
  317. // 27.2.4.7 Promise.resolve ( x ), https://tc39.es/ecma262/#sec-promise.resolve
  318. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::resolve)
  319. {
  320. auto* constructor = TRY_OR_DISCARD(vm.this_value(global_object).to_object(global_object));
  321. auto value = vm.argument(0);
  322. return promise_resolve(global_object, *constructor, value);
  323. }
  324. // 27.2.4.8 get Promise [ @@species ], https://tc39.es/ecma262/#sec-get-promise-@@species
  325. JS_DEFINE_OLD_NATIVE_FUNCTION(PromiseConstructor::symbol_species_getter)
  326. {
  327. return vm.this_value(global_object);
  328. }
  329. }