Skip to content

Commit 667ba74

Browse files
sheetalkamatDanielRosenwasser
sheetalkamat
and
DanielRosenwasser
authored
Resolve only relative references in open files on syntax server (microsoft#39476)
* Resolve only relative references in open files on syntax server * Support resolving tripleslash references only in the open file * Apply suggestions from code review Co-authored-by: Daniel Rosenwasser <DanielRosenwasser@users.noreply.github.com> Co-authored-by: Daniel Rosenwasser <DanielRosenwasser@users.noreply.github.com>
1 parent c07c885 commit 667ba74

File tree

9 files changed

+218
-31
lines changed

9 files changed

+218
-31
lines changed

‎src/compiler/program.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -807,6 +807,8 @@ namespace ts {
807807
let mapFromFileToProjectReferenceRedirects: ESMap<Path, Path> | undefined;
808808
let mapFromToProjectReferenceRedirectSource: ESMap<Path, SourceOfProjectReferenceRedirect> | undefined;
809809

810+
let skippedTrippleSlashReferences: Set<Path> | undefined;
811+
810812
const useSourceOfProjectReferenceRedirect = !!host.useSourceOfProjectReferenceRedirect?.() &&
811813
!options.disableSourceOfProjectReferenceRedirect;
812814
const { onProgramCreateComplete, fileExists } = updateHostForUseSourceOfProjectReferenceRedirect({
@@ -928,6 +930,7 @@ namespace ts {
928930
getSourceFiles: () => files,
929931
getMissingFilePaths: () => missingFilePaths!, // TODO: GH#18217
930932
getRefFileMap: () => refFileMap,
933+
getSkippedTrippleSlashReferences: () => skippedTrippleSlashReferences,
931934
getFilesByNameMap: () => filesByName,
932935
getCompilerOptions: () => options,
933936
getSyntacticDiagnostics,
@@ -1269,6 +1272,7 @@ namespace ts {
12691272
const oldSourceFiles = oldProgram.getSourceFiles();
12701273
const enum SeenPackageName { Exists, Modified }
12711274
const seenPackageNames = new Map<string, SeenPackageName>();
1275+
const oldSkippedTrippleSlashReferences = oldProgram.getSkippedTrippleSlashReferences();
12721276

12731277
for (const oldSourceFile of oldSourceFiles) {
12741278
let newSourceFile = host.getSourceFileByPath
@@ -1341,6 +1345,11 @@ namespace ts {
13411345
oldProgram.structureIsReused = StructureIsReused.SafeModules;
13421346
}
13431347

1348+
if (oldSkippedTrippleSlashReferences?.has(oldSourceFile.path) && includeTripleslashReferencesFrom(newSourceFile)) {
1349+
// tripleslash reference resolution is now allowed
1350+
oldProgram.structureIsReused = StructureIsReused.SafeModules;
1351+
}
1352+
13441353
// check imports and module augmentations
13451354
collectExternalModuleReferences(newSourceFile);
13461355
if (!arrayIsEqualTo(oldSourceFile.imports, newSourceFile.imports, moduleNameIsEqualTo)) {
@@ -1428,6 +1437,7 @@ namespace ts {
14281437

14291438
missingFilePaths = oldProgram.getMissingFilePaths();
14301439
refFileMap = oldProgram.getRefFileMap();
1440+
skippedTrippleSlashReferences = oldSkippedTrippleSlashReferences;
14311441

14321442
// update fileName -> file mapping
14331443
Debug.assert(newSourceFiles.length === oldProgram.getSourceFiles().length);
@@ -2647,7 +2657,15 @@ namespace ts {
26472657
return projectReferenceRedirects.get(projectReferencePath) || undefined;
26482658
}
26492659

2660+
function includeTripleslashReferencesFrom(file: SourceFile) {
2661+
return !host.includeTripleslashReferencesFrom || host.includeTripleslashReferencesFrom(file.originalFileName);
2662+
}
2663+
26502664
function processReferencedFiles(file: SourceFile, isDefaultLib: boolean) {
2665+
if (!includeTripleslashReferencesFrom(file)) {
2666+
(skippedTrippleSlashReferences ||= new Set()).add(file.path);
2667+
return;
2668+
}
26512669
forEach(file.referencedFiles, (ref, index) => {
26522670
const referencedFileName = resolveTripleslashReference(ref.fileName, file.originalFileName);
26532671
processSourceFile(

‎src/compiler/resolutionCache.ts‎

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ namespace ts {
1111

1212
invalidateResolutionsOfFailedLookupLocations(): boolean;
1313
invalidateResolutionOfFile(filePath: Path): void;
14+
removeRelativeNoResolveResolutionsOfFile(filePath: Path): boolean;
1415
removeResolutionsOfFile(filePath: Path): void;
1516
removeResolutionsFromProjectReferenceRedirects(filePath: Path): void;
1617
setFilesWithInvalidatedNonRelativeUnresolvedImports(filesWithUnresolvedImports: ESMap<Path, readonly string[]>): void;
@@ -141,7 +142,21 @@ namespace ts {
141142
type GetResolutionWithResolvedFileName<T extends ResolutionWithFailedLookupLocations = ResolutionWithFailedLookupLocations, R extends ResolutionWithResolvedFileName = ResolutionWithResolvedFileName> =
142143
(resolution: T) => R | undefined;
143144

144-
export function createResolutionCache(resolutionHost: ResolutionCacheHost, rootDirForResolution: string | undefined, logChangesWhenResolvingModule: boolean): ResolutionCache {
145+
export enum ResolutionKind {
146+
All,
147+
RelativeReferencesInOpenFileOnly
148+
}
149+
150+
const noResolveResolvedModule: ResolvedModuleWithFailedLookupLocations = {
151+
resolvedModule: undefined,
152+
failedLookupLocations: []
153+
};
154+
const noResolveResolvedTypeReferenceDirective: ResolvedTypeReferenceDirectiveWithFailedLookupLocations = {
155+
resolvedTypeReferenceDirective: undefined,
156+
failedLookupLocations: []
157+
};
158+
159+
export function createResolutionCache(resolutionHost: ResolutionCacheHost, rootDirForResolution: string | undefined, resolutionKind: ResolutionKind, logChangesWhenResolvingModule: boolean): ResolutionCache {
145160
let filesWithChangedSetOfUnresolvedImports: Path[] | undefined;
146161
let filesWithInvalidatedResolutions: Set<Path> | undefined;
147162
let filesWithInvalidatedNonRelativeUnresolvedImports: ReadonlyESMap<Path, readonly string[]> | undefined;
@@ -206,6 +221,7 @@ namespace ts {
206221
hasChangedAutomaticTypeDirectiveNames: () => hasChangedAutomaticTypeDirectiveNames,
207222
invalidateResolutionOfFile,
208223
invalidateResolutionsOfFailedLookupLocations,
224+
removeRelativeNoResolveResolutionsOfFile,
209225
setFilesWithInvalidatedNonRelativeUnresolvedImports,
210226
createHasInvalidatedResolution,
211227
updateTypeRootsWatch,
@@ -341,11 +357,12 @@ namespace ts {
341357
shouldRetryResolution: (t: T) => boolean;
342358
reusedNames?: readonly string[];
343359
logChanges?: boolean;
360+
noResolveResolution: T;
344361
}
345362
function resolveNamesWithLocalCache<T extends ResolutionWithFailedLookupLocations, R extends ResolutionWithResolvedFileName>({
346363
names, containingFile, redirectedReference,
347364
cache, perDirectoryCacheWithRedirects,
348-
loader, getResolutionWithResolvedFileName,
365+
loader, getResolutionWithResolvedFileName, noResolveResolution,
349366
shouldRetryResolution, reusedNames, logChanges
350367
}: ResolveNamesWithLocalCacheInput<T, R>): (R | undefined)[] {
351368
const path = resolutionHost.toPath(containingFile);
@@ -382,7 +399,10 @@ namespace ts {
382399
resolution = resolutionInDirectory;
383400
}
384401
else {
385-
resolution = loader(name, containingFile, compilerOptions, resolutionHost.getCompilerHost?.() || resolutionHost, redirectedReference);
402+
resolution = resolutionKind === ResolutionKind.All ||
403+
(isExternalModuleNameRelative(name) && resolutionHost.fileIsOpen(path)) ?
404+
loader(name, containingFile, compilerOptions, resolutionHost.getCompilerHost?.() || resolutionHost, redirectedReference) :
405+
noResolveResolution;
386406
perDirectoryResolution.set(name, resolution);
387407
}
388408
resolutionsInFile.set(name, resolution);
@@ -441,6 +461,7 @@ namespace ts {
441461
loader: resolveTypeReferenceDirective,
442462
getResolutionWithResolvedFileName: getResolvedTypeReferenceDirective,
443463
shouldRetryResolution: resolution => resolution.resolvedTypeReferenceDirective === undefined,
464+
noResolveResolution: noResolveResolvedTypeReferenceDirective,
444465
});
445466
}
446467

@@ -455,7 +476,8 @@ namespace ts {
455476
getResolutionWithResolvedFileName: getResolvedModule,
456477
shouldRetryResolution: resolution => !resolution.resolvedModule || !resolutionExtensionIsTSOrJson(resolution.resolvedModule.extension),
457478
reusedNames,
458-
logChanges: logChangesWhenResolvingModule
479+
logChanges: logChangesWhenResolvingModule,
480+
noResolveResolution: noResolveResolvedModule,
459481
});
460482
}
461483

@@ -741,6 +763,31 @@ namespace ts {
741763
}
742764
}
743765

766+
function removeRelativeNoResolveResolutionsOfFileFromCache<T extends ResolutionWithFailedLookupLocations>(
767+
cache: ESMap<Path, ESMap<string, T>>,
768+
filePath: Path,
769+
noResolveResolution: T,
770+
) {
771+
Debug.assert(resolutionKind === ResolutionKind.RelativeReferencesInOpenFileOnly);
772+
// Deleted file, stop watching failed lookups for all the resolutions in the file
773+
const resolutions = cache.get(filePath);
774+
if (!resolutions) return false;
775+
let invalidated = false;
776+
resolutions.forEach((resolution, name) => {
777+
if (resolution === noResolveResolution && isExternalModuleNameRelative(name)) {
778+
resolutions.delete(name);
779+
invalidated = true;
780+
}
781+
});
782+
return invalidated;
783+
}
784+
785+
function removeRelativeNoResolveResolutionsOfFile(filePath: Path) {
786+
let invalidated = removeRelativeNoResolveResolutionsOfFileFromCache(resolvedModuleNames, filePath, noResolveResolvedModule);
787+
invalidated = removeRelativeNoResolveResolutionsOfFileFromCache(resolvedTypeReferenceDirectives, filePath, noResolveResolvedTypeReferenceDirective) || invalidated;
788+
return invalidated;
789+
}
790+
744791
function setFilesWithInvalidatedNonRelativeUnresolvedImports(filesMap: ReadonlyESMap<Path, readonly string[]>) {
745792
Debug.assert(filesWithInvalidatedNonRelativeUnresolvedImports === filesMap || filesWithInvalidatedNonRelativeUnresolvedImports === undefined);
746793
filesWithInvalidatedNonRelativeUnresolvedImports = filesMap;

‎src/compiler/types.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3687,6 +3687,8 @@ namespace ts {
36873687
/* @internal */
36883688
getRefFileMap(): MultiMap<Path, RefFile> | undefined;
36893689
/* @internal */
3690+
getSkippedTrippleSlashReferences(): Set<Path> | undefined;
3691+
/* @internal */
36903692
getFilesByNameMap(): ESMap<string, SourceFile | false | undefined>;
36913693

36923694
/**
@@ -6227,6 +6229,7 @@ namespace ts {
62276229
* This method is a companion for 'resolveModuleNames' and is used to resolve 'types' references to actual type declaration files
62286230
*/
62296231
resolveTypeReferenceDirectives?(typeReferenceDirectiveNames: string[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedTypeReferenceDirective | undefined)[];
6232+
/* @internal */ includeTripleslashReferencesFrom?(containingFile: string): boolean;
62306233
getEnvironmentVariable?(name: string): string | undefined;
62316234
/* @internal */ onReleaseOldSourceFile?(oldSourceFile: SourceFile, oldOptions: CompilerOptions, hasSourceFileByPath: boolean): void;
62326235
/* @internal */ hasInvalidatedResolution?: HasInvalidatedResolution;

‎src/compiler/watchPublic.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,7 @@ namespace ts {
320320
configFileName ?
321321
getDirectoryPath(getNormalizedAbsolutePath(configFileName, currentDirectory)) :
322322
currentDirectory,
323+
ResolutionKind.All,
323324
/*logChangesWhenResolvingModule*/ false
324325
);
325326
// Resolve module using host module resolution strategy if provided otherwise use resolution cache to resolve module names

‎src/server/editorServices.ts‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2967,7 +2967,15 @@ namespace ts.server {
29672967
let project: ConfiguredProject | ExternalProject | undefined = this.findExternalProjectContainingOpenScriptInfo(info);
29682968
let defaultConfigProject: ConfiguredProject | undefined;
29692969
let retainProjects: ConfiguredProject[] | ConfiguredProject | undefined;
2970-
if (!project && !this.syntaxOnly) { // Checking syntaxOnly is an optimization
2970+
if (this.syntaxOnly) {
2971+
// Invalidate resolutions in the file since this file is now open
2972+
info.containingProjects.forEach(project => {
2973+
if (project.resolutionCache.removeRelativeNoResolveResolutionsOfFile(info.path)) {
2974+
project.markAsDirty();
2975+
}
2976+
});
2977+
}
2978+
else if (!project) { // Checking syntaxOnly is an optimization
29712979
configFileName = this.getConfigFileNameForFile(info);
29722980
if (configFileName) {
29732981
project = this.findConfiguredProjectByProjectName(configFileName);
@@ -3047,6 +3055,10 @@ namespace ts.server {
30473055
Debug.assert(this.openFiles.has(info.path));
30483056
this.assignOrphanScriptInfoToInferredProject(info, this.openFiles.get(info.path));
30493057
}
3058+
else if (this.syntaxOnly && info.cacheSourceFile?.sourceFile.referencedFiles.length) {
3059+
// This file was just opened and references in this file will previously not been resolved so schedule update
3060+
info.containingProjects.forEach(project => project.markAsDirty());
3061+
}
30503062
Debug.assert(!info.isOrphan());
30513063
return { configFileName, configFileErrors, retainProjects };
30523064
}

‎src/server/project.ts‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,6 @@ namespace ts.server {
281281

282282
this.languageServiceEnabled = true;
283283
if (projectService.syntaxOnly) {
284-
this.compilerOptions.noResolve = true;
285284
this.compilerOptions.types = [];
286285
}
287286

@@ -296,7 +295,12 @@ namespace ts.server {
296295
this.realpath = maybeBind(host, host.realpath);
297296

298297
// Use the current directory as resolution root only if the project created using current directory string
299-
this.resolutionCache = createResolutionCache(this, currentDirectory && this.currentDirectory, /*logChangesWhenResolvingModule*/ true);
298+
this.resolutionCache = createResolutionCache(
299+
this,
300+
currentDirectory && this.currentDirectory,
301+
projectService.syntaxOnly ? ResolutionKind.RelativeReferencesInOpenFileOnly : ResolutionKind.All,
302+
/*logChangesWhenResolvingModule*/ true
303+
);
300304
this.languageService = createLanguageService(this, this.documentRegistry, this.projectService.syntaxOnly);
301305
if (lastFileExceededProgramSize) {
302306
this.disableLanguageService(lastFileExceededProgramSize);
@@ -450,6 +454,11 @@ namespace ts.server {
450454
return this.resolutionCache.resolveTypeReferenceDirectives(typeDirectiveNames, containingFile, redirectedReference);
451455
}
452456

457+
/*@internal*/
458+
includeTripleslashReferencesFrom(containingFile: string) {
459+
return !this.projectService.syntaxOnly || this.fileIsOpen(this.toPath(containingFile));
460+
}
461+
453462
directoryExists(path: string): boolean {
454463
return this.directoryStructureHost.directoryExists!(path); // TODO: GH#18217
455464
}

‎src/services/services.ts‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,7 @@ namespace ts {
12961296
getCurrentDirectory: () => currentDirectory,
12971297
fileExists,
12981298
readFile,
1299-
realpath: host.realpath && (path => host.realpath!(path)),
1299+
realpath: maybeBind(host, host.realpath),
13001300
directoryExists: directoryName => {
13011301
return directoryProbablyExists(directoryName, host);
13021302
},
@@ -1309,21 +1309,13 @@ namespace ts {
13091309
},
13101310
onReleaseOldSourceFile,
13111311
hasInvalidatedResolution,
1312-
hasChangedAutomaticTypeDirectiveNames
1312+
hasChangedAutomaticTypeDirectiveNames,
1313+
includeTripleslashReferencesFrom: maybeBind(host, host.includeTripleslashReferencesFrom),
1314+
trace: maybeBind(host, host.trace),
1315+
resolveModuleNames: maybeBind(host, host.resolveModuleNames),
1316+
resolveTypeReferenceDirectives: maybeBind(host, host.resolveTypeReferenceDirectives),
1317+
useSourceOfProjectReferenceRedirect: maybeBind(host, host.useSourceOfProjectReferenceRedirect),
13131318
};
1314-
if (host.trace) {
1315-
compilerHost.trace = message => host.trace!(message);
1316-
}
1317-
1318-
if (host.resolveModuleNames) {
1319-
compilerHost.resolveModuleNames = (...args) => host.resolveModuleNames!(...args);
1320-
}
1321-
if (host.resolveTypeReferenceDirectives) {
1322-
compilerHost.resolveTypeReferenceDirectives = (...args) => host.resolveTypeReferenceDirectives!(...args);
1323-
}
1324-
if (host.useSourceOfProjectReferenceRedirect) {
1325-
compilerHost.useSourceOfProjectReferenceRedirect = () => host.useSourceOfProjectReferenceRedirect!();
1326-
}
13271319
host.setCompilerHost?.(compilerHost);
13281320

13291321
const documentRegistryBucketKey = documentRegistry.getKeyForCompilationSettings(newSettings);

‎src/services/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@ namespace ts {
266266
resolveModuleNames?(moduleNames: string[], containingFile: string, reusedNames: string[] | undefined, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedModule | undefined)[];
267267
getResolvedModuleWithFailedLookupLocationsFromCache?(modulename: string, containingFile: string): ResolvedModuleWithFailedLookupLocations | undefined;
268268
resolveTypeReferenceDirectives?(typeDirectiveNames: string[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedTypeReferenceDirective | undefined)[];
269+
/* @internal */ includeTripleslashReferencesFrom?(containingFile: string): boolean;
269270
/* @internal */ hasInvalidatedResolution?: HasInvalidatedResolution;
270271
/* @internal */ hasChangedAutomaticTypeDirectiveNames?: HasChangedAutomaticTypeDirectiveNames;
271272
/* @internal */

0 commit comments

Comments
 (0)