Skip to content

fix(transformer/legacy-decorator): keep imports when it's referenced as metadata #10632

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

Merged
graphite-app merged 1 commit into from
Apr 27, 2025
Merged

fix(transformer/legacy-decorator): keep imports when it's referenced as metadata #10632

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
18 changes: 5 additions & 13 deletions crates/oxc_transformer/src/decorator/legacy/metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
/// * TypeScript's [emitDecoratorMetadata](https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata)
use oxc_allocator::{Box as ArenaBox, TakeIn};
use oxc_ast::ast::*;
use oxc_semantic::{Reference, ReferenceFlags};
use oxc_semantic::ReferenceFlags;
use oxc_span::{ContentEq, SPAN};
use oxc_traverse::{MaybeBoundIdentifier, Traverse, TraverseCtx};

Expand Down Expand Up @@ -505,18 +505,10 @@ impl<'a> LegacyDecoratorMetadata<'a, '_> {
ctx: &TraverseCtx<'a>,
) -> ReferenceFlags {
if let Some(symbol_id) = binding.symbol_id {
if ctx.scoping().get_resolved_references(symbol_id).any(Reference::is_value) {
// If the symbol has a value reference, we can use it as a value reference
ReferenceFlags::Read
} else {
// Otherwise, we can only use it as a type reference because the TypeScript plugin will
// remove imports by checking references of `Symbol` whether it contains a
// `ReferenceFlags::Read`. If it doesn't, that means the symbol can be removed. That's
// why we need to use `Type` flag here, which hints the TypeScript plugin this Reference
// is only used as a type reference. If no `ReferenceFlags::Read` is found, we can
// safely remove the import.
ReferenceFlags::Type
}
let flags = ctx.scoping().symbol_flags(symbol_id);
// `design::*type` would be called by `reflect-metadata` APIs, use `Read` flag
// to avoid TypeScript remove it because only used as types.
if flags.is_value() { ReferenceFlags::Read } else { ReferenceFlags::Type }
} else {
// Unresolved reference
ReferenceFlags::Type | ReferenceFlags::Read
Expand Down
177 changes: 33 additions & 144 deletions tasks/coverage/snapshots/semantic_typescript.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8561,24 +8561,9 @@ after transform: [ReferenceId(11), ReferenceId(12)]
rebuilt : [ReferenceId(13)]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataElidedImport.ts
Bindings mismatch:
after transform: ScopeId(0): ["Observable", "Test", "_decorate", "_decorateMetadata", "_decorateParam", "_ref", "whatever"]
rebuilt : ScopeId(0): ["Test", "_decorate", "_decorateMetadata", "_decorateParam", "_ref", "whatever"]
Reference symbol mismatch for "Observable":
after transform: SymbolId(0) "Observable"
rebuilt : <None>
Reference flags mismatch for "Observable":
after transform: ReferenceId(8): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "Observable":
after transform: SymbolId(0) "Observable"
rebuilt : <None>
Reference flags mismatch for "Observable":
after transform: ReferenceId(9): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Function", "Number", "Object", "String"]
rebuilt : ["Function", "Number", "Object", "Observable", "String"]
Symbol reference IDs mismatch for "Observable":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(8), ReferenceId(9)]
rebuilt : SymbolId(0): [ReferenceId(8), ReferenceId(9)]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataElidedImportOnDeclare.ts
Bindings mismatch:
Expand Down Expand Up @@ -8693,56 +8678,26 @@ after transform: [ReferenceId(1), ReferenceId(10)]
rebuilt : [ReferenceId(10)]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision.ts
Bindings mismatch:
after transform: ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "db", "someDecorator"]
rebuilt : ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "someDecorator"]
Symbol reference IDs mismatch for "db":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(3), ReferenceId(6), ReferenceId(7)]
rebuilt : SymbolId(0): [ReferenceId(8), ReferenceId(9)]
Symbol span mismatch for "MyClass":
after transform: SymbolId(3): Span { start: 100, end: 107 }
rebuilt : SymbolId(6): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 0, end: 0 }
Symbol span mismatch for "MyClass":
after transform: SymbolId(8): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 100, end: 107 }
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Object", "db"]
rebuilt : SymbolId(8): Span { start: 100, end: 107 }

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision2.ts
Bindings mismatch:
after transform: ScopeId(0): ["Database", "MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "someDecorator"]
rebuilt : ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "someDecorator"]
Symbol reference IDs mismatch for "Database":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(3), ReferenceId(6), ReferenceId(7)]
rebuilt : SymbolId(0): [ReferenceId(8), ReferenceId(9)]
Symbol span mismatch for "MyClass":
after transform: SymbolId(3): Span { start: 112, end: 119 }
rebuilt : SymbolId(6): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 0, end: 0 }
Symbol span mismatch for "MyClass":
after transform: SymbolId(8): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 112, end: 119 }
Reference symbol mismatch for "Database":
after transform: SymbolId(0) "Database"
rebuilt : <None>
Reference flags mismatch for "Database":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "Database":
after transform: SymbolId(0) "Database"
rebuilt : <None>
Reference flags mismatch for "Database":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Database", "Object"]
rebuilt : SymbolId(8): Span { start: 112, end: 119 }

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision3.ts
Symbol span mismatch for "MyClass":
Expand All @@ -8754,70 +8709,34 @@ rebuilt : SymbolId(7): Span { start: 104, end: 111 }
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Object", "db"]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision5.ts
Bindings mismatch:
after transform: ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "db", "someDecorator"]
rebuilt : ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "someDecorator"]
Symbol reference IDs mismatch for "db":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(3), ReferenceId(6), ReferenceId(7)]
rebuilt : SymbolId(0): [ReferenceId(8), ReferenceId(9)]
Symbol span mismatch for "MyClass":
after transform: SymbolId(3): Span { start: 98, end: 105 }
rebuilt : SymbolId(6): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 0, end: 0 }
Symbol span mismatch for "MyClass":
after transform: SymbolId(8): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 98, end: 105 }
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "db":
after transform: SymbolId(0) "db"
rebuilt : <None>
Reference flags mismatch for "db":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Object", "db"]
rebuilt : SymbolId(8): Span { start: 98, end: 105 }

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision6.ts
Bindings mismatch:
after transform: ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "database", "someDecorator"]
rebuilt : ScopeId(0): ["MyClass", "_decorate", "_decorateMetadata", "_defineProperty", "_ref", "someDecorator"]
Symbol reference IDs mismatch for "database":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(3), ReferenceId(6), ReferenceId(7)]
rebuilt : SymbolId(0): [ReferenceId(8), ReferenceId(9)]
Symbol span mismatch for "MyClass":
after transform: SymbolId(3): Span { start: 104, end: 111 }
rebuilt : SymbolId(6): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 0, end: 0 }
Symbol span mismatch for "MyClass":
after transform: SymbolId(8): Span { start: 0, end: 0 }
rebuilt : SymbolId(7): Span { start: 104, end: 111 }
Reference symbol mismatch for "database":
after transform: SymbolId(0) "database"
rebuilt : <None>
Reference flags mismatch for "database":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "database":
after transform: SymbolId(0) "database"
rebuilt : <None>
Reference flags mismatch for "database":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Object", "database"]
rebuilt : SymbolId(8): Span { start: 104, end: 111 }

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorMetadataWithImportDeclarationNameCollision8.ts
Symbol span mismatch for "MyClass":
Expand All @@ -8829,38 +8748,17 @@ rebuilt : SymbolId(7): Span { start: 110, end: 117 }
Reference symbol mismatch for "database":
after transform: SymbolId(0) "database"
rebuilt : <None>
Reference flags mismatch for "database":
after transform: ReferenceId(7): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
Reference symbol mismatch for "database":
after transform: SymbolId(0) "database"
rebuilt : <None>
Reference flags mismatch for "database":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(9): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Object"]
rebuilt : ["Object", "database"]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorReferenceOnOtherProperty.ts
Bindings mismatch:
after transform: ScopeId(0): ["Bar", "Yoha", "_decorate", "_decorateMetadata", "_decorateParam", "_ref", "foo"]
rebuilt : ScopeId(0): ["Bar", "_decorate", "_decorateMetadata", "_decorateParam", "_ref", "foo"]
Reference symbol mismatch for "Yoha":
after transform: SymbolId(0) "Yoha"
rebuilt : <None>
Reference flags mismatch for "Yoha":
after transform: ReferenceId(5): ReferenceFlags(Type)
rebuilt : ReferenceId(6): ReferenceFlags(Read)
Reference symbol mismatch for "Yoha":
after transform: SymbolId(0) "Yoha"
rebuilt : <None>
Reference flags mismatch for "Yoha":
after transform: ReferenceId(6): ReferenceFlags(Type)
rebuilt : ReferenceId(7): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Function", "Object"]
rebuilt : ["Function", "Object", "Yoha"]
Symbol reference IDs mismatch for "Yoha":
after transform: SymbolId(0): [ReferenceId(1), ReferenceId(5), ReferenceId(6)]
rebuilt : SymbolId(0): [ReferenceId(6), ReferenceId(7)]

semantic Error: tasks/coverage/typescript/tests/cases/compiler/decoratorReferences.ts
Bindings mismatch:
Expand Down Expand Up @@ -36775,34 +36673,25 @@ rebuilt : SymbolId(0): []
semantic Error: tasks/coverage/typescript/tests/cases/conformance/decorators/decoratorMetadata.ts
Bindings mismatch:
after transform: ScopeId(0): ["MyComponent", "Service", "_decorate", "_decorateMetadata", "_ref", "decorator"]
rebuilt : ScopeId(0): ["MyComponent", "_decorate", "_decorateMetadata", "_ref"]
rebuilt : ScopeId(0): ["MyComponent", "Service", "_decorate", "_decorateMetadata", "_ref"]
Symbol reference IDs mismatch for "Service":
after transform: SymbolId(0): [ReferenceId(1), ReferenceId(3), ReferenceId(4)]
rebuilt : SymbolId(0): [ReferenceId(14), ReferenceId(15)]
Symbol span mismatch for "MyComponent":
after transform: SymbolId(2): Span { start: 80, end: 91 }
rebuilt : SymbolId(3): Span { start: 0, end: 0 }
rebuilt : SymbolId(4): Span { start: 0, end: 0 }
Symbol span mismatch for "MyComponent":
after transform: SymbolId(7): Span { start: 0, end: 0 }
rebuilt : SymbolId(4): Span { start: 80, end: 91 }
rebuilt : SymbolId(5): Span { start: 80, end: 91 }
Reference symbol mismatch for "decorator":
after transform: SymbolId(1) "decorator"
rebuilt : <None>
Reference symbol mismatch for "decorator":
after transform: SymbolId(1) "decorator"
rebuilt : <None>
Reference symbol mismatch for "Service":
after transform: SymbolId(0) "Service"
rebuilt : <None>
Reference flags mismatch for "Service":
after transform: ReferenceId(3): ReferenceFlags(Type)
rebuilt : ReferenceId(14): ReferenceFlags(Read)
Reference symbol mismatch for "Service":
after transform: SymbolId(0) "Service"
rebuilt : <None>
Reference flags mismatch for "Service":
after transform: ReferenceId(4): ReferenceFlags(Type)
rebuilt : ReferenceId(15): ReferenceFlags(Read)
Unresolved references mismatch:
after transform: ["Function", "Object"]
rebuilt : ["Function", "Object", "Service", "decorator"]
rebuilt : ["Function", "Object", "decorator"]

semantic Error: tasks/coverage/typescript/tests/cases/conformance/decorators/decoratorMetadataWithTypeOnlyImport.ts
Bindings mismatch:
Expand Down
23 changes: 7 additions & 16 deletions tasks/transform_conformance/snapshots/oxc.snap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,34 +439,25 @@ rebuilt : SymbolId(3): Span { start: 87, end: 94 }
* oxc/metadata/imports/input.ts
Bindings mismatch:
after transform: ScopeId(0): ["Bar", "Cls", "Foo", "_ref", "dec"]
rebuilt : ScopeId(0): ["Cls", "_ref"]
rebuilt : ScopeId(0): ["Cls", "Foo", "_ref"]
Scope children mismatch:
after transform: ScopeId(0): [ScopeId(1), ScopeId(2)]
rebuilt : ScopeId(0): [ScopeId(1)]
Symbol reference IDs mismatch for "Foo":
after transform: SymbolId(0): [ReferenceId(2), ReferenceId(3), ReferenceId(8), ReferenceId(9)]
rebuilt : SymbolId(0): [ReferenceId(7), ReferenceId(8)]
Symbol span mismatch for "Cls":
after transform: SymbolId(6): Span { start: 135, end: 138 }
rebuilt : SymbolId(1): Span { start: 0, end: 0 }
rebuilt : SymbolId(2): Span { start: 0, end: 0 }
Symbol span mismatch for "Cls":
after transform: SymbolId(10): Span { start: 0, end: 0 }
rebuilt : SymbolId(2): Span { start: 135, end: 138 }
Reference symbol mismatch for "Foo":
after transform: SymbolId(0) "Foo"
rebuilt : <None>
Reference flags mismatch for "Foo":
after transform: ReferenceId(8): ReferenceFlags(Type)
rebuilt : ReferenceId(7): ReferenceFlags(Read)
Reference symbol mismatch for "Foo":
after transform: SymbolId(0) "Foo"
rebuilt : <None>
Reference flags mismatch for "Foo":
after transform: ReferenceId(9): ReferenceFlags(Type)
rebuilt : ReferenceId(8): ReferenceFlags(Read)
rebuilt : SymbolId(3): Span { start: 135, end: 138 }
Reference symbol mismatch for "dec":
after transform: SymbolId(2) "dec"
rebuilt : <None>
Unresolved references mismatch:
after transform: ["Object", "PropertyDescriptor", "babelHelpers", "console"]
rebuilt : ["Foo", "Object", "babelHelpers", "console", "dec"]
rebuilt : ["Object", "babelHelpers", "console", "dec"]

* oxc/metadata/typescript-syntax/input.ts
Bindings mismatch:
Expand Down
3 changes: 1 addition & 2 deletions ...ransform_conformance/tests/legacy-decorators/test/fixtures/oxc/metadata/imports/output.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Foo } from "mod";
var _ref;

let Cls = class Cls {
Expand All @@ -18,5 +19,3 @@ Cls = babelHelpers.decorate(
],
Cls,
);

export {};
Loading