Skip to content

Don't pass deprecated options to Completion request #233

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

Merged
merged 3 commits into from
Aug 8, 2021
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions server/src/completion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { ScriptElementKind } from './tsp-command-types';
import { asRange, toTextEdit, asPlainText, asDocumentation } from './protocol-translation';
import { Commands } from './commands';

export interface TSCompletionItem extends lsp.CompletionItem {
interface TSCompletionItem extends lsp.CompletionItem {
data: tsp.CompletionDetailsRequestArgs;
}

Expand Down Expand Up @@ -145,7 +145,7 @@ function asCommitCharacters(kind: ScriptElementKind): string[] | undefined {
return commitCharacters.length === 0 ? undefined : commitCharacters;
}

export function asResolvedCompletionItem(item: TSCompletionItem, details: tsp.CompletionEntryDetails): TSCompletionItem {
export function asResolvedCompletionItem(item: lsp.CompletionItem, details: tsp.CompletionEntryDetails): lsp.CompletionItem {
item.detail = asDetail(details);
item.documentation = asDocumentation(details);
Object.assign(item, asCodeActions(details, item.data.file));
Expand Down
86 changes: 63 additions & 23 deletions server/src/lsp-server.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ import * as chai from 'chai';
import * as lsp from 'vscode-languageserver/node';
import * as lspcalls from './lsp-protocol.calls.proposed';
import { LspServer } from './lsp-server';
import { uri, createServer, position, lastPosition, filePath, getDefaultClientCapabilities } from './test-utils';
import { TSCompletionItem } from './completion';
import { uri, createServer, position, lastPosition, filePath, getDefaultClientCapabilities, positionAfter } from './test-utils';
import { TextDocument } from 'vscode-languageserver-textdocument';

const assert = chai.assert;
Expand Down Expand Up @@ -51,14 +50,13 @@ describe('completion', () => {
textDocument: doc
});
const pos = position(doc, 'console');
const proposals = await server.completion({
textDocument: doc,
position: pos
}) as TSCompletionItem[];
assert.isTrue(proposals.length > 800, String(proposals.length));
const item = proposals.filter(i => i.label === 'addEventListener')[0];
const resolvedItem = await server.completionResolve(item);
assert.isTrue(resolvedItem.detail !== undefined, JSON.stringify(resolvedItem, undefined, 2));
const proposals = await server.completion({ textDocument: doc, position: pos });
assert.isNotNull(proposals);
assert.isAbove(proposals!.items.length, 800);
const item = proposals!.items.find(i => i.label === 'addEventListener');
assert.isDefined(item);
const resolvedItem = await server.completionResolve(item!);
assert.isDefined(resolvedItem.detail, JSON.stringify(resolvedItem, undefined, 2));
server.didCloseTextDocument({
textDocument: doc
});
Expand All @@ -79,16 +77,14 @@ describe('completion', () => {
textDocument: doc
});
const pos = position(doc, 'console');
const proposals = await server.completion({
textDocument: doc,
position: pos
}) as TSCompletionItem[];
assert.isTrue(proposals.length > 800, String(proposals.length));
const item = proposals.filter(i => i.label === 'addEventListener')[0];
const resolvedItem = await server.completionResolve(item);
const proposals = await server.completion({ textDocument: doc, position: pos });
assert.isNotNull(proposals);
assert.isAbove(proposals!.items.length, 800);
const item = proposals!.items.find(i => i.label === 'addEventListener');
const resolvedItem = await server.completionResolve(item!);
assert.isTrue(resolvedItem.detail !== undefined, JSON.stringify(resolvedItem, undefined, 2));

const containsInvalidCompletions = proposals.reduce((accumulator, current) => {
const containsInvalidCompletions = proposals!.items.reduce((accumulator, current) => {
if (accumulator) {
return accumulator;
}
Expand Down Expand Up @@ -119,11 +115,55 @@ describe('completion', () => {
textDocument: doc
});
const pos = position(doc, 'foo');
const proposals = await server.completion({
textDocument: doc,
position: pos
}) as TSCompletionItem[];
assert.isTrue(proposals === null);
const proposals = await server.completion({ textDocument: doc, position: pos });
assert.isNull(proposals);
server.didCloseTextDocument({
textDocument: doc
});
}).timeout(10000);

it('includes completions from global modules', async () => {
const doc = {
uri: uri('bar.ts'),
languageId: 'typescript',
version: 1,
text: 'pathex'
};
server.didOpenTextDocument({
textDocument: doc
});
const proposals = await server.completion({ textDocument: doc, position: position(doc, 'ex') });
assert.isNotNull(proposals);
const pathExistsCompletion = proposals!.items.find(completion => completion.label === 'pathExists');
assert.isDefined(pathExistsCompletion);
server.didCloseTextDocument({
textDocument: doc
});
}).timeout(10000);

it('includes completions with invalid identifier names', async () => {
const doc = {
uri: uri('bar.ts'),
languageId: 'typescript',
version: 1,
text: `
interface Foo {
'invalid-identifier-name': string
}

const foo: Foo
foo.i
`
};
server.didOpenTextDocument({
textDocument: doc
});
const proposals = await server.completion({ textDocument: doc, position: positionAfter(doc, '.i') });
assert.isNotNull(proposals);
const completion = proposals!.items.find(completion => completion.label === 'invalid-identifier-name');
assert.isDefined(completion);
assert.isDefined(completion!.textEdit);
assert.equal(completion!.textEdit!.newText, '["invalid-identifier-name"]');
server.didCloseTextDocument({
textDocument: doc
});
Expand Down
35 changes: 20 additions & 15 deletions server/src/lsp-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
} from './protocol-translation';
import { getTsserverExecutable } from './utils';
import { LspDocuments, LspDocument } from './document';
import { asCompletionItem, TSCompletionItem, asResolvedCompletionItem } from './completion';
import { asCompletionItem, asResolvedCompletionItem } from './completion';
import { asSignatureHelp } from './hover';
import { Commands } from './commands';
import { provideQuickFix } from './quickfix';
Expand Down Expand Up @@ -105,12 +105,18 @@ export class LspServer {
);
}

const { logVerbosity, plugins, preferences, hostInfo }: TypeScriptInitializationOptions = {
logVerbosity: this.options.tsserverLogVerbosity,
plugins: [],
preferences: {},
...this.initializeParams.initializationOptions
const userInitializationOptions: TypeScriptInitializationOptions = this.initializeParams.initializationOptions || {};
const { hostInfo } = userInitializationOptions;
const { logVerbosity, plugins, preferences }: TypeScriptInitializationOptions = {
logVerbosity: userInitializationOptions.logVerbosity || this.options.tsserverLogVerbosity,
plugins: userInitializationOptions.plugins || [],
preferences: {
includeCompletionsForModuleExports: true,
includeCompletionsWithInsertText: true,
...userInitializationOptions.preferences
}
};

const logFile = this.getLogFile(logVerbosity);
const globalPlugins: string[] = [];
const pluginProbeLocations: string[] = [];
Expand Down Expand Up @@ -436,11 +442,11 @@ export class LspServer {
* implemented based on
* https://github.com/Microsoft/vscode/blob/master/extensions/typescript-language-features/src/features/completions.ts
*/
async completion(params: lsp.CompletionParams): Promise<TSCompletionItem[] | null> {
async completion(params: lsp.CompletionParams): Promise<lsp.CompletionList | null> {
const file = uriToPath(params.textDocument.uri);
this.logger.log('completion', params, file);
if (!file) {
return [];
return lsp.CompletionList.create([]);
}

const document = this.documents.get(file);
Expand All @@ -449,17 +455,16 @@ export class LspServer {
}

try {
const result = await this.interuptDiagnostics(() => this.tspClient.request(CommandTypes.Completions, {
const result = await this.interuptDiagnostics(() => this.tspClient.request(CommandTypes.CompletionInfo, {
file,
line: params.position.line + 1,
offset: params.position.character + 1,
includeExternalModuleExports: true,
includeInsertTextCompletions: true
offset: params.position.character + 1
}));
const body = result.body || [];
return body
const { body } = result;
const completions = (body ? body.entries : [])
.filter(entry => entry.kind !== 'warning')
.map(entry => asCompletionItem(entry, file, params.position, document));
return lsp.CompletionList.create(completions, body?.isIncomplete);
} catch (error) {
if (error.message === 'No content available.') {
this.logger.info('No content was available for completion request');
Expand All @@ -470,7 +475,7 @@ export class LspServer {
}
}

async completionResolve(item: TSCompletionItem): Promise<lsp.CompletionItem> {
async completionResolve(item: lsp.CompletionItem): Promise<lsp.CompletionItem> {
this.logger.log('completion/resolve', item);
const { body } = await this.interuptDiagnostics(() => this.tspClient.request(CommandTypes.CompletionDetails, item.data));
const details = body && body.length && body[0];
Expand Down
4 changes: 4 additions & 0 deletions server/src/test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ export function position(document: lsp.TextDocumentItem, match: string): lsp.Pos
return positionAt(document, document.text.indexOf(match));
}

export function positionAfter(document: lsp.TextDocumentItem, match: string): lsp.Position {
return positionAt(document, document.text.indexOf(match) + match.length);
}

export function lastPosition(document: lsp.TextDocumentItem, match: string): lsp.Position {
return positionAt(document, document.text.lastIndexOf(match));
}
Expand Down