Fix the config lifetime when getting project for non open file

Author: sheetalkamat

internal/project/configfileregistrybuilder.go

@@ -76,10 +76,10 @@ func (c *configFileRegistryBuilder) Finalize() *ConfigFileRegistry {
 	return newRegistry
 }
 
-func (c *configFileRegistryBuilder) findOrAcquireConfigForOpenFile(
+func (c *configFileRegistryBuilder) findOrAcquireConfigForFile(
 	configFileName string,
 	configFilePath tspath.Path,
-	openFilePath tspath.Path,
+	filePath tspath.Path,
 	loadKind projectLoadKind,
 	logger *logging.LogTree,
 ) *tsoptions.ParsedCommandLine {
@@ -90,7 +90,7 @@ func (c *configFileRegistryBuilder) findOrAcquireConfigForOpenFile(
 		}
 		return nil
 	case projectLoadKindCreate:
-		return c.acquireConfigForOpenFile(configFileName, configFilePath, openFilePath, logger)
+		return c.acquireConfigForFile(configFileName, configFilePath, filePath, logger)
 	default:
 		panic(fmt.Sprintf("unknown project load kind: %d", loadKind))
 	}
@@ -248,25 +248,27 @@ func (c *configFileRegistryBuilder) acquireConfigForProject(fileName string, pat
 	return entry.Value().commandLine
 }
 
-// acquireConfigForOpenFile loads a config file entry from the cache, or parses it if not already
+// acquireConfigForFile loads a config file entry from the cache, or parses it if not already
 // cached, then adds the open file to `retainingOpenFiles` to keep it alive in the cache.
-// Each `acquireConfigForOpenFile` call that passes an `openFilePath`
+// Each `acquireConfigForFile` call that passes an `openFilePath`
 // should be accompanied by an eventual `releaseConfigForOpenFile` call with the same open file.
-func (c *configFileRegistryBuilder) acquireConfigForOpenFile(configFileName string, configFilePath tspath.Path, openFilePath tspath.Path, logger *logging.LogTree) *tsoptions.ParsedCommandLine {
+func (c *configFileRegistryBuilder) acquireConfigForFile(configFileName string, configFilePath tspath.Path, filePath tspath.Path, logger *logging.LogTree) *tsoptions.ParsedCommandLine {
 	entry, _ := c.configs.LoadOrStore(configFilePath, newConfigFileEntry(configFileName))
 	var needsRetainOpenFile bool
 	entry.ChangeIf(
 		func(config *configFileEntry) bool {
-			_, alreadyRetaining := config.retainingOpenFiles[openFilePath]
-			needsRetainOpenFile = !alreadyRetaining
+			if c.fs.isOpenFile(filePath) {
+				_, alreadyRetaining := config.retainingOpenFiles[filePath]
+				needsRetainOpenFile = !alreadyRetaining
+			}
 			return needsRetainOpenFile || config.pendingReload != PendingReloadNone
 		},
 		func(config *configFileEntry) {
 			if needsRetainOpenFile {
 				if config.retainingOpenFiles == nil {
 					config.retainingOpenFiles = make(map[tspath.Path]struct{})
 				}
-				config.retainingOpenFiles[openFilePath] = struct{}{}
+				config.retainingOpenFiles[filePath] = struct{}{}
 			}
 			c.reloadIfNeeded(config, configFileName, configFilePath, logger)
 		},
@@ -524,8 +526,7 @@ func (c *configFileRegistryBuilder) getConfigFileNameForFile(fileName string, pa
 	}
 
 	configName := c.computeConfigFileName(fileName, false, logger)
-
-	if _, ok := c.fs.overlays[path]; ok {
+	if c.fs.isOpenFile(path) {
 		c.configFileNames.Add(path, &configFileNames{
 			nearestConfigFileName: configName,
 		})
@@ -568,7 +569,7 @@ func (c *configFileRegistryBuilder) getAncestorConfigFileName(fileName string, p
 	// Look for config in parent folders of config file
 	result := c.computeConfigFileName(configFileName, true, logger)
 
-	if _, ok := c.fs.overlays[path]; ok {
+	if c.fs.isOpenFile(path) {
 		entry.Change(func(value *configFileNames) {
 			if value.ancestors == nil {
 				value.ancestors = make(map[string]string)

internal/project/dirty/set.go

@@ -27,8 +27,6 @@ type ProjectCollection struct {
 	// apiOpenedProjects is the set of projects that should be kept open for
 	// API clients.
 	apiOpenedProjects map[tspath.Path]struct{}
-	// Files that are open
-	openedFiles map[tspath.Path]struct{}
 }
 
 func (c *ProjectCollection) ConfigFileRegistry() *ConfigFileRegistry { return c.configFileRegistry }
@@ -231,7 +229,6 @@ func (c *ProjectCollection) clone() *ProjectCollection {
 		configuredProjects:  c.configuredProjects,
 		inferredProject:     c.inferredProject,
 		fileDefaultProjects: c.fileDefaultProjects,
-		openedFiles:         c.openedFiles,
 	}
 }
 

internal/project/projectcollection.go

@@ -42,7 +42,6 @@ type ProjectCollectionBuilder struct {
 	fileDefaultProjects map[tspath.Path]tspath.Path
 	configuredProjects  *dirty.SyncMap[tspath.Path, *Project]
 	inferredProject     *dirty.Box[*Project]
-	openedFiles         *dirty.Set[tspath.Path]
 
 	apiOpenedProjects map[tspath.Path]struct{}
 }
@@ -71,7 +70,6 @@ func newProjectCollectionBuilder(
 		newSnapshotID:                      newSnapshotID,
 		configuredProjects:                 dirty.NewSyncMap(oldProjectCollection.configuredProjects, nil),
 		inferredProject:                    dirty.NewBox(oldProjectCollection.inferredProject),
-		openedFiles:                        dirty.NewSet(oldProjectCollection.openedFiles),
 		apiOpenedProjects:                  maps.Clone(oldAPIOpenedProjects),
 	}
 }
@@ -101,11 +99,6 @@ func (b *ProjectCollectionBuilder) Finalize(logger *logging.LogTree) (*ProjectCo
 		newProjectCollection.inferredProject = newInferredProject
 	}
 
-	if openedFiles, openedFilesChanged := b.openedFiles.Finalize(); openedFilesChanged {
-		ensureCloned()
-		newProjectCollection.openedFiles = openedFiles
-	}
-
 	configFileRegistry := b.configFileRegistryBuilder.Finalize()
 	newProjectCollection.configFileRegistry = configFileRegistry
 	return newProjectCollection, configFileRegistry
@@ -182,7 +175,6 @@ func (b *ProjectCollectionBuilder) DidChangeFiles(summary FileChangeSummary, log
 		if fh := b.fs.GetFileByPath(fileName, path); fh == nil || fh.Hash() != hash {
 			changedFiles = append(changedFiles, path)
 		}
-		b.openedFiles.Delete(path)
 	}
 	for uri := range summary.Changed.Keys() {
 		fileName := uri.FileName()
@@ -251,7 +243,6 @@ func (b *ProjectCollectionBuilder) DidChangeFiles(summary FileChangeSummary, log
 	if summary.Opened != "" {
 		fileName := summary.Opened.FileName()
 		path := b.toPath(fileName)
-		b.openedFiles.Add(path)
 		var toRemoveProjects collections.Set[tspath.Path]
 		openFileResult := b.ensureConfiguredProjectAndAncestorsForFile(fileName, path, logger)
 		b.configuredProjects.Range(func(entry *dirty.SyncMapEntry[tspath.Path, *Project]) bool {
@@ -420,7 +411,7 @@ func (b *ProjectCollectionBuilder) DidRequestProject(projectId tspath.Path, logg
 func (b *ProjectCollectionBuilder) DidRequestEnsureDefaultProject(uri lsproto.DocumentUri, logger *logging.LogTree) {
 	fileName := uri.FileName()
 	path := b.toPath(fileName)
-	if b.openedFiles.Has(path) {
+	if b.fs.isOpenFile(path) {
 		b.DidRequestFile(uri, logger)
 		return
 	}
@@ -640,7 +631,7 @@ func (b *ProjectCollectionBuilder) findDefaultConfiguredProject(fileName string,
 
 func (b *ProjectCollectionBuilder) ensureConfiguredProjectAndAncestorsForFile(fileName string, path tspath.Path, logger *logging.LogTree) searchResult {
 	result := b.findOrCreateDefaultConfiguredProjectForFile(fileName, path, projectLoadKindCreate, logger)
-	if result.project != nil && b.openedFiles.Has(path) {
+	if result.project != nil && b.fs.isOpenFile(path) {
 		b.createAncestorTree(fileName, path, &result, logger)
 	}
 	return result
@@ -737,7 +728,7 @@ func (b *ProjectCollectionBuilder) findOrCreateDefaultConfiguredProjectWorker(
 		},
 		func(node searchNode) (isResult bool, stop bool) {
 			configFilePath := b.toPath(node.configFileName)
-			config := b.configFileRegistryBuilder.findOrAcquireConfigForOpenFile(node.configFileName, configFilePath, path, node.loadKind, node.logger.Fork("Acquiring config for open file"))
+			config := b.configFileRegistryBuilder.findOrAcquireConfigForFile(node.configFileName, configFilePath, path, node.loadKind, node.logger.Fork("Acquiring config for open file"))
 			if config == nil {
 				node.logger.Log("Config file for project does not already exist")
 				return false, false

internal/project/projectcollectionbuilder.go

@@ -92,6 +92,11 @@ func (s *snapshotFSBuilder) Finalize() (*SnapshotFS, bool) {
 	}, changed
 }
 
+func (s *snapshotFSBuilder) isOpenFile(path tspath.Path) bool {
+	_, ok := s.overlays[path]
+	return ok
+}
+
 func (s *snapshotFSBuilder) GetFile(fileName string) FileHandle {
 	path := s.toPath(fileName)
 	return s.GetFileByPath(fileName, path)

internal/project/snapshotfs.go

@@ -87,8 +87,6 @@ Config::
     RetainingProjects: *modified*
       /home/src/projects/project/a/tsconfig.json  *new*
       /home/src/projects/project/b/tsconfig.json  
-    RetainingOpenFiles: *modified*
-      /home/src/projects/project/a/a.ts  *new*
   [/home/src/projects/project/b/tsconfig.json] 
     RetainingProjects:
       /home/src/projects/project/b/tsconfig.json  

testdata/baselines/reference/lspservertests/declarationMaps/findAllReferences-definition-is-in-mapped-file.js

@@ -103,8 +103,6 @@ Config::
   [/home/src/projects/project/a/tsconfig.json] *new*
     RetainingProjects:
       /home/src/projects/project/a/tsconfig.json  
-    RetainingOpenFiles:
-      /home/src/projects/project/a/a.ts  
 // === /home/src/projects/project/a/a.ts ===
 // export function [|fnA|]() {}
 // export interface IfaceA {}
@@ -148,11 +146,7 @@ Open Files::
   [/home/src/projects/project/dummy/dummy.ts] *new*
     /home/src/projects/project/dummy/tsconfig.json  (default) 
 Config::
-  [/home/src/projects/project/a/tsconfig.json] *modified*
-    RetainingProjects: *modified*
-      /home/src/projects/project/a/tsconfig.json  *deleted*
-    RetainingOpenFiles:
-      /home/src/projects/project/a/a.ts  
+  [/home/src/projects/project/a/tsconfig.json] *deleted*
   [/home/src/projects/project/dummy/tsconfig.json] *new*
     RetainingProjects:
       /home/src/projects/project/dummy/tsconfig.json  

testdata/baselines/reference/lspservertests/declarationMaps/findAllReferences.js

@@ -85,8 +85,6 @@ Config::
     RetainingProjects: *modified*
       /user/username/projects/a/tsconfig.json  *new*
       /user/username/projects/b/tsconfig.json  
-    RetainingOpenFiles: *modified*
-      /user/username/projects/a/a.ts  *new*
   [/user/username/projects/b/tsconfig.json] 
     RetainingProjects:
       /user/username/projects/b/tsconfig.json  

testdata/baselines/reference/lspservertests/declarationMaps/opening-original-location-project-disableSourceOfProjectReferenceRedirect.js

@@ -85,8 +85,6 @@ Config::
     RetainingProjects: *modified*
       /user/username/projects/a/tsconfig.json  *new*
       /user/username/projects/b/tsconfig.json  
-    RetainingOpenFiles: *modified*
-      /user/username/projects/a/a.ts  *new*
   [/user/username/projects/b/tsconfig.json] 
     RetainingProjects:
       /user/username/projects/b/tsconfig.json  

testdata/baselines/reference/lspservertests/declarationMaps/opening-original-location-project.js

@@ -163,8 +163,6 @@ Config::
     RetainingProjects:
       /user/username/projects/myproject/main/tsconfig.json  
       /user/username/projects/myproject/tsconfig.json       
-    RetainingOpenFiles:
-      /user/username/projects/myproject/main/main.ts  
   [/user/username/projects/myproject/tsconfig.json] *new*
     RetainingProjects:
       /user/username/projects/myproject/tsconfig.json  
@@ -276,12 +274,7 @@ Open Files::
     /user/username/projects/random/tsconfig.json  (default) 
 Config::
   [/user/username/projects/myproject/dependency/tsconfig.json] *deleted*
-  [/user/username/projects/myproject/main/tsconfig.json] *modified*
-    RetainingProjects: *modified*
-      /user/username/projects/myproject/main/tsconfig.json  *deleted*
-      /user/username/projects/myproject/tsconfig.json       *deleted*
-    RetainingOpenFiles:
-      /user/username/projects/myproject/main/main.ts  
+  [/user/username/projects/myproject/main/tsconfig.json] *deleted*
   [/user/username/projects/myproject/tsconfig.json] *deleted*
   [/user/username/projects/random/tsconfig.json] 
     RetainingProjects: