Skip to content

Commit e2d178f

Browse files
sheetalkamatsheetalkamat
committed
Move shared watcher into utilities and add more tests
1 parent 21c71b1 commit e2d178f

14 files changed

Lines changed: 1074 additions & 698 deletions

‎src/compiler/tsbuildPublic.ts‎

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,6 @@ namespace ts {
209209
originalGetSourceFile: CompilerHost["getSourceFile"];
210210
}
211211

212-
interface SharedExtendedConfigFileWatcher extends FileWatcher {
213-
projects: Set<ResolvedConfigFilePath>;
214-
}
215-
216212
interface SolutionBuilderState<T extends BuilderProgram = BuilderProgram> extends WatchFactory<WatchType, ResolvedConfigFileName> {
217213
readonly host: SolutionBuilderHost<T>;
218214
readonly hostWithWatch: SolutionBuilderWithWatchHost<T>;
@@ -257,7 +253,7 @@ namespace ts {
257253
readonly allWatchedWildcardDirectories: ESMap<ResolvedConfigFilePath, ESMap<string, WildcardDirectoryWatcher>>;
258254
readonly allWatchedInputFiles: ESMap<ResolvedConfigFilePath, ESMap<Path, FileWatcher>>;
259255
readonly allWatchedConfigFiles: ESMap<ResolvedConfigFilePath, FileWatcher>;
260-
readonly allWatchedExtendedConfigFiles: ESMap<ResolvedConfigFilePath, SharedExtendedConfigFileWatcher>;
256+
readonly allWatchedExtendedConfigFiles: ESMap<Path, SharedExtendedConfigFileWatcher<ResolvedConfigFilePath>>;
261257

262258
timerToBuildInvalidatedProject: any;
263259
reportFileChangeDetected: boolean;
@@ -467,8 +463,8 @@ namespace ts {
467463
{ onDeleteValue: closeFileWatcher }
468464
);
469465

470-
state.allWatchedExtendedConfigFiles.forEach((watcher) => {
471-
watcher.projects.forEach((project) => {
466+
state.allWatchedExtendedConfigFiles.forEach(watcher => {
467+
watcher.projects.forEach(project => {
472468
if (!currentProjects.has(project)) {
473469
watcher.projects.delete(project);
474470
}
@@ -1807,50 +1803,21 @@ namespace ts {
18071803
}
18081804

18091805
function watchExtendedConfigFiles(state: SolutionBuilderState, resolvedPath: ResolvedConfigFilePath, parsed: ParsedCommandLine | undefined) {
1810-
const extendedConfigs = arrayToMap(
1811-
(parsed?.options.configFile?.extendedSourceFiles || emptyArray) as ResolvedConfigFileName[],
1812-
extendedSourceFile => toResolvedConfigFilePath(state, extendedSourceFile)
1806+
updateSharedExtendedConfigFileWatcher(
1807+
resolvedPath,
1808+
parsed,
1809+
state.allWatchedExtendedConfigFiles,
1810+
(extendedConfigFileName, extendedConfigFilePath) => state.watchFile(
1811+
extendedConfigFileName,
1812+
() => state.allWatchedExtendedConfigFiles.get(extendedConfigFilePath)?.projects.forEach(projectConfigFilePath =>
1813+
invalidateProjectAndScheduleBuilds(state, projectConfigFilePath, ConfigFileProgramReloadLevel.Full)
1814+
),
1815+
PollingInterval.High,
1816+
parsed?.watchOptions,
1817+
WatchType.ExtendedConfigFile,
1818+
),
1819+
fileName => toPath(state, fileName),
18131820
);
1814-
extendedConfigs.forEach((extendedConfigFileName, extendedConfigFilePath) => {
1815-
const watcher = state.allWatchedExtendedConfigFiles.get(extendedConfigFilePath);
1816-
if (watcher) {
1817-
watcher.projects.add(resolvedPath);
1818-
}
1819-
else {
1820-
// start watching previously unseen extended config
1821-
const projects = new Set<ResolvedConfigFilePath>([resolvedPath]);
1822-
let fileWatcher = state.watchFile(
1823-
extendedConfigFileName,
1824-
() => {
1825-
projects.forEach((projectConfigFilePath) => {
1826-
invalidateProjectAndScheduleBuilds(state, projectConfigFilePath, ConfigFileProgramReloadLevel.Full);
1827-
});
1828-
},
1829-
PollingInterval.High,
1830-
parsed?.watchOptions,
1831-
WatchType.ExtendedConfigFile,
1832-
extendedConfigFileName
1833-
);
1834-
state.allWatchedExtendedConfigFiles.set(extendedConfigFilePath, {
1835-
close: () => {
1836-
if (projects.size === 0) {
1837-
Debug.assert(fileWatcher !== undefined);
1838-
fileWatcher.close();
1839-
fileWatcher = undefined!;
1840-
state.allWatchedExtendedConfigFiles.delete(extendedConfigFilePath);
1841-
}
1842-
},
1843-
projects,
1844-
});
1845-
}
1846-
});
1847-
// remove project from all unrelated watchers
1848-
state.allWatchedExtendedConfigFiles.forEach((watcher, extendedConfigFilePath) => {
1849-
if (!extendedConfigs.has(extendedConfigFilePath)) {
1850-
watcher.projects.delete(resolvedPath);
1851-
watcher.close();
1852-
}
1853-
});
18541821
}
18551822

18561823
function watchWildCardDirectories(state: SolutionBuilderState, resolved: ResolvedConfigFileName, resolvedPath: ResolvedConfigFilePath, parsed: ParsedCommandLine) {
@@ -1924,7 +1891,10 @@ namespace ts {
19241891

19251892
function stopWatching(state: SolutionBuilderState) {
19261893
clearMap(state.allWatchedConfigFiles, closeFileWatcher);
1927-
clearMap(state.allWatchedExtendedConfigFiles, closeFileWatcher);
1894+
clearMap(state.allWatchedExtendedConfigFiles, watcher => {
1895+
watcher.projects.clear();
1896+
watcher.close();
1897+
});
19281898
clearMap(state.allWatchedWildcardDirectories, watchedWildcardDirectories => clearMap(watchedWildcardDirectories, closeFileWatcherOf));
19291899
clearMap(state.allWatchedInputFiles, watchedWildcardDirectories => clearMap(watchedWildcardDirectories, closeFileWatcher));
19301900
}

‎src/compiler/watchPublic.ts‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -792,11 +792,16 @@ namespace ts {
792792
}
793793

794794
function watchExtendedConfigFiles() {
795-
updateExtendedConfigFilesMap(
796-
compilerOptions.configFile,
797-
extendedConfigFilesMap || (extendedConfigFilesMap = new Map()),
798-
toPath,
799-
watchExtendedConfigFile
795+
// Update the extended config files watcher
796+
mutateMap(
797+
extendedConfigFilesMap ||= new Map(),
798+
arrayToMap(compilerOptions.configFile?.extendedSourceFiles || emptyArray, toPath),
799+
{
800+
// Watch the extended config files
801+
createNewValue: watchExtendedConfigFile,
802+
// Config files that are no longer extended should no longer be watched.
803+
onDeleteValue: closeFileWatcher
804+
}
800805
);
801806
}
802807

‎src/compiler/watchUtilities.ts‎

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -257,29 +257,49 @@ namespace ts {
257257
Full
258258
}
259259

260+
export interface SharedExtendedConfigFileWatcher<T> extends FileWatcher {
261+
fileWatcher: FileWatcher;
262+
projects: Set<T>;
263+
}
264+
260265
/**
261-
* Updates the map of extended config file watches with a new set of extended config files from a base config file
266+
* Updates the map of shared extended config file watches with a new set of extended config files from a base config file of the project
262267
*/
263-
export function updateExtendedConfigFilesMap(
264-
configFile: TsConfigSourceFile | undefined,
265-
extendedConfigFilesMap: ESMap<Path, FileWatcher>,
266-
toPath: (file: string) => Path,
267-
createExtendedConfigFileWatch: (extendedConfigPath: Path) => FileWatcher,
268+
export function updateSharedExtendedConfigFileWatcher<T>(
269+
projectPath: T,
270+
parsed: ParsedCommandLine | undefined,
271+
extendedConfigFilesMap: ESMap<Path, SharedExtendedConfigFileWatcher<T>>,
272+
createExtendedConfigFileWatch: (extendedConfigPath: string, extendedConfigFilePath: Path) => FileWatcher,
273+
toPath: (fileName: string) => Path,
268274
) {
269-
const extendedSourceFiles = configFile?.extendedSourceFiles ?? emptyArray;
270-
// TODO(rbuckton): Should be a `Set` but that requires changing the below code that uses `mutateMap`
271-
const newExtendedConfigFilesMap = arrayToMap(extendedSourceFiles, toPath, returnTrue);
275+
const extendedConfigs = arrayToMap(parsed?.options.configFile?.extendedSourceFiles || emptyArray, toPath);
276+
// remove project from all unrelated watchers
277+
extendedConfigFilesMap.forEach((watcher, extendedConfigFilePath) => {
278+
if (!extendedConfigs.has(extendedConfigFilePath)) {
279+
watcher.projects.delete(projectPath);
280+
watcher.close();
281+
}
282+
});
272283
// Update the extended config files watcher
273-
mutateMap(
274-
extendedConfigFilesMap,
275-
newExtendedConfigFilesMap,
276-
{
277-
// Watch the extended config files
278-
createNewValue: createExtendedConfigFileWatch,
279-
// Config files that are no longer extended should no longer be watched.
280-
onDeleteValue: closeFileWatcher
284+
extendedConfigs.forEach((extendedConfigFileName, extendedConfigFilePath) => {
285+
const existing = extendedConfigFilesMap.get(extendedConfigFilePath);
286+
if (existing) {
287+
existing.projects.add(projectPath);
281288
}
282-
);
289+
else {
290+
// start watching previously unseen extended config
291+
extendedConfigFilesMap.set(extendedConfigFilePath, {
292+
projects: new Set([projectPath]),
293+
fileWatcher: createExtendedConfigFileWatch(extendedConfigFileName, extendedConfigFilePath),
294+
close: () => {
295+
const existing = extendedConfigFilesMap.get(extendedConfigFilePath);
296+
if (!existing || existing.projects.size !== 0) return;
297+
existing.fileWatcher.close();
298+
extendedConfigFilesMap.delete(extendedConfigFilePath);
299+
},
300+
});
301+
}
302+
});
283303
}
284304

285305
/**

‎src/server/editorServices.ts‎

Lines changed: 29 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -641,10 +641,6 @@ namespace ts.server {
641641
errors: Diagnostic[] | undefined;
642642
}
643643

644-
interface SharedExtendedConfigFileWatcher extends FileWatcher {
645-
projects: Set<ConfiguredProject>;
646-
}
647-
648644
export class ProjectService {
649645

650646
/*@internal*/
@@ -761,7 +757,7 @@ namespace ts.server {
761757
readonly watchFactory: WatchFactory<WatchType, Project>;
762758

763759
/*@internal*/
764-
private readonly sharedExtendedConfigFileWatchers = new Map<Path, SharedExtendedConfigFileWatcher>();
760+
private readonly sharedExtendedConfigFileWatchers = new Map<Path, SharedExtendedConfigFileWatcher<NormalizedPath>>();
765761

766762
/*@internal*/
767763
readonly packageJsonCache: PackageJsonCache;
@@ -1359,61 +1355,40 @@ namespace ts.server {
13591355
}
13601356

13611357
/*@internal*/
1362-
private updateSharedExtendedConfigFileMap(project: ConfiguredProject) {
1363-
const extendedConfigPaths: readonly Path[] = project.getCompilerOptions().configFile?.extendedSourceFiles
1364-
?.map((file) => this.toPath(file)) ?? emptyArray;
1365-
for (const extendedConfigPath of extendedConfigPaths) {
1366-
const watcher = this.sharedExtendedConfigFileWatchers.get(extendedConfigPath);
1367-
if (watcher) {
1368-
watcher.projects.add(project);
1369-
}
1370-
else {
1371-
// start watching previously unseen extended config
1372-
const projects = new Set<ConfiguredProject>([project]);
1373-
const fileWatcherCallback = () => {
1374-
const reason = `Change in extended config file ${extendedConfigPath} detected`;
1375-
projects.forEach((project: ConfiguredProject) => {
1358+
updateSharedExtendedConfigFileMap({ canonicalConfigFilePath }: ConfiguredProject, parsedCommandLine: ParsedCommandLine) {
1359+
updateSharedExtendedConfigFileWatcher(
1360+
canonicalConfigFilePath,
1361+
parsedCommandLine,
1362+
this.sharedExtendedConfigFileWatchers,
1363+
(extendedConfigFileName, extendedConfigFilePath) => this.watchFactory.watchFile(
1364+
extendedConfigFileName,
1365+
() => {
1366+
let ensureProjectsForOpenFiles = false;
1367+
this.sharedExtendedConfigFileWatchers.get(extendedConfigFilePath)?.projects.forEach(canonicalPath => {
1368+
const project = this.configuredProjects.get(canonicalPath);
13761369
// Skip refresh if project is not yet loaded
1377-
if (project.isInitialLoadPending()) return;
1370+
if (!project || project.isInitialLoadPending()) return;
13781371
project.pendingReload = ConfigFileProgramReloadLevel.Full;
1379-
project.pendingReloadReason = reason;
1372+
project.pendingReloadReason = `Change in extended config file ${extendedConfigFileName} detected`;
13801373
this.delayUpdateProjectGraph(project);
1374+
ensureProjectsForOpenFiles = true;
13811375
});
1382-
};
1383-
const fileWatcher = this.watchFactory.watchFile(
1384-
extendedConfigPath,
1385-
fileWatcherCallback,
1386-
PollingInterval.High,
1387-
this.hostConfiguration.watchOptions,
1388-
WatchType.ExtendedConfigFile
1389-
);
1390-
this.sharedExtendedConfigFileWatchers.set(extendedConfigPath, {
1391-
close: () => fileWatcher.close(),
1392-
projects,
1393-
});
1394-
}
1395-
}
1396-
// remove project from all unrelated watchers
1397-
this.sharedExtendedConfigFileWatchers.forEach((watcher, extendedConfigPath) => {
1398-
if (!extendedConfigPaths.includes(extendedConfigPath)) {
1399-
watcher.projects.delete(project);
1400-
if (watcher.projects.size === 0) {
1401-
watcher.close();
1402-
this.sharedExtendedConfigFileWatchers.delete(extendedConfigPath);
1403-
}
1404-
}
1405-
});
1376+
if (ensureProjectsForOpenFiles) this.delayEnsureProjectForOpenFiles();
1377+
},
1378+
PollingInterval.High,
1379+
this.hostConfiguration.watchOptions,
1380+
WatchType.ExtendedConfigFile
1381+
),
1382+
fileName => this.toPath(fileName),
1383+
);
14061384
}
14071385

14081386
/*@internal*/
1409-
private removeProjectFromSharedExtendedConfigFileMap(project: ConfiguredProject) {
1410-
for (const [sharedConfigPath, watcher] of arrayFrom(this.sharedExtendedConfigFileWatchers.entries())) {
1411-
watcher.projects.delete(project);
1412-
if (watcher.projects.size === 0) {
1413-
watcher.close();
1414-
this.sharedExtendedConfigFileWatchers.delete(sharedConfigPath);
1415-
}
1416-
}
1387+
removeProjectFromSharedExtendedConfigFileMap(project: ConfiguredProject) {
1388+
this.sharedExtendedConfigFileWatchers.forEach(watcher => {
1389+
watcher.projects.delete(project.canonicalConfigFilePath);
1390+
watcher.close();
1391+
});
14171392
}
14181393

14191394
/**
@@ -1471,7 +1446,6 @@ namespace ts.server {
14711446
this.configuredProjects.delete((<ConfiguredProject>project).canonicalConfigFilePath);
14721447
this.projectToSizeMap.delete((project as ConfiguredProject).canonicalConfigFilePath);
14731448
this.setConfigFileExistenceInfoByClosedConfiguredProject(<ConfiguredProject>project);
1474-
this.removeProjectFromSharedExtendedConfigFileMap(project as ConfiguredProject);
14751449
break;
14761450
case ProjectKind.Inferred:
14771451
unorderedRemoveItem(this.inferredProjects, <InferredProject>project);
@@ -2208,7 +2182,7 @@ namespace ts.server {
22082182
project.setWatchOptions(parsedCommandLine.watchOptions);
22092183
project.enableLanguageService();
22102184
project.watchWildcards(new Map(getEntries(parsedCommandLine.wildcardDirectories!))); // TODO: GH#18217
2211-
this.updateSharedExtendedConfigFileMap(project);
2185+
this.updateSharedExtendedConfigFileMap(project, parsedCommandLine);
22122186
}
22132187
project.enablePluginsWithOptions(compilerOptions, this.currentPluginConfigOverrides);
22142188
const filesToAdd = parsedCommandLine.fileNames.concat(project.getExternalFiles());

‎src/server/project.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2293,6 +2293,7 @@ namespace ts.server {
22932293
}
22942294

22952295
this.stopWatchingWildCards();
2296+
this.projectService.removeProjectFromSharedExtendedConfigFileMap(this);
22962297
this.configFileSpecs = undefined;
22972298
this.openFileWatchTriggered.clear();
22982299
this.compilerHost = undefined;

0 commit comments

Comments
 (0)