Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop invalidating module resolution cache when saving an open file #31685

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/compiler/resolutionCache.ts
Expand Up @@ -54,6 +54,7 @@ namespace ts {
writeLog(s: string): void;
maxNumberOfFilesToIterateForInvalidation?: number;
getCurrentProgram(): Program | undefined;
fileIsOpen(filePath: Path): boolean;
}

interface DirectoryWatchesOfFailedLookup {
Expand Down Expand Up @@ -713,6 +714,10 @@ namespace ts {
if (!isPathWithDefaultFailedLookupExtension(fileOrDirectoryPath) && !customFailedLookupPaths.has(fileOrDirectoryPath)) {
return false;
}
// prevent saving an open file from over-eagerly triggering invalidation
uniqueiniquity marked this conversation as resolved.
Show resolved Hide resolved
if (resolutionHost.fileIsOpen(fileOrDirectoryPath)) {
return false;
}
// Ignore emits from the program
if (isEmittedFileOfProgram(resolutionHost.getCurrentProgram(), fileOrDirectoryPath)) {
return false;
Expand Down
1 change: 1 addition & 0 deletions src/compiler/watch.ts
Expand Up @@ -691,6 +691,7 @@ namespace ts {
hasChangedAutomaticTypeDirectiveNames = true;
scheduleProgramUpdate();
};
compilerHost.fileIsOpen = returnFalse;
compilerHost.maxNumberOfFilesToIterateForInvalidation = host.maxNumberOfFilesToIterateForInvalidation;
compilerHost.getCurrentProgram = getCurrentProgram;
compilerHost.writeLog = writeLog;
Expand Down
5 changes: 5 additions & 0 deletions src/server/project.ts
Expand Up @@ -457,6 +457,11 @@ namespace ts.server {
return this.getTypeAcquisition().enable ? this.projectService.typingsInstaller.globalTypingsCacheLocation : undefined;
}

/*@internal*/
fileIsOpen(filePath: Path) {
return this.projectService.openFiles.has(filePath);
}

sheetalkamat marked this conversation as resolved.
Show resolved Hide resolved
/*@internal*/
writeLog(s: string) {
this.projectService.logger.info(s);
Expand Down
28 changes: 28 additions & 0 deletions src/testRunner/unittests/tsserver/resolutionCache.ts
Expand Up @@ -975,5 +975,33 @@ export const x = 10;`
host.checkTimeoutQueueLength(0);
});
});

describe("avoid unnecessary invalidation", () => {
it("failed lookup invalidation", () => {
const expectedNonRelativeDirectories = [`${projectLocation}/node_modules`, `${projectLocation}/src`];
const module1Name = "module1";
const module2Name = "module2";
const fileContent = `import { module1 } from "${module1Name}";import { module2 } from "${module2Name}";`;
const file1: File = {
path: `${projectLocation}/src/file1.ts`,
content: fileContent
};
const { module1, module2 } = getModules(`${projectLocation}/src/node_modules/module1/index.ts`, `${projectLocation}/node_modules/module2/index.ts`);
const files = [module1, module2, file1, configFile, libFile];
const host = createServerHost(files);
const resolutionTrace = createHostModuleResolutionTrace(host);
const service = createProjectService(host);
service.openClientFile(file1.path);
const project = service.configuredProjects.get(configFile.path)!;
(project as ResolutionCacheHost).maxNumberOfFilesToIterateForInvalidation = 1;
const expectedTrace = getExpectedNonRelativeModuleResolutionTrace(host, file1, module1, module1Name);
getExpectedNonRelativeModuleResolutionTrace(host, file1, module2, module2Name, expectedTrace);
verifyTrace(resolutionTrace, expectedTrace);
verifyWatchesWithConfigFile(host, files, file1, expectedNonRelativeDirectories);

host.invokeWatchedDirectoriesRecursiveCallback(projectLocation + "/src", "file1.ts");
uniqueiniquity marked this conversation as resolved.
Show resolved Hide resolved
host.checkTimeoutQueueLengthAndRun(0);
});
});
});
}