Implement textDocument/rename (#251)

Author: felixfbecker

src/test/typescript-service-helpers.ts

@@ -2,14 +2,14 @@ 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 } from 'vscode-languageserver-types';
+import { Hover, Location, SignatureHelp, SymbolInformation, SymbolKind, WorkspaceEdit } from 'vscode-languageserver-types';
 import { LanguageClient, RemoteLanguageClient } from '../lang-handler';
 import { TextDocumentContentParams, WorkspaceFilesParams } from '../request-type';
 import { SymbolLocationInformation } from '../request-type';
 import { TypeScriptService, TypeScriptServiceFactory } from '../typescript-service';
 import chaiAsPromised = require('chai-as-promised');
 import { apply } from 'json-patch';
-import { ITestCallbackContext } from 'mocha';
+import { ISuiteCallbackContext, ITestCallbackContext } from 'mocha';
 chai.use(chaiAsPromised);
 const assert = chai.assert;
 
@@ -2172,6 +2172,144 @@ export function describeTypeScriptService(createService: TypeScriptServiceFactor
 		});
 	} as any);
 
+	describe('textDocumentRename()', function (this: TestContext & ISuiteCallbackContext) {
+		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([
+			[rootUri + 'package.json', JSON.stringify({ name: 'mypkg' })],
+			[rootUri + 'a.ts', [
+				'class A {',
+				'	/** foo doc*/',
+				'    foo() {}',
+				'	/** bar doc*/',
+				'    bar(): number { return 1; }',
+				'	/** baz doc*/',
+				'    baz(): string { return ""; }',
+				'	/** qux doc*/',
+				'    qux: number;',
+				'}',
+				'const a = new A();',
+				'a.'
+			].join('\n')],
+			[rootUri + 'uses-import.ts', [
+				'import {d} from "./import"',
+				'const x = d();'
+			].join('\n')],
+			[rootUri + 'import.ts', 'export function d(): number { return 55; }']
+		])) as any);
+
+		afterEach(shutdownService as any);
+
+		it('should error on an invalid symbol', async function (this: TestContext & ITestCallbackContext) {
+			await assert.isRejected(
+				this.service.textDocumentRename({
+					textDocument: {
+						uri: rootUri + 'a.ts'
+					},
+					position: {
+						line: 0,
+						character: 1
+					},
+					newName: 'asdf'
+				}).toArray().map(patches => apply(null, patches)).toPromise(),
+				'This symbol cannot be renamed'
+			);
+		});
+		it('should return a correct WorkspaceEdit to rename a class', async function (this: TestContext & ITestCallbackContext) {
+			const result: WorkspaceEdit = await this.service.textDocumentRename({
+				textDocument: {
+					uri: rootUri + 'a.ts'
+				},
+				position: {
+					line: 0,
+					character: 6
+				},
+				newName: 'B'
+			}).toArray().map(patches => apply(null, patches)).toPromise();
+			assert.deepEqual(result, {
+				changes: {
+					[rootUri + 'a.ts']: [{
+						newText: 'B',
+						range: {
+							end: {
+								character: 7,
+								line: 0
+							},
+							start: {
+								character: 6,
+								line: 0
+							}
+						}
+					}, {
+						newText: 'B',
+						range: {
+							end: {
+								character: 15,
+								line: 10
+							},
+							start: {
+								character: 14,
+								line: 10
+							}
+						}
+					}]
+				}
+			});
+		});
+		it('should return a correct WorkspaceEdit to rename an imported function', async function (this: TestContext & ITestCallbackContext) {
+			const result: WorkspaceEdit = await this.service.textDocumentRename({
+				textDocument: {
+					uri: rootUri + 'import.ts'
+				},
+				position: {
+					line: 0,
+					character: 16
+				},
+				newName: 'f'
+			}).toArray().map(patches => apply(null, patches)).toPromise();
+			assert.deepEqual(result, {
+				changes: {
+					[rootUri + 'import.ts']: [{
+						newText: 'f',
+						range: {
+							end: {
+								character: 17,
+								line: 0
+							},
+							start: {
+								character: 16,
+								line: 0
+							}
+						}
+					}],
+					[rootUri + 'uses-import.ts']: [{
+						newText: 'f',
+						range: {
+							end: {
+								character: 9,
+								line: 0
+							},
+							start: {
+								character: 8,
+								line: 0
+							}
+						}
+					}, {
+						newText: 'f',
+						range: {
+							end: {
+								character: 11,
+								line: 1
+							},
+							start: {
+								character: 10,
+								line: 1
+							}
+						}
+					}]
+				}
+			});
+		});
+	});
+
 	describe('Special file names', function (this: TestContext) {
 
 		beforeEach(initializeTypeScriptService(createService, rootUri, new Map([

src/test/util-test.ts

@@ -1,7 +1,14 @@
 import * as assert from 'assert';
-import { getMatchScore, isGlobalTSFile, isSymbolDescriptorMatch } from '../util';
+import { getMatchScore, isGlobalTSFile, isSymbolDescriptorMatch, JSONPTR } from '../util';
 
 describe('util', () => {
+	describe('JSONPTR', () => {
+		it('should escape JSON Pointer components', () => {
+			const uri = 'file:///foo/~bar';
+			const pointer = JSONPTR`/changes/${uri}/-`;
+			assert.equal(pointer, '/changes/file:~1~1~1foo~1~0bar/-');
+		});
+	});
 	describe('getMatchScore()', () => {
 		it('should return a score of 4 if 4 properties match', () => {
 			const score = getMatchScore({

src/typescript-service.ts

@@ -19,11 +19,14 @@ import {
 	MarkedString,
 	ParameterInformation,
 	ReferenceParams,
+	RenameParams,
 	SignatureHelp,
 	SignatureInformation,
 	SymbolInformation,
 	TextDocumentPositionParams,
-	TextDocumentSyncKind
+	TextDocumentSyncKind,
+	TextEdit,
+	WorkspaceEdit
 } from 'vscode-languageserver';
 import { walkMostAST } from './ast';
 import { convertTsDiagnostic } from './diagnostics';
@@ -49,6 +52,7 @@ import {
 	getMatchScore,
 	isLocalUri,
 	isSymbolDescriptorMatch,
+	JSONPTR,
 	normalizeUri,
 	path2uri,
 	toUnixPath,
@@ -986,6 +990,61 @@ export class TypeScriptService {
 			.map(signatureHelp => ({ op: 'add', path: '', value: signatureHelp }) as AddPatch);
 	}
 
+	/**
+	 * The rename request is sent from the client to the server to perform a workspace-wide rename of a symbol.
+	 *
+	 * @return Observable of JSON Patches that build a `WorkspaceEdit` result
+	 */
+	textDocumentRename(params: RenameParams, span = new Span()): Observable<OpPatch> {
+		const uri = normalizeUri(params.textDocument.uri);
+		const editUris = new Set<string>();
+		return Observable.fromPromise(this.projectManager.ensureOwnFiles(span))
+			.mergeMap(() => {
+
+				const filePath = uri2path(uri);
+				const configuration = this.projectManager.getParentConfiguration(params.textDocument.uri);
+				if (!configuration) {
+					throw new Error(`tsconfig.json not found for ${filePath}`);
+				}
+				configuration.ensureAllFiles(span);
+
+				const sourceFile = this._getSourceFile(configuration, filePath, span);
+				if (!sourceFile) {
+					throw new Error(`Expected source file ${filePath} to exist in configuration`);
+				}
+
+				const position = ts.getPositionOfLineAndCharacter(sourceFile, params.position.line, params.position.character);
+
+				const renameInfo = configuration.getService().getRenameInfo(filePath, position);
+				if (!renameInfo.canRename) {
+					throw new Error('This symbol cannot be renamed');
+				}
+
+				return Observable.from(configuration.getService().findRenameLocations(filePath, position, false, true))
+					.map((location: ts.RenameLocation): [string, TextEdit] => {
+						const sourceFile = this._getSourceFile(configuration, location.fileName, span);
+						if (!sourceFile) {
+							throw new Error(`expected source file ${location.fileName} to exist in configuration`);
+						}
+						const editUri = path2uri(this.root, location.fileName);
+						const start = ts.getLineAndCharacterOfPosition(sourceFile, location.textSpan.start);
+						const end = ts.getLineAndCharacterOfPosition(sourceFile, location.textSpan.start + location.textSpan.length);
+						const edit: TextEdit = { range: { start, end }, newText: params.newName };
+						return [editUri, edit];
+					});
+			})
+			.map(([uri, edit]): AddPatch => {
+				// if file has no edit yet, initialize array
+				if (!editUris.has(uri)) {
+					editUris.add(uri);
+					return { op: 'add', path: JSONPTR`/changes/${uri}`, value: [edit] };
+				}
+				// else append to array
+				return { op: 'add', path: JSONPTR`/changes/${uri}/-`, value: edit };
+			})
+			.startWith({ op: 'add', path: '', value: { changes: {} } as WorkspaceEdit } as AddPatch);
+	}
+
 	/**
 	 * The document open notification is sent from the client to the server to signal newly opened
 	 * text documents. The document's truth is now managed by the client and the server must not try

src/util.ts

@@ -7,6 +7,13 @@ import { PackageDescriptor, SymbolDescriptor } from './request-type';
 
 let strict = false;
 
+/**
+ * Template string tag to escape JSON Pointer components as per https://tools.ietf.org/html/rfc6901#section-3
+ */
+export function JSONPTR(strings: TemplateStringsArray, ...toEscape: string[]): string {
+	return strings.reduce((prev, curr, i) => prev + toEscape[i - 1].replace(/~/g, '~0').replace(/\//g, '~1') + curr);
+}
+
 /**
  * Toggles "strict" flag, affects how we are parsing/generating URLs.
  * In strict mode we using "file://PATH", otherwise on Windows we are using "file:///PATH"