Fixes #503: Can we allow isTrusted configuration for MarkdownString?

microsoft · Oct 7, 2020 · 9c9d6ec · 9c9d6ec
1 parent f933432
commit 9c9d6ec
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 12 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -9,6 +9,9 @@
 				"kind": "build",
 				"isDefault": true
 			},
+			"runOptions": {
+				"runOn": "folderOpen"
+			},
 			"isBackground": true,
 			"presentation": {
 				"panel": "dedicated",

diff --git a/client-node-tests/src/converter.test.ts b/client-node-tests/src/converter.test.ts
@@ -15,7 +15,7 @@ import * as vscode from 'vscode';
 import { CompletionItemTag, SymbolTag } from 'vscode-languageserver-protocol';
 
 const c2p: codeConverter.Converter = codeConverter.createConverter();
-const p2c: protocolConverter.Converter = protocolConverter.createConverter();
+const p2c: protocolConverter.Converter = protocolConverter.createConverter(undefined, false);
 
 interface InsertReplaceRange {
 	inserting: vscode.Range;
@@ -919,7 +919,7 @@ suite('Protocol Converter', () => {
 	test('Uri Rewrite', () => {
 		let converter = protocolConverter.createConverter((value: string) => {
 			return vscode.Uri.parse(`${value}.vscode`);
-		});
+		}, false);
 
 		let result = converter.asUri('file://localhost/folder/file');
 		strictEqual('file://localhost/folder/file.vscode', result.toString());

diff --git a/client/src/common/client.ts b/client/src/common/client.ts
@@ -517,6 +517,9 @@ export interface LanguageClientOptions {
 	};
 	workspaceFolder?: VWorkspaceFolder;
 	connectionOptions?: ConnectionOptions;
+	markdown?: {
+		isTrusted?: boolean;
+	}
 }
 
 interface ResolvedClientOptions {
@@ -537,6 +540,9 @@ interface ResolvedClientOptions {
 	};
 	workspaceFolder?: VWorkspaceFolder;
 	connectionOptions?: ConnectionOptions;
+	markdown: {
+		isTrusted: boolean;
+	}
 }
 
 export enum State {
@@ -2616,6 +2622,11 @@ export abstract class BaseLanguageClient {
 
 		clientOptions = clientOptions || {};
 
+		const markdown = { isTrusted: false };
+		if (clientOptions.markdown !== undefined && clientOptions.markdown.isTrusted === true) {
+			markdown.isTrusted = true;
+		}
+
 		this._clientOptions = {
 			documentSelector: clientOptions.documentSelector || [],
 			synchronize: clientOptions.synchronize || {},
@@ -2630,7 +2641,8 @@ export abstract class BaseLanguageClient {
 			middleware: clientOptions.middleware || {},
 			uriConverters: clientOptions.uriConverters,
 			workspaceFolder: clientOptions.workspaceFolder,
-			connectionOptions: clientOptions.connectionOptions
+			connectionOptions: clientOptions.connectionOptions,
+			markdown
 		};
 		this._clientOptions.synchronize = this._clientOptions.synchronize || {};
 
@@ -2669,7 +2681,7 @@ export abstract class BaseLanguageClient {
 			},
 		};
 		this._c2p = c2p.createConverter(clientOptions.uriConverters ? clientOptions.uriConverters.code2Protocol : undefined);
-		this._p2c = p2c.createConverter(clientOptions.uriConverters ? clientOptions.uriConverters.protocol2Code : undefined);
+		this._p2c = p2c.createConverter(clientOptions.uriConverters ? clientOptions.uriConverters.protocol2Code : undefined, this._clientOptions.markdown.isTrusted);
 		this._syncedDocuments = new Map<string, TextDocument>();
 		this.registerBuiltinFeatures();
 	}

diff --git a/client/src/common/protocolConverter.ts b/client/src/common/protocolConverter.ts
@@ -243,7 +243,9 @@ namespace CodeBlock {
 	}
 }
 
-export function createConverter(uriConverter?: URIConverter): Converter {
+export function createConverter(uriConverter: URIConverter | undefined, trustMarkdown: boolean | undefined): Converter {
+
+	trustMarkdown = !trustMarkdown;
 
 	const nullConverter = (value: string) => code.Uri.parse(value);
 
@@ -348,14 +350,14 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 
 	function asHoverContent(value: ls.MarkedString | ls.MarkedString[] | ls.MarkupContent): code.MarkdownString | code.MarkdownString[] {
 		if (Is.string(value)) {
-			return new code.MarkdownString(value);
+			return asMarkdownString(value);
 		} else if (CodeBlock.is(value)) {
-			let result = new code.MarkdownString();
+			let result = asMarkdownString();
 			return result.appendCodeblock(value.value, value.language);
 		} else if (Array.isArray(value)) {
 			let result: code.MarkdownString[] = [];
 			for (let element of value) {
-				let item = new code.MarkdownString();
+				let item = asMarkdownString();
 				if (CodeBlock.is(element)) {
 					item.appendCodeblock(element.value, element.language);
 				} else {
@@ -368,13 +370,13 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 			let result: code.MarkdownString;
 			switch (value.kind) {
 				case ls.MarkupKind.Markdown:
-					return new code.MarkdownString(value.value);
+					return asMarkdownString(value.value);
 				case ls.MarkupKind.PlainText:
-					result = new code.MarkdownString();
+					result = asMarkdownString();
 					result.appendText(value.value);
 					return result;
 				default:
-					result = new code.MarkdownString();
+					result = asMarkdownString();
 					result.appendText(`Unsupported Markup content received. Kind is: ${value.kind}`);
 					return result;
 			}
@@ -387,7 +389,7 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 		} else {
 			switch (value.kind) {
 				case ls.MarkupKind.Markdown:
-					return new code.MarkdownString(value.value);
+					return asMarkdownString(value.value);
 				case ls.MarkupKind.PlainText:
 					return value.value;
 				default:
@@ -396,6 +398,14 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 		}
 	}
 
+	function asMarkdownString(value?: string): code.MarkdownString {
+		const result = new code.MarkdownString(value);
+		if (trustMarkdown === true) {
+			result.isTrusted = trustMarkdown;
+		}
+		return result;
+	}
+
 	function asHover(hover: ls.Hover): code.Hover;
 	function asHover(hover: undefined | null): undefined;
 	function asHover(hover: ls.Hover | undefined | null): code.Hover | undefined;