RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 06:37:43 +00:00
Code Issues Activity Actions

LibJS: Rewrite most of Object for spec compliance :^)

Browse source 
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>
This commit is contained in:
Linus Groh 2021-07-04 18:14:16 +01:00
parent 4e5362b7cb
commit 09bd5f8772
80 changed files with 4019 additions and 2239 deletions
Download patch file Download diff file Expand all files Collapse all files

189
Userland/Libraries/LibJS/Runtime/ObjectConstructor.cpp
View file

@ -80,55 +80,102 @@ Value ObjectConstructor::construct(FunctionObject& new_target)
return value.to_object(global_object);
}
enum class GetOwnPropertyKeysType {
String,
Symbol,
};
// 20.1.2.11.1 GetOwnPropertyKeys ( O, type ), https://tc39.es/ecma262/#sec-getownpropertykeys
static Array* get_own_property_keys(GlobalObject& global_object, Value value, GetOwnPropertyKeysType type)
{
auto& vm = global_object.vm();
// 1. Let obj be ? ToObject(O).
auto* object = value.to_object(global_object);
if (vm.exception())
return {};
// 2. Let keys be ? obj.[[OwnPropertyKeys]]().
auto keys = object->internal_own_property_keys();
if (vm.exception())
return {};
// 3. Let nameList be a new empty List.
auto name_list = MarkedValueList { vm.heap() };
// 4. For each element nextKey of keys, do
for (auto& next_key : keys) {
// a. If Type(nextKey) is Symbol and type is symbol or Type(nextKey) is String and type is string, then
if ((next_key.is_symbol() && type == GetOwnPropertyKeysType::Symbol) || (next_key.is_string() && type == GetOwnPropertyKeysType::String)) {
// i. Append nextKey as the last element of nameList.
name_list.append(next_key);
}
}
// 5. Return CreateArrayFromList(nameList).
return Array::create_from(global_object, name_list);
}
// 20.1.2.10 Object.getOwnPropertyNames ( O ), https://tc39.es/ecma262/#sec-object.getownpropertynames
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::get_own_property_names)
{
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return Array::create_from(global_object, object->get_own_properties(PropertyKind::Key, false, GetOwnPropertyReturnType::StringOnly));
// 1. Return ? GetOwnPropertyKeys(O, string).
return get_own_property_keys(global_object, vm.argument(0), GetOwnPropertyKeysType::String);
}
// 20.1.2.11 Object.getOwnPropertySymbols ( O ), https://tc39.es/ecma262/#sec-object.getownpropertysymbols
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::get_own_property_symbols)
{
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return Array::create_from(global_object, object->get_own_properties(PropertyKind::Key, false, GetOwnPropertyReturnType::SymbolOnly));
// 1. Return ? GetOwnPropertyKeys(O, symbol).
return get_own_property_keys(global_object, vm.argument(0), GetOwnPropertyKeysType::Symbol);
}
// 20.1.2.12 Object.getPrototypeOf ( O ), https://tc39.es/ecma262/#sec-object.getprototypeof
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::get_prototype_of)
{
// 1. Let obj be ? ToObject(O).
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return object->prototype();
// 2. Return ? obj.[[GetPrototypeOf]]().
return object->internal_get_prototype_of();
}
// 20.1.2.21 Object.setPrototypeOf ( O, proto ), https://tc39.es/ecma262/#sec-object.setprototypeof
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::set_prototype_of)
{
auto argument = require_object_coercible(global_object, vm.argument(0));
auto proto = vm.argument(1);
// 1. Set O to ? RequireObjectCoercible(O).
auto object = require_object_coercible(global_object, vm.argument(0));
if (vm.exception())
return {};
auto prototype_value = vm.argument(1);
if (!prototype_value.is_object() && !prototype_value.is_null()) {
// 2. If Type(proto) is neither Object nor Null, throw a TypeError exception.
if (!proto.is_object() && !proto.is_null()) {
vm.throw_exception<TypeError>(global_object, ErrorType::ObjectPrototypeWrongType);
return {};
}
if (!argument.is_object())
return argument;
auto* prototype = prototype_value.is_null() ? nullptr : &prototype_value.as_object();
auto status = argument.as_object().set_prototype(prototype);
// 3. If Type(O) is not Object, return O.
if (!object.is_object())
return object;
// 4. Let status be ? O.[[SetPrototypeOf]](proto).
auto status = object.as_object().internal_set_prototype_of(proto.is_null() ? nullptr : &proto.as_object());
if (vm.exception())
return {};
// 5. If status is false, throw a TypeError exception.
if (!status) {
// FIXME: Improve/contextualize error message
vm.throw_exception<TypeError>(global_object, ErrorType::ObjectSetPrototypeOfReturnedFalse);
return {};
}
return argument;
// 6. Return O.
return object;
}
// 20.1.2.14 Object.isExtensible ( O ), https://tc39.es/ecma262/#sec-object.isextensible
@ -164,10 +211,11 @@ JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::prevent_extensions)
auto argument = vm.argument(0);
if (!argument.is_object())
return argument;
auto status = argument.as_object().prevent_extensions();
auto status = argument.as_object().internal_prevent_extensions();
if (vm.exception())
return {};
if (!status) {
// FIXME: Improve/contextualize error message
vm.throw_exception<TypeError>(global_object, ErrorType::ObjectPreventExtensionsReturnedFalse);
return {};
}
@ -247,54 +295,48 @@ JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::get_own_property_descriptor)
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
auto property_key = vm.argument(1).to_property_key(global_object);
auto key = vm.argument(1).to_property_key(global_object);
if (vm.exception())
return {};
return object->get_own_property_descriptor_object(property_key);
auto descriptor = object->internal_get_own_property(key);
if (vm.exception())
return {};
return from_property_descriptor(global_object, descriptor);
}
// 20.1.2.4 Object.defineProperty ( O, P, Attributes ), https://tc39.es/ecma262/#sec-object.defineproperty
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::define_property_)
{
if (!vm.argument(0).is_object()) {
vm.throw_exception<TypeError>(global_object, ErrorType::NotAnObject, "Object argument");
vm.throw_exception<TypeError>(global_object, ErrorType::NotAnObject, vm.argument(0).to_string_without_side_effects());
return {};
}
auto property_key = vm.argument(1).to_property_key(global_object);
auto key = vm.argument(1).to_property_key(global_object);
if (vm.exception())
return {};
if (!vm.argument(2).is_object()) {
vm.throw_exception<TypeError>(global_object, ErrorType::NotAnObject, "Descriptor argument");
auto descriptor = to_property_descriptor(global_object, vm.argument(2));
if (vm.exception())
return {};
}
auto& object = vm.argument(0).as_object();
auto& descriptor = vm.argument(2).as_object();
if (!object.define_property(property_key, descriptor)) {
if (!vm.exception()) {
if (AK::is<ProxyObject>(object)) {
vm.throw_exception<TypeError>(global_object, ErrorType::ObjectDefinePropertyReturnedFalse);
} else {
vm.throw_exception<TypeError>(global_object, ErrorType::NonExtensibleDefine, property_key.to_display_string());
}
}
vm.argument(0).as_object().define_property_or_throw(key, descriptor);
if (vm.exception())
return {};
}
return &object;
return vm.argument(0);
}
// 20.1.2.3 Object.defineProperties ( O, Properties ), https://tc39.es/ecma262/#sec-object.defineproperties
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::define_properties)
{
if (!vm.argument(0).is_object()) {
auto object = vm.argument(0);
auto properties = vm.argument(1);
// 1. If Type(O) is not Object, throw a TypeError exception.
if (!object.is_object()) {
vm.throw_exception<TypeError>(global_object, ErrorType::NotAnObject, "Object argument");
return {};
}
auto& object = vm.argument(0).as_object();
auto properties = vm.argument(1);
object.define_properties(properties);
if (vm.exception())
return {};
return &object;
// 2. Return ? ObjectDefineProperties(O, Properties).
return object.as_object().define_properties(properties);
}
// 20.1.2.13 Object.is ( value1, value2 ), https://tc39.es/ecma262/#sec-object.is
@ -306,56 +348,61 @@ JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::is)
// 20.1.2.17 Object.keys ( O ), https://tc39.es/ecma262/#sec-object.keys
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::keys)
{
auto* obj_arg = vm.argument(0).to_object(global_object);
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return Array::create_from(global_object, obj_arg->get_enumerable_own_property_names(PropertyKind::Key));
auto name_list = object->enumerable_own_property_names(PropertyKind::Key);
if (vm.exception())
return {};
return Array::create_from(global_object, name_list);
}
// 20.1.2.22 Object.values ( O ), https://tc39.es/ecma262/#sec-object.values
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::values)
{
auto* obj_arg = vm.argument(0).to_object(global_object);
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return Array::create_from(global_object, obj_arg->get_enumerable_own_property_names(PropertyKind::Value));
auto name_list = object->enumerable_own_property_names(PropertyKind::Value);
if (vm.exception())
return {};
return Array::create_from(global_object, name_list);
}
// 20.1.2.5 Object.entries ( O ), https://tc39.es/ecma262/#sec-object.entries
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::entries)
{
auto* obj_arg = vm.argument(0).to_object(global_object);
auto* object = vm.argument(0).to_object(global_object);
if (vm.exception())
return {};
return Array::create_from(global_object, obj_arg->get_enumerable_own_property_names(PropertyKind::KeyAndValue));
auto name_list = object->enumerable_own_property_names(PropertyKind::KeyAndValue);
if (vm.exception())
return {};
return Array::create_from(global_object, name_list);
}
// 20.1.2.2 Object.create ( O, Properties ), https://tc39.es/ecma262/#sec-object.create
JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::create)
{
auto prototype_value = vm.argument(0);
auto proto = vm.argument(0);
auto properties = vm.argument(1);
Object* prototype;
if (prototype_value.is_null()) {
prototype = nullptr;
} else if (prototype_value.is_object()) {
prototype = &prototype_value.as_object();
} else {
// 1. If Type(O) is neither Object nor Null, throw a TypeError exception.
if (!proto.is_object() && !proto.is_null()) {
vm.throw_exception<TypeError>(global_object, ErrorType::ObjectPrototypeWrongType);
return {};
}
auto* object = Object::create(global_object, prototype);
// 2. Let obj be ! OrdinaryObjectCreate(O).
auto* object = Object::create(global_object, proto.is_null() ? nullptr : &proto.as_object());
// 3. If Properties is not undefined, then
if (!properties.is_undefined()) {
object->define_properties(properties);
if (vm.exception())
return {};
// a. Return ? ObjectDefineProperties(obj, Properties).
return object->define_properties(properties);
}
// 4. Return obj.
return object;
}
@ -385,18 +432,18 @@ JS_DEFINE_NATIVE_FUNCTION(ObjectConstructor::assign)
continue;
auto from = next_source.to_object(global_object);
VERIFY(!vm.exception());
auto keys = from->get_own_properties(PropertyKind::Key);
auto keys = from->internal_own_property_keys();
if (vm.exception())
return {};
for (auto& key : keys) {
auto property_name = PropertyName::from_value(global_object, key);
auto property_descriptor = from->get_own_property_descriptor(property_name);
if (!property_descriptor.has_value() || !property_descriptor->attributes.is_enumerable())
for (auto& next_key : keys) {
auto property_name = PropertyName::from_value(global_object, next_key);
auto property_descriptor = from->internal_get_own_property(property_name);
if (!property_descriptor.has_value() || !*property_descriptor->enumerable)
continue;
auto value = from->get(property_name);
auto prop_value = from->get(property_name);
if (vm.exception())
return {};
to->put(property_name, value);
to->set(property_name, prop_value, true);
if (vm.exception())
return {};
}