Skip to content

fix: keep object methods, accessors and computed keys in decorator metadata #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ashley-hunter wants to merge 1 commit into
base: main
Choose a base branch
from
+724 −31
Open

fix: keep object methods, accessors and computed keys in decorator metadata #498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions crates/oxc_angular_compiler/src/class_metadata/builders.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ use crate::output::ast::{
ArrowFunctionBody, ArrowFunctionExpr, LiteralArrayExpr, LiteralExpr, LiteralMapEntry,
LiteralMapExpr, LiteralValue, OutputExpression, ReadPropExpr, ReadVarExpr,
};
use crate::output::oxc_converter::convert_oxc_expression;
use crate::output::oxc_converter::{
convert_oxc_expression, convert_plain_properties, is_plain_property,
};

/// Build the decorators metadata array expression.
///
Expand Down Expand Up @@ -101,7 +103,20 @@ pub fn build_decorator_metadata_array<'a>(
let mut args = AllocVec::new_in(&allocator);
for (arg_idx, arg) in call.arguments.iter().enumerate() {
let expr = arg.to_expression();
if let Some(mut converted) = convert_oxc_expression(allocator, expr, source_text) {
let converted = match expr {
// ngtsc rebuilds the metadata from its plain properties when it
// inlines resources, so methods and accessors are dropped.
Expression::ObjectExpression(obj)
if is_component_decorator
&& decorator_idx == 0
&& arg_idx == 0
&& has_resource_property(obj) =>
{
convert_plain_properties(allocator, obj, source_text)
}
_ => convert_oxc_expression(allocator, expr, source_text),
};
if let Some(mut converted) = converted {
// Inline resolved templates/styles into the first arg of the
// first @Component decorator. Other decorators / other args
// are left alone.
Expand Down Expand Up @@ -154,6 +169,18 @@ pub fn build_decorator_metadata_array<'a>(
))
}

/// Whether a `@Component` metadata object has a resource field that ngtsc
/// inlines: `templateUrl`, `styleUrl`, `styleUrls` or `styles`.
fn has_resource_property(obj: &oxc_ast::ast::ObjectExpression<'_>) -> bool {
obj.properties.iter().any(|prop| {
let ObjectPropertyKind::ObjectProperty(prop) = prop else { return false };
is_plain_property(prop)
&& get_property_key_name(&prop.key).is_some_and(|name| {
matches!(name.as_str(), "templateUrl" | "styleUrl" | "styleUrls" | "styles")
})
})
}

/// Rewrite the `@Component` config map so external resource references are
/// inlined into the `setClassMetadata` args.
///
Expand Down
13 changes: 10 additions & 3 deletions crates/oxc_angular_compiler/src/component/decorator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ use crate::directive::{
extract_output_metadata,
};
use crate::output::oxc_converter::convert_oxc_expression;
use crate::util::is_metadata_property;

/// Extract component metadata from a class with decorators.
///
Expand Down Expand Up @@ -86,7 +87,9 @@ pub fn extract_component_metadata<'a>(

// Parse each property in the config object
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let key_name = get_property_key_name(&prop.key, consts)?;

match key_name.as_str() {
Expand Down Expand Up @@ -509,7 +512,9 @@ fn extract_host_metadata<'a>(
};

for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key, consts) else {
continue;
};
Expand Down Expand Up @@ -611,7 +616,9 @@ fn extract_single_host_directive<'a>(
let mut is_forward_reference = false;

for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key, consts) else {
continue;
};
Expand Down
13 changes: 10 additions & 3 deletions crates/oxc_angular_compiler/src/directive/decorator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ use super::metadata::{
use crate::factory::R3DependencyMetadata;
use crate::output::ast::{OutputAstBuilder, OutputExpression, ReadVarExpr};
use crate::output::oxc_converter::convert_oxc_expression;
use crate::util::is_metadata_property;

/// Find the @Directive decorator in a list of decorators.
pub(crate) fn find_directive_decorator<'a>(
Expand Down Expand Up @@ -121,7 +122,9 @@ pub fn extract_directive_metadata<'a>(
// Parse each property in the config object (if present)
if let Some(config_obj) = config_obj {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key, consts) else {
continue;
};
Expand Down Expand Up @@ -624,7 +627,9 @@ fn extract_host_metadata<'a>(
let mut host = R3HostMetadata::new(allocator);

for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key, consts) else {
continue;
};
Expand Down Expand Up @@ -714,7 +719,9 @@ fn extract_single_host_directive<'a>(
let mut is_forward_reference = false;

for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key, consts) else {
continue;
};
Expand Down
25 changes: 19 additions & 6 deletions crates/oxc_angular_compiler/src/directive/property_decorators.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ use oxc_str::Ident;
use super::metadata::{QueryPredicate, R3InputMetadata, R3QueryMetadata};
use crate::output::ast::OutputExpression;
use crate::output::oxc_converter::convert_oxc_expression;
use crate::util::is_metadata_property;

// ============================================================================
// Helper Functions
Expand Down Expand Up @@ -169,7 +170,9 @@ fn parse_input_config<'a>(
let mut config = InputConfig::default();

for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down Expand Up @@ -280,7 +283,9 @@ pub(crate) fn try_parse_signal_model<'a>(
if let Some(options_arg) = call_expr.arguments.get(options_arg_index) {
if let Argument::ObjectExpression(obj) = options_arg {
for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down Expand Up @@ -357,7 +362,9 @@ pub(crate) fn try_parse_signal_output<'a>(

if let Some(Argument::ObjectExpression(obj)) = call_expr.arguments.get(options_idx) {
for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down Expand Up @@ -465,7 +472,9 @@ pub(crate) fn try_parse_signal_input<'a>(
if let Some(options_arg) = call_expr.arguments.get(options_arg_index) {
if let Argument::ObjectExpression(obj) = options_arg {
for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down Expand Up @@ -816,7 +825,9 @@ fn parse_query_config<'a>(
if let Some(second_arg) = call.arguments.get(1) {
if let Argument::ObjectExpression(obj) = second_arg {
for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down Expand Up @@ -982,7 +993,9 @@ fn try_parse_signal_query<'a>(
if let Some(second_arg) = call_expr.arguments.get(1) {
if let Argument::ObjectExpression(obj) = second_arg {
for prop in &obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down
25 changes: 19 additions & 6 deletions crates/oxc_angular_compiler/src/injectable/decorator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use oxc_str::Ident;
use crate::factory::R3DependencyMetadata;
use crate::output::ast::{OutputExpression, ReadVarExpr};
use crate::output::oxc_converter::convert_oxc_expression;
use crate::util::is_metadata_property;

/// Extracted injectable metadata from a `@Injectable` decorator.
#[derive(Debug)]
Expand Down Expand Up @@ -316,7 +317,9 @@ fn extract_provided_in<'a>(
source_text: Option<&'a str>,
) -> Option<ProvidedInValue<'a>> {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "providedIn" {
return parse_provided_in_value(allocator, &prop.value, source_text);
Expand Down Expand Up @@ -355,7 +358,9 @@ fn extract_use_class<'a>(
source_text: Option<&'a str>,
) -> Option<UseClassMetadata<'a>> {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "useClass" {
let (class_expr, is_forward_ref) =
Expand All @@ -375,7 +380,9 @@ fn extract_use_factory<'a>(
source_text: Option<&'a str>,
) -> Option<UseFactoryMetadata<'a>> {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "useFactory" {
let factory = convert_oxc_expression(allocator, &prop.value, source_text)?;
Expand All @@ -394,7 +401,9 @@ fn extract_use_value<'a>(
source_text: Option<&'a str>,
) -> Option<OutputExpression<'a>> {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "useValue" {
return convert_oxc_expression(allocator, &prop.value, source_text);
Expand All @@ -411,7 +420,9 @@ fn extract_use_existing<'a>(
source_text: Option<&'a str>,
) -> Option<UseExistingMetadata<'a>> {
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "useExisting" {
let (existing, is_forward_ref) =
Expand Down Expand Up @@ -459,7 +470,9 @@ fn extract_deps_from_config<'a>(
let mut deps = Vec::new_in(&allocator);

for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
if let Some(key_name) = get_property_key_name(&prop.key) {
if key_name.as_str() == "deps" {
if let Expression::ArrayExpression(arr) = &prop.value {
Expand Down
5 changes: 4 additions & 1 deletion crates/oxc_angular_compiler/src/ng_module/decorator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use oxc_str::Ident;
use crate::factory::R3DependencyMetadata;
use crate::output::ast::{OutputExpression, ReadVarExpr};
use crate::output::oxc_converter::convert_oxc_expression;
use crate::util::is_metadata_property;

/// Extracted NgModule metadata from a `@NgModule` decorator.
///
Expand Down Expand Up @@ -213,7 +214,9 @@ pub fn extract_ng_module_metadata<'a>(

// Parse each property in the config object
for prop in &config_obj.properties {
if let ObjectPropertyKind::ObjectProperty(prop) = prop {
if let ObjectPropertyKind::ObjectProperty(prop) = prop
&& is_metadata_property(prop)
{
let Some(key_name) = get_property_key_name(&prop.key) else {
continue;
};
Expand Down
7 changes: 6 additions & 1 deletion crates/oxc_angular_compiler/src/output/emitter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,12 @@ impl JsEmitter {
OutputExpression::Parenthesized(p) => p.expr.as_ref(),
other => other,
};
let is_object_literal = matches!(inner, OutputExpression::LiteralMap(_));
// Objects the converter keeps as written arrive as raw source.
let is_object_literal = match inner {
OutputExpression::LiteralMap(_) => true,
OutputExpression::RawSource(raw) => raw.source.starts_with('{'),
_ => false,
};
if is_object_literal {
ctx.print("(");
}
Expand Down
Loading
Loading