Skip to content

Commit

Permalink
Use open file to determine file existence (#86318)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sheetalkamat
sheetalkamat authored Jul 25, 2024
1 parent 7319968 commit 941d154
Show file tree
Hide file tree
Showing 26 changed files with 5,288 additions and 439 deletions.
14 changes: 7 additions & 7 deletions src/compiler/watchUtilities.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -486,8 +486,8 @@ export function updateMissingFilePathsWatch(
}

/** @internal */
export interface WildcardDirectoryWatcher {
watcher: FileWatcher;
export interface WildcardDirectoryWatcher<T extends FileWatcher = FileWatcher> {
watcher: T;
flags: WatchDirectoryFlags;
}

Expand All @@ -499,10 +499,10 @@ export interface WildcardDirectoryWatcher {
*
* @internal
*/
export function updateWatchingWildcardDirectories(
existingWatchedForWildcards: Map<string, WildcardDirectoryWatcher>,
export function updateWatchingWildcardDirectories<T extends FileWatcher>(
existingWatchedForWildcards: Map<string, WildcardDirectoryWatcher<T>>,
wildcardDirectories: MapLike<WatchDirectoryFlags> | undefined,
watchDirectory: (directory: string, flags: WatchDirectoryFlags) => FileWatcher,
watchDirectory: (directory: string, flags: WatchDirectoryFlags) => T,
) {
if (wildcardDirectories) {
mutateMap(
Expand All @@ -522,15 +522,15 @@ export function updateWatchingWildcardDirectories(
clearMap(existingWatchedForWildcards, closeFileWatcherOf);
}

function createWildcardDirectoryWatcher(directory: string, flags: WatchDirectoryFlags): WildcardDirectoryWatcher {
function createWildcardDirectoryWatcher(directory: string, flags: WatchDirectoryFlags): WildcardDirectoryWatcher<T> {
// Create new watch and recursive info
return {
watcher: watchDirectory(directory, flags),
flags,
};
}

function updateWildcardDirectoryWatcher(existingWatcher: WildcardDirectoryWatcher, flags: WatchDirectoryFlags, directory: string) {
function updateWildcardDirectoryWatcher(existingWatcher: WildcardDirectoryWatcher<T>, flags: WatchDirectoryFlags, directory: string) {
// Watcher needs to be updated if the recursive flags dont match
if (existingWatcher.flags === flags) {
return;
Expand Down
215 changes: 142 additions & 73 deletions src/server/editorServices.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ import {
emptyOptions,
endsWith,
ensureTrailingDirectorySeparator,
equateStringsCaseInsensitive,
equateStringsCaseSensitive,
ExtendedConfigCacheEntry,
FileExtensionInfo,
fileExtensionIs,
Expand Down Expand Up @@ -1060,7 +1062,7 @@ export interface ParsedConfig {
*/
projects: Map<NormalizedPath, boolean>;
parsedCommandLine?: ParsedCommandLine;
watchedDirectories?: Map<string, WildcardDirectoryWatcher>;
watchedDirectories?: Map<string, WildcardDirectoryWatcher<WildcardWatcher>>;
/**
* true if watchedDirectories need to be updated as per parsedCommandLine's updated watched directories
*/
Expand Down Expand Up @@ -1852,80 +1854,22 @@ export class ProjectService {
/**
* This is to watch whenever files are added or removed to the wildcard directories
*/
private watchWildcardDirectory(directory: string, flags: WatchDirectoryFlags, configFileName: NormalizedPath, config: ParsedConfig) {
private watchWildcardDirectory(
directory: string,
flags: WatchDirectoryFlags,
configFileName: NormalizedPath,
config: ParsedConfig,
) {
let watcher: FileWatcher | undefined = this.watchFactory.watchDirectory(
directory,
fileOrDirectory => {
const fileOrDirectoryPath = this.toPath(fileOrDirectory);
const fsResult = config.cachedDirectoryStructureHost.addOrDeleteFileOrDirectory(fileOrDirectory, fileOrDirectoryPath);
if (
getBaseFileName(fileOrDirectoryPath) === "package.json" && !isInsideNodeModules(fileOrDirectoryPath) &&
(fsResult && fsResult.fileExists || !fsResult && this.host.fileExists(fileOrDirectory))
) {
const file = this.getNormalizedAbsolutePath(fileOrDirectory);
this.logger.info(`Config: ${configFileName} Detected new package.json: ${file}`);
this.packageJsonCache.addOrUpdate(file, fileOrDirectoryPath);
this.watchPackageJsonFile(file, fileOrDirectoryPath, result);
}

const configuredProjectForConfig = this.findConfiguredProjectByProjectName(configFileName);
if (
isIgnoredFileFromWildCardWatching({
watchedDirPath: this.toPath(directory),
fileOrDirectory,
fileOrDirectoryPath,
configFileName,
extraFileExtensions: this.hostConfiguration.extraFileExtensions,
currentDirectory: this.currentDirectory,
options: config.parsedCommandLine!.options,
program: configuredProjectForConfig?.getCurrentProgram() || config.parsedCommandLine!.fileNames,
useCaseSensitiveFileNames: this.host.useCaseSensitiveFileNames,
writeLog: s => this.logger.info(s),
toPath: s => this.toPath(s),
getScriptKind: configuredProjectForConfig ? (fileName => configuredProjectForConfig.getScriptKind(fileName)) : undefined,
})
) return;

// Reload is pending, do the reload
if (config.updateLevel !== ProgramUpdateLevel.Full) config.updateLevel = ProgramUpdateLevel.RootNamesAndUpdate;
config.projects.forEach((watchWildcardDirectories, projectCanonicalPath) => {
if (!watchWildcardDirectories) return;
const project = this.getConfiguredProjectByCanonicalConfigFilePath(projectCanonicalPath);
if (!project) return;

if (
configuredProjectForConfig !== project &&
this.getHostPreferences().includeCompletionsForModuleExports
) {
const path = this.toPath(configFileName);
if (find(project.getCurrentProgram()?.getResolvedProjectReferences(), ref => ref?.sourceFile.path === path)) {
project.markAutoImportProviderAsDirty();
}
}

// Load root file names for configured project with the config file name
// But only schedule update if project references this config file
const updateLevel = configuredProjectForConfig === project ? ProgramUpdateLevel.RootNamesAndUpdate : ProgramUpdateLevel.Update;
if (project.pendingUpdateLevel > updateLevel) return;

// don't trigger callback on open, existing files
if (this.openFiles.has(fileOrDirectoryPath)) {
const info = Debug.checkDefined(this.getScriptInfoForPath(fileOrDirectoryPath));
if (info.isAttached(project)) {
const loadLevelToSet = Math.max(updateLevel, project.openFileWatchTriggered.get(fileOrDirectoryPath) || ProgramUpdateLevel.Update) as ProgramUpdateLevel;
project.openFileWatchTriggered.set(fileOrDirectoryPath, loadLevelToSet);
}
else {
project.pendingUpdateLevel = updateLevel;
this.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project);
}
}
else {
project.pendingUpdateLevel = updateLevel;
this.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project);
}
});
},
fileOrDirectory =>
this.onWildCardDirectoryWatcherInvoke(
directory,
configFileName,
config,
result,
fileOrDirectory,
),
flags,
this.getWatchOptionsFromProjectWatchOptions(config.parsedCommandLine!.watchOptions, getDirectoryPath(configFileName)),
WatchType.WildcardDirectory,
Expand All @@ -1949,6 +1893,84 @@ export class ProjectService {
return result;
}

private onWildCardDirectoryWatcherInvoke(
directory: string,
configFileName: NormalizedPath,
config: ParsedConfig,
wildCardWatcher: WildcardWatcher,
fileOrDirectory: string,
) {
const fileOrDirectoryPath = this.toPath(fileOrDirectory);
const fsResult = config.cachedDirectoryStructureHost.addOrDeleteFileOrDirectory(fileOrDirectory, fileOrDirectoryPath);
if (
getBaseFileName(fileOrDirectoryPath) === "package.json" && !isInsideNodeModules(fileOrDirectoryPath) &&
(fsResult && fsResult.fileExists || !fsResult && this.host.fileExists(fileOrDirectory))
) {
const file = this.getNormalizedAbsolutePath(fileOrDirectory);
this.logger.info(`Config: ${configFileName} Detected new package.json: ${file}`);
this.packageJsonCache.addOrUpdate(file, fileOrDirectoryPath);
this.watchPackageJsonFile(file, fileOrDirectoryPath, wildCardWatcher);
}

const configuredProjectForConfig = this.findConfiguredProjectByProjectName(configFileName);
if (
isIgnoredFileFromWildCardWatching({
watchedDirPath: this.toPath(directory),
fileOrDirectory,
fileOrDirectoryPath,
configFileName,
extraFileExtensions: this.hostConfiguration.extraFileExtensions,
currentDirectory: this.currentDirectory,
options: config.parsedCommandLine!.options,
program: configuredProjectForConfig?.getCurrentProgram() || config.parsedCommandLine!.fileNames,
useCaseSensitiveFileNames: this.host.useCaseSensitiveFileNames,
writeLog: s => this.logger.info(s),
toPath: s => this.toPath(s),
getScriptKind: configuredProjectForConfig ? (fileName => configuredProjectForConfig.getScriptKind(fileName)) : undefined,
})
) return;

// Reload is pending, do the reload
if (config.updateLevel !== ProgramUpdateLevel.Full) config.updateLevel = ProgramUpdateLevel.RootNamesAndUpdate;
config.projects.forEach((watchWildcardDirectories, projectCanonicalPath) => {
if (!watchWildcardDirectories) return;
const project = this.getConfiguredProjectByCanonicalConfigFilePath(projectCanonicalPath);
if (!project) return;

if (
configuredProjectForConfig !== project &&
this.getHostPreferences().includeCompletionsForModuleExports
) {
const path = this.toPath(configFileName);
if (find(project.getCurrentProgram()?.getResolvedProjectReferences(), ref => ref?.sourceFile.path === path)) {
project.markAutoImportProviderAsDirty();
}
}

// Load root file names for configured project with the config file name
// But only schedule update if project references this config file
const updateLevel = configuredProjectForConfig === project ? ProgramUpdateLevel.RootNamesAndUpdate : ProgramUpdateLevel.Update;
if (project.pendingUpdateLevel > updateLevel) return;

// don't trigger callback on open, existing files
if (this.openFiles.has(fileOrDirectoryPath)) {
const info = Debug.checkDefined(this.getScriptInfoForPath(fileOrDirectoryPath));
if (info.isAttached(project)) {
const loadLevelToSet = Math.max(updateLevel, project.openFileWatchTriggered.get(fileOrDirectoryPath) || ProgramUpdateLevel.Update) as ProgramUpdateLevel;
project.openFileWatchTriggered.set(fileOrDirectoryPath, loadLevelToSet);
}
else {
project.pendingUpdateLevel = updateLevel;
this.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project);
}
}
else {
project.pendingUpdateLevel = updateLevel;
this.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project);
}
});
}

private delayUpdateProjectsFromParsedConfigOnConfigFileChange(canonicalConfigFilePath: NormalizedPath, loadReason: string) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath);
if (!configFileExistenceInfo?.config) return false;
Expand Down Expand Up @@ -4434,8 +4456,42 @@ export class ProjectService {
this.removeOrphanScriptInfos();
}

private tryInvokeWildCardDirectories(info: ScriptInfo) {
// This might not have reflected in projects,
this.configFileExistenceInfoCache.forEach((configFileExistenceInfo, config) => {
if (
!configFileExistenceInfo.config?.parsedCommandLine ||
contains(
configFileExistenceInfo.config.parsedCommandLine.fileNames,
info.fileName,
!this.host.useCaseSensitiveFileNames ? equateStringsCaseInsensitive : equateStringsCaseSensitive,
)
) {
return;
}
configFileExistenceInfo.config.watchedDirectories?.forEach((watcher, directory) => {
if (containsPath(directory, info.fileName, !this.host.useCaseSensitiveFileNames)) {
this.logger.info(`Invoking ${config}:: wildcard for open scriptInfo:: ${info.fileName}`);
this.onWildCardDirectoryWatcherInvoke(
directory,
config,
configFileExistenceInfo.config!,
watcher.watcher,
info.fileName,
);
}
});
});
}

openClientFileWithNormalizedPath(fileName: NormalizedPath, fileContent?: string, scriptKind?: ScriptKind, hasMixedContent?: boolean, projectRootPath?: NormalizedPath): OpenConfiguredProjectResult {
const existing = this.getScriptInfoForPath(normalizedPathToPath(
fileName,
projectRootPath ? this.getNormalizedAbsolutePath(projectRootPath) : this.currentDirectory,
this.toCanonicalFileName,
));
const info = this.getOrCreateOpenScriptInfo(fileName, fileContent, scriptKind, hasMixedContent, projectRootPath);
if (!existing && info && !info.isDynamic) this.tryInvokeWildCardDirectories(info);
const { retainProjects, ...result } = this.assignProjectToOpenedScriptInfo(info);
this.cleanupProjectsAndScriptInfos(
retainProjects,
Expand Down Expand Up @@ -4636,10 +4692,16 @@ export class ProjectService {

/** @internal */
applyChangesInOpenFiles(openFiles: Iterable<OpenFileArguments> | undefined, changedFiles?: Iterable<ChangeFileArguments>, closedFiles?: string[]): void {
let existingOpenScriptInfos: (ScriptInfo | undefined)[] | undefined;
let openScriptInfos: ScriptInfo[] | undefined;
let assignOrphanScriptInfosToInferredProject = false;
if (openFiles) {
for (const file of openFiles) {
(existingOpenScriptInfos ??= []).push(this.getScriptInfoForPath(normalizedPathToPath(
toNormalizedPath(file.fileName),
file.projectRootPath ? this.getNormalizedAbsolutePath(file.projectRootPath) : this.currentDirectory,
this.toCanonicalFileName,
)));
// Create script infos so we have the new content for all the open files before we do any updates to projects
const info = this.getOrCreateOpenScriptInfo(
toNormalizedPath(file.fileName),
Expand Down Expand Up @@ -4670,6 +4732,13 @@ export class ProjectService {

// All the script infos now exist, so ok to go update projects for open files
let retainProjects: Set<ConfiguredProject> | undefined;
forEach(
existingOpenScriptInfos,
(existing, index) =>
!existing && openScriptInfos![index] && !openScriptInfos![index].isDynamic ?
this.tryInvokeWildCardDirectories(openScriptInfos![index]) :
undefined,
);
openScriptInfos?.forEach(info => this.assignProjectToOpenedScriptInfo(info).retainProjects?.forEach(p => (retainProjects ??= new Set()).add(p)));

// While closing files there could be open files that needed assigning new inferred projects, do it now
Expand Down
3 changes: 2 additions & 1 deletion src/server/project.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,8 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
// As an optimization, don't hit the disks for files we already know don't exist
// (because we're watching for their creation).
const path = this.toPath(file);
return !this.isWatchedMissingFile(path) && this.directoryStructureHost.fileExists(file);
return !!this.projectService.getScriptInfoForPath(path) ||
(!this.isWatchedMissingFile(path) && this.directoryStructureHost.fileExists(file));
}

/** @internal */
Expand Down
Loading

0 comments on commit 941d154

Please sign in to comment.