Skip to content

Fixed declaration emit issue related to a qualifier being reused cross-file - #58810

Merged
Jake Bailey (jakebailey) merged 3 commits into
microsoft:mainfrom
Andarist:fix/qualifier-reuse
Jun 14, 2024
Merged

Fixed declaration emit issue related to a qualifier being reused cross-file#58810
Jake Bailey (jakebailey) merged 3 commits into
microsoft:mainfrom
Andarist:fix/qualifier-reuse

Conversation

@Andarist

Copy link
Copy Markdown
Contributor

fixes#58807

@typescript-botTypeScript Bot (typescript-bot) added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Jun 9, 2024
factory.updateLiteralTypeNode(node.argument, rewriteModuleSpecifier(node, node.argument.literal)),
node.attributes,
node.qualifier,
visitNode(node.qualifier, visitExistingNodeTreeSymbols, isEntityName),

@MichaelMitchell-atmichaelm (MichaelMitchell-at)Jun 10, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I definitely don't have enough context on the workings of the checker to give any informed feedback, but I can at least ask at a high level do we have some confidence whether anything more could be done to the structure of the code to avoid this general class of problem?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Tbh, I don't know this part of TS too well either so we need to wait for Wesley Wigham (@weswigham) or Titian Cernicova-Dragomir (@dragomirtitian) to give some feedback on this. I'd expect that other things in this function (like node.attributes here) should be wrapped like this too (if only this is the right fix).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would definitely suspect a lot of this needs this same fix.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

100% - any child node we copy should have its' children visited - any missing visitor calls on manually remapped nodes are an oversight, presumably.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Jake Bailey (@jakebailey) do we just want to take this as-is, or should we use this opportunity to audit all the factory calls in the visitor?

@jakebailey

Copy link
Copy Markdown
Member

I think it'd be fine to merge this since it clearly helps code in the wild, but I do think we should audit effectively everything and backport what we find.

@Andarist

Copy link
Copy Markdown
ContributorAuthor

I can make this audit as part of this PR (or separately), if you are OK with waiting till tomorrow.

@jakebailey

Copy link
Copy Markdown
Member

I think we could wait a day on this one; we still have time before the release.

@Andarist

Copy link
Copy Markdown
ContributorAuthor

aye aye, captain

@typescript-botTypeScript Bot (typescript-bot) added For Milestone Bug PRs that fix a bug with a specific milestone and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Jun 12, 2024
Comment threadsrc/compiler/checker.ts Outdated
Comment threadsrc/compiler/checker.ts Outdated
getEffectiveDotDotDotForParameter(p),
setTextRange(context, factory.createIdentifier(getNameForJSDocFunctionParameter(p, i)), p),
p.questionToken,
p.questionToken ? factory.createToken(SyntaxKind.QuestionToken) : undefined,

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Some other code paths in this function do a similar "cloning" of the .questionToken so I assume that it's the right thing to do here and in other places that I touched

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Those 2 call sites related to .questionToken are also related to JSDoc. I wonder if this cloning even matters in this context.

return factory.updateTypeParameterDeclaration(
node,
node.modifiers,
visitNodes(node.modifiers, visitExistingNodeTreeSymbols, isModifier),

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

those modifiers are just tokens so i guess i could just map over them and clone them?

factory.updateLiteralTypeNode(node.argument, rewriteModuleSpecifier(node, node.argument.literal)),
node.attributes,
node.qualifier,
visitNode(node.attributes, visitExistingNodeTreeSymbols, isImportAttributes),

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

those are not jus flat tokens so I wasn't quite sure what to do about those, it seemed like maybe i should deep clone them?

return factory.updateTypePredicateNode(node, node.assertsModifier ? factory.createToken(SyntaxKind.AssertsKeyword) : undefined, parameterName, visitNode(node.type, visitExistingNodeTreeSymbols, isTypeNode));
}

if (isTupleTypeNode(node) || isTypeLiteralNode(node) || isMappedTypeNode(node)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

there are also places in this function that do smth like:

if(visited===node){visited=factory.cloneNode(node)}

this pattern is not applied consistently across the whole function, should it be? 🤔

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I suspect yes.... Sure seems like though that we should make some sort of wrapper for the visitor func that would check that. Though I feel like I've seen that exact code in some visitor transformer code already (maybe we're not going through that)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think this might be a bigger change so I'd leave it out of this PR. I just want to flag this as a potential problem.

@jakebaileyJake Bailey (jakebailey) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, likely need to be cherry picking this to 5.5.

@jakebailey

Copy link
Copy Markdown
Member

TypeScript Bot (@typescript-bot) cherry-pick this to release-5.5

@typescript-bot

TypeScript Bot (typescript-bot) commented Jun 12, 2024

Copy link
Copy Markdown
Contributor

Starting jobs; this comment will be updated as builds start and complete.

CommandStatusResults
cherry-pick this to release-5.5✅ Started✅ Results

@typescript-bot

Copy link
Copy Markdown
Contributor

Hey, Jake Bailey (@jakebailey)! I've created #58842 for you.

@jakebailey
Jake Bailey (jakebailey) merged commit c2e48e5 into microsoft:mainJun 14, 2024
Daniel Rosenwasser (DanielRosenwasser) pushed a commit that referenced this pull request Jun 15, 2024
…e-5.5 (#58842)
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
@microsoftMicrosoft (microsoft) locked as resolved and limited conversation to collaborators Oct 16, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

For Milestone BugPRs that fix a bug with a specific milestone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[nightly] Syntactically invalid declaration files emitted under extremely specific conditions

6 participants

@Andarist@jakebailey@typescript-bot@weswigham@MichaelMitchell-at@sandersn