Skip to content

Scratch: How much can we save by not tracking or enforcing search order? #47963

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.

Sign up for GitHub

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

Closed
amcasey wants to merge 4 commits into from
Closed

Scratch: How much can we save by not tracking or enforcing search order? #47963

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14afc16
Start inlining helpers and renaming functions related to FAR/NavTo
amcasey Feb 8, 2022
55f2a31
Clean up navto
amcasey Feb 11, 2022
00c0e9d
Clean up FAR and RenameLocations
amcasey Feb 11, 2022
01acfdd
Stop enforcing search and aggregation order
amcasey Feb 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Start inlining helpers and renaming functions related to FAR/NavTo
  • Loading branch information
@amcasey
amcasey committed Feb 17, 2022
commit 14afc16a1a1e163e719ba77bd14c5981a0950cfa
246 changes: 126 additions & 120 deletions src/server/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,70 +294,35 @@ namespace ts.server {
return deduplicate(outputs, equateValues);
}

type CombineOutputResult<T> = { project: Project; result: readonly T[]; }[];
function combineOutputResultContains<T>(outputs: CombineOutputResult<T>, output: T, areEqual: (a: T, b: T) => boolean) {
return outputs.some(({ result }) => contains(result, output, areEqual));
}
function addToCombineOutputResult<T>(outputs: CombineOutputResult<T>, project: Project, result: readonly T[]) {
if (result.length) outputs.push({ project, result });
}

function combineProjectOutputFromEveryProject<T>(projectService: ProjectService, action: (project: Project) => readonly T[], areEqual: (a: T, b: T) => boolean): CombineOutputResult<T> {
const outputs: CombineOutputResult<T> = [];
projectService.loadAncestorProjectTree();
projectService.forEachEnabledProject(project => {
const theseOutputs = action(project);
addToCombineOutputResult(outputs, project, filter(theseOutputs, output => !combineOutputResultContains(outputs, output, areEqual)));
});
return outputs;
}

function flattenCombineOutputResult<T>(outputs: CombineOutputResult<T>): readonly T[] {
return flatMap(outputs, ({ result }) => result);
}

function combineProjectOutputWhileOpeningReferencedProjects<T>(
projects: Projects,
defaultProject: Project,
action: (project: Project) => readonly T[],
getLocation: (t: T) => DocumentPosition,
resultsEqual: (a: T, b: T) => boolean,
): CombineOutputResult<T> {
const outputs: CombineOutputResult<T> = [];
combineProjectOutputWorker(
projects,
defaultProject,
/*initialLocation*/ undefined,
(project, _, tryAddToTodo) => {
const theseOutputs = action(project);
addToCombineOutputResult(outputs, project, filter(theseOutputs, output => !combineOutputResultContains(outputs, output, resultsEqual) && !tryAddToTodo(project, getLocation(output))));
},
);
return outputs;
}
interface ProjectNavigateToItems {
project: Project;
navigateToItems: readonly NavigateToItem[];
};

function combineProjectOutputForRenameLocations(
projects: Projects,
defaultProject: Project,
initialLocation: DocumentPosition,
findInStrings: boolean,
findInComments: boolean,
hostPreferences: UserPreferences
{ providePrefixAndSuffixTextForRename }: UserPreferences
): readonly RenameLocation[] {
const outputs: RenameLocation[] = [];
combineProjectOutputWorker(
projects,
defaultProject,
initialLocation,
(project, location, tryAddToTodo) => {
for (const output of project.getLanguageService().findRenameLocations(location.fileName, location.pos, findInStrings, findInComments, hostPreferences.providePrefixAndSuffixTextForRename) || emptyArray) {
if (!contains(outputs, output, documentSpansEqual) && !tryAddToTodo(project, documentSpanLocation(output))) {
outputs.push(output);
const projectOutputs = project.getLanguageService().findRenameLocations(location.fileName, location.pos, findInStrings, findInComments, providePrefixAndSuffixTextForRename);
if (projectOutputs) {
for (const output of projectOutputs) {
if (!contains(outputs, output, documentSpansEqual) && !tryAddToTodo(project, documentSpanLocation(output))) {
outputs.push(output);
}
}
}
},
);

return outputs;
}

Expand All @@ -381,27 +346,30 @@ namespace ts.server {
initialLocation,
(project, location, getMappedLocation) => {
logger.info(`Finding references to ${location.fileName} position ${location.pos} in project ${project.getProjectName()}`);
for (const outputReferencedSymbol of project.getLanguageService().findReferences(location.fileName, location.pos) || emptyArray) {
const mappedDefinitionFile = getMappedLocation(project, documentSpanLocation(outputReferencedSymbol.definition));
const definition: ReferencedSymbolDefinitionInfo = mappedDefinitionFile === undefined ?
outputReferencedSymbol.definition :
{
...outputReferencedSymbol.definition,
textSpan: createTextSpan(mappedDefinitionFile.pos, outputReferencedSymbol.definition.textSpan.length),
fileName: mappedDefinitionFile.fileName,
contextSpan: getMappedContextSpan(outputReferencedSymbol.definition, project)
};

let symbolToAddTo = find(outputs, o => documentSpansEqual(o.definition, definition));
if (!symbolToAddTo) {
symbolToAddTo = { definition, references: [] };
outputs.push(symbolToAddTo);
}
const projectOutputs = project.getLanguageService().findReferences(location.fileName, location.pos);
if (projectOutputs) {
for (const referencedSymbol of projectOutputs) {
const mappedDefinitionFile = getMappedLocation(project, documentSpanLocation(referencedSymbol.definition));
const definition: ReferencedSymbolDefinitionInfo = mappedDefinitionFile === undefined ?
referencedSymbol.definition :
{
...referencedSymbol.definition,
textSpan: createTextSpan(mappedDefinitionFile.pos, referencedSymbol.definition.textSpan.length),
fileName: mappedDefinitionFile.fileName,
contextSpan: getMappedContextSpan(referencedSymbol.definition, project)
};

let symbolToAddTo = find(outputs, o => documentSpansEqual(o.definition, definition));
if (!symbolToAddTo) {
symbolToAddTo = { definition, references: [] };
outputs.push(symbolToAddTo);
}

for (const ref of outputReferencedSymbol.references) {
// If it's in a mapped file, that is added to the todo list by `getMappedLocation`.
if (!contains(symbolToAddTo.references, ref, documentSpansEqual) && !getMappedLocation(project, documentSpanLocation(ref))) {
symbolToAddTo.references.push(ref);
for (const ref of referencedSymbol.references) {
// If it's in a mapped file, that is added to the todo list by `getMappedLocation`.
if (!contains(symbolToAddTo.references, ref, documentSpansEqual) && !getMappedLocation(project, documentSpanLocation(ref))) {
symbolToAddTo.references.push(ref);
}
}
}
}
Expand All @@ -411,29 +379,6 @@ namespace ts.server {
return outputs.filter(o => o.references.length !== 0);
}

function combineProjectOutputForFileReferences(
projects: Projects,
defaultProject: Project,
fileName: string
): readonly ReferenceEntry[] {
const outputs: ReferenceEntry[] = [];

combineProjectOutputWorker(
projects,
defaultProject,
/*initialLocation*/ undefined,
project => {
for (const referenceEntry of project.getLanguageService().getFileReferences(fileName) || emptyArray) {
if (!contains(outputs, referenceEntry, documentSpansEqual)) {
outputs.push(referenceEntry);
}
}
},
);

return outputs;
}

interface ProjectAndLocation<TLocation extends DocumentPosition | undefined> {
readonly project: Project;
readonly location: TLocation;
Expand Down Expand Up @@ -1610,11 +1555,22 @@ namespace ts.server {

private getFileReferences(args: protocol.FileRequestArgs, simplifiedResult: boolean): protocol.FileReferencesResponseBody | readonly ReferenceEntry[] {
const projects = this.getProjects(args);
const references = combineProjectOutputForFileReferences(
projects,
this.getDefaultProject(args),
args.file,
);
const fileName = args.file;

const references: ReferenceEntry[] = [];

forEachProjectInProjects(projects, /*path*/ undefined, project => {
if (project.getCancellationToken().isCancellationRequested()) return;

const projectOutputs = project.getLanguageService().getFileReferences(fileName);
if (projectOutputs) {
for (const referenceEntry of projectOutputs) {
if (!contains(references, referenceEntry, documentSpansEqual)) {
references.push(referenceEntry);
}
}
}
});

if (!simplifiedResult) return references;
const refs = references.map(entry => referenceEntryToReferencesResponseItem(this.projectService, entry));
Expand Down Expand Up @@ -2092,10 +2048,10 @@ namespace ts.server {
private getNavigateToItems(args: protocol.NavtoRequestArgs, simplifiedResult: boolean): readonly protocol.NavtoItem[] | readonly NavigateToItem[] {
const full = this.getFullNavigateToItems(args);
return !simplifiedResult ?
flattenCombineOutputResult(full) :
flatMap(full, ({ navigateToItems }) => navigateToItems) :
flatMap(
full,
({ project, result }) => result.map(navItem => {
({ project, navigateToItems }) => navigateToItems.map(navItem => {
const scriptInfo = project.getScriptInfo(navItem.fileName)!;
const bakedItem: protocol.NavtoItem = {
name: navItem.name,
Expand All @@ -2121,26 +2077,65 @@ namespace ts.server {
);
}

private getFullNavigateToItems(args: protocol.NavtoRequestArgs): CombineOutputResult<NavigateToItem> {
private getFullNavigateToItems(args: protocol.NavtoRequestArgs): ProjectNavigateToItems[] {
const { currentFileOnly, searchValue, maxResultCount, projectFileName } = args;

if (currentFileOnly) {
Debug.assertIsDefined(args.file);
const { file, project } = this.getFileAndProject(args as protocol.FileRequestArgs);
return [{ project, result: project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, file) }];
}
else if (!args.file && !projectFileName) {
return combineProjectOutputFromEveryProject(
this.projectService,
project => project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, /*filename*/ undefined, /*excludeDts*/ project.isNonTsProject()),
navigateToItemIsEqualTo);
}
const fileArgs = args as protocol.FileRequestArgs;
return combineProjectOutputWhileOpeningReferencedProjects<NavigateToItem>(
this.getProjects(fileArgs),
this.getDefaultProject(fileArgs),
project => project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, /*fileName*/ undefined, /*excludeDts*/ project.isNonTsProject()),
documentSpanLocation,
navigateToItemIsEqualTo);
return [{ project, navigateToItems: project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, file) }];
}

const outputs: ProjectNavigateToItems[] = [];
const seenItems = new Map<string, NavigateToItem[]>(); // name to items with that name

if (!args.file && !projectFileName) {
this.projectService.loadAncestorProjectTree();
this.projectService.forEachEnabledProject(project => {
const projectItems = project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, /*filename*/ undefined, /*excludeDts*/ project.isNonTsProject());
const unseenItems = filter(projectItems, item => tryAddSeenItem(item));
if (unseenItems.length) {
outputs.push({ project, navigateToItems: unseenItems });
}
});
}
else {
const fileArgs = args as protocol.FileRequestArgs;

combineProjectOutputWorker(
this.getProjects(fileArgs),
this.getDefaultProject(fileArgs),
/*initialLocation*/ undefined,
(project, _, tryAddToTodo) => {
const projectItems = project.getLanguageService().getNavigateToItems(searchValue, maxResultCount, /*fileName*/ undefined, /*excludeDts*/ project.isNonTsProject());
const unseenItems = filter(projectItems, item => tryAddSeenItem(item) && !tryAddToTodo(project, documentSpanLocation(item)));
if (unseenItems.length) {
outputs.push({ project, navigateToItems: unseenItems });
}
}
);
}

return outputs;

// Returns true if the item had not been seen before
function tryAddSeenItem(item: NavigateToItem) {
const name = item.name;
if (!seenItems.has(name)) {
seenItems.set(name, [item]);
return true;
}

const seen = seenItems.get(name)!;
for (const seenItem of seen) {
if (navigateToItemIsEqualTo(seenItem, item)) {
return false;
}
}

seen.push(item);
return true;
}

function navigateToItemIsEqualTo(a: NavigateToItem, b: NavigateToItem): boolean {
if (a === b) {
Expand Down Expand Up @@ -2255,14 +2250,25 @@ namespace ts.server {
const newPath = toNormalizedPath(args.newFilePath);
const formatOptions = this.getHostFormatOptions();
const preferences = this.getHostPreferences();
const changes = flattenCombineOutputResult(
combineProjectOutputFromEveryProject(
this.projectService,
project => project.getLanguageService().getEditsForFileRename(oldPath, newPath, formatOptions, preferences),
(a, b) => a.fileName === b.fileName
)
);
return simplifiedResult ? changes.map(c => this.mapTextChangeToCodeEdit(c)) : changes;

const seenFiles = new Set<string>();
const textChanges: FileTextChanges[] = [];
this.projectService.loadAncestorProjectTree();
this.projectService.forEachEnabledProject(project => {
const projectTextChanges = project.getLanguageService().getEditsForFileRename(oldPath, newPath, formatOptions, preferences);
const projectFiles: string[] = [];
for (const textChange of projectTextChanges) {
if (!seenFiles.has(textChange.fileName)) {
textChanges.push(textChange);
projectFiles.push(textChange.fileName);
}
}
for (const file of projectFiles) {
seenFiles.add(file);
}
});

return simplifiedResult ? textChanges.map(c => this.mapTextChangeToCodeEdit(c)) : textChanges;
}

private getCodeFixes(args: protocol.CodeFixRequestArgs, simplifiedResult: boolean): readonly protocol.CodeFixAction[] | readonly CodeFixAction[] | undefined {
Expand Down