Delay update graph when opening external project, and delay load configured project referenced from external project when opening it

Author: sheetalkamat

src/server/editorServices.ts

@@ -1091,9 +1091,8 @@ namespace ts.server {
             this.rootFilesMap.delete(info.path);
         }
 
-        protected enableGlobalPlugins() {
+        protected enableGlobalPlugins(options: CompilerOptions) {
             const host = this.projectService.host;
-            const options = this.getCompilationSettings();
 
             if (!host.require) {
                 this.projectService.logger.info("Plugins were requested but not running in environment that supports 'require'. Nothing will be loaded");
@@ -1244,7 +1243,7 @@ namespace ts.server {
             if (!projectRootPath && !projectService.useSingleInferredProject) {
                 this.canonicalCurrentDirectory = projectService.toCanonicalFileName(this.currentDirectory);
             }
-            this.enableGlobalPlugins();
+            this.enableGlobalPlugins(this.getCompilerOptions());
         }
 
         addRoot(info: ScriptInfo) {
@@ -1316,28 +1315,27 @@ namespace ts.server {
 
         private projectErrors: Diagnostic[] | undefined;
 
+        private projectReferences: ReadonlyArray<ProjectReference> | undefined;
+
+        /*@internal*/
+        projectOptions?: ProjectOptions | true;
+
         /*@internal*/
         constructor(configFileName: NormalizedPath,
             projectService: ProjectService,
             documentRegistry: DocumentRegistry,
-            hasExplicitListOfFiles: boolean,
-            compilerOptions: CompilerOptions,
-            lastFileExceededProgramSize: string | undefined,
-            public compileOnSaveEnabled: boolean,
-            cachedDirectoryStructureHost: CachedDirectoryStructureHost,
-            private projectReferences: ReadonlyArray<ProjectReference> | undefined) {
+            cachedDirectoryStructureHost: CachedDirectoryStructureHost) {
             super(configFileName,
                 ProjectKind.Configured,
                 projectService,
                 documentRegistry,
-                hasExplicitListOfFiles,
-                lastFileExceededProgramSize,
-                compilerOptions,
-                compileOnSaveEnabled,
+                /*hasExplicitListOfFiles*/ false,
+                /*lastFileExceededProgramSize*/ undefined,
+                /*compilerOptions*/ {},
+                /*compileOnSaveEnabled*/ false,
                 cachedDirectoryStructureHost,
                 getDirectoryPath(configFileName));
             this.canonicalConfigFilePath = asNormalizedPath(projectService.toCanonicalFileName(configFileName));
-            this.enablePlugins();
         }
 
         /**
@@ -1347,15 +1345,20 @@ namespace ts.server {
         updateGraph(): boolean {
             const reloadLevel = this.pendingReload;
             this.pendingReload = ConfigFileProgramReloadLevel.None;
+            let result: boolean;
             switch (reloadLevel) {
                 case ConfigFileProgramReloadLevel.Partial:
-                    return this.projectService.reloadFileNamesOfConfiguredProject(this);
+                    result = this.projectService.reloadFileNamesOfConfiguredProject(this);
+                    break;
                 case ConfigFileProgramReloadLevel.Full:
                     this.projectService.reloadConfiguredProject(this);
-                    return true;
+                    result = true;
+                    break;
                 default:
-                    return super.updateGraph();
+                    result = super.updateGraph();
             }
+            this.projectService.sendProjectTelemetry(this);
+            return result;
         }
 
         /*@internal*/
@@ -1382,8 +1385,12 @@ namespace ts.server {
         }
 
         enablePlugins() {
+            this.enablePluginsWithOptions(this.getCompilerOptions());
+        }
+
+        /*@internal*/
+        enablePluginsWithOptions(options: CompilerOptions) {
             const host = this.projectService.host;
-            const options = this.getCompilationSettings();
 
             if (!host.require) {
                 this.projectService.logger.info("Plugins were requested but not running in environment that supports 'require'. Nothing will be loaded");
@@ -1407,7 +1414,7 @@ namespace ts.server {
                 }
             }
 
-            this.enableGlobalPlugins();
+            this.enableGlobalPlugins(options);
         }
 
         /**
@@ -1547,6 +1554,12 @@ namespace ts.server {
                 getDirectoryPath(projectFilePath || normalizeSlashes(externalProjectName)));
         }
 
+        updateGraph() {
+            const result = super.updateGraph();
+            this.projectService.sendProjectTelemetry(this);
+            return result;
+        }
+
         getExcludedFiles() {
             return this.excludedFiles;
         }

src/server/project.ts

@@ -120,6 +120,7 @@ namespace ts.server {
         };
     }
 
+    /*@internal*/
     export interface ProjectOptions {
         configHasExtendsProperty: boolean;
         /**
@@ -128,16 +129,6 @@ namespace ts.server {
         configHasFilesProperty: boolean;
         configHasIncludeProperty: boolean;
         configHasExcludeProperty: boolean;
-
-        projectReferences: ReadonlyArray<ProjectReference> | undefined;
-        /**
-         * these fields can be present in the project file
-         */
-        files?: string[];
-        wildcardDirectories?: Map<WatchDirectoryFlags>;
-        compilerOptions?: CompilerOptions;
-        typeAcquisition?: TypeAcquisition;
-        compileOnSave?: boolean;
     }
 
     export function isInferredProjectName(name: string) {

src/server/utilities.ts

@@ -68,6 +68,7 @@ namespace ts.projectSystem {
             }, "/hunter2/foo.csproj");
 
             // Also test that opening an external project only sends an event once.
+            et.service.closeClientFile(file1.path);
 
             et.service.closeExternalProject(projectFileName);
             checkNumberOfProjects(et.service, { externalProjects: 0 });
@@ -82,6 +83,7 @@ namespace ts.projectSystem {
                     projectFileName,
                 });
                 checkNumberOfProjects(et.service, { externalProjects: 1 });
+                et.service.openClientFile(file1.path); // Only on file open the project will be updated
             }
         });
 

src/testRunner/unittests/telemetry.ts

@@ -663,12 +663,15 @@ namespace ts.projectSystem {
                 options: {}
             });
             service.checkNumberOfProjects({ configuredProjects: 1 });
-            checkProjectActualFiles(configuredProjectAt(service, 0), [upperCaseConfigFilePath]);
+            const project = service.configuredProjects.get(config.path)!;
+            assert.equal(project.pendingReload, ConfigFileProgramReloadLevel.Full); // External project referenced configured project pending to be reloaded
+            checkProjectActualFiles(project, emptyArray);
 
             service.openClientFile(f1.path);
             service.checkNumberOfProjects({ configuredProjects: 1, inferredProjects: 1 });
 
-            checkProjectActualFiles(configuredProjectAt(service, 0), [upperCaseConfigFilePath]);
+            assert.equal(project.pendingReload, ConfigFileProgramReloadLevel.None); // External project referenced configured project is updated
+            checkProjectActualFiles(project, [upperCaseConfigFilePath]);
             checkProjectActualFiles(service.inferredProjects[0], [f1.path]);
         });
 
@@ -778,7 +781,7 @@ namespace ts.projectSystem {
 
             // Add a tsconfig file
             host.reloadFS(filesWithConfig);
-            host.checkTimeoutQueueLengthAndRun(1);
+            host.checkTimeoutQueueLengthAndRun(2); // load configured project from disk + ensureProjectsForOpenFiles
 
             projectService.checkNumberOfProjects({ inferredProjects: 2, configuredProjects: 1 });
             assert.isTrue(projectService.inferredProjects[0].isOrphan());
@@ -1229,7 +1232,7 @@ namespace ts.projectSystem {
 
 
             host.reloadFS([file1, configFile, file2, file3, libFile]);
-            host.checkTimeoutQueueLengthAndRun(1);
+            host.checkTimeoutQueueLengthAndRun(2); // load configured project from disk + ensureProjectsForOpenFiles
             checkNumberOfConfiguredProjects(projectService, 1);
             checkNumberOfInferredProjects(projectService, 1);
             checkProjectActualFiles(projectService.inferredProjects[0], [file2.path, file3.path, libFile.path]);
@@ -1773,8 +1776,11 @@ namespace ts.projectSystem {
             try {
                 projectService.openExternalProject({ projectFileName: "project", options: {}, rootFiles: toExternalFiles([file1.path, office.path]) });
                 const proj = projectService.externalProjects[0];
-                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), [file1.path]);
+                // Since the file is not yet open, the project wont have program yet
+                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), emptyArray);
                 assert.deepEqual(proj.getTypeAcquisition().include, ["duck-types"]);
+                projectService.openClientFile(file1.path);
+                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), [file1.path]);
             } finally {
                 projectService.resetSafeList();
             }
@@ -1815,8 +1821,11 @@ namespace ts.projectSystem {
             try {
                 projectService.openExternalProject({ projectFileName: "project", options: {}, rootFiles: toExternalFiles(files.map(f => f.path)) });
                 const proj = projectService.externalProjects[0];
-                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), [file1.path]);
+                // Since the file is not yet open, the project wont have program yet
+                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), emptyArray);
                 assert.deepEqual(proj.getTypeAcquisition().include, ["kendo-ui", "office"]);
+                projectService.openClientFile(file1.path);
+                assert.deepEqual(proj.getFileNames(/*excludeFilesFromExternalLibraries*/ true), [file1.path]);
             } finally {
                 projectService.resetSafeList();
             }
@@ -1856,6 +1865,9 @@ namespace ts.projectSystem {
             try {
                 projectService.openExternalProject({ projectFileName: "project", options: {}, rootFiles: toExternalFiles([file1.path, file2.path]), typeAcquisition: { enable: true } });
                 const proj = projectService.externalProjects[0];
+                // Since the file is not yet open, the project wont have program yet
+                assert.deepEqual(proj.getFileNames(), emptyArray);
+                projectService.openClientFile(file2.path);
                 assert.deepEqual(proj.getFileNames(), [file2.path]);
             } finally {
                 projectService.resetSafeList();
@@ -1893,7 +1905,7 @@ namespace ts.projectSystem {
             checkProjectActualFiles(projectService.inferredProjects[1], [file3.path]);
 
             host.reloadFS([file1, file2, file3, configFile]);
-            host.checkTimeoutQueueLengthAndRun(1);
+            host.checkTimeoutQueueLengthAndRun(2); // load configured project from disk + ensureProjectsForOpenFiles
             checkNumberOfProjects(projectService, { configuredProjects: 1, inferredProjects: 2 });
             checkProjectActualFiles(configuredProjectAt(projectService, 0), [file1.path, file2.path, file3.path, configFile.path]);
             assert.isTrue(projectService.inferredProjects[0].isOrphan());
@@ -2071,6 +2083,9 @@ namespace ts.projectSystem {
 
             projectService.openExternalProject({ projectFileName: "project", options: {}, rootFiles: toExternalFiles([file1.path]) });
             checkNumberOfProjects(projectService, { externalProjects: 1 });
+            // Since the file is not yet open, the project wont have program yet
+            assert.deepEqual(projectService.externalProjects[0].getFileNames(), emptyArray);
+            projectService.openClientFile(file1.path);
             checkProjectActualFiles(projectService.externalProjects[0], [file1.path]);
 
             projectService.openExternalProject({ projectFileName: "project", options: {}, rootFiles: toExternalFiles([file1.path, file2.path]) });
@@ -2098,11 +2113,17 @@ namespace ts.projectSystem {
             projectService.openExternalProject({ projectFileName: "project", options: { moduleResolution: ModuleResolutionKind.NodeJs }, rootFiles: toExternalFiles([file1.path, file2.path]) });
             checkNumberOfProjects(projectService, { externalProjects: 1 });
             checkProjectRootFiles(projectService.externalProjects[0], [file1.path, file2.path]);
+            // Since the file is not yet open, the project wont have program yet
+            checkProjectActualFiles(projectService.externalProjects[0], emptyArray);
+            projectService.openClientFile(file1.path);
             checkProjectActualFiles(projectService.externalProjects[0], [file1.path, file2.path]);
 
             projectService.openExternalProject({ projectFileName: "project", options: { moduleResolution: ModuleResolutionKind.Classic }, rootFiles: toExternalFiles([file1.path, file2.path]) });
             checkNumberOfProjects(projectService, { externalProjects: 1 });
             checkProjectRootFiles(projectService.externalProjects[0], [file1.path, file2.path]);
+            // The update doesnt happen right away until needed, so either open a file or ensure projects uptodate
+            checkProjectActualFiles(projectService.externalProjects[0], [file1.path, file2.path]);
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(projectService.externalProjects[0], [file1.path, file2.path, file3.path]);
         });
 
@@ -2404,6 +2425,10 @@ namespace ts.projectSystem {
             projectService.openExternalProject({ projectFileName, options: {}, rootFiles: [{ fileName: file1.path, scriptKind: ScriptKind.JS, hasMixedContent: true }] });
 
             checkNumberOfProjects(projectService, { externalProjects: 1 });
+            // Since the external project is not updated till needed (eg opening client file/ensuringProjectStructureUptodate)
+            // watched files will be empty at first
+            checkWatchedFiles(host, emptyArray);
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkWatchedFiles(host, [libFile.path]); // watching the "missing" lib file
 
             const project = projectService.externalProjects[0];
@@ -2988,6 +3013,9 @@ namespace ts.projectSystem {
             projectService.openExternalProjects([externalProject]);
 
             checkNumberOfProjects(projectService, { configuredProjects: 0, externalProjects: 1, inferredProjects: 0 });
+            // Since the external project is not updated till needed (eg opening client file/ensuringProjectStructureUptodate)
+            checkProjectActualFiles(projectService.externalProjects[0], emptyArray);
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(projectService.externalProjects[0], [site.path, libFile.path]);
         });
 
@@ -3334,6 +3362,9 @@ namespace ts.projectSystem {
             checkNumberOfProjects(projectService, { configuredProjects: 1 });
 
             const configuredProject = configuredProjectAt(projectService, 0);
+            // configured project is just created and not yet loaded
+            checkProjectActualFiles(configuredProject, emptyArray);
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(configuredProject, [file1.path, tsconfig.path]);
 
             // Allow allowNonTsExtensions will be set to true for deferred extensions.
@@ -3975,6 +4006,8 @@ namespace ts.projectSystem {
                 options: {}
             });
             projectService.checkNumberOfProjects({ configuredProjects: 1 });
+            checkProjectActualFiles(configuredProjectAt(projectService, 0), emptyArray); // Configured project created but not loaded till actually needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(configuredProjectAt(projectService, 0), [f1.path, tsconfig.path]);
 
             // rename tsconfig.json back to lib.ts
@@ -3986,6 +4019,8 @@ namespace ts.projectSystem {
             });
 
             projectService.checkNumberOfProjects({ externalProjects: 1 });
+            checkProjectActualFiles(projectService.externalProjects[0], emptyArray); // external project created but not updated till actually needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(projectService.externalProjects[0], [f1.path, f2.path]);
         });
 
@@ -4023,6 +4058,8 @@ namespace ts.projectSystem {
             });
 
             projectService.checkNumberOfProjects({ externalProjects: 1 });
+            checkProjectActualFiles(projectService.externalProjects[0], emptyArray); // external project created but program is not created till its needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(projectService.externalProjects[0], [f1.path]);
 
             // add two config file as root files
@@ -4032,6 +4069,9 @@ namespace ts.projectSystem {
                 options: {}
             });
             projectService.checkNumberOfProjects({ configuredProjects: 2 });
+            checkProjectActualFiles(configuredProjectAt(projectService, 0), emptyArray); // Configured project created but not loaded till actually needed
+            checkProjectActualFiles(configuredProjectAt(projectService, 1), emptyArray); // Configured project created but not loaded till actually needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(configuredProjectAt(projectService, 0), [cLib.path, cTsconfig.path]);
             checkProjectActualFiles(configuredProjectAt(projectService, 1), [dLib.path, dTsconfig.path]);
 
@@ -4053,6 +4093,8 @@ namespace ts.projectSystem {
             });
 
             projectService.checkNumberOfProjects({ externalProjects: 1 });
+            checkProjectActualFiles(projectService.externalProjects[0], emptyArray); // external project created but program is not created till its needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(projectService.externalProjects[0], [f1.path]);
 
             // open two config files
@@ -4063,6 +4105,9 @@ namespace ts.projectSystem {
                 options: {}
             });
             projectService.checkNumberOfProjects({ configuredProjects: 2 });
+            checkProjectActualFiles(configuredProjectAt(projectService, 0), emptyArray); // Configured project created but not loaded till actually needed
+            checkProjectActualFiles(configuredProjectAt(projectService, 1), emptyArray); // Configured project created but not loaded till actually needed
+            projectService.ensureInferredProjectsUpToDate_TestOnly();
             checkProjectActualFiles(configuredProjectAt(projectService, 0), [cLib.path, cTsconfig.path]);
             checkProjectActualFiles(configuredProjectAt(projectService, 1), [dLib.path, dTsconfig.path]);