Fix incorrect printing of information about signature calculation because of false possitives from check file.signagure === file.version

Author: sheetalkamat

src/compiler/builder.ts

@@ -73,6 +73,7 @@ import {
     returnUndefined,
     sameMap,
     SemanticDiagnosticsBuilderProgram,
+    SignatureInfo,
     skipTypeChecking,
     SourceFile,
     sourceFileMayBeEmitted,
@@ -242,8 +243,6 @@ export interface BuilderProgramState extends BuilderState, ReusableBuilderProgra
      * Already seen emitted files
      */
     seenEmittedFiles: Map<Path, BuilderFileEmit> | undefined;
-    /** Stores list of files that change signature during emit - test only */
-    filesChangingSignature?: Set<Path>;
 }
 
 /** @internal */
@@ -1602,7 +1601,7 @@ export function createBuilderProgram(kind: BuilderProgramKind, { newProgram, hos
                             // With d.ts diagnostics they are also part of the signature so emitSignature will be different from it since its just hash of d.ts
                             if (!data?.diagnostics?.length) emitSignature = signature;
                             if (signature !== file.version) { // Update it
-                                if (host.storeFilesChangingSignatureDuringEmit) (state.filesChangingSignature ??= new Set()).add(file.resolvedPath);
+                                if (host.storeSignatureInfo) (state.signatureInfo ??= new Map()).set(file.resolvedPath, SignatureInfo.StoredSignatureAtEmit);
                                 if (state.exportedModulesMap) BuilderState.updateExportedModules(state, file, file.exportedModulesFromDeclarationEmit);
                                 if (state.affectedFiles) {
                                     // Keep old signature so we know what to undo if cancellation happens

src/compiler/builderPublic.ts

@@ -31,15 +31,15 @@ export interface BuilderProgramHost {
      */
     writeFile?: WriteFileCallback;
     /**
-     * Store the list of files that update signature during the emit
+     * Store information about the signature
      *
      * @internal
      */
-    storeFilesChangingSignatureDuringEmit?: boolean;
+    storeSignatureInfo?: boolean;
 }
 
 /** @internal */
-export type HostForComputeHash = Pick<BuilderProgramHost, "createHash">;
+export type HostForComputeHash = Pick<BuilderProgramHost, "createHash" | "storeSignatureInfo">;
 
 /**
  * Builder to manage the program state changes

src/compiler/builderState.ts

@@ -52,6 +52,12 @@ export function getFileEmitOutput(
     }
 }
 /** @internal */
+export enum SignatureInfo {
+    ComputedDts,
+    StoredSignatureAtEmit,
+    UsedVersion,
+}
+/** @internal */
 export interface BuilderState {
     /**
      * Information of the file eg. its version, signature etc
@@ -98,6 +104,8 @@ export interface BuilderState {
      * Cache of all the file names
      */
     allFileNames?: readonly string[];
+    /** Information about the signature computation - test only */
+    signatureInfo?: Map<Path, SignatureInfo>;
 }
 /** @internal */
 export namespace BuilderState {
@@ -455,6 +463,7 @@ export namespace BuilderState {
         if (!sourceFile.isDeclarationFile && !useFileVersionAsSignature) {
             computeDtsSignature(programOfThisState, sourceFile, cancellationToken, host, (signature, sourceFiles) => {
                 latestSignature = signature;
+                if (host.storeSignatureInfo) (state.signatureInfo ??= new Map()).set(sourceFile.resolvedPath, SignatureInfo.ComputedDts);
                 if (latestSignature !== prevSignature) {
                     updateExportedModules(state, sourceFile, sourceFiles[0].exportedModulesFromDeclarationEmit);
                 }
@@ -463,6 +472,7 @@ export namespace BuilderState {
         // Default is to use file version as signature
         if (latestSignature === undefined) {
             latestSignature = sourceFile.version;
+            if (host.storeSignatureInfo) (state.signatureInfo ??= new Map()).set(sourceFile.resolvedPath, SignatureInfo.UsedVersion);
             if (state.exportedModulesMap && latestSignature !== prevSignature) {
                 (state.oldExportedModulesMap ||= new Map()).set(sourceFile.resolvedPath, state.exportedModulesMap.getValues(sourceFile.resolvedPath) || false);
                 // All the references in this file are exported

src/compiler/sys.ts

@@ -1458,7 +1458,7 @@ export interface System {
 
     // For testing
     /** @internal */ now?(): Date;
-    /** @internal */ storeFilesChangingSignatureDuringEmit?: boolean;
+    /** @internal */ storeSignatureInfo?: boolean;
 }
 
 export interface FileWatcher {

src/compiler/types.ts

@@ -7799,7 +7799,7 @@ export interface CompilerHost extends ModuleResolutionHost {
     /** @internal */ getSymlinkCache?(): SymlinkCache;
 
     // For testing:
-    /** @internal */ storeFilesChangingSignatureDuringEmit?: boolean;
+    /** @internal */ storeSignatureInfo?: boolean;
     /** @internal */ getBuildInfo?(fileName: string, configFilePath: string | undefined): BuildInfo | undefined;
 
     jsDocParsingMode?: JSDocParsingMode;

src/compiler/watch.ts

@@ -765,7 +765,7 @@ export function createCompilerHostFromProgramHost(host: ProgramHost<any>, getCom
         getEnvironmentVariable: maybeBind(host, host.getEnvironmentVariable) || (() => ""),
         createHash: maybeBind(host, host.createHash),
         readDirectory: maybeBind(host, host.readDirectory),
-        storeFilesChangingSignatureDuringEmit: host.storeFilesChangingSignatureDuringEmit,
+        storeSignatureInfo: host.storeSignatureInfo,
         jsDocParsingMode: host.jsDocParsingMode,
     };
     return compilerHost;
@@ -847,7 +847,7 @@ export function createProgramHost<T extends BuilderProgram = EmitAndSemanticDiag
         writeFile: (path, data, writeByteOrderMark) => system.writeFile(path, data, writeByteOrderMark),
         createHash: maybeBind(system, system.createHash),
         createProgram: createProgram || createEmitAndSemanticDiagnosticsBuilderProgram as any as CreateProgram<T>,
-        storeFilesChangingSignatureDuringEmit: system.storeFilesChangingSignatureDuringEmit,
+        storeSignatureInfo: system.storeSignatureInfo,
         now: maybeBind(system, system.now),
     };
 }

src/compiler/watchPublic.ts

@@ -123,7 +123,7 @@ export function readBuilderProgram(compilerOptions: CompilerOptions, host: ReadB
 export function createIncrementalCompilerHost(options: CompilerOptions, system = sys): CompilerHost {
     const host = createCompilerHostWorker(options, /*setParentNodes*/ undefined, system);
     host.createHash = maybeBind(system, system.createHash);
-    host.storeFilesChangingSignatureDuringEmit = system.storeFilesChangingSignatureDuringEmit;
+    host.storeSignatureInfo = system.storeSignatureInfo;
     setGetSourceFileAsHashVersioned(host);
     changeCompilerHostLikeToUseCache(host, fileName => toPath(fileName, host.getCurrentDirectory(), host.getCanonicalFileName));
     return host;
@@ -268,7 +268,7 @@ export interface ProgramHost<T extends BuilderProgram> {
     writeFile?(path: string, data: string, writeByteOrderMark?: boolean): void;
     // For testing
     /** @internal */
-    storeFilesChangingSignatureDuringEmit?: boolean;
+    storeSignatureInfo?: boolean;
     /** @internal */
     now?(): Date;
 }

src/testRunner/unittests/helpers/baseline.ts

@@ -91,14 +91,20 @@ function baselineProgram(baseline: string[], [program, builderProgram]: CommandL
                 baseline.push("Shape signatures in builder refreshed for::");
                 internalState.hasCalledUpdateShapeSignature.forEach((path: ts.Path) => {
                     const info = state.fileInfos.get(path);
-                    if (info?.version === info?.signature || !info?.signature) {
-                        baseline.push(path + " (used version)");
-                    }
-                    else if (internalState.filesChangingSignature?.has(path)) {
-                        baseline.push(path + " (computed .d.ts during emit)");
-                    }
-                    else {
-                        baseline.push(path + " (computed .d.ts)");
+                    const signatureInfo = internalState.signatureInfo?.get(path)!;
+                    switch (signatureInfo) {
+                        case ts.SignatureInfo.ComputedDts:
+                            baseline.push(path + " (computed .d.ts)");
+                            break;
+                        case ts.SignatureInfo.StoredSignatureAtEmit:
+                            baseline.push(path + " (computed .d.ts during emit)");
+                            break;
+                        case ts.SignatureInfo.UsedVersion:
+                            ts.Debug.assert(info?.version === info?.signature || !info?.signature);
+                            baseline.push(path + " (used version)");
+                            break;
+                        default:
+                            ts.Debug.assertNever(signatureInfo);
                     }
                 });
             }

src/testRunner/unittests/helpers/tsc.ts

@@ -28,7 +28,7 @@ export type TscCompileSystem = fakes.System & {
     writtenFiles: Set<ts.Path>;
     baseLine(): { file: string; text: string; };
     dtsSignaures?: Map<ts.Path, Map<string, DtsSignatureData>>;
-    storeFilesChangingSignatureDuringEmit?: boolean;
+    storeSignatureInfo?: boolean;
 };
 
 export const noChangeRun: TestTscEdit = {
@@ -77,7 +77,7 @@ export function testTscCompileLike(input: TestTscCompileLike) {
 
     // Create system
     const sys = new fakes.System(fs, { executingFilePath: `${fs.meta.get("defaultLibLocation")}/tsc`, env: environmentVariables }) as TscCompileSystem;
-    sys.storeFilesChangingSignatureDuringEmit = true;
+    sys.storeSignatureInfo = true;
     sys.write(`${sys.getExecutingFilePath()} ${commandLineArgs.join(" ")}\n`);
     sys.exit = exitCode => sys.exitCode = exitCode;
     worker(sys);

src/testRunner/unittests/helpers/virtualFileSystemWithWatch.ts

@@ -351,7 +351,7 @@ export class TestServerHost implements server.ServerHost, FormatDiagnosticsHost,
     private readonly currentDirectory: string;
     require?: (initialPath: string, moduleName: string) => ModuleImportResult;
     importPlugin?: (root: string, moduleName: string) => Promise<ModuleImportResult>;
-    public storeFilesChangingSignatureDuringEmit = true;
+    public storeSignatureInfo = true;
     watchFile: HostWatchFile;
     private inodeWatching: boolean | undefined;
     private readonly inodes?: Map<Path, number>;

src/testRunner/unittests/tsbuild/publicApi.ts

@@ -52,6 +52,7 @@ export function f22() { } // trailing`,
 
         // Create system
         sys = new fakes.System(fs, { executingFilePath: "/lib/tsc" }) as TscCompileSystem;
+        sys.storeSignatureInfo = true;
         fakes.patchHostForBuildInfoReadWrite(sys);
         const commandLineArgs = ["--b", "/src/tsconfig.json"];
         sys.write(`${sys.getExecutingFilePath()} ${commandLineArgs.join(" ")}\n`);

tests/baselines/reference/tsbuild/noEmitOnError/syntax-errors-with-incremental.js

@@ -241,7 +241,7 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /a/lib/lib.d.ts (used version)
-/user/username/projects/noemitonerror/shared/types/db.ts (used version)
+/user/username/projects/noemitonerror/shared/types/db.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/main.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/other.ts (computed .d.ts)
 

tests/baselines/reference/tsbuildWatch/noEmit/does-not-go-in-loop-when-watching-when-no-files-are-emitted-with-incremental.js

@@ -302,6 +302,6 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /user/username/projects/myproject/a.js (computed .d.ts)
-/user/username/projects/myproject/b.ts (used version)
+/user/username/projects/myproject/b.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tsbuildWatch/noEmit/does-not-go-in-loop-when-watching-when-no-files-are-emitted.js

@@ -186,6 +186,6 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /user/username/projects/myproject/a.js (computed .d.ts)
-/user/username/projects/myproject/b.ts (used version)
+/user/username/projects/myproject/b.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tsbuildWatch/noEmitOnError/does-not-emit-any-files-on-error-with-incremental.js

@@ -401,7 +401,7 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /a/lib/lib.d.ts (used version)
-/user/username/projects/noemitonerror/shared/types/db.ts (used version)
+/user/username/projects/noemitonerror/shared/types/db.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/main.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/other.ts (computed .d.ts)
 

tests/baselines/reference/tsbuildWatch/noEmitOnError/does-not-emit-any-files-on-error.js

@@ -233,7 +233,7 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /a/lib/lib.d.ts (used version)
-/user/username/projects/noemitonerror/shared/types/db.ts (used version)
+/user/username/projects/noemitonerror/shared/types/db.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/main.ts (computed .d.ts)
 /user/username/projects/noemitonerror/src/other.ts (computed .d.ts)
 

tests/baselines/reference/tsbuildWatch/reexport/Reports-errors-correctly.js

@@ -459,8 +459,8 @@ Semantic diagnostics in builder refreshed for::
 /user/username/projects/reexport/src/pure/index.ts
 
 Shape signatures in builder refreshed for::
-/user/username/projects/reexport/src/pure/session.ts (used version)
-/user/username/projects/reexport/src/pure/index.ts (used version)
+/user/username/projects/reexport/src/pure/session.ts (computed .d.ts)
+/user/username/projects/reexport/src/pure/index.ts (computed .d.ts)
 
 Program root files: [
   "/user/username/projects/reexport/src/main/index.ts"
@@ -646,7 +646,7 @@ Semantic diagnostics in builder refreshed for::
 
 Shape signatures in builder refreshed for::
 /user/username/projects/reexport/src/pure/session.ts (computed .d.ts)
-/user/username/projects/reexport/src/pure/index.ts (used version)
+/user/username/projects/reexport/src/pure/index.ts (computed .d.ts)
 
 Program root files: [
   "/user/username/projects/reexport/src/main/index.ts"

tests/baselines/reference/tscWatch/incremental/incremental-with-circular-references-incremental.js

@@ -418,9 +418,9 @@ Semantic diagnostics in builder refreshed for::
 /users/username/projects/project/index.ts
 
 Shape signatures in builder refreshed for::
-/users/username/projects/project/a.ts (used version)
-/users/username/projects/project/index.ts (used version)
-/users/username/projects/project/c.ts (used version)
+/users/username/projects/project/a.ts (computed .d.ts)
+/users/username/projects/project/index.ts (computed .d.ts)
+/users/username/projects/project/c.ts (computed .d.ts)
 /users/username/projects/project/b.ts (used version)
 
 exitCode:: ExitStatus.Success

tests/baselines/reference/tscWatch/incremental/incremental-with-circular-references-watch.js

@@ -502,9 +502,9 @@ Semantic diagnostics in builder refreshed for::
 /users/username/projects/project/index.ts
 
 Shape signatures in builder refreshed for::
-/users/username/projects/project/a.ts (used version)
-/users/username/projects/project/index.ts (used version)
-/users/username/projects/project/c.ts (used version)
+/users/username/projects/project/a.ts (computed .d.ts)
+/users/username/projects/project/index.ts (computed .d.ts)
+/users/username/projects/project/c.ts (computed .d.ts)
 /users/username/projects/project/b.ts (used version)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tscWatch/watchApi/extraFileExtensions-are-supported.js

@@ -155,6 +155,6 @@ Semantic diagnostics in builder refreshed for::
 /user/username/projects/myproject/other2.vue
 
 Shape signatures in builder refreshed for::
-/user/username/projects/myproject/other2.vue (used version)
+/user/username/projects/myproject/other2.vue (computed .d.ts)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tscWatch/watchEnvironment/fsEvent-for-change-is-repeated.js

@@ -210,7 +210,7 @@ Semantic diagnostics in builder refreshed for::
 main.ts
 
 Shape signatures in builder refreshed for::
-/user/username/projects/project/main.ts (used version)
+/user/username/projects/project/main.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined
 

tests/baselines/reference/tscWatch/watchEnvironment/watchDirectories/uses-non-recursive-dynamic-polling-when-renaming-file-in-subfolder.js

@@ -148,6 +148,6 @@ Semantic diagnostics in builder refreshed for::
 /a/username/project/src/file2.ts
 
 Shape signatures in builder refreshed for::
-/a/username/project/src/file2.ts (used version)
+/a/username/project/src/file2.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tscWatch/watchEnvironment/watchDirectories/uses-non-recursive-watchDirectory-when-renaming-file-in-subfolder.js

@@ -141,6 +141,6 @@ Semantic diagnostics in builder refreshed for::
 /a/username/project/src/file2.ts
 
 Shape signatures in builder refreshed for::
-/a/username/project/src/file2.ts (used version)
+/a/username/project/src/file2.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined

tests/baselines/reference/tscWatch/watchEnvironment/watchDirectories/uses-watchFile-when-renaming-file-in-subfolder.js

@@ -144,6 +144,6 @@ Semantic diagnostics in builder refreshed for::
 /a/username/project/src/file2.ts
 
 Shape signatures in builder refreshed for::
-/a/username/project/src/file2.ts (used version)
+/a/username/project/src/file2.ts (computed .d.ts)
 
 exitCode:: ExitStatus.undefined