Print original projects in baseline diff as they impact life time of the projects (#57315)

Author: sheetalkamat

src/harness/projectServiceStateLogger.ts

@@ -2,6 +2,7 @@ import {
     arrayFrom,
     compareStringsCaseSensitive,
     Debug,
+    identity,
     noop,
 } from "./_namespaces/ts";
 import {
@@ -22,6 +23,7 @@ interface ProjectData {
     projectProgramVersion: Project["projectProgramVersion"];
     autoImportProviderHost: Project["autoImportProviderHost"];
     noDtsResolutionProject: Project["noDtsResolutionProject"];
+    originalConfiguredProjects: Project["originalConfiguredProjects"];
 }
 
 interface ScriptInfoData {
@@ -38,20 +40,14 @@ enum Diff {
     Deleted = " *deleted*",
 }
 
-type StateItemLog = [string, string[], string[]?];
+type StateItemLog = [string, ...string[][]];
 
 export function patchServiceForStateBaseline(service: ProjectService) {
     if (!service.logger.isTestLogger || !service.logger.hasLevel(LogLevel.verbose)) return;
     if (service.baseline !== noop) return; // Already patched
 
     const projects = new Map<Project, ProjectData>();
     const scriptInfos = new Map<ScriptInfo, ScriptInfoData>();
-    const allPropertiesOfProjectData: (keyof ProjectData & keyof Project)[] = [
-        "projectStateVersion",
-        "projectProgramVersion",
-        "autoImportProviderHost",
-        "noDtsResolutionProject",
-    ];
     const logger = service.logger as LoggerWithInMemoryLogs;
     service.baseline = title => {
         const projectLogs = baselineProjects();
@@ -67,10 +63,9 @@ export function patchServiceForStateBaseline(service: ProjectService) {
         if (!logs) return;
         logger.log(title);
         logs.sort((a, b) => compareStringsCaseSensitive(a[0], b[0]))
-            .forEach(([title, propertyLogs, additionalPropertyLogs]) => {
+            .forEach(([title, ...propertyLogs]) => {
                 logger.log(title);
-                propertyLogs.forEach(s => logger.log(s));
-                additionalPropertyLogs?.forEach(s => logger.log(s));
+                propertyLogs.forEach(p => p.forEach(s => logger.log(s)));
             });
         logger.log("");
     }
@@ -86,22 +81,28 @@ export function patchServiceForStateBaseline(service: ProjectService) {
                 if (project.noDtsResolutionProject) auxiliaryProjects.push(project.noDtsResolutionProject);
                 let projectDiff = newOrDeleted(project, projects, data);
                 const projectPropertyLogs = [] as string[];
-                allPropertiesOfProjectData.forEach(key => {
-                    let value: Project[typeof key] | string = project[key];
-                    if (key === "autoImportProviderHost" || key === "noDtsResolutionProject") {
-                        if (project[key]) value = (project[key] as Project).projectName;
-                        else if (project[key] === undefined && data?.[key] === undefined) return;
-                    }
-                    projectDiff = printProperty(PrintPropertyWhen.Always, data, key, project[key], projectDiff, projectPropertyLogs, value);
-                });
-                logs.push([`${project.projectName} (${ProjectKind[project.projectKind]})${projectDiff}`, projectPropertyLogs]);
-                return projectDiff;
+                projectDiff = printProperty(PrintPropertyWhen.Always, data, "projectStateVersion", project.projectStateVersion, projectDiff, projectPropertyLogs);
+                projectDiff = printProperty(PrintPropertyWhen.Always, data, "projectProgramVersion", project.projectProgramVersion, projectDiff, projectPropertyLogs);
+                projectDiff = printProperty(PrintPropertyWhen.DefinedOrChangedOrNew, data, "autoImportProviderHost", project.autoImportProviderHost, projectDiff, projectPropertyLogs, project.autoImportProviderHost ? project.autoImportProviderHost.projectName : project.autoImportProviderHost);
+                projectDiff = printProperty(PrintPropertyWhen.DefinedOrChangedOrNew, data, "noDtsResolutionProject", project.noDtsResolutionProject, projectDiff, projectPropertyLogs, project.noDtsResolutionProject ? project.noDtsResolutionProject.projectName : project.noDtsResolutionProject);
+                return printSetPropertyAndCreateStatementLog(
+                    logs,
+                    `${project.projectName} (${ProjectKind[project.projectKind]})`,
+                    PrintPropertyWhen.DefinedOrChangedOrNew,
+                    "originalConfiguredProjects",
+                    projectPropertyLogs,
+                    projectDiff,
+                    project.originalConfiguredProjects,
+                    data?.originalConfiguredProjects,
+                    identity,
+                );
             },
             project => ({
                 projectStateVersion: project.projectStateVersion,
                 projectProgramVersion: project.projectProgramVersion,
                 autoImportProviderHost: project.autoImportProviderHost,
                 noDtsResolutionProject: project.noDtsResolutionProject,
+                originalConfiguredProjects: project.originalConfiguredProjects && new Set(project.originalConfiguredProjects),
             }),
         );
     }
@@ -117,41 +118,24 @@ export function patchServiceForStateBaseline(service: ProjectService) {
                 infoDiff = printProperty(PrintPropertyWhen.Changed, data, "open", isOpen, infoDiff, infoPropertyLogs);
                 infoDiff = printProperty(PrintPropertyWhen.Always, data, "version", info.textStorage.getVersion(), infoDiff, infoPropertyLogs);
                 infoDiff = printProperty(PrintPropertyWhen.TruthyOrChangedOrNew, data, "pendingReloadFromDisk", info.textStorage.pendingReloadFromDisk, infoDiff, infoPropertyLogs);
-                const containingProjectsLogs = [] as string[];
-                let containingProjectsDiff = Diff.None;
-                const defaultProject = isOpen && info.containingProjects.length ? info.getDefaultProject() : undefined;
-                info.containingProjects.forEach(project =>
-                    containingProjectsDiff = printPropertyWorker(
-                        PrintPropertyWhen.Always,
-                        `    ${project.projectName}${defaultProject === project ? " *default*" : ""}`,
-                        containingProjectsLogs,
-                        containingProjectsDiff,
-                        !!data && !data.containingProjects.has(project),
-                        Diff.New,
-                        project,
-                    )
-                );
-                const infoProjects = new Set(info.containingProjects);
-                data?.containingProjects.forEach(project => {
-                    if (infoProjects.has(project)) return;
-                    containingProjectsDiff = Diff.Change;
-                    containingProjectsLogs.push(`        ${project.projectName}${Diff.Deleted}`);
-                });
-                infoDiff = printPropertyWorker(
+                let defaultProject: Project | undefined;
+                try {
+                    if (isOpen) defaultProject = info.getDefaultProject();
+                }
+                catch (e) {
+                    Debug.assert(e.message === "No Project.");
+                }
+                return printSetPropertyAndCreateStatementLog(
+                    logs,
+                    `${info.fileName}${isOpen ? " (Open)" : ""}`,
                     PrintPropertyWhen.Always,
-                    `containingProjects: ${info.containingProjects.length}`,
+                    "containingProjects",
                     infoPropertyLogs,
                     infoDiff,
-                    !!containingProjectsDiff,
-                    Diff.Change,
-                    info.containingProjects,
+                    new Set(info.containingProjects),
+                    data?.containingProjects,
+                    project => `${project.projectName}${defaultProject === project ? " *default*" : ""}`,
                 );
-                logs.push([
-                    `${info.fileName}${isOpen ? " (Open)" : ""}${infoDiff}`,
-                    infoPropertyLogs,
-                    containingProjectsLogs,
-                ]);
-                return infoDiff;
             },
             info => ({
                 open: info.isScriptOpen(),
@@ -201,6 +185,7 @@ export function patchServiceForStateBaseline(service: ProjectService) {
         Always,
         TruthyOrChangedOrNew,
         Changed,
+        DefinedOrChangedOrNew,
     }
     function printProperty<Data, Key extends keyof Data & string>(
         printWhen: PrintPropertyWhen,
@@ -222,6 +207,45 @@ export function patchServiceForStateBaseline(service: ProjectService) {
         );
     }
 
+    function printSetPropertyValueWorker<T>(
+        printWhen: PrintPropertyWhen.Always | PrintPropertyWhen.DefinedOrChangedOrNew,
+        propertyName: string,
+        propertyLogs: string[],
+        dataDiff: Diff,
+        propertyValue: Set<T> | undefined,
+        dataValue: Set<T> | undefined,
+        toStringPropertyValue: (v: T) => string,
+    ) {
+        const setPropertyLogs = [] as string[];
+        let setPropertyDiff = Diff.None;
+        propertyValue?.forEach(p =>
+            setPropertyDiff = printPropertyWorker(
+                PrintPropertyWhen.Always,
+                `    ${toStringPropertyValue(p)}`,
+                setPropertyLogs,
+                setPropertyDiff,
+                dataDiff !== Diff.New && !dataValue?.has(p),
+                Diff.New,
+                p,
+            )
+        );
+        dataValue?.forEach(p => {
+            if (propertyValue?.has(p)) return;
+            setPropertyDiff = Diff.Change;
+            setPropertyLogs.push(`        ${toStringPropertyValue(p)}${Diff.Deleted}`);
+        });
+        dataDiff = printPropertyWorker(
+            printWhen,
+            `${propertyName}: ${propertyValue?.size || 0}`,
+            propertyLogs,
+            dataDiff,
+            !!setPropertyDiff,
+            Diff.Change,
+            propertyValue,
+        );
+        return { dataDiff, setPropertyLogs };
+    }
+
     function printPropertyWorker(
         printWhen: PrintPropertyWhen,
         stringValue: string,
@@ -242,10 +266,41 @@ export function patchServiceForStateBaseline(service: ProjectService) {
                 break;
             case PrintPropertyWhen.Always:
                 break;
+            case PrintPropertyWhen.DefinedOrChangedOrNew:
+                if (value === undefined && !propertyDiff) return result;
+                break;
             default:
                 Debug.assertNever(printWhen);
         }
         propertyLogs.push(`    ${stringValue}${propertyDiff}`);
         return result;
     }
+
+    function printSetPropertyAndCreateStatementLog<T>(
+        logs: StateItemLog[],
+        header: string,
+        printWhen: PrintPropertyWhen.Always | PrintPropertyWhen.DefinedOrChangedOrNew,
+        propertyName: string,
+        propertyLogs: string[],
+        dataDiff: Diff,
+        propertyValue: Set<T> | undefined,
+        dataValue: Set<T> | undefined,
+        toStringPropertyValue: (v: T) => string,
+    ) {
+        const result = printSetPropertyValueWorker(
+            printWhen,
+            propertyName,
+            propertyLogs,
+            dataDiff,
+            propertyValue,
+            dataValue,
+            toStringPropertyValue,
+        );
+        logs.push([
+            `${header}${result.dataDiff}`,
+            propertyLogs,
+            result.setPropertyLogs,
+        ]);
+        return result.dataDiff;
+    }
 }

tests/baselines/reference/tsserver/autoImportProvider/Does-not-create-auto-import-providers-upon-opening-projects-for-find-all-references.js

@@ -644,13 +644,21 @@ Projects::
 /packages/a/tsconfig.json (Configured) *new*
     projectStateVersion: 1
     projectProgramVersion: 1
+    originalConfiguredProjects: 3
+        /packages/b/tsconfig.json
+        /tsconfig.json
+        /packages/a/tsconfig.json
 /packages/b/tsconfig.json (Configured)
     projectStateVersion: 1
     projectProgramVersion: 1
     autoImportProviderHost: /dev/null/autoImportProviderProject1*
 /tsconfig.json (Configured) *changed*
     projectStateVersion: 1
     projectProgramVersion: 1 *changed*
+    originalConfiguredProjects: 3 *changed*
+        /packages/b/tsconfig.json *new*
+        /tsconfig.json *new*
+        /packages/a/tsconfig.json *new*
 
 ScriptInfos::
 /node_modules/@angular/forms/forms.d.ts

tests/baselines/reference/tsserver/declarationFileMaps/findAllReferences-starting-at-definition.js

@@ -1030,6 +1030,16 @@ FsWatchesRecursive::
 /a:
   {}
 
+Projects::
+/a/tsconfig.json (Configured)
+    projectStateVersion: 1
+    projectProgramVersion: 1
+/dev/null/inferredProject1* (Inferred) *changed*
+    projectStateVersion: 1
+    projectProgramVersion: 1
+    originalConfiguredProjects: 1 *changed*
+        /a/tsconfig.json *new*
+
 ScriptInfos::
 /a/a.ts (Open)
     version: SVC-2-0
@@ -1107,6 +1117,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *changed*
     projectStateVersion: 2 *changed*
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 
 ScriptInfos::
 /a/a.ts (Open)
@@ -1222,6 +1234,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *deleted*
     projectStateVersion: 2
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 /dev/null/inferredProject2* (Inferred) *new*
     projectStateVersion: 1
     projectProgramVersion: 1

tests/baselines/reference/tsserver/declarationFileMaps/findAllReferences.js

@@ -902,9 +902,11 @@ Projects::
 /a/tsconfig.json (Configured) *new*
     projectStateVersion: 1
     projectProgramVersion: 1
-/dev/null/inferredProject1* (Inferred)
+/dev/null/inferredProject1* (Inferred) *changed*
     projectStateVersion: 1
     projectProgramVersion: 1
+    originalConfiguredProjects: 1 *changed*
+        /a/tsconfig.json *new*
 
 ScriptInfos::
 /a/a.ts *new*
@@ -983,6 +985,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *changed*
     projectStateVersion: 2 *changed*
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 
 ScriptInfos::
 /a/a.ts
@@ -1109,6 +1113,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *deleted*
     projectStateVersion: 2
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 /dev/null/inferredProject2* (Inferred) *new*
     projectStateVersion: 1
     projectProgramVersion: 1

tests/baselines/reference/tsserver/declarationFileMaps/findAllReferencesFull-definition-is-in-mapped-file.js

@@ -627,3 +627,14 @@ Info seq  [hh:mm:ss:mss] response:
       "responseRequired": true
     }
 After request
+
+Projects::
+/a/tsconfig.json (Configured)
+    projectStateVersion: 1
+    projectProgramVersion: 1
+/b/tsconfig.json (Configured) *changed*
+    projectStateVersion: 1
+    projectProgramVersion: 1
+    originalConfiguredProjects: 2 *changed*
+        /a/tsconfig.json *new*
+        /b/tsconfig.json *new*

tests/baselines/reference/tsserver/declarationFileMaps/findAllReferencesFull.js

@@ -936,9 +936,11 @@ Projects::
 /a/tsconfig.json (Configured) *new*
     projectStateVersion: 1
     projectProgramVersion: 1
-/dev/null/inferredProject1* (Inferred)
+/dev/null/inferredProject1* (Inferred) *changed*
     projectStateVersion: 1
     projectProgramVersion: 1
+    originalConfiguredProjects: 1 *changed*
+        /a/tsconfig.json *new*
 
 ScriptInfos::
 /a/a.ts *new*
@@ -1017,6 +1019,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *changed*
     projectStateVersion: 2 *changed*
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 
 ScriptInfos::
 /a/a.ts
@@ -1143,6 +1147,8 @@ Projects::
 /dev/null/inferredProject1* (Inferred) *deleted*
     projectStateVersion: 2
     projectProgramVersion: 1
+    originalConfiguredProjects: 1
+        /a/tsconfig.json
 /dev/null/inferredProject2* (Inferred) *new*
     projectStateVersion: 1
     projectProgramVersion: 1