In tsc --b mode detect if root file of compilation is not root any more (#52417)

Author: sheetalkamat

src/compiler/builder.ts

@@ -37,6 +37,7 @@ import {
     emitSkippedWithNoDiagnostics,
     emptyArray,
     ensurePathIsNonModuleName,
+    FileIncludeKind,
     filterSemanticDiagnostics,
     forEach,
     forEachEntry,
@@ -911,9 +912,17 @@ export type ProgramBuildInfoEmitSignature = ProgramBuildInfoFileId | [fileId: Pr
  */
 export type ProgramMultiFileEmitBuildInfoFileInfo = string | ProgramMultiFileEmitBuildInfoBuilderStateFileInfo;
 /** @internal */
+export type ProgramBuildInfoRootStartEnd = [start: ProgramBuildInfoFileId, end: ProgramBuildInfoFileId];
+/**
+ * Either start and end of FileId for consecutive fileIds to be included as root or single fileId that is root
+ * @internal
+ */
+export type ProgramBuildInfoRoot = ProgramBuildInfoRootStartEnd | ProgramBuildInfoFileId;
+/** @internal */
 export interface ProgramMultiFileEmitBuildInfo {
     fileNames: readonly string[];
     fileInfos: readonly ProgramMultiFileEmitBuildInfoFileInfo[];
+    root: readonly ProgramBuildInfoRoot[];
     options: CompilerOptions | undefined;
     fileIdsList: readonly (readonly ProgramBuildInfoFileId[])[] | undefined;
     referencedMap: ProgramBuildInfoReferencedMap | undefined;
@@ -942,6 +951,7 @@ export type ProgramBuildInfoBundlePendingEmit = BuilderFileEmit | false;
 export interface ProgramBundleEmitBuildInfo {
     fileNames: readonly string[];
     fileInfos: readonly ProgramBundleEmitBuildInfoFileInfo[];
+    root: readonly ProgramBuildInfoRoot[];
     options: CompilerOptions | undefined;
     outSignature: EmitSignature | undefined;
     latestChangedDtsFile: string | undefined;
@@ -966,19 +976,22 @@ function getBuildInfo(state: BuilderProgramState, bundle: BundleBuildInfo | unde
     const latestChangedDtsFile = state.latestChangedDtsFile ? relativeToBuildInfoEnsuringAbsolutePath(state.latestChangedDtsFile) : undefined;
     const fileNames: string[] = [];
     const fileNameToFileId = new Map<string, ProgramBuildInfoFileId>();
+    const root: ProgramBuildInfoRoot[] = [];
     if (outFile(state.compilerOptions)) {
         // Copy all fileInfo, version and impliedFormat
         // Affects global scope and signature doesnt matter because with --out they arent calculated or needed to determine upto date ness
         const fileInfos = arrayFrom(state.fileInfos.entries(), ([key, value]): ProgramBundleEmitBuildInfoFileInfo => {
             // Ensure fileId
-            toFileId(key);
+            const fileId = toFileId(key);
+            tryAddRoot(key, fileId);
             return value.impliedFormat ?
                 { version: value.version, impliedFormat: value.impliedFormat, signature: undefined, affectsGlobalScope: undefined } :
                 value.version;
         });
         const program: ProgramBundleEmitBuildInfo = {
             fileNames,
             fileInfos,
+            root,
             options: convertToProgramBuildInfoCompilerOptions(state.compilerOptions),
             outSignature: state.outSignature,
             latestChangedDtsFile,
@@ -1005,6 +1018,7 @@ function getBuildInfo(state: BuilderProgramState, bundle: BundleBuildInfo | unde
     const fileInfos = arrayFrom(state.fileInfos.entries(), ([key, value]): ProgramMultiFileEmitBuildInfoFileInfo => {
         // Ensure fileId
         const fileId = toFileId(key);
+        tryAddRoot(key, fileId);
         Debug.assert(fileNames[fileId - 1] === relativeToBuildInfo(key));
         const oldSignature = state.oldSignatures?.get(key);
         const actualSignature = oldSignature !== undefined ? oldSignature || undefined : value.signature;
@@ -1100,6 +1114,7 @@ function getBuildInfo(state: BuilderProgramState, bundle: BundleBuildInfo | unde
     const program: ProgramMultiFileEmitBuildInfo = {
         fileNames,
         fileInfos,
+        root,
         options: convertToProgramBuildInfoCompilerOptions(state.compilerOptions),
         fileIdsList,
         referencedMap,
@@ -1140,6 +1155,25 @@ function getBuildInfo(state: BuilderProgramState, bundle: BundleBuildInfo | unde
         return fileIdListId;
     }
 
+    function tryAddRoot(path: Path, fileId: ProgramBuildInfoFileId) {
+        const file = state.program!.getSourceFile(path)!;
+        if (!state.program!.getFileIncludeReasons().get(file.path)!.some(r => r.kind === FileIncludeKind.RootFile)) return;
+        // First fileId as is
+        if (!root.length) return root.push(fileId);
+        const last = root[root.length - 1];
+        const isLastStartEnd = isArray(last);
+        // If its [..., last = [start, end = fileId - 1]], update last to [start, fileId]
+        if (isLastStartEnd && last[1] === fileId - 1) return last[1] = fileId;
+        // If its [..., last = [start, end !== fileId - 1]] or [last] or [..., last !== fileId - 1], push the fileId
+        if (isLastStartEnd || root.length === 1 || last !== fileId - 1) return root.push(fileId);
+        const lastButOne = root[root.length - 2];
+        // If [..., lastButOne = [start, end], lastFileId] or [..., lastButOne !== lastFileId - 1, lastFileId], push the fileId
+        if (!isNumber(lastButOne) || lastButOne !== last - 1) return root.push(fileId);
+        // Convert lastButOne as [lastButOne, fileId]
+        root[root.length - 2] = [lastButOne, fileId];
+        return root.length = root.length - 1;
+    }
+
     /**
      * @param optionKey key of CommandLineOption to use to determine if the option should be serialized in tsbuildinfo
      */
@@ -1776,16 +1810,32 @@ export function getBuildInfoFileVersionMap(
     program: ProgramBuildInfo,
     buildInfoPath: string,
     host: Pick<ReadBuildProgramHost, "useCaseSensitiveFileNames" | "getCurrentDirectory">
-): Map<Path, string> {
+) {
     const buildInfoDirectory = getDirectoryPath(getNormalizedAbsolutePath(buildInfoPath, host.getCurrentDirectory()));
     const getCanonicalFileName = createGetCanonicalFileName(host.useCaseSensitiveFileNames());
     const fileInfos = new Map<Path, string>();
+    let rootIndex = 0;
+    const roots: Path[] = [];
     program.fileInfos.forEach((fileInfo, index) => {
         const path = toPath(program.fileNames[index], buildInfoDirectory, getCanonicalFileName);
         const version = isString(fileInfo) ? fileInfo : fileInfo.version;
         fileInfos.set(path, version);
+        if (rootIndex < program.root.length) {
+            const current = program.root[rootIndex];
+            const fileId = (index + 1) as ProgramBuildInfoFileId;
+            if (isArray(current)) {
+                if (current[0] <= fileId && fileId <= current[1]) {
+                    roots.push(path);
+                    if (current[1] === fileId) rootIndex++;
+                }
+            }
+            else if (current === fileId) {
+                roots.push(path);
+                rootIndex++;
+            }
+        }
     });
-    return fileInfos;
+    return { fileInfos, roots };
 }
 
 /** @internal */

src/compiler/diagnosticMessages.json

@@ -5562,6 +5562,10 @@
         "category": "Message",
         "code": 6411
     },
+    "Project '{0}' is out of date because buildinfo file '{1}' indicates that file '{2}' was root file of compilation but not any more.": {
+        "category": "Message",
+        "code": 6412
+    },
 
     "The expected type comes from property '{0}' which is declared here on type '{1}'": {
         "category": "Message",

src/compiler/tsbuild.ts

@@ -2,6 +2,7 @@ import {
     combinePaths,
     Extension,
     fileExtensionIs,
+    Path,
     ResolvedConfigFileName,
 } from "./_namespaces/ts";
 
@@ -28,6 +29,7 @@ export enum UpToDateStatusType {
     OutOfDateWithUpstream,
     OutOfDateBuildInfo,
     OutOfDateOptions,
+    OutOfDateRoots,
     UpstreamOutOfDate,
     UpstreamBlocked,
     ComputingUpstream,
@@ -51,6 +53,7 @@ export type UpToDateStatus =
     | Status.OutOfDateWithSelf
     | Status.OutOfDateWithUpstream
     | Status.OutOfDateBuildInfo
+    | Status.OutOfDateRoots
     | Status.UpstreamOutOfDate
     | Status.UpstreamBlocked
     | Status.ComputingUpstream
@@ -127,10 +130,16 @@ export namespace Status {
      * Buildinfo indicates that build is out of date
      */
     export interface OutOfDateBuildInfo {
-        type: UpToDateStatusType.OutOfDateBuildInfo | UpToDateStatusType.OutOfDateOptions,
+        type: UpToDateStatusType.OutOfDateBuildInfo | UpToDateStatusType.OutOfDateOptions;
         buildInfoFile: string;
     }
 
+    export interface OutOfDateRoots {
+        type: UpToDateStatusType.OutOfDateRoots,
+        buildInfoFile: string;
+        inputFile: Path;
+    }
+
     /**
      * This project depends on an out-of-date project, so shouldn't be built yet
      */

src/compiler/tsbuildPublic.ts

@@ -1729,7 +1729,7 @@ function getUpToDateStatusWorker<T extends BuilderProgram>(state: SolutionBuilde
     let oldestOutputFileTime = maximumDate;
     let buildInfoTime: Date | undefined;
     let buildInfoProgram: ProgramBuildInfo | undefined;
-    let buildInfoVersionMap: Map<Path, string> | undefined;
+    let buildInfoVersionMap: ReturnType<typeof getBuildInfoFileVersionMap> | undefined;
     if (buildInfoPath) {
         const buildInfoCacheEntry = getBuildInfoCacheEntry(state, buildInfoPath, resolvedPath);
         buildInfoTime = buildInfoCacheEntry?.modifiedTime || ts.getModifiedTime(host, buildInfoPath);
@@ -1798,6 +1798,7 @@ function getUpToDateStatusWorker<T extends BuilderProgram>(state: SolutionBuilde
     let newestInputFileTime = minimumDate;
     /** True if input file has changed timestamp but text is not changed, we can then do only timestamp updates on output to make it look up-to-date later */
     let pseudoInputUpToDate = false;
+    const seenRoots = new Set<Path>();
     // Get timestamps of input files
     for (const inputFile of project.fileNames) {
         const inputTime = getModifiedTime(state, inputFile);
@@ -1815,7 +1816,7 @@ function getUpToDateStatusWorker<T extends BuilderProgram>(state: SolutionBuilde
             if (buildInfoProgram) {
                 // Read files and see if they are same, read is anyways cached
                 if (!buildInfoVersionMap) buildInfoVersionMap = getBuildInfoFileVersionMap(buildInfoProgram, buildInfoPath!, host);
-                version = buildInfoVersionMap.get(toPath(state, inputFile));
+                version = buildInfoVersionMap.fileInfos.get(toPath(state, inputFile));
                 const text = version ? state.readFileWithCache(inputFile) : undefined;
                 currentVersion = text !== undefined ? getSourceFileVersionAsHashFromText(host, text) : undefined;
                 if (version && version === currentVersion) pseudoInputUpToDate = true;
@@ -1834,6 +1835,22 @@ function getUpToDateStatusWorker<T extends BuilderProgram>(state: SolutionBuilde
             newestInputFileName = inputFile;
             newestInputFileTime = inputTime;
         }
+
+        if (buildInfoProgram) seenRoots.add(toPath(state, inputFile));
+    }
+
+    if (buildInfoProgram) {
+        if (!buildInfoVersionMap) buildInfoVersionMap = getBuildInfoFileVersionMap(buildInfoProgram, buildInfoPath!, host);
+        for (const existingRoot of buildInfoVersionMap.roots) {
+            if (!seenRoots.has(existingRoot)) {
+                // File was root file when project was built but its not any more
+                return {
+                    type: UpToDateStatusType.OutOfDateRoots,
+                    buildInfoFile: buildInfoPath!,
+                    inputFile: existingRoot,
+                };
+            }
+        }
     }
 
     // Now see if all outputs are newer than the newest input
@@ -2561,6 +2578,14 @@ function reportUpToDateStatus<T extends BuilderProgram>(state: SolutionBuilderSt
                 relName(state, configFileName),
                 relName(state, status.buildInfoFile)
             );
+        case UpToDateStatusType.OutOfDateRoots:
+            return reportStatus(
+                state,
+                Diagnostics.Project_0_is_out_of_date_because_buildinfo_file_1_indicates_that_file_2_was_root_file_of_compilation_but_not_any_more,
+                relName(state, configFileName),
+                relName(state, status.buildInfoFile),
+                relName(state, status.inputFile),
+            );
         case UpToDateStatusType.UpToDate:
             if (status.newestInputFileTime !== undefined) {
                 return reportStatus(

src/testRunner/tests.ts

@@ -71,6 +71,7 @@ import "./unittests/tsbuild/demo";
 import "./unittests/tsbuild/emitDeclarationOnly";
 import "./unittests/tsbuild/emptyFiles";
 import "./unittests/tsbuild/exitCodeOnBogusFile";
+import "./unittests/tsbuild/fileDelete";
 import "./unittests/tsbuild/graphOrdering";
 import "./unittests/tsbuild/inferredTypeFromTransitiveModule";
 import "./unittests/tsbuild/javascriptProjectEmit";
@@ -84,6 +85,7 @@ import "./unittests/tsbuild/outputPaths";
 import "./unittests/tsbuild/publicApi";
 import "./unittests/tsbuild/referencesWithRootDirInParent";
 import "./unittests/tsbuild/resolveJsonModule";
+import "./unittests/tsbuild/roots";
 import "./unittests/tsbuild/sample";
 import "./unittests/tsbuild/transitiveReferences";
 import "./unittests/tsbuildWatch/configFileErrors";

src/testRunner/unittests/tsbuild/fileDelete.ts

@@ -0,0 +1,96 @@
+import * as ts from "../../_namespaces/ts";
+import {
+    dedent
+} from "../../_namespaces/Utils";
+import {
+    compilerOptionsToConfigJson,
+    loadProjectFromFiles,
+    verifyTsc,
+} from "../tsc/helpers";
+
+describe("unittests:: tsbuild:: fileDelete::", () => {
+    function fs(childOptions: ts.CompilerOptions, mainOptions?: ts.CompilerOptions) {
+        return loadProjectFromFiles({
+            "/src/child/child.ts": dedent`
+                import { child2 } from "../child/child2";
+                export function child() {
+                    child2();
+                }
+            `,
+            "/src/child/child2.ts": dedent`
+                export function child2() {
+                }
+            `,
+            "/src/child/tsconfig.json": JSON.stringify({
+                compilerOptions: compilerOptionsToConfigJson(childOptions),
+            }),
+            ...(mainOptions ? {
+                "/src/main/main.ts": dedent`
+                    import { child } from "${childOptions.outFile ? "child" : "../child/child"}";
+                    export function main() {
+                        child();
+                    }
+                `,
+                "/src/main/tsconfig.json": JSON.stringify({
+                    compilerOptions: compilerOptionsToConfigJson(mainOptions),
+                    references: [{ path: "../child" }],
+                }),
+            } : {}),
+        });
+    }
+
+    verifyTsc({
+        scenario: "fileDelete",
+        subScenario: `detects deleted file`,
+        commandLineArgs: ["--b", "/src/main/tsconfig.json", "-v", "--traceResolution", "--explainFiles"],
+        fs: () => fs({ composite: true }, { composite: true }),
+        edits: [{
+            caption: "delete child2 file",
+            edit: fs => {
+                fs.rimrafSync("/src/child/child2.ts");
+                fs.rimrafSync("/src/child/child2.js");
+                fs.rimrafSync("/src/child/child2.d.ts");
+            },
+            discrepancyExplanation: () => [
+                "Clean build will not have latestChangedDtsFile as there was no emit and emitSignatures as undefined for files",
+                "Incremental will store the past latestChangedDtsFile and emitSignatures",
+            ]
+        }],
+    });
+
+    verifyTsc({
+        scenario: "fileDelete",
+        subScenario: `detects deleted file with outFile`,
+        commandLineArgs: ["--b", "/src/main/tsconfig.json", "-v", "--traceResolution", "--explainFiles"],
+        fs: () => fs({ composite: true, outFile: "../childResult.js", module: ts.ModuleKind.AMD }, { composite: true, outFile: "../mainResult.js", module: ts.ModuleKind.AMD }),
+        edits: [{
+            caption: "delete child2 file",
+            edit: fs => fs.rimrafSync("/src/child/child2.ts")
+        }],
+    });
+
+    verifyTsc({
+        scenario: "fileDelete",
+        subScenario: `deleted file without composite`,
+        commandLineArgs: ["--b", "/src/child/tsconfig.json", "-v", "--traceResolution", "--explainFiles"],
+        fs: () => fs({}),
+        edits: [{
+            caption: "delete child2 file",
+            edit: fs => {
+                fs.rimrafSync("/src/child/child2.ts");
+                fs.rimrafSync("/src/child/child2.js");
+            }
+        }],
+    });
+
+    verifyTsc({
+        scenario: "fileDelete",
+        subScenario: `deleted file with outFile without composite`,
+        commandLineArgs: ["--b", "/src/child/tsconfig.json", "-v", "--traceResolution", "--explainFiles"],
+        fs: () => fs({ outFile: "../childResult.js", module: ts.ModuleKind.AMD }),
+        edits: [{
+            caption: "delete child2 file",
+            edit: fs => fs.rimrafSync("/src/child/child2.ts"),
+        }],
+    });
+});