Skip to content
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

Fixed accidentally reused comments between files in the emitter #61261

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed accidentally reused comments between files in the emitter #61261

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
5 changes: 4 additions & 1 deletion src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6207,6 +6207,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
const context = syntacticContext as NodeBuilderContext;
if (context.bundled || context.enclosingFile !== getSourceFileOfNode(lit)) {
let name = lit.text;
const originalName = name;
const nodeSymbol = getNodeLinks(parent).resolvedSymbol;
const meaning = parent.isTypeOf ? SymbolFlags.Value : SymbolFlags.Type;
const parentSymbol = nodeSymbol
Expand All @@ -6227,7 +6228,9 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
context.tracker.reportLikelyUnsafeImportRequiredError(name);
}
}
return name;
if (name !== originalName) {
return name;
}
}
},
canReuseTypeNode(context, typeNode) {
Expand Down
9 changes: 4 additions & 5 deletions src/compiler/expressionToTypeNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,9 +435,11 @@ export function createSyntacticTypeNodeBuilder(
if (!resolver.canReuseTypeNode(context, node)) {
return resolver.serializeExistingTypeNode(context, node);
}
const specifier = rewriteModuleSpecifier(node, node.argument.literal);
const literal = specifier === node.argument.literal ? reuseNode(context, node.argument.literal) : specifier;
return factory.updateImportTypeNode(
node,
factory.updateLiteralTypeNode(node.argument, rewriteModuleSpecifier(node, node.argument.literal)),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue was caused by factory.updateLiteralTypeNode calling its setTextRange. This one is specifically different from setTextRange used by reuseNode (check the comment above setTextRange in the checker.ts).

But it also means that likely all factory.update* methods used in this file here are susceptible for similar bugs. At least some of them are using the internal update function that calls setTextRange. There is a chance though this bug was extra tricky because LiteralType and StringLiteral here have the very same positions and only StringLiteral was correctly stripped from its positions before. So maybe the other update methods are safe-ish.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The factories doing anything with locations sounds very very cursed; but I can very much see update being used all over the place inside of the factory. So, not sure what to think there. I'd personally prefer if we didn't set ranges on nodes that didn't come out of real parsed source.

literal === node.argument.literal ? reuseNode(context, node.argument) : factory.createLiteralTypeNode(literal),
visitNode(node.attributes, visitExistingNodeTreeSymbols, isImportAttributes),
visitNode(node.qualifier, visitExistingNodeTreeSymbols, isEntityName),
visitNodes(node.typeArguments, visitExistingNodeTreeSymbols, isTypeNode),
Expand Down Expand Up @@ -612,10 +614,7 @@ export function createSyntacticTypeNodeBuilder(

function rewriteModuleSpecifier(parent: ImportTypeNode, lit: StringLiteral) {
const newName = resolver.getModuleSpecifierOverride(context, parent, lit);
if (newName) {
return setOriginalNode(factory.createStringLiteral(newName), lit);
}
return visitNode(lit, visitExistingNodeTreeSymbols, isStringLiteral)!;
return newName ? setOriginalNode(factory.createStringLiteral(newName), lit) : lit;
}
}
}
Expand Down
29 changes: 29 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse1.ts] ////

//// [a.ts]
import { object } from "./obj";

export const _ = object;

///////////
/**
* huh
*/
//// [obj.d.ts]
export declare const object: import("./id").Id<{
foo: import("./id" ).Id<{}>;
}>;

//// [id.d.ts]
export type Id<T> = T;




//// [a.d.ts]
export declare const _: {
foo: import("./id").Id<{}>;
};
/**
* huh
*/
31 changes: 31 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse1.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse1.ts] ////

=== a.ts ===
import { object } from "./obj";
>object : Symbol(object, Decl(a.ts, 0, 8))

export const _ = object;
>_ : Symbol(_, Decl(a.ts, 2, 12))
>object : Symbol(object, Decl(a.ts, 0, 8))

///////////
/**
* huh
*/
=== obj.d.ts ===
export declare const object: import("./id").Id<{
>object : Symbol(object, Decl(obj.d.ts, 0, 20))
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))

foo: import("./id" ).Id<{}>;
>foo : Symbol(foo, Decl(obj.d.ts, 0, 48))
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))

}>;

=== id.d.ts ===
export type Id<T> = T;
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))
>T : Symbol(T, Decl(id.d.ts, 0, 15))
>T : Symbol(T, Decl(id.d.ts, 0, 15))

33 changes: 33 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse1.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse1.ts] ////

=== a.ts ===
import { object } from "./obj";
>object : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^

export const _ = object;
>_ : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^
>object : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^

///////////
/**
* huh
*/
=== obj.d.ts ===
export declare const object: import("./id").Id<{
>object : { foo: import("./id").Id<{}>; }
> : ^^^^^^^ ^^^

foo: import("./id" ).Id<{}>;
>foo : {}
> : ^^

}>;

=== id.d.ts ===
export type Id<T> = T;
>Id : T
> : ^

29 changes: 29 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse2.ts] ////

//// [a.ts]
import { object } from "./obj.ts";

export const _ = object;

///////////
/**
* huh
*/
//// [obj.d.ts]
export declare const object: import("./id.ts").Id<{
foo: import("./id.ts" ).Id<{}>;
}>;

//// [id.d.ts]
export type Id<T> = T;




//// [a.d.ts]
export declare const _: {
foo: import("./id").Id<{}>;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm slightly surprised this one gets rewritten to "./id" (this test is using rewriteRelativeImportExtensions). IIRC I couldn't make it to be rewritten to anything else with any module-related options but maybe I have not tried hard enough. I guess it might behave differently from what rewriteRelativeImportExtensions promises us normally because it's in a type node.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See: #61037

};
/**
* huh
*/
31 changes: 31 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse2.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse2.ts] ////

=== a.ts ===
import { object } from "./obj.ts";
>object : Symbol(object, Decl(a.ts, 0, 8))

export const _ = object;
>_ : Symbol(_, Decl(a.ts, 2, 12))
>object : Symbol(object, Decl(a.ts, 0, 8))

///////////
/**
* huh
*/
=== obj.d.ts ===
export declare const object: import("./id.ts").Id<{
>object : Symbol(object, Decl(obj.d.ts, 0, 20))
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))

foo: import("./id.ts" ).Id<{}>;
>foo : Symbol(foo, Decl(obj.d.ts, 0, 51))
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))

}>;

=== id.d.ts ===
export type Id<T> = T;
>Id : Symbol(Id, Decl(id.d.ts, 0, 0))
>T : Symbol(T, Decl(id.d.ts, 0, 15))
>T : Symbol(T, Decl(id.d.ts, 0, 15))

33 changes: 33 additions & 0 deletions tests/baselines/reference/declarationEmitNoInvalidCommentReuse2.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
//// [tests/cases/compiler/declarationEmitNoInvalidCommentReuse2.ts] ////

=== a.ts ===
import { object } from "./obj.ts";
>object : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^

export const _ = object;
>_ : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^
>object : { foo: import("id").Id<{}>; }
> : ^^^^^^^ ^^^

///////////
/**
* huh
*/
=== obj.d.ts ===
export declare const object: import("./id.ts").Id<{
>object : { foo: import("./id.ts").Id<{}>; }
> : ^^^^^^^ ^^^

foo: import("./id.ts" ).Id<{}>;
>foo : {}
> : ^^

}>;

=== id.d.ts ===
export type Id<T> = T;
>Id : T
> : ^

22 changes: 22 additions & 0 deletions tests/cases/compiler/declarationEmitNoInvalidCommentReuse1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// @strict: true
// @declaration: true
// @emitDeclarationOnly: true

// https://github.com/microsoft/TypeScript/issues/61239

// @filename: a.ts
import { object } from "./obj";

export const _ = object;

///////////
/**
* huh
*/
// @filename: obj.d.ts
export declare const object: import("./id").Id<{
foo: import("./id" ).Id<{}>;
}>;

// @filename: id.d.ts
export type Id<T> = T;
21 changes: 21 additions & 0 deletions tests/cases/compiler/declarationEmitNoInvalidCommentReuse2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// @strict: true
// @declaration: true
// @emitDeclarationOnly: true
// @rewriteRelativeImportExtensions: true

// @filename: a.ts
import { object } from "./obj.ts";

export const _ = object;

///////////
/**
* huh
*/
// @filename: obj.d.ts
export declare const object: import("./id.ts").Id<{
foo: import("./id.ts" ).Id<{}>;
}>;

// @filename: id.d.ts
export type Id<T> = T;