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

Port #31685 to release-3.5 #31877

Merged
merged 1 commit into from Jun 12, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
6 changes: 6 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 @@ -698,6 +699,11 @@ namespace ts {
// If something to do with folder/file starting with "." in node_modules folder, skip it
if (isPathIgnored(fileOrDirectoryPath)) return false;

// prevent saving an open file from over-eagerly triggering invalidation
if (resolutionHost.fileIsOpen(fileOrDirectoryPath)) {
return false;
}

// Some file or directory in the watching directory is created
// Return early if it does not have any of the watching extension or not the custom failed lookup path
const dirOfFileOrDirectory = getDirectoryPath(fileOrDirectoryPath);
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
6 changes: 6 additions & 0 deletions src/server/editorServices.ts
Expand Up @@ -1003,6 +1003,12 @@ namespace ts.server {
fileOrDirectory => {
const fileOrDirectoryPath = this.toPath(fileOrDirectory);
project.getCachedDirectoryStructureHost().addOrDeleteFileOrDirectory(fileOrDirectory, fileOrDirectoryPath);

// don't trigger callback on open, existing files
if (project.fileIsOpen(fileOrDirectoryPath)) {
return;
}

if (isPathIgnored(fileOrDirectoryPath)) return;
const configFilename = project.getConfigFilePath();

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);
}

/*@internal*/
writeLog(s: string) {
this.projectService.logger.info(s);
Expand Down
20 changes: 20 additions & 0 deletions src/testRunner/unittests/tsserver/projects.ts
Expand Up @@ -1341,6 +1341,26 @@ var x = 10;`
}
});

it("no project structure update on directory watch invoke on open file save", () => {
const projectRootPath = "/users/username/projects/project";
const file1: File = {
path: `${projectRootPath}/a.ts`,
content: "export const a = 10;"
};
const config: File = {
path: `${projectRootPath}/tsconfig.json`,
content: "{}"
};
const files = [file1, config];
const host = createServerHost(files);
const service = createProjectService(host);
service.openClientFile(file1.path);
checkNumberOfProjects(service, { configuredProjects: 1 });

host.modifyFile(file1.path, file1.content, { invokeFileDeleteCreateAsPartInsteadOfChange: true });
host.checkTimeoutQueueLength(0);
});

it("handles delayed directory watch invoke on file creation", () => {
const projectRootPath = "/users/username/projects/project";
const fileB: File = {
Expand Down
29 changes: 29 additions & 0 deletions src/testRunner/unittests/tsserver/resolutionCache.ts
Expand Up @@ -975,5 +975,34 @@ export const x = 10;`
host.checkTimeoutQueueLength(0);
});
});

describe("avoid unnecessary invalidation", () => {
it("unnecessary lookup invalidation on save", () => {
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);

// invoke callback to simulate saving
host.modifyFile(file1.path, file1.content, { invokeFileDeleteCreateAsPartInsteadOfChange: true });
host.checkTimeoutQueueLengthAndRun(0);
});
});
});
}
5 changes: 3 additions & 2 deletions src/testRunner/unittests/tsserver/syntaxOperations.ts
Expand Up @@ -60,13 +60,14 @@ describe("Test Suite 1", () => {

const navBarResultUnitTest1 = navBarFull(session, unitTest1);
host.deleteFile(unitTest1.path);
host.checkTimeoutQueueLengthAndRun(2);
checkProjectActualFiles(project, expectedFilesWithoutUnitTest1);
host.checkTimeoutQueueLengthAndRun(0);
checkProjectActualFiles(project, expectedFilesWithUnitTest1);

session.executeCommandSeq<protocol.CloseRequest>({
command: protocol.CommandTypes.Close,
arguments: { file: unitTest1.path }
});
host.checkTimeoutQueueLengthAndRun(2);
checkProjectActualFiles(project, expectedFilesWithoutUnitTest1);

const unitTest1WithChangedContent: File = {
Expand Down