Implement textDocument/codeAction (#252)

Author: felixfbecker

src/lang-handler.ts

@@ -3,6 +3,8 @@ import { FORMAT_TEXT_MAP, Span } from 'opentracing';
 import { inspect } from 'util';
 import { isReponseMessage, Message, NotificationMessage, RequestMessage, ResponseMessage } from 'vscode-jsonrpc/lib/messages';
 import {
+	ApplyWorkspaceEditParams,
+	ApplyWorkspaceEditResponse,
 	LogMessageParams,
 	PublishDiagnosticsParams,
 	TextDocumentIdentifier,
@@ -56,6 +58,13 @@ export interface LanguageClient {
 	 * @param params The diagnostics to send to the client
 	 */
 	textDocumentPublishDiagnostics(params: PublishDiagnosticsParams): void;
+
+	/**
+	 * Requests a set of text changes to be applied to documents in the workspace
+	 * Can occur as as a result of rename or executeCommand (code action).
+	 * @param params The edits to apply to the workspace
+	 */
+	workspaceApplyEdit(params: ApplyWorkspaceEditParams, childOf?: Span): Promise<ApplyWorkspaceEditResponse>;
 }
 
 /**
@@ -186,4 +195,14 @@ export class RemoteLanguageClient {
 	textDocumentPublishDiagnostics(params: PublishDiagnosticsParams): void {
 		this.notify('textDocument/publishDiagnostics', params);
 	}
+
+	/**
+	 * The workspace/applyEdit request is sent from the server to the client to modify resource on
+	 * the client side.
+	 *
+	 * @param params The edits to apply.
+	 */
+	workspaceApplyEdit(params: ApplyWorkspaceEditParams, childOf = new Span()): Promise<ApplyWorkspaceEditResponse> {
+		return this.request('workspace/applyEdit', params, childOf).toPromise();
+	}
 }

src/project-manager.ts

@@ -622,6 +622,12 @@ export class InMemoryLanguageServiceHost implements ts.LanguageServiceHost {
 		return '' + this.projectVersion;
 	}
 
+	getNewLine(): string {
+		// Although this is optional, language service was sending edits with carriage returns if not specified.
+		// TODO: combine with the FormatOptions defaults.
+		return '\n';
+	}
+
 	/**
 	 * Incrementing current project version, telling TS compiler to invalidate internal data
 	 */

src/test/typescript-service-helpers.ts

@@ -1,8 +1,8 @@
 import * as chai from 'chai';
 import * as sinon from 'sinon';
 import * as ts from 'typescript';
-import { CompletionItemKind, CompletionList, TextDocumentIdentifier, TextDocumentItem } from 'vscode-languageserver';
-import { Hover, Location, SignatureHelp, SymbolInformation, SymbolKind, WorkspaceEdit } from 'vscode-languageserver-types';
+import { CompletionItemKind, CompletionList, DiagnosticSeverity, TextDocumentIdentifier, TextDocumentItem, WorkspaceEdit } from 'vscode-languageserver';
+import { Command, Diagnostic, Hover, Location, SignatureHelp, SymbolInformation, SymbolKind } from 'vscode-languageserver-types';
 import { LanguageClient, RemoteLanguageClient } from '../lang-handler';
 import { TextDocumentContentParams, WorkspaceFilesParams } from '../request-type';
 import { SymbolLocationInformation } from '../request-type';
@@ -16,7 +16,7 @@ const assert = chai.assert;
 /**
  * Enforcing strict mode to make tests pass on Windows
  */
-import { setStrict } from '../util';
+import { setStrict, uri2path } from '../util';
 setStrict(true);
 
 export interface TestContext {
@@ -53,6 +53,7 @@ export const initializeTypeScriptService = (createService: TypeScriptServiceFact
 		return Array.from(files.keys()).map(uri => ({ uri }));
 	});
 	this.client.xcacheGet.returns(null);
+	this.client.workspaceApplyEdit.returns(Promise.resolve({applied: true}));
 	this.service = createService(this.client);
 
 	await this.service.initialize({
@@ -2310,6 +2311,126 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 		});
 	});
 
+	describe('textDocumentCodeAction()', function (this: TestContext & ISuiteCallbackContext) {
+		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([
+			[rootUri + 'package.json', JSON.stringify({ name: 'mypkg' })],
+			[rootUri + 'a.ts', [
+				'class A {',
+				'\tconstructor() {',
+				'\t\tmissingThis = 33;',
+				'\t}',
+				'}',
+				'const a = new A();'
+			].join('\n')]
+		])) as any);
+
+		afterEach(shutdownService as any);
+
+		it('suggests a missing this', async function (this: TestContext & ITestCallbackContext) {
+			await this.service.textDocumentDidOpen({
+				textDocument: {
+					uri: rootUri + 'a.ts',
+					languageId: 'typescript',
+					text: [
+						'class A {',
+						'\tmissingThis: number;',
+						'\tconstructor() {',
+						'\t\tmissingThis = 33;',
+						'\t}',
+						'}',
+						'const a = new A();'
+					].join('\n'),
+					version: 1
+				}
+			});
+
+			const firstDiagnostic: Diagnostic = {
+				range: {
+					start: { line: 3, character: 4 },
+					end: { line: 3, character: 15 }
+				},
+				message: 'Cannot find name \'missingThis\'. Did you mean the instance member \'this.missingThis\'?',
+				severity: DiagnosticSeverity.Error,
+				code: 2663,
+				source: 'ts'
+			};
+			const actions: Command[] = await this.service.textDocumentCodeAction({
+				textDocument: {
+					uri: rootUri + 'a.ts'
+				},
+				range: firstDiagnostic.range,
+				context: {
+					diagnostics: [firstDiagnostic]
+				}
+			}).toArray().map(patches => apply(null, patches)).toPromise();
+			assert.deepEqual(actions, [{
+				title: 'Add \'this.\' to unresolved variable.',
+				command: 'codeFix',
+				arguments: [{
+					fileName: uri2path(rootUri + 'a.ts'),
+					textChanges: [{
+						span: { start: 49, length: 13 },
+						newText: '\t\tthis.missingThis'
+					}]
+				}]
+			}]);
+
+		});
+	});
+
+	describe('workspaceExecuteCommand()', function (this: TestContext & ISuiteCallbackContext) {
+		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([
+			[rootUri + 'package.json', JSON.stringify({ name: 'mypkg' })],
+			[rootUri + 'a.ts', [
+				'class A {',
+				'  constructor() {',
+				'    missingThis = 33;',
+				'  }',
+				'}',
+				'const a = new A();'
+			].join('\n')]
+		])) as any);
+
+		afterEach(shutdownService as any);
+
+		describe('codeFix', () => {
+			it('should apply a WorkspaceEdit for the passed FileTextChanges', async function (this: TestContext & ITestCallbackContext) {
+				await this.service.workspaceExecuteCommand({
+					command: 'codeFix',
+					arguments: [{
+						fileName: uri2path(rootUri + 'a.ts'),
+						textChanges: [{
+							span: { start: 50, length: 15 },
+							newText: '\t\tthis.missingThis'
+						}]
+					}]
+				}).toArray().map(patches => apply(null, patches)).toPromise();
+
+				sinon.assert.calledOnce(this.client.workspaceApplyEdit);
+				const workspaceEdit = this.client.workspaceApplyEdit.lastCall.args[0];
+				assert.deepEqual(workspaceEdit, {
+					edit: {
+						changes: {
+							[rootUri + 'a.ts']: [{
+								newText: '\t\tthis.missingThis',
+								range: {
+									end: {
+										character: 9,
+										line: 5
+									},
+									start: {
+										character: 0,
+										line: 3
+									}
+								}
+							}]
+						}
+					}
+				});
+			});
+		});
+	});
+
 	describe('Special file names', function (this: TestContext) {
 
 		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([