Skip to content

Fixes to session's handling of empty results #17728

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

Merged
3 commits merged into from
Aug 14, 2017
Merged

Fixes to session's handling of empty results #17728

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
753bd2d
Fixes to session's handling of empty results
Aug 10, 2017
f3a1a29
Fix emptyArray -> undefined
Aug 14, 2017
87a1a0b
Merge branch 'master' into session
Aug 14, 2017
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
17 changes: 7 additions & 10 deletions src/server/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ namespace ts.server {

const definitions = project.getLanguageService().getTypeDefinitionAtPosition(file, position);
if (!definitions) {
return undefined;
return emptyArray;
Copy link
Member

@amcasey amcasey Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}

return definitions.map(def => {
Expand Down Expand Up @@ -714,7 +714,7 @@ namespace ts.server {
const documentHighlights = project.getLanguageService().getDocumentHighlights(file, position, args.filesToSearch);

if (!documentHighlights) {
return undefined;
return emptyArray;
Copy link
Member

@amcasey amcasey Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}

if (simplifiedResult) {
Expand Down Expand Up @@ -809,7 +809,7 @@ namespace ts.server {
// The rename info should be the same for every project
const renameInfo = defaultProject.getLanguageService().getRenameInfo(file, position);
if (!renameInfo) {
return undefined;
return emptyArray;
Copy link
Member

@amcasey amcasey Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we confident that callers expecting a protocol.RenameResponseBody won't hit this case?

Copy link
Author

@ghost ghost Aug 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D'oh, got the meaning of simplifiedResult backwards.

}

if (!renameInfo.canRename) {
Expand Down Expand Up @@ -901,7 +901,7 @@ namespace ts.server {
}
}

private getReferences(args: protocol.FileLocationRequestArgs, simplifiedResult: boolean): protocol.ReferencesResponseBody | ReadonlyArray<ReferencedSymbol> {
private getReferences(args: protocol.FileLocationRequestArgs, simplifiedResult: boolean): protocol.ReferencesResponseBody | undefined | ReadonlyArray<ReferencedSymbol> {
Copy link
Member

@amcasey amcasey Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we are okay with returning undefined on success?

Copy link
Author

@ghost ghost Aug 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't really have a way to return a ReferencesResponseBody if the cursor wasn't at a valid location. It would be nice if we had some way to indicate a non-result in a way that's distinguishable from a crash in services.

const file = toNormalizedPath(args.file);
const projects = this.getProjects(args);

Expand All @@ -911,7 +911,7 @@ namespace ts.server {
if (simplifiedResult) {
const nameInfo = defaultProject.getLanguageService().getQuickInfoAtPosition(file, position);
if (!nameInfo) {
return emptyArray;
return undefined;
}

const displayString = displayPartsToString(nameInfo.displayParts);
Expand Down Expand Up @@ -1165,19 +1165,16 @@ namespace ts.server {
});
}

private getCompletions(args: protocol.CompletionsRequestArgs, simplifiedResult: boolean): ReadonlyArray<protocol.CompletionEntry> | CompletionInfo {
private getCompletions(args: protocol.CompletionsRequestArgs, simplifiedResult: boolean): ReadonlyArray<protocol.CompletionEntry> | CompletionInfo | undefined {
const prefix = args.prefix || "";
const { file, project } = this.getFileAndProject(args);

const scriptInfo = project.getScriptInfoForNormalizedPath(file);
const position = this.getPosition(args, scriptInfo);

const completions = project.getLanguageService().getCompletionsAtPosition(file, position);
if (!completions) {
return emptyArray;
}
if (simplifiedResult) {
return mapDefined(completions.entries, entry => {
return mapDefined(completions && completions.entries, entry => {
Copy link
Member

@amcasey amcasey Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have thought we'd want to return emptyArray when !completions.

Copy link
Author

@ghost ghost Aug 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mapDefined always returns a defined result.

if (completions.isMemberCompletion || (entry.name.toLowerCase().indexOf(prefix.toLowerCase()) === 0)) {
const { name, kind, kindModifiers, sortText, replacementSpan } = entry;
const convertedSpan = replacementSpan ? this.decorateSpan(replacementSpan, scriptInfo) : undefined;
Expand Down