Improve implementation

Author: felixfbecker

src/lang-handler.ts

@@ -64,7 +64,7 @@ export interface LanguageClient {
 	 * Can occur as as a result of rename or executeCommand (code action).
 	 * @param params The edits to apply to the workspace
 	 */
-	workspaceApplyEdit(params: ApplyWorkspaceEditParams): Promise<ApplyWorkspaceEditResponse>;
+	workspaceApplyEdit(params: ApplyWorkspaceEditParams, childOf?: Span): Promise<ApplyWorkspaceEditResponse>;
 }
 
 /**
@@ -197,11 +197,12 @@ export class RemoteLanguageClient {
 	}
 
 	/**
-	 * 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
+	 * 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): Promise<ApplyWorkspaceEditResponse> {
-		return this.request('workspace/applyEdit', params).toPromise();
+	workspaceApplyEdit(params: ApplyWorkspaceEditParams, childOf = new Span()): Promise<ApplyWorkspaceEditResponse> {
+		return this.request('workspace/applyEdit', params, childOf).toPromise();
 	}
 }

src/test/typescript-service-helpers.ts

@@ -2,7 +2,7 @@ import * as chai from 'chai';
 import * as sinon from 'sinon';
 import * as ts from 'typescript';
 import { CompletionItemKind, CompletionList, DiagnosticSeverity, TextDocumentIdentifier, TextDocumentItem, WorkspaceEdit } from 'vscode-languageserver';
-import { Hover, Location, SignatureHelp, SymbolInformation, SymbolKind } from 'vscode-languageserver-types';
+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';
@@ -2311,40 +2311,40 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 		});
 	});
 
-	describe('textDocumentCodeAction()', function (this: TestContext) {
+	describe('textDocumentCodeAction()', function (this: TestContext & ISuiteCallbackContext) {
 		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([
-			[rootUri + 'package.json', '{ "name": "mypkg" }'],
+			[rootUri + 'package.json', JSON.stringify({ name: 'mypkg' })],
 			[rootUri + 'a.ts', [
 				'class A {',
-				'  constructor() {',
-				'    missingThis = 33;',
-				'  }',
+				'\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) {
+		it('suggests a missing this', async function (this: TestContext & ITestCallbackContext) {
 			await this.service.textDocumentDidOpen({
 				textDocument: {
 					uri: rootUri + 'a.ts',
 					languageId: 'typescript',
 					text: [
 						'class A {',
-						' missingThis: number;',
-						'  constructor() {',
-						'    missingThis = 33;',
-						'  }',
+						'\tmissingThis: number;',
+						'\tconstructor() {',
+						'\t\tmissingThis = 33;',
+						'\t}',
 						'}',
 						'const a = new A();'
 					].join('\n'),
 					version: 1
 				}
 			});
 
-			const firstDiagnostic = {
+			const firstDiagnostic: Diagnostic = {
 				range: {
 					start: { line: 3, character: 4 },
 					end: { line: 3, character: 15 }
@@ -2354,7 +2354,7 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 				code: 2663,
 				source: 'ts'
 			};
-			const actions = await this.service.textDocumentCodeAction({
+			const actions: Command[] = await this.service.textDocumentCodeAction({
 				textDocument: {
 					uri: rootUri + 'a.ts'
 				},
@@ -2363,31 +2363,24 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 					diagnostics: [firstDiagnostic]
 				}
 			}).toArray().map(patches => apply(null, patches)).toPromise();
-			assert.lengthOf(actions, 1);
-			assert.sameDeepMembers(actions, [
-				{
-					title: 'Add \'this.\' to unresolved variable.',
-					command: 'codeFix',
-					arguments: [
-						{
-							fileName: uri2path(rootUri + 'a.ts'),
-							textChanges: [
-								{
-									span: { start: 50, length: 15 },
-									newText: '\t  this.missingThis'
-								}
-							]
-						}
-					]
-				}
-			]);
+			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'
+					}]
+				}]
+			}]);
 
-		} as any);
-	} as any);
+		});
+	});
 
-	describe('workspaceExecuteCommand()', function (this: TestContext) {
+	describe('workspaceExecuteCommand()', function (this: TestContext & ISuiteCallbackContext) {
 		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([
-			[rootUri + 'package.json', '{ "name": "mypkg" }'],
+			[rootUri + 'package.json', JSON.stringify({ name: 'mypkg' })],
 			[rootUri + 'a.ts', [
 				'class A {',
 				'  constructor() {',
@@ -2400,47 +2393,43 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 
 		afterEach(shutdownService as any);
 
-		it('should return edits for a codeFix command', async function (this: TestContext) {
-			const result = await this.service.workspaceExecuteCommand({
-				command: 'codeFix',
-				arguments: [
-					{
+		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  this.missingThis'
-							}
-						]
-					}
-				]
-			}).toArray().map(patches => apply(null, patches)).toPromise();
-
-			assert.isUndefined(result);
+						textChanges: [{
+							span: { start: 50, length: 15 },
+							newText: '\t\tthis.missingThis'
+						}]
+					}]
+				}).toArray().map(patches => apply(null, patches)).toPromise();
 
-			sinon.assert.called(this.client.workspaceApplyEdit);
-			const workspaceEdit = this.client.workspaceApplyEdit.lastCall.args[0];
-			assert.deepEqual(workspaceEdit, {
-				edit: {
-					changes: {
-						[rootUri + 'a.ts']: [{
-							newText: '\t  this.missingThis',
-							range: {
-								end: {
-									character: 9,
-									line: 5
-								},
-								start: {
-									character: 0,
-									line: 3
+				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
+									}
 								}
-							}
-						}]
+							}]
+						}
 					}
-				}
+				});
 			});
-		} as any);
-	} as any);
+		});
+	});
 
 	describe('Special file names', function (this: TestContext) {