Skip to content

Commit

Permalink
LibIDL+LibWeb: Mark [FIXME] interfaces as [[Unimplemented]]
Browse files Browse the repository at this point in the history 
Methods and attributes marked with [FIXME] are now implemented as
direct properties with the value `undefined` and are marked with the
[[Unimplemented]] attribute. This allows accesses to these properties
to be reported, while having no other side-effects.

This fixes an issue where [FIXME] methods broke feature detection on
some sites.

(cherry picked from commit 2f5cf8ac204a58dc2a6f722dd95015c6c2fb7a78)
  • Loading branch information
@tcl3 @nico
tcl3 authored and nico committed Jun 24, 2024
1 parent e67a8b8 commit 59efb9a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 31 deletions.
68 changes: 37 additions & 31 deletions Meta/Lagom/Tools/CodeGenerators/LibWeb/BindingsGenerator/IDLGenerators.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1946,15 +1946,6 @@ JS_DEFINE_NATIVE_FUNCTION(@class_name@::@function.name:snakecase@@overload_suffi
[[maybe_unused]] auto& realm = *vm.current_realm();
)~~~");

if (function.extended_attributes.contains("FIXME")) {
function_generator.append(R"~~~(
dbgln("FIXME: Unimplemented IDL interface '@namespaced_name@[email protected]@'");
return JS::js_undefined();
}
)~~~");
return;
}

if (is_static_function == StaticFunction::No) {
function_generator.append(R"~~~(
auto* impl = TRY(impl_from(vm));
Expand Down Expand Up @@ -2696,6 +2687,8 @@ static void generate_prototype_or_global_mixin_declarations(IDL::Interface const
}

for (auto& attribute : interface.attributes) {
if (attribute.extended_attributes.contains("FIXME"))
continue;
auto attribute_generator = generator.fork();
attribute_generator.set("attribute.name:snakecase", attribute.name.to_snakecase());
attribute_generator.append(R"~~~(
Expand Down Expand Up @@ -2777,6 +2770,8 @@ static void collect_attribute_values_of_an_inheritance_stack(SourceGenerator& fu
// NOTE: Functions, constructors and static functions cannot be JSON types, so they're not checked here.

for (auto& attribute : interface_in_chain.attributes) {
if (attribute.extended_attributes.contains("FIXME"))
continue;
if (!attribute.type->is_json(interface_in_chain))
continue;

Expand Down Expand Up @@ -3130,6 +3125,15 @@ void @class_name@::initialize(JS::Realm& realm)

// https://webidl.spec.whatwg.org/#es-attributes
for (auto& attribute : interface.attributes) {
if (attribute.extended_attributes.contains("FIXME")) {
auto fixme_attribute_generator = generator.fork();
fixme_attribute_generator.set("attribute.name", attribute.name);
fixme_attribute_generator.append(R"~~~(
define_direct_property("@attribute.name@", JS::js_undefined(), default_attributes | JS::Attribute::Unimplemented);
)~~~");
continue;
}

auto attribute_generator = generator.fork();
attribute_generator.set("attribute.name", attribute.name);
attribute_generator.set("attribute.getter_callback", attribute.getter_callback_name);
Expand All @@ -3150,6 +3154,16 @@ void @class_name@::initialize(JS::Realm& realm)
)~~~");
}

for (auto& function : interface.functions) {
if (function.extended_attributes.contains("FIXME")) {
auto fixme_function_generator = generator.fork();
fixme_function_generator.set("function.name", function.name);
fixme_function_generator.append(R"~~~(
define_direct_property("@function.name@", JS::js_undefined(), default_attributes | JS::Attribute::Unimplemented);
)~~~");
}
}

// https://webidl.spec.whatwg.org/#es-constants
for (auto& constant : interface.constants) {
// FIXME: Do constants need to be added to the unscopable list?
Expand Down Expand Up @@ -3309,6 +3323,8 @@ void @class_name@::initialize(JS::Realm& realm)
}

for (auto& attribute : interface.attributes) {
if (attribute.extended_attributes.contains("FIXME"))
continue;
auto attribute_generator = generator.fork();
attribute_generator.set("attribute.name", attribute.name);
attribute_generator.set("attribute.getter_callback", attribute.getter_callback_name);
Expand Down Expand Up @@ -3341,26 +3357,6 @@ JS_DEFINE_NATIVE_FUNCTION(@class_name@::@attribute.getter_callback@)
[[maybe_unused]] auto& realm = *vm.current_realm();
[[maybe_unused]] auto* impl = TRY(impl_from(vm));
)~~~");
if (attribute.extended_attributes.contains("FIXME")) {
attribute_generator.append(R"~~~(
dbgln("FIXME: Unimplemented IDL interface '@namespaced_name@[email protected]@'");
return JS::js_undefined();
}
)~~~");
if (!attribute.readonly || attribute.extended_attributes.contains("PutForwards"sv)) {
attribute_generator.append(R"~~~(
JS_DEFINE_NATIVE_FUNCTION(@class_name@::@attribute.setter_callback@)
{
WebIDL::log_trace(vm, "@class_name@::@attribute.setter_callback@");
dbgln("FIXME: Unimplemented IDL interface '@namespaced_name@[email protected]@'");
return JS::js_undefined();
}
)~~~");
}

continue;
}

if (attribute.extended_attributes.contains("CEReactions")) {
// 1. Push a new element queue onto this object's relevant agent's custom element reactions stack.
attribute_generator.append(R"~~~(
Expand Down Expand Up @@ -3756,6 +3752,8 @@ JS_DEFINE_NATIVE_FUNCTION(@class_name@::@attribute.setter_callback@)

// Implementation: Functions
for (auto& function : interface.functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
if (function.extended_attributes.contains("Default")) {
if (function.name == "toJSON"sv && function.return_type->name() == "object"sv) {
generate_default_to_json_function(generator, class_name, interface);
Expand Down Expand Up @@ -4191,8 +4189,11 @@ void @namespace_class@::finalize()
)~~~");
}

for (auto const& function : interface.functions)
for (auto const& function : interface.functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
generate_function(generator, function, StaticFunction::Yes, interface.namespace_class, interface.name, interface);
}
for (auto const& overload_set : interface.overload_sets) {
if (overload_set.value.size() == 1)
continue;
Expand Down Expand Up @@ -4483,8 +4484,11 @@ JS_DEFINE_NATIVE_FUNCTION(@constructor_class@::@attribute.getter_callback@)
}

// Implementation: Static Functions
for (auto& function : interface.static_functions)
for (auto& function : interface.static_functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
generate_function(generator, function, StaticFunction::Yes, interface.constructor_class, interface.fully_qualified_name, interface);
}
for (auto const& overload_set : interface.static_overload_sets) {
if (overload_set.value.size() == 1)
continue;
Expand Down Expand Up @@ -4585,6 +4589,8 @@ void generate_prototype_implementation(IDL::Interface const& interface, StringBu

bool has_ce_reactions = false;
for (auto const& function : interface.functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
if (function.extended_attributes.contains("CEReactions")) {
has_ce_reactions = true;
break;
Expand Down
6 changes: 6 additions & 0 deletions Userland/Libraries/LibIDL/IDLParser.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1158,6 +1158,8 @@ Interface& Parser::parse()

// Create overload sets
for (auto& function : interface.functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
auto& overload_set = interface.overload_sets.ensure(function.name);
function.overload_index = overload_set.size();
overload_set.append(function);
Expand All @@ -1169,6 +1171,8 @@ Interface& Parser::parse()
overloaded_function.is_overloaded = true;
}
for (auto& function : interface.static_functions) {
if (function.extended_attributes.contains("FIXME"))
continue;
auto& overload_set = interface.static_overload_sets.ensure(function.name);
function.overload_index = overload_set.size();
overload_set.append(function);
Expand All @@ -1180,6 +1184,8 @@ Interface& Parser::parse()
overloaded_function.is_overloaded = true;
}
for (auto& constructor : interface.constructors) {
if (constructor.extended_attributes.contains("FIXME"))
continue;
auto& overload_set = interface.constructor_overload_sets.ensure(constructor.name);
constructor.overload_index = overload_set.size();
overload_set.append(constructor);
Expand Down
3 changes: 3 additions & 0 deletions Userland/Libraries/LibWeb/Bindings/MainThreadVM.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ ErrorOr<void> initialize_main_thread_vm()
VERIFY(!s_main_thread_vm);

s_main_thread_vm = TRY(JS::VM::create(make<WebEngineCustomData>()));
s_main_thread_vm->on_unimplemented_property_access = [](auto const& object, auto const& property_key) {
dbgln("FIXME: Unimplemented IDL interface: '{}.{}'", object.class_name(), property_key.to_string());
};

// NOTE: We intentionally leak the main thread JavaScript VM.
// This avoids doing an exhaustive garbage collection on process exit.
Expand Down

0 comments on commit 59efb9a

Please sign in to comment.