2020-09-20 19:24:44 +02:00
/*
2021-06-22 13:30:48 +02:00
* Copyright ( c ) 2020 - 2021 , Andreas Kling < kling @ serenityos . org >
2021-04-22 22:51:19 +02:00
* Copyright ( c ) 2020 - 2021 , Linus Groh < linusg @ serenityos . org >
2020-09-20 19:24:44 +02:00
*
2021-04-22 01:24:48 -07:00
* SPDX - License - Identifier : BSD - 2 - Clause
2020-09-20 19:24:44 +02:00
*/
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
# include <AK/Debug.h>
2020-09-27 15:18:55 +02:00
# include <AK/ScopeGuard.h>
2020-09-27 17:24:14 +02:00
# include <AK/StringBuilder.h>
2020-09-20 19:24:44 +02:00
# include <LibJS/Interpreter.h>
2021-06-22 13:30:48 +02:00
# include <LibJS/Runtime/AbstractOperations.h>
2020-12-05 16:38:29 +01:00
# include <LibJS/Runtime/Array.h>
2020-09-27 15:18:55 +02:00
# include <LibJS/Runtime/Error.h>
2021-06-15 22:16:17 +03:00
# include <LibJS/Runtime/FinalizationRegistry.h>
2021-07-01 12:24:46 +02:00
# include <LibJS/Runtime/FunctionEnvironment.h>
# include <LibJS/Runtime/GlobalEnvironment.h>
2020-09-27 15:18:55 +02:00
# include <LibJS/Runtime/GlobalObject.h>
2021-05-29 16:03:19 +04:30
# include <LibJS/Runtime/IteratorOperations.h>
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
# include <LibJS/Runtime/NativeFunction.h>
2021-06-27 22:15:58 +02:00
# include <LibJS/Runtime/OrdinaryFunctionObject.h>
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
# include <LibJS/Runtime/PromiseReaction.h>
2020-09-27 15:18:55 +02:00
# include <LibJS/Runtime/Reference.h>
2020-09-22 16:18:51 +02:00
# include <LibJS/Runtime/Symbol.h>
2021-04-24 17:56:16 +02:00
# include <LibJS/Runtime/TemporaryClearException.h>
2020-09-20 19:24:44 +02:00
# include <LibJS/Runtime/VM.h>
namespace JS {
NonnullRefPtr < VM > VM : : create ( )
{
2021-04-23 16:46:57 +02:00
return adopt_ref ( * new VM ) ;
2020-09-20 19:24:44 +02:00
}
VM : : VM ( )
: m_heap ( * this )
{
2020-09-22 16:36:33 +02:00
m_empty_string = m_heap . allocate_without_global_object < PrimitiveString > ( String : : empty ( ) ) ;
2020-10-22 17:43:48 +02:00
for ( size_t i = 0 ; i < 128 ; + + i ) {
2020-12-06 16:55:19 +00:00
m_single_ascii_character_strings [ i ] = m_heap . allocate_without_global_object < PrimitiveString > ( String : : formatted ( " {:c} " , i ) ) ;
2020-10-22 17:43:48 +02:00
}
2020-09-22 16:18:51 +02:00
# define __JS_ENUMERATE(SymbolName, snake_name) \
m_well_known_symbol_ # # snake_name = js_symbol ( * this , " Symbol. " # SymbolName , false ) ;
JS_ENUMERATE_WELL_KNOWN_SYMBOLS
# undef __JS_ENUMERATE
2020-09-20 19:24:44 +02:00
}
VM : : ~ VM ( )
{
}
Interpreter & VM : : interpreter ( )
{
2021-02-23 20:42:32 +01:00
VERIFY ( ! m_interpreters . is_empty ( ) ) ;
2020-09-20 19:24:44 +02:00
return * m_interpreters . last ( ) ;
}
Interpreter * VM : : interpreter_if_exists ( )
{
if ( m_interpreters . is_empty ( ) )
return nullptr ;
return m_interpreters . last ( ) ;
}
void VM : : push_interpreter ( Interpreter & interpreter )
{
m_interpreters . append ( & interpreter ) ;
}
void VM : : pop_interpreter ( Interpreter & interpreter )
{
2021-02-23 20:42:32 +01:00
VERIFY ( ! m_interpreters . is_empty ( ) ) ;
2020-09-20 19:24:44 +02:00
auto * popped_interpreter = m_interpreters . take_last ( ) ;
2021-02-23 20:42:32 +01:00
VERIFY ( popped_interpreter = = & interpreter ) ;
2020-09-20 19:24:44 +02:00
}
2020-09-21 13:36:32 +02:00
VM : : InterpreterExecutionScope : : InterpreterExecutionScope ( Interpreter & interpreter )
2020-09-20 19:24:44 +02:00
: m_interpreter ( interpreter )
{
m_interpreter . vm ( ) . push_interpreter ( m_interpreter ) ;
}
2020-09-21 13:36:32 +02:00
VM : : InterpreterExecutionScope : : ~ InterpreterExecutionScope ( )
2020-09-20 19:24:44 +02:00
{
m_interpreter . vm ( ) . pop_interpreter ( m_interpreter ) ;
}
2020-09-21 13:47:33 +02:00
void VM : : gather_roots ( HashTable < Cell * > & roots )
{
2020-09-22 16:36:33 +02:00
roots . set ( m_empty_string ) ;
2020-10-22 17:43:48 +02:00
for ( auto * string : m_single_ascii_character_strings )
roots . set ( string ) ;
2020-12-08 16:06:05 +01:00
roots . set ( m_exception ) ;
2020-09-27 15:18:55 +02:00
if ( m_last_value . is_cell ( ) )
2021-05-25 18:48:11 +02:00
roots . set ( & m_last_value . as_cell ( ) ) ;
2020-09-27 15:18:55 +02:00
2021-06-24 19:17:45 +02:00
for ( auto & execution_context : m_execution_context_stack ) {
if ( execution_context - > this_value . is_cell ( ) )
roots . set ( & execution_context - > this_value . as_cell ( ) ) ;
roots . set ( execution_context - > arguments_object ) ;
for ( auto & argument : execution_context - > arguments ) {
2020-09-27 15:18:55 +02:00
if ( argument . is_cell ( ) )
2021-05-25 18:48:11 +02:00
roots . set ( & argument . as_cell ( ) ) ;
2020-09-27 15:18:55 +02:00
}
2021-06-24 19:17:45 +02:00
roots . set ( execution_context - > lexical_environment ) ;
2021-06-24 20:10:31 +02:00
roots . set ( execution_context - > variable_environment ) ;
2020-09-27 15:18:55 +02:00
}
2020-09-22 16:18:51 +02:00
# define __JS_ENUMERATE(SymbolName, snake_name) \
roots . set ( well_known_symbol_ # # snake_name ( ) ) ;
JS_ENUMERATE_WELL_KNOWN_SYMBOLS
# undef __JS_ENUMERATE
for ( auto & symbol : m_global_symbol_map )
roots . set ( symbol . value ) ;
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
for ( auto * job : m_promise_jobs )
roots . set ( job ) ;
2020-09-22 16:18:51 +02:00
}
Symbol * VM : : get_global_symbol ( const String & description )
{
auto result = m_global_symbol_map . get ( description ) ;
if ( result . has_value ( ) )
return result . value ( ) ;
auto new_global_symbol = js_symbol ( * this , description , true ) ;
m_global_symbol_map . set ( description , new_global_symbol ) ;
return new_global_symbol ;
2020-09-21 13:47:33 +02:00
}
2021-07-01 12:24:46 +02:00
void VM : : set_variable ( const FlyString & name , Value value , GlobalObject & global_object , bool first_assignment , Environment * specific_scope )
2020-09-27 15:18:55 +02:00
{
2021-05-29 16:03:19 +04:30
Optional < Variable > possible_match ;
2021-06-24 19:17:45 +02:00
if ( ! specific_scope & & m_execution_context_stack . size ( ) ) {
2021-07-01 12:24:46 +02:00
for ( auto * environment = lexical_environment ( ) ; environment ; environment = environment - > outer_environment ( ) ) {
possible_match = environment - > get_from_environment ( name ) ;
2020-09-27 15:18:55 +02:00
if ( possible_match . has_value ( ) ) {
2021-07-01 12:24:46 +02:00
specific_scope = environment ;
2021-05-29 16:03:19 +04:30
break ;
}
}
}
if ( specific_scope & & possible_match . has_value ( ) ) {
if ( ! first_assignment & & possible_match . value ( ) . declaration_kind = = DeclarationKind : : Const ) {
throw_exception < TypeError > ( global_object , ErrorType : : InvalidAssignToConst ) ;
return ;
}
2021-07-01 12:24:46 +02:00
specific_scope - > put_into_environment ( name , { value , possible_match . value ( ) . declaration_kind } ) ;
2021-05-29 16:03:19 +04:30
return ;
}
if ( specific_scope ) {
2021-07-01 12:24:46 +02:00
specific_scope - > put_into_environment ( name , { value , DeclarationKind : : Var } ) ;
2021-05-29 16:03:19 +04:30
return ;
}
2021-07-16 15:16:27 +03:00
global_object . set ( name , value , Object : : ShouldThrowExceptions : : Yes ) ;
2021-05-29 16:03:19 +04:30
}
2021-06-08 04:00:53 +03:00
bool VM : : delete_variable ( FlyString const & name )
{
2021-07-01 12:24:46 +02:00
Environment * specific_scope = nullptr ;
2021-06-08 04:00:53 +03:00
Optional < Variable > possible_match ;
2021-06-24 19:17:45 +02:00
if ( ! m_execution_context_stack . is_empty ( ) ) {
2021-07-01 12:24:46 +02:00
for ( auto * environment = lexical_environment ( ) ; environment ; environment = environment - > outer_environment ( ) ) {
possible_match = environment - > get_from_environment ( name ) ;
2021-06-08 04:00:53 +03:00
if ( possible_match . has_value ( ) ) {
2021-07-01 12:24:46 +02:00
specific_scope = environment ;
2021-06-08 04:00:53 +03:00
break ;
}
}
}
if ( ! possible_match . has_value ( ) )
return false ;
if ( possible_match . value ( ) . declaration_kind = = DeclarationKind : : Const )
return false ;
VERIFY ( specific_scope ) ;
2021-07-01 12:24:46 +02:00
return specific_scope - > delete_from_environment ( name ) ;
2021-06-08 04:00:53 +03:00
}
2021-07-01 12:24:46 +02:00
void VM : : assign ( const FlyString & target , Value value , GlobalObject & global_object , bool first_assignment , Environment * specific_scope )
2021-05-29 16:03:19 +04:30
{
set_variable ( target , move ( value ) , global_object , first_assignment , specific_scope ) ;
}
2021-07-01 12:24:46 +02:00
void VM : : assign ( const Variant < NonnullRefPtr < Identifier > , NonnullRefPtr < BindingPattern > > & target , Value value , GlobalObject & global_object , bool first_assignment , Environment * specific_scope )
2021-05-29 16:03:19 +04:30
{
if ( auto id_ptr = target . get_pointer < NonnullRefPtr < Identifier > > ( ) )
return assign ( ( * id_ptr ) - > string ( ) , move ( value ) , global_object , first_assignment , specific_scope ) ;
assign ( target . get < NonnullRefPtr < BindingPattern > > ( ) , move ( value ) , global_object , first_assignment , specific_scope ) ;
}
2021-07-01 12:24:46 +02:00
void VM : : assign ( const NonnullRefPtr < BindingPattern > & target , Value value , GlobalObject & global_object , bool first_assignment , Environment * specific_scope )
2021-05-29 16:03:19 +04:30
{
auto & binding = * target ;
switch ( binding . kind ) {
case BindingPattern : : Kind : : Array : {
2021-06-02 20:52:46 +01:00
auto iterator = get_iterator ( global_object , value ) ;
2021-05-29 16:03:19 +04:30
if ( ! iterator )
return ;
2021-06-12 18:04:28 -07:00
for ( size_t i = 0 ; i < binding . entries . size ( ) ; i + + ) {
2021-05-29 16:03:19 +04:30
if ( exception ( ) )
return ;
2021-06-12 18:04:28 -07:00
auto & entry = binding . entries [ i ] ;
2021-05-29 16:03:19 +04:30
2021-06-12 18:04:28 -07:00
if ( entry . is_rest ) {
VERIFY ( i = = binding . entries . size ( ) - 1 ) ;
2021-05-29 16:03:19 +04:30
2021-07-04 01:36:44 +03:00
auto * array = Array : : create ( global_object , 0 ) ;
2021-05-29 16:03:19 +04:30
for ( ; ; ) {
auto next_object = iterator_next ( * iterator ) ;
if ( ! next_object )
return ;
auto done_property = next_object - > get ( names . done ) ;
if ( exception ( ) )
return ;
2021-07-04 22:55:45 +01:00
if ( done_property . to_boolean ( ) )
2021-05-29 16:03:19 +04:30
break ;
auto next_value = next_object - > get ( names . value ) ;
if ( exception ( ) )
return ;
array - > indexed_properties ( ) . append ( next_value ) ;
2020-09-27 15:18:55 +02:00
}
2021-05-29 16:03:19 +04:30
value = array ;
2021-06-12 18:04:28 -07:00
} else if ( iterator ) {
2021-05-29 16:03:19 +04:30
auto next_object = iterator_next ( * iterator ) ;
if ( ! next_object )
return ;
auto done_property = next_object - > get ( names . done ) ;
if ( exception ( ) )
return ;
2020-09-27 15:18:55 +02:00
2021-07-04 22:55:45 +01:00
if ( done_property . to_boolean ( ) ) {
2021-06-12 18:04:28 -07:00
iterator = nullptr ;
value = js_undefined ( ) ;
} else {
value = next_object - > get ( names . value ) ;
if ( exception ( ) )
return ;
}
} else {
value = js_undefined ( ) ;
}
2021-05-29 16:03:19 +04:30
2021-06-12 18:04:28 -07:00
if ( value . is_undefined ( ) & & entry . initializer ) {
value = entry . initializer - > execute ( interpreter ( ) , global_object ) ;
2021-05-29 16:03:19 +04:30
if ( exception ( ) )
return ;
}
2021-06-12 18:04:28 -07:00
entry . alias . visit (
[ & ] ( Empty ) { } ,
[ & ] ( NonnullRefPtr < Identifier > const & identifier ) {
set_variable ( identifier - > string ( ) , value , global_object , first_assignment , specific_scope ) ;
} ,
[ & ] ( NonnullRefPtr < BindingPattern > const & pattern ) {
assign ( pattern , value , global_object , first_assignment , specific_scope ) ;
} ) ;
2021-05-29 16:03:19 +04:30
2021-06-12 18:04:28 -07:00
if ( entry . is_rest )
break ;
2020-09-27 15:18:55 +02:00
}
2021-06-12 18:04:28 -07:00
2021-05-29 16:03:19 +04:30
break ;
2020-09-27 15:18:55 +02:00
}
2021-05-29 16:03:19 +04:30
case BindingPattern : : Kind : : Object : {
auto object = value . to_object ( global_object ) ;
2021-06-12 18:04:28 -07:00
HashTable < PropertyName , PropertyNameTraits > seen_names ;
for ( auto & property : binding . entries ) {
VERIFY ( ! property . is_elision ( ) ) ;
PropertyName assignment_name ;
2021-05-29 16:03:19 +04:30
JS : : Value value_to_assign ;
if ( property . is_rest ) {
2021-06-12 18:04:28 -07:00
VERIFY ( property . name . has < NonnullRefPtr < Identifier > > ( ) ) ;
assignment_name = property . name . get < NonnullRefPtr < Identifier > > ( ) - > string ( ) ;
auto * rest_object = Object : : create ( global_object , global_object . object_prototype ( ) ) ;
for ( auto & object_property : object - > shape ( ) . property_table ( ) ) {
LibJS: Rewrite most of Object for spec compliance :^)
This is a huge patch, I know. In hindsight this perhaps could've been
done slightly more incremental, but I started and then fixed everything
until it worked, and here we are. I tried splitting of some completely
unrelated changes into separate commits, however. Anyway.
This is a rewrite of most of Object, and by extension large parts of
Array, Proxy, Reflect, String, TypedArray, and some other things.
What we already had worked fine for about 90% of things, but getting the
last 10% right proved to be increasingly difficult with the current code
that sort of grew organically and is only very loosely based on the
spec - this became especially obvious when we started fixing a large
number of test262 failures.
Key changes include:
- 1:1 matching function names and parameters of all object-related
functions, to avoid ambiguity. Previously we had things like put(),
which the spec doesn't have - as a result it wasn't always clear which
need to be used.
- Better separation between object abstract operations and internal
methods - the former are always the same, the latter can be overridden
(and are therefore virtual). The internal methods (i.e. [[Foo]] in the
spec) are now prefixed with 'internal_' for clarity - again, it was
previously not always clear which AO a certain method represents,
get() could've been both Get and [[Get]] (I don't know which one it
was closer to right now).
Note that some of the old names have been kept until all code relying
on them is updated, but they are now simple wrappers around the
closest matching standard abstract operation.
- Simplifications of the storage layer: functions that write values to
storage are now prefixed with 'storage_' to make their purpose clear,
and as they are not part of the spec they should not contain any steps
specified by it. Much functionality is now covered by the layers above
it and was removed (e.g. handling of accessors, attribute checks).
- PropertyAttributes has been greatly simplified, and is being replaced
by PropertyDescriptor - a concept similar to the current
implementation, but more aligned with the actual spec. See the commit
message of the previous commit where it was introduced for details.
- As a bonus, and since I had to look at the spec a whole lot anyway, I
introduced more inline comments with the exact steps from the spec -
this makes it super easy to verify correctness.
- East-const all the things.
As a result of all of this, things are much more correct but a bit
slower now. Retaining speed wasn't a consideration at all, I have done
no profiling of the new code - there might be low hanging fruits, which
we can then harvest separately.
Special thanks to Idan for helping me with this by tracking down bugs,
updating everything outside of LibJS to work with these changes (LibWeb,
Spreadsheet, HackStudio), as well as providing countless patches to fix
regressions I introduced - there still are very few (we got it down to
5), but we also get many new passing test262 tests in return. :^)
Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 18:14:16 +01:00
if ( ! object_property . value . attributes . is_enumerable ( ) )
2021-05-29 16:03:19 +04:30
continue ;
2021-06-12 18:04:28 -07:00
if ( seen_names . contains ( object_property . key . to_display_string ( ) ) )
2021-05-29 16:03:19 +04:30
continue ;
2021-07-16 15:16:27 +03:00
rest_object - > set ( object_property . key , object - > get ( object_property . key ) , Object : : ShouldThrowExceptions : : Yes ) ;
2021-05-29 16:03:19 +04:30
if ( exception ( ) )
return ;
}
2021-06-12 18:04:28 -07:00
2021-05-29 16:03:19 +04:30
value_to_assign = rest_object ;
} else {
2021-06-12 18:04:28 -07:00
property . name . visit (
[ & ] ( Empty ) { VERIFY_NOT_REACHED ( ) ; } ,
[ & ] ( NonnullRefPtr < Identifier > const & identifier ) {
assignment_name = identifier - > string ( ) ;
} ,
[ & ] ( NonnullRefPtr < Expression > const & expression ) {
auto result = expression - > execute ( interpreter ( ) , global_object ) ;
if ( exception ( ) )
return ;
assignment_name = result . to_property_key ( global_object ) ;
} ) ;
2020-09-27 15:18:55 +02:00
2021-06-12 18:04:28 -07:00
if ( exception ( ) )
break ;
value_to_assign = object - > get ( assignment_name ) ;
}
2021-05-29 16:03:19 +04:30
2021-06-12 18:04:28 -07:00
seen_names . set ( assignment_name ) ;
2021-05-29 16:03:19 +04:30
if ( value_to_assign . is_empty ( ) )
value_to_assign = js_undefined ( ) ;
if ( value_to_assign . is_undefined ( ) & & property . initializer )
value_to_assign = property . initializer - > execute ( interpreter ( ) , global_object ) ;
if ( exception ( ) )
break ;
2021-06-12 18:04:28 -07:00
property . alias . visit (
[ & ] ( Empty ) {
set_variable ( assignment_name . to_string ( ) , value_to_assign , global_object , first_assignment , specific_scope ) ;
} ,
[ & ] ( NonnullRefPtr < Identifier > const & identifier ) {
VERIFY ( ! property . is_rest ) ;
set_variable ( identifier - > string ( ) , value_to_assign , global_object , first_assignment , specific_scope ) ;
} ,
[ & ] ( NonnullRefPtr < BindingPattern > const & pattern ) {
VERIFY ( ! property . is_rest ) ;
assign ( pattern , value_to_assign , global_object , first_assignment , specific_scope ) ;
} ) ;
2021-05-29 16:03:19 +04:30
if ( property . is_rest )
break ;
}
break ;
}
}
2020-09-27 15:18:55 +02:00
}
Value VM : : get_variable ( const FlyString & name , GlobalObject & global_object )
{
2021-06-24 19:17:45 +02:00
if ( ! m_execution_context_stack . is_empty ( ) ) {
auto & context = running_execution_context ( ) ;
2021-06-24 19:25:38 +02:00
if ( name = = names . arguments . as_string ( ) & & context . function ) {
2020-12-05 16:38:29 +01:00
// HACK: Special handling for the name "arguments":
// If the name "arguments" is defined in the current scope, for example via
// a function parameter, or by a local var declaration, we use that.
// Otherwise, we return a lazily constructed Array with all the argument values.
// FIXME: Do something much more spec-compliant.
2021-07-01 12:24:46 +02:00
auto possible_match = lexical_environment ( ) - > get_from_environment ( name ) ;
2020-12-05 16:38:29 +01:00
if ( possible_match . has_value ( ) )
return possible_match . value ( ) . value ;
2021-06-24 19:17:45 +02:00
if ( ! context . arguments_object ) {
2021-06-28 11:18:32 +02:00
if ( context . function - > is_strict_mode ( ) | | ! context . function - > has_simple_parameter_list ( ) ) {
2021-06-28 01:44:58 +02:00
context . arguments_object = create_unmapped_arguments_object ( global_object , context . arguments ) ;
} else {
2021-06-28 13:26:01 +02:00
context . arguments_object = create_mapped_arguments_object ( global_object , * context . function , verify_cast < OrdinaryFunctionObject > ( context . function ) - > parameters ( ) , context . arguments , * lexical_environment ( ) ) ;
2020-12-05 16:38:29 +01:00
}
}
2021-06-24 19:17:45 +02:00
return context . arguments_object ;
2020-12-05 16:38:29 +01:00
}
2021-07-01 12:24:46 +02:00
for ( auto * environment = lexical_environment ( ) ; environment ; environment = environment - > outer_environment ( ) ) {
auto possible_match = environment - > get_from_environment ( name ) ;
2021-04-12 20:57:30 -04:00
if ( exception ( ) )
return { } ;
2020-09-27 15:18:55 +02:00
if ( possible_match . has_value ( ) )
return possible_match . value ( ) . value ;
2021-07-07 22:53:32 +02:00
if ( environment - > has_binding ( name ) )
return environment - > get_binding_value ( global_object , name , false ) ;
2020-09-27 15:18:55 +02:00
}
}
LibJS: Rewrite most of Object for spec compliance :^)
This is a huge patch, I know. In hindsight this perhaps could've been
done slightly more incremental, but I started and then fixed everything
until it worked, and here we are. I tried splitting of some completely
unrelated changes into separate commits, however. Anyway.
This is a rewrite of most of Object, and by extension large parts of
Array, Proxy, Reflect, String, TypedArray, and some other things.
What we already had worked fine for about 90% of things, but getting the
last 10% right proved to be increasingly difficult with the current code
that sort of grew organically and is only very loosely based on the
spec - this became especially obvious when we started fixing a large
number of test262 failures.
Key changes include:
- 1:1 matching function names and parameters of all object-related
functions, to avoid ambiguity. Previously we had things like put(),
which the spec doesn't have - as a result it wasn't always clear which
need to be used.
- Better separation between object abstract operations and internal
methods - the former are always the same, the latter can be overridden
(and are therefore virtual). The internal methods (i.e. [[Foo]] in the
spec) are now prefixed with 'internal_' for clarity - again, it was
previously not always clear which AO a certain method represents,
get() could've been both Get and [[Get]] (I don't know which one it
was closer to right now).
Note that some of the old names have been kept until all code relying
on them is updated, but they are now simple wrappers around the
closest matching standard abstract operation.
- Simplifications of the storage layer: functions that write values to
storage are now prefixed with 'storage_' to make their purpose clear,
and as they are not part of the spec they should not contain any steps
specified by it. Much functionality is now covered by the layers above
it and was removed (e.g. handling of accessors, attribute checks).
- PropertyAttributes has been greatly simplified, and is being replaced
by PropertyDescriptor - a concept similar to the current
implementation, but more aligned with the actual spec. See the commit
message of the previous commit where it was introduced for details.
- As a bonus, and since I had to look at the spec a whole lot anyway, I
introduced more inline comments with the exact steps from the spec -
this makes it super easy to verify correctness.
- East-const all the things.
As a result of all of this, things are much more correct but a bit
slower now. Retaining speed wasn't a consideration at all, I have done
no profiling of the new code - there might be low hanging fruits, which
we can then harvest separately.
Special thanks to Idan for helping me with this by tracking down bugs,
updating everything outside of LibJS to work with these changes (LibWeb,
Spreadsheet, HackStudio), as well as providing countless patches to fix
regressions I introduced - there still are very few (we got it down to
5), but we also get many new passing test262 tests in return. :^)
Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 18:14:16 +01:00
if ( ! global_object . storage_has ( name ) ) {
if ( m_underscore_is_last_value & & name = = " _ " )
return m_last_value ;
return { } ;
}
return global_object . get ( name ) ;
2020-09-27 15:18:55 +02:00
}
2021-07-02 21:54:56 +02:00
// 9.1.2.1 GetIdentifierReference ( env, name, strict ), https://tc39.es/ecma262/#sec-getidentifierreference
Reference VM : : get_identifier_reference ( Environment * environment , FlyString const & name , bool strict )
2020-09-27 15:18:55 +02:00
{
2021-07-02 21:54:56 +02:00
// 1. If env is the value null, then
if ( ! environment ) {
// a. Return the Reference Record { [[Base]]: unresolvable, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty }.
return Reference { Reference : : BaseType : : Unresolvable , name , strict } ;
}
// FIXME: The remainder of this function is non-conforming.
2021-06-25 11:24:47 +02:00
2021-07-02 21:54:56 +02:00
auto & global_object = environment - > global_object ( ) ;
for ( ; environment & & environment - > outer_environment ( ) ; environment = environment - > outer_environment ( ) ) {
2021-07-01 12:24:46 +02:00
auto possible_match = environment - > get_from_environment ( name ) ;
2021-06-22 17:16:08 +02:00
if ( possible_match . has_value ( ) )
2021-07-02 21:54:56 +02:00
return Reference { * environment , name , strict } ;
2020-09-27 15:18:55 +02:00
}
2021-07-02 21:54:56 +02:00
return Reference { global_object . environment ( ) , name , strict } ;
}
// 9.4.2 ResolveBinding ( name [ , env ] ), https://tc39.es/ecma262/#sec-resolvebinding
Reference VM : : resolve_binding ( FlyString const & name , Environment * environment )
{
// 1. If env is not present or if env is undefined, then
if ( ! environment ) {
// a. Set env to the running execution context's LexicalEnvironment.
environment = running_execution_context ( ) . lexical_environment ;
}
// 2. Assert: env is an Environment Record.
VERIFY ( environment ) ;
// 3. If the code matching the syntactic production that is being evaluated is contained in strict mode code, let strict be true; else let strict be false.
bool strict = in_strict_mode ( ) ;
// 4. Return ? GetIdentifierReference(env, name, strict).
return get_identifier_reference ( environment , name , strict ) ;
2020-09-27 15:18:55 +02:00
}
2021-06-27 21:48:34 +02:00
Value VM : : construct ( FunctionObject & function , FunctionObject & new_target , Optional < MarkedValueList > arguments )
2020-09-27 15:18:55 +02:00
{
2021-06-10 23:17:29 +02:00
auto & global_object = function . global_object ( ) ;
2021-06-25 23:41:24 +02:00
Value this_argument ;
2021-06-27 21:48:34 +02:00
if ( function . constructor_kind ( ) = = FunctionObject : : ConstructorKind : : Base ) {
2021-06-25 23:41:24 +02:00
this_argument = ordinary_create_from_constructor < Object > ( global_object , new_target , & GlobalObject : : object_prototype ) ;
if ( exception ( ) )
return { } ;
}
2021-06-25 20:10:00 +02:00
ExecutionContext callee_context ;
2021-07-02 21:02:56 +02:00
prepare_for_ordinary_call ( function , callee_context , & new_target ) ;
2020-11-08 12:54:52 +00:00
if ( exception ( ) )
return { } ;
2021-07-02 21:02:56 +02:00
2021-06-24 19:17:45 +02:00
ArmedScopeGuard pop_guard = [ & ] {
pop_execution_context ( ) ;
2020-09-27 15:18:55 +02:00
} ;
2021-07-02 21:02:56 +02:00
if ( auto * interpreter = interpreter_if_exists ( ) )
callee_context . current_node = interpreter - > current_node ( ) ;
2021-06-25 20:10:00 +02:00
callee_context . arguments = function . bound_arguments ( ) ;
2020-09-27 15:18:55 +02:00
if ( arguments . has_value ( ) )
2021-06-25 20:10:00 +02:00
callee_context . arguments . extend ( arguments . value ( ) . values ( ) ) ;
2021-07-02 21:02:56 +02:00
if ( auto * environment = callee_context . lexical_environment ) {
auto & function_environment = verify_cast < FunctionEnvironment > ( * environment ) ;
function_environment . set_new_target ( & new_target ) ;
2021-06-25 23:41:24 +02:00
if ( ! this_argument . is_empty ( ) ) {
2021-07-02 21:02:56 +02:00
function_environment . bind_this_value ( global_object , this_argument ) ;
2020-09-27 15:18:55 +02:00
if ( exception ( ) )
return { } ;
}
}
// If we are a Derived constructor, |this| has not been constructed before super is called.
2021-06-25 23:41:24 +02:00
callee_context . this_value = this_argument ;
2020-09-27 18:45:21 +02:00
auto result = function . construct ( new_target ) ;
2020-09-27 15:18:55 +02:00
2021-06-24 19:17:45 +02:00
pop_execution_context ( ) ;
pop_guard . disarm ( ) ;
2020-09-27 15:18:55 +02:00
// If we are constructing an instance of a derived class,
// set the prototype on objects created by constructors that return an object (i.e. NativeFunction subclasses).
2021-06-27 21:48:34 +02:00
if ( function . constructor_kind ( ) = = FunctionObject : : ConstructorKind : : Base & & new_target . constructor_kind ( ) = = FunctionObject : : ConstructorKind : : Derived & & result . is_object ( ) ) {
2021-07-02 21:02:56 +02:00
if ( auto * environment = callee_context . lexical_environment )
verify_cast < FunctionEnvironment > ( environment ) - > replace_this_binding ( result ) ;
2020-10-13 23:49:19 +02:00
auto prototype = new_target . get ( names . prototype ) ;
2020-09-27 15:18:55 +02:00
if ( exception ( ) )
return { } ;
if ( prototype . is_object ( ) ) {
LibJS: Rewrite most of Object for spec compliance :^)
This is a huge patch, I know. In hindsight this perhaps could've been
done slightly more incremental, but I started and then fixed everything
until it worked, and here we are. I tried splitting of some completely
unrelated changes into separate commits, however. Anyway.
This is a rewrite of most of Object, and by extension large parts of
Array, Proxy, Reflect, String, TypedArray, and some other things.
What we already had worked fine for about 90% of things, but getting the
last 10% right proved to be increasingly difficult with the current code
that sort of grew organically and is only very loosely based on the
spec - this became especially obvious when we started fixing a large
number of test262 failures.
Key changes include:
- 1:1 matching function names and parameters of all object-related
functions, to avoid ambiguity. Previously we had things like put(),
which the spec doesn't have - as a result it wasn't always clear which
need to be used.
- Better separation between object abstract operations and internal
methods - the former are always the same, the latter can be overridden
(and are therefore virtual). The internal methods (i.e. [[Foo]] in the
spec) are now prefixed with 'internal_' for clarity - again, it was
previously not always clear which AO a certain method represents,
get() could've been both Get and [[Get]] (I don't know which one it
was closer to right now).
Note that some of the old names have been kept until all code relying
on them is updated, but they are now simple wrappers around the
closest matching standard abstract operation.
- Simplifications of the storage layer: functions that write values to
storage are now prefixed with 'storage_' to make their purpose clear,
and as they are not part of the spec they should not contain any steps
specified by it. Much functionality is now covered by the layers above
it and was removed (e.g. handling of accessors, attribute checks).
- PropertyAttributes has been greatly simplified, and is being replaced
by PropertyDescriptor - a concept similar to the current
implementation, but more aligned with the actual spec. See the commit
message of the previous commit where it was introduced for details.
- As a bonus, and since I had to look at the spec a whole lot anyway, I
introduced more inline comments with the exact steps from the spec -
this makes it super easy to verify correctness.
- East-const all the things.
As a result of all of this, things are much more correct but a bit
slower now. Retaining speed wasn't a consideration at all, I have done
no profiling of the new code - there might be low hanging fruits, which
we can then harvest separately.
Special thanks to Idan for helping me with this by tracking down bugs,
updating everything outside of LibJS to work with these changes (LibWeb,
Spreadsheet, HackStudio), as well as providing countless patches to fix
regressions I introduced - there still are very few (we got it down to
5), but we also get many new passing test262 tests in return. :^)
Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 18:14:16 +01:00
result . as_object ( ) . internal_set_prototype_of ( & prototype . as_object ( ) ) ;
2020-09-27 15:18:55 +02:00
if ( exception ( ) )
return { } ;
}
return result ;
}
if ( exception ( ) )
return { } ;
if ( result . is_object ( ) )
return result ;
LibJS: Rewrite most of Object for spec compliance :^)
This is a huge patch, I know. In hindsight this perhaps could've been
done slightly more incremental, but I started and then fixed everything
until it worked, and here we are. I tried splitting of some completely
unrelated changes into separate commits, however. Anyway.
This is a rewrite of most of Object, and by extension large parts of
Array, Proxy, Reflect, String, TypedArray, and some other things.
What we already had worked fine for about 90% of things, but getting the
last 10% right proved to be increasingly difficult with the current code
that sort of grew organically and is only very loosely based on the
spec - this became especially obvious when we started fixing a large
number of test262 failures.
Key changes include:
- 1:1 matching function names and parameters of all object-related
functions, to avoid ambiguity. Previously we had things like put(),
which the spec doesn't have - as a result it wasn't always clear which
need to be used.
- Better separation between object abstract operations and internal
methods - the former are always the same, the latter can be overridden
(and are therefore virtual). The internal methods (i.e. [[Foo]] in the
spec) are now prefixed with 'internal_' for clarity - again, it was
previously not always clear which AO a certain method represents,
get() could've been both Get and [[Get]] (I don't know which one it
was closer to right now).
Note that some of the old names have been kept until all code relying
on them is updated, but they are now simple wrappers around the
closest matching standard abstract operation.
- Simplifications of the storage layer: functions that write values to
storage are now prefixed with 'storage_' to make their purpose clear,
and as they are not part of the spec they should not contain any steps
specified by it. Much functionality is now covered by the layers above
it and was removed (e.g. handling of accessors, attribute checks).
- PropertyAttributes has been greatly simplified, and is being replaced
by PropertyDescriptor - a concept similar to the current
implementation, but more aligned with the actual spec. See the commit
message of the previous commit where it was introduced for details.
- As a bonus, and since I had to look at the spec a whole lot anyway, I
introduced more inline comments with the exact steps from the spec -
this makes it super easy to verify correctness.
- East-const all the things.
As a result of all of this, things are much more correct but a bit
slower now. Retaining speed wasn't a consideration at all, I have done
no profiling of the new code - there might be low hanging fruits, which
we can then harvest separately.
Special thanks to Idan for helping me with this by tracking down bugs,
updating everything outside of LibJS to work with these changes (LibWeb,
Spreadsheet, HackStudio), as well as providing countless patches to fix
regressions I introduced - there still are very few (we got it down to
5), but we also get many new passing test262 tests in return. :^)
Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 18:14:16 +01:00
if ( auto * environment = callee_context . lexical_environment )
return environment - > get_this_binding ( global_object ) ;
return this_argument ;
2020-09-27 15:18:55 +02:00
}
2021-04-13 01:02:38 +02:00
void VM : : throw_exception ( Exception & exception )
2020-09-27 15:18:55 +02:00
{
2021-04-13 01:02:38 +02:00
set_exception ( exception ) ;
2020-09-27 15:18:55 +02:00
unwind ( ScopeType : : Try ) ;
}
2021-06-25 11:40:03 +02:00
// 9.4.4 ResolveThisBinding ( ), https://tc39.es/ecma262/#sec-resolvethisbinding
Value VM : : resolve_this_binding ( GlobalObject & global_object )
{
auto & environment = get_this_environment ( * this ) ;
return environment . get_this_binding ( global_object ) ;
}
2021-04-18 17:08:14 +02:00
String VM : : join_arguments ( size_t start_index ) const
2020-09-27 15:18:55 +02:00
{
StringBuilder joined_arguments ;
2021-04-18 17:08:14 +02:00
for ( size_t i = start_index ; i < argument_count ( ) ; + + i ) {
2020-09-27 15:18:55 +02:00
joined_arguments . append ( argument ( i ) . to_string_without_side_effects ( ) . characters ( ) ) ;
if ( i ! = argument_count ( ) - 1 )
joined_arguments . append ( ' ' ) ;
}
return joined_arguments . build ( ) ;
}
2021-06-22 13:30:48 +02:00
Value VM : : get_new_target ( )
2020-09-27 15:18:55 +02:00
{
2021-06-22 13:30:48 +02:00
auto & env = get_this_environment ( * this ) ;
2021-07-01 12:24:46 +02:00
return verify_cast < FunctionEnvironment > ( env ) . new_target ( ) ;
2020-09-27 15:18:55 +02:00
}
2021-07-02 21:02:56 +02:00
// 10.2.1.1 PrepareForOrdinaryCall ( F, newTarget ), https://tc39.es/ecma262/#sec-prepareforordinarycall
void VM : : prepare_for_ordinary_call ( FunctionObject & function , ExecutionContext & callee_context , Value new_target )
{
// NOTE: This is a LibJS specific hack for NativeFunction to inherit the strictness of its caller.
// FIXME: I feel like we should be able to get rid of this.
if ( is < NativeFunction > ( function ) )
callee_context . is_strict_mode = in_strict_mode ( ) ;
else
callee_context . is_strict_mode = function . is_strict_mode ( ) ;
// 1. Assert: Type(newTarget) is Undefined or Object.
VERIFY ( new_target . is_undefined ( ) | | new_target . is_object ( ) ) ;
// 2. Let callerContext be the running execution context.
// 3. Let calleeContext be a new ECMAScript code execution context.
// NOTE: In the specification, PrepareForOrdinaryCall "returns" a new callee execution context.
// To avoid heap allocations, we put our ExecutionContext objects on the C++ stack instead.
// Whoever calls us should put an ExecutionContext on their stack and pass that as the `callee_context`.
// 4. Set the Function of calleeContext to F.
callee_context . function = & function ;
callee_context . function_name = function . name ( ) ;
// 5. Let calleeRealm be F.[[Realm]].
// 6. Set the Realm of calleeContext to calleeRealm.
// 7. Set the ScriptOrModule of calleeContext to F.[[ScriptOrModule]].
// FIXME: Our execution context struct currently does not track these items.
// 8. Let localEnv be NewFunctionEnvironment(F, newTarget).
// FIXME: This should call NewFunctionEnvironment instead of the ad-hoc FunctionObject::create_environment()
auto * local_environment = function . create_environment ( function ) ;
// 9. Set the LexicalEnvironment of calleeContext to localEnv.
callee_context . lexical_environment = local_environment ;
// 10. Set the VariableEnvironment of calleeContext to localEnv.
callee_context . variable_environment = local_environment ;
// 11. Set the PrivateEnvironment of calleeContext to F.[[PrivateEnvironment]].
// FIXME: We currently don't support private environments.
// 12. If callerContext is not already suspended, suspend callerContext.
// FIXME: We don't have this concept yet.
// 13. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
push_execution_context ( callee_context , function . global_object ( ) ) ;
// 14. NOTE: Any exception objects produced after this point are associated with calleeRealm.
// 15. Return calleeContext. (See NOTE above about how contexts are allocated on the C++ stack.)
}
2021-06-27 21:48:34 +02:00
Value VM : : call_internal ( FunctionObject & function , Value this_value , Optional < MarkedValueList > arguments )
2020-09-27 17:24:14 +02:00
{
2021-02-23 20:42:32 +01:00
VERIFY ( ! exception ( ) ) ;
2021-03-26 19:40:55 +01:00
VERIFY ( ! this_value . is_empty ( ) ) ;
2020-09-27 17:24:14 +02:00
2021-06-25 20:10:00 +02:00
ExecutionContext callee_context ;
2021-07-02 21:02:56 +02:00
prepare_for_ordinary_call ( function , callee_context , js_undefined ( ) ) ;
if ( exception ( ) )
return { } ;
ScopeGuard pop_guard = [ & ] {
pop_execution_context ( ) ;
} ;
2021-03-21 12:18:56 +01:00
if ( auto * interpreter = interpreter_if_exists ( ) )
2021-06-25 20:10:00 +02:00
callee_context . current_node = interpreter - > current_node ( ) ;
2021-07-02 21:02:56 +02:00
2021-06-25 20:10:00 +02:00
callee_context . this_value = function . bound_this ( ) . value_or ( this_value ) ;
callee_context . arguments = function . bound_arguments ( ) ;
2020-09-27 17:24:14 +02:00
if ( arguments . has_value ( ) )
2021-06-25 20:10:00 +02:00
callee_context . arguments . extend ( arguments . value ( ) . values ( ) ) ;
2020-09-27 17:24:14 +02:00
2021-07-02 21:02:56 +02:00
if ( auto * environment = callee_context . lexical_environment ) {
auto & function_environment = verify_cast < FunctionEnvironment > ( * environment ) ;
VERIFY ( function_environment . this_binding_status ( ) = = FunctionEnvironment : : ThisBindingStatus : : Uninitialized ) ;
function_environment . bind_this_value ( function . global_object ( ) , callee_context . this_value ) ;
2021-06-09 20:52:35 +02:00
}
2020-11-08 12:54:52 +00:00
if ( exception ( ) )
return { } ;
2020-09-27 17:24:14 +02:00
2021-07-02 21:02:56 +02:00
return function . call ( ) ;
2020-09-27 17:24:14 +02:00
}
2020-10-04 13:54:44 +02:00
bool VM : : in_strict_mode ( ) const
{
2021-06-24 19:17:45 +02:00
if ( execution_context_stack ( ) . is_empty ( ) )
2020-10-04 13:54:44 +02:00
return false ;
2021-06-24 19:17:45 +02:00
return running_execution_context ( ) . is_strict_mode ;
2020-10-04 13:54:44 +02:00
}
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
void VM : : run_queued_promise_jobs ( )
{
dbgln_if ( PROMISE_DEBUG , " Running queued promise jobs " ) ;
// Temporarily get rid of the exception, if any - job functions must be called
// either way, and that can't happen if we already have an exception stored.
2021-04-24 17:56:16 +02:00
TemporaryClearException clear_exception ( * this ) ;
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
while ( ! m_promise_jobs . is_empty ( ) ) {
auto * job = m_promise_jobs . take_first ( ) ;
dbgln_if ( PROMISE_DEBUG , " Calling promise job function @ {} " , job ) ;
[[maybe_unused]] auto result = call ( * job , js_undefined ( ) ) ;
}
// Ensure no job has created a new exception, they must clean up after themselves.
VERIFY ( ! m_exception ) ;
}
2021-06-13 00:22:35 +01:00
// 9.5.4 HostEnqueuePromiseJob ( job, realm ), https://tc39.es/ecma262/#sec-hostenqueuepromisejob
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
void VM : : enqueue_promise_job ( NativeFunction & job )
{
m_promise_jobs . append ( & job ) ;
}
2021-06-15 22:16:17 +03:00
void VM : : run_queued_finalization_registry_cleanup_jobs ( )
{
while ( ! m_finalization_registry_cleanup_jobs . is_empty ( ) ) {
auto * registry = m_finalization_registry_cleanup_jobs . take_first ( ) ;
registry - > cleanup ( ) ;
}
}
// 9.10.4.1 HostEnqueueFinalizationRegistryCleanupJob ( finalizationRegistry ), https://tc39.es/ecma262/#sec-host-cleanup-finalization-registry
void VM : : enqueue_finalization_registry_cleanup_job ( FinalizationRegistry & registry )
{
m_finalization_registry_cleanup_jobs . append ( & registry ) ;
}
2021-06-13 00:22:35 +01:00
// 27.2.1.9 HostPromiseRejectionTracker ( promise, operation ), https://tc39.es/ecma262/#sec-host-promise-rejection-tracker
LibJS: Add initial support for Promises
Almost a year after first working on this, it's finally done: an
implementation of Promises for LibJS! :^)
The core functionality is working and closely following the spec [1].
I mostly took the pseudo code and transformed it into C++ - if you read
and understand it, you will know how the spec implements Promises; and
if you read the spec first, the code will look very familiar.
Implemented functions are:
- Promise() constructor
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.resolve()
- Promise.reject()
For the tests I added a new function to test-js's global object,
runQueuedPromiseJobs(), which calls vm.run_queued_promise_jobs().
By design, queued jobs normally only run after the script was fully
executed, making it improssible to test handlers in individual test()
calls by default [2].
Subsequent commits include integrations into LibWeb and js(1) -
pretty-printing, running queued promise jobs when necessary.
This has an unusual amount of dbgln() statements, all hidden behind the
PROMISE_DEBUG flag - I'm leaving them in for now as they've been very
useful while debugging this, things can get quite complex with so many
asynchronously executed functions.
I've not extensively explored use of these APIs for promise-based
functionality in LibWeb (fetch(), Notification.requestPermission()
etc.), but we'll get there in due time.
[1]: https://tc39.es/ecma262/#sec-promise-objects
[2]: https://tc39.es/ecma262/#sec-jobs-and-job-queues
2021-04-01 22:13:29 +02:00
void VM : : promise_rejection_tracker ( const Promise & promise , Promise : : RejectionOperation operation ) const
{
switch ( operation ) {
case Promise : : RejectionOperation : : Reject :
// A promise was rejected without any handlers
if ( on_promise_unhandled_rejection )
on_promise_unhandled_rejection ( promise ) ;
break ;
case Promise : : RejectionOperation : : Handle :
// A handler was added to an already rejected promise
if ( on_promise_rejection_handled )
on_promise_rejection_handled ( promise ) ;
break ;
default :
VERIFY_NOT_REACHED ( ) ;
}
}
2021-06-06 22:53:44 +02:00
void VM : : dump_backtrace ( ) const
{
2021-06-24 19:17:45 +02:00
for ( ssize_t i = m_execution_context_stack . size ( ) - 1 ; i > = 0 ; - - i )
dbgln ( " -> {} " , m_execution_context_stack [ i ] - > function_name ) ;
2021-06-06 22:53:44 +02:00
}
2021-07-01 12:24:46 +02:00
void VM : : dump_environment_chain ( ) const
2021-06-21 20:54:02 +02:00
{
2021-07-01 12:24:46 +02:00
for ( auto * environment = lexical_environment ( ) ; environment ; environment = environment - > outer_environment ( ) ) {
dbgln ( " +> {} ({:p}) " , environment - > class_name ( ) , environment ) ;
if ( is < DeclarativeEnvironment > ( * environment ) ) {
auto & declarative_environment = static_cast < DeclarativeEnvironment const & > ( * environment ) ;
for ( auto & variable : declarative_environment . variables ( ) ) {
2021-06-21 20:54:02 +02:00
dbgln ( " {} " , variable . key ) ;
}
}
}
}
2020-09-20 19:24:44 +02:00
}