Skip to content

To handle d.ts emit errors that could affect other files, in incremental mode use d.ts emit text + diagnostics as signature of the file #49543

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
merged 7 commits into from
Jun 27, 2022
Merged

To handle d.ts emit errors that could affect other files, in incremental mode use d.ts emit text + diagnostics as signature of the file #49543

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b8b9478
Add test when declaration emit has errors and d.ts emit doesnt change…
sheetalkamat Jun 13, 2022
d024e27
Refactor
sheetalkamat Jun 14, 2022
daceaa2
Use declaration diagnostics in the d.ts signature for the file so it …
sheetalkamat Jun 14, 2022
21298a0
Renames and clarifications
sheetalkamat Jun 23, 2022
fd38c2c
Merge branch 'main' into staleErrors
sheetalkamat Jun 23, 2022
196d93d
Simplify serialize declaration diagnostics for signature purpose
sheetalkamat Jun 27, 2022
1e39e7b
Fix baselines
sheetalkamat Jun 27, 2022
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
105 changes: 86 additions & 19 deletions src/compiler/builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,13 @@ namespace ts {
* This is to allow the callers to be able to actually remove affected file only when the operation is complete
* eg. if during diagnostics check cancellation token ends up cancelling the request, the affected file should be retained
*/
function getNextAffectedFile(state: BuilderProgramState, cancellationToken: CancellationToken | undefined, computeHash: BuilderState.ComputeHash, host: BuilderProgramHost): SourceFile | Program | undefined {
function getNextAffectedFile(
state: BuilderProgramState,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost
): SourceFile | Program | undefined {
while (true) {
const { affectedFiles } = state;
if (affectedFiles) {
Expand All @@ -344,7 +350,14 @@ namespace ts {
if (!seenAffectedFiles.has(affectedFile.resolvedPath)) {
// Set the next affected file as seen and remove the cached semantic diagnostics
state.affectedFilesIndex = affectedFilesIndex;
handleDtsMayChangeOfAffectedFile(state, affectedFile, cancellationToken, computeHash, host);
handleDtsMayChangeOfAffectedFile(
state,
affectedFile,
cancellationToken,
computeHash,
getCanonicalFileName,
host
);
return affectedFile;
}
affectedFilesIndex++;
Expand Down Expand Up @@ -376,7 +389,14 @@ namespace ts {
}

// Get next batch of affected files
state.affectedFiles = BuilderState.getFilesAffectedByWithOldState(state, program, nextKey.value, cancellationToken, computeHash);
state.affectedFiles = BuilderState.getFilesAffectedByWithOldState(
state,
program,
nextKey.value,
cancellationToken,
computeHash,
getCanonicalFileName,
);
state.currentChangedFilePath = nextKey.value;
state.affectedFilesIndex = 0;
if (!state.seenAffectedFiles) state.seenAffectedFiles = new Set();
Expand Down Expand Up @@ -435,6 +455,7 @@ namespace ts {
affectedFile: SourceFile,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost,
) {
removeSemanticDiagnosticsOf(state, affectedFile.resolvedPath);
Expand All @@ -451,11 +472,19 @@ namespace ts {
affectedFile,
cancellationToken,
computeHash,
getCanonicalFileName,
);
return;
}
if (state.compilerOptions.assumeChangesOnlyAffectDirectDependencies) return;
handleDtsMayChangeOfReferencingExportOfAffectedFile(state, affectedFile, cancellationToken, computeHash, host);
handleDtsMayChangeOfReferencingExportOfAffectedFile(
state,
affectedFile,
cancellationToken,
computeHash,
getCanonicalFileName,
host,
);
}

/**
Expand All @@ -467,6 +496,7 @@ namespace ts {
path: Path,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost
): void {
removeSemanticDiagnosticsOf(state, path);
Expand All @@ -486,6 +516,7 @@ namespace ts {
sourceFile,
cancellationToken,
computeHash,
getCanonicalFileName,
!host.disableUseFileVersionAsSignature
);
// If not dts emit, nothing more to do
Expand Down Expand Up @@ -520,6 +551,7 @@ namespace ts {
filePath: Path,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost,
): boolean {
if (!state.fileInfos.get(filePath)?.affectsGlobalScope) return false;
Expand All @@ -530,6 +562,7 @@ namespace ts {
file.resolvedPath,
cancellationToken,
computeHash,
getCanonicalFileName,
host,
));
removeDiagnosticsOfLibraryFiles(state);
Expand All @@ -544,6 +577,7 @@ namespace ts {
affectedFile: SourceFile,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost
) {
// If there was change in signature (dts output) for the changed file,
Expand All @@ -561,8 +595,8 @@ namespace ts {
const currentPath = queue.pop()!;
if (!seenFileNamesMap.has(currentPath)) {
seenFileNamesMap.set(currentPath, true);
if (handleDtsMayChangeOfGlobalScope(state, currentPath, cancellationToken, computeHash, host)) return;
handleDtsMayChangeOf(state, currentPath, cancellationToken, computeHash, host);
if (handleDtsMayChangeOfGlobalScope(state, currentPath, cancellationToken, computeHash, getCanonicalFileName, host)) return;
handleDtsMayChangeOf(state, currentPath, cancellationToken, computeHash, getCanonicalFileName, host);
if (isChangedSignature(state, currentPath)) {
const currentSourceFile = Debug.checkDefined(state.program).getSourceFileByPath(currentPath)!;
queue.push(...BuilderState.getReferencedByPaths(state, currentSourceFile.resolvedPath));
Expand All @@ -575,7 +609,7 @@ namespace ts {
// Go through exported modules from cache first
// If exported modules has path, all files referencing file exported from are affected
state.exportedModulesMap.getKeys(affectedFile.resolvedPath)?.forEach(exportedFromPath => {
if (handleDtsMayChangeOfGlobalScope(state, exportedFromPath, cancellationToken, computeHash, host)) return true;
if (handleDtsMayChangeOfGlobalScope(state, exportedFromPath, cancellationToken, computeHash, getCanonicalFileName, host)) return true;
const references = state.referencedMap!.getKeys(exportedFromPath);
return references && forEachKey(references, filePath =>
handleDtsMayChangeOfFileAndExportsOfFile(
Expand All @@ -584,6 +618,7 @@ namespace ts {
seenFileAndExportsOfFile,
cancellationToken,
computeHash,
getCanonicalFileName,
host,
)
);
Expand All @@ -600,12 +635,13 @@ namespace ts {
seenFileAndExportsOfFile: Set<string>,
cancellationToken: CancellationToken | undefined,
computeHash: BuilderState.ComputeHash,
getCanonicalFileName: GetCanonicalFileName,
host: BuilderProgramHost,
): boolean | undefined {
if (!tryAddToSet(seenFileAndExportsOfFile, filePath)) return undefined;

if (handleDtsMayChangeOfGlobalScope(state, filePath, cancellationToken, computeHash, host)) return true;
handleDtsMayChangeOf(state, filePath, cancellationToken, computeHash, host);
if (handleDtsMayChangeOfGlobalScope(state, filePath, cancellationToken, computeHash, getCanonicalFileName, host)) return true;
handleDtsMayChangeOf(state, filePath, cancellationToken, computeHash, getCanonicalFileName, host);

// If exported modules has path, all files referencing file exported from are affected
state.exportedModulesMap!.getKeys(filePath)?.forEach(exportedFromPath =>
Expand All @@ -615,6 +651,7 @@ namespace ts {
seenFileAndExportsOfFile,
cancellationToken,
computeHash,
getCanonicalFileName,
host,
)
);
Expand All @@ -627,6 +664,7 @@ namespace ts {
referencingFilePath,
cancellationToken,
computeHash,
getCanonicalFileName,
host,
)
);
Expand Down Expand Up @@ -1038,8 +1076,30 @@ namespace ts {
return { host, newProgram, oldProgram, configFileParsingDiagnostics: configFileParsingDiagnostics || emptyArray };
}

export function computeSignature(text: string, data: WriteFileCallbackData | undefined, computeHash: BuilderState.ComputeHash | undefined) {
return BuilderState.computeSignature(data?.sourceMapUrlPos !== undefined ? text.substring(0, data.sourceMapUrlPos) : text, computeHash);
function getTextHandlingSourceMapForSignature(text: string, data: WriteFileCallbackData | undefined) {
return data?.sourceMapUrlPos !== undefined ? text.substring(0, data.sourceMapUrlPos) : text;
}

export function computeSignatureWithDiagnostics(
program: Program,
text: string,
computeHash: BuilderState.ComputeHash | undefined,
getCanonicalFileName: GetCanonicalFileName,
data: WriteFileCallbackData | undefined
) {
text = getTextHandlingSourceMapForSignature(text, data);
if (data?.diagnostics?.length) {
text += formatDiagnostics(data.diagnostics, {
getCurrentDirectory: () => program.getCommonSourceDirectory(),
getCanonicalFileName,
getNewLine: () => "\n",
});
}
return (computeHash || generateDjb2Hash)(text);
}

export function computeSignature(text: string, computeHash: BuilderState.ComputeHash | undefined, data?: WriteFileCallbackData) {
return (computeHash || generateDjb2Hash)(getTextHandlingSourceMapForSignature(text, data));
}

export function createBuilderProgram(kind: BuilderProgramKind.SemanticDiagnosticsBuilderProgram, builderCreationParameters: BuilderCreationParameters): SemanticDiagnosticsBuilderProgram;
Expand Down Expand Up @@ -1108,7 +1168,7 @@ namespace ts {
* in that order would be used to write the files
*/
function emitNextAffectedFile(writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): AffectedFileResult<EmitResult> {
let affected = getNextAffectedFile(state, cancellationToken, computeHash, host);
let affected = getNextAffectedFile(state, cancellationToken, computeHash, getCanonicalFileName, host);
let emitKind = BuilderFileEmit.Full;
let isPendingEmitFile = false;
if (!affected) {
Expand Down Expand Up @@ -1170,19 +1230,26 @@ namespace ts {
const file = sourceFiles[0];
const info = state.fileInfos.get(file.resolvedPath)!;
if (info.signature === file.version) {
newSignature = computeSignature(text, data, computeHash);
if (newSignature !== file.version) { // Update it
const signature = computeSignatureWithDiagnostics(
state.program!,
text,
computeHash,
getCanonicalFileName,
data,
);
if (!data?.diagnostics?.length) newSignature = signature;
if (signature !== file.version) { // Update it
if (host.storeFilesChangingSignatureDuringEmit) (state.filesChangingSignature ||= new Set()).add(file.resolvedPath);
if (state.exportedModulesMap) BuilderState.updateExportedModules(state, file, file.exportedModulesFromDeclarationEmit);
if (state.affectedFiles) {
// Keep old signature so we know what to undo if cancellation happens
const existing = state.oldSignatures?.get(file.resolvedPath);
if (existing === undefined) (state.oldSignatures ||= new Map()).set(file.resolvedPath, info.signature || false);
info.signature = newSignature;
info.signature = signature;
}
else {
// These are directly commited
info.signature = newSignature;
info.signature = signature;
state.oldExportedModulesMap?.clear();
}
}
Expand All @@ -1195,15 +1262,15 @@ namespace ts {
if (state.compilerOptions.composite) {
const filePath = sourceFiles[0].resolvedPath;
const oldSignature = state.emitSignatures?.get(filePath);
newSignature ||= computeSignature(text, data, computeHash);
newSignature ||= computeSignature(text, computeHash, data);
if (newSignature !== oldSignature) {
(state.emitSignatures ||= new Map()).set(filePath, newSignature);
state.hasChangedEmitSignature = true;
}
}
}
else if (state.compilerOptions.composite) {
const newSignature = computeSignature(text, data, computeHash);
const newSignature = computeSignature(text, computeHash, data);
if (newSignature !== state.outSignature) {
state.outSignature = newSignature;
state.hasChangedEmitSignature = true;
Expand Down Expand Up @@ -1287,7 +1354,7 @@ namespace ts {
*/
function getSemanticDiagnosticsOfNextAffectedFile(cancellationToken?: CancellationToken, ignoreSourceFile?: (sourceFile: SourceFile) => boolean): AffectedFileResult<readonly Diagnostic[]> {
while (true) {
const affected = getNextAffectedFile(state, cancellationToken, computeHash, host);
const affected = getNextAffectedFile(state, cancellationToken, computeHash, getCanonicalFileName, host);
if (!affected) {
// Done
return undefined;
Expand Down
Loading