commit 563918458879d7e5d7cb82d783ce5585000395b8
author Hana <hyangah@gmail.com> Tue Apr 20 23:45:15 2021 -0400
committer Hyang-Ah Hana Kim <hyangah@gmail.com> Wed Apr 21 17:09:58 2021 +0000
tree 1b00286167aa6c873be55eca5f70afe169bf7a72
parent aabfc9f60102b4e3c097aede9ca45d216c77e8d1

src/welcome: avoid vscode.Uri.joinPath

Fixes golang/vscode-go#1444

Change-Id: Icbcfbe1440b9eb08ea2b0eeb6883448704fd0786
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/312110
Trust: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Suzy Mueller <suzmue@golang.org>

src/welcome.ts

diff --git a/src/welcome.ts b/src/welcome.ts
index c03aa5b..cd26378 100644
--- a/src/welcome.ts
+++ b/src/welcome.ts
@@ -8,8 +8,8 @@
 // https://github.com/microsoft/vscode-extension-samples/tree/master/webview-sample
 
 import vscode = require('vscode');
+import path = require('path');
 import { extensionId } from './const';
-
 export class WelcomePanel {
 	public static currentPanel: WelcomePanel | undefined;
 
@@ -34,10 +34,10 @@
 				enableScripts: true,
 
 				// And restrict the webview to only loading content from our extension's directory.
-				localResourceRoots: [vscode.Uri.joinPath(extensionUri)]
+				localResourceRoots: [joinPath(extensionUri)]
 			}
 		);
-		panel.iconPath = vscode.Uri.joinPath(extensionUri, 'media', 'go-logo-blue.png');
+		panel.iconPath = joinPath(extensionUri, 'media', 'go-logo-blue.png');
 
 		WelcomePanel.currentPanel = new WelcomePanel(panel, extensionUri);
 	}
@@ -46,15 +46,15 @@
 		WelcomePanel.currentPanel = new WelcomePanel(panel, extensionUri);
 	}
 
+	public readonly dataroot: vscode.Uri; // exported for testing.
 	private readonly panel: vscode.WebviewPanel;
 	private readonly extensionUri: vscode.Uri;
-	private readonly dataroot: vscode.Uri;
 	private disposables: vscode.Disposable[] = [];
 
 	private constructor(panel: vscode.WebviewPanel, extensionUri: vscode.Uri) {
 		this.panel = panel;
 		this.extensionUri = extensionUri;
-		this.dataroot = vscode.Uri.joinPath(this.extensionUri, 'media');
+		this.dataroot = joinPath(this.extensionUri, 'media');
 
 		// Set the webview's initial html content
 		this.update();
@@ -72,7 +72,7 @@
 						vscode.window.showErrorMessage(message.text);
 						return;
 					case 'openDocument':
-						const uri = vscode.Uri.joinPath(this.extensionUri, message.document);
+						const uri = joinPath(this.extensionUri, message.document);
 						vscode.commands.executeCommand('markdown.showPreviewToSide', uri);
 						return;
 					case 'openSetting':
@@ -106,9 +106,9 @@
 
 	private getHtmlForWebview(webview: vscode.Webview) {
 		// Local path to css styles and images
-		const scriptPathOnDisk = vscode.Uri.joinPath(this.dataroot, 'welcome.js');
-		const stylePath = vscode.Uri.joinPath(this.dataroot, 'welcome.css');
-		const gopherPath = vscode.Uri.joinPath(this.dataroot, 'go-logo-blue.png');
+		const scriptPathOnDisk = joinPath(this.dataroot, 'welcome.js');
+		const stylePath = joinPath(this.dataroot, 'welcome.css');
+		const gopherPath = joinPath(this.dataroot, 'go-logo-blue.png');
 		const goExtension = vscode.extensions.getExtension(extensionId)!;
 		const goExtensionVersion = goExtension.packageJSON.version;
 
@@ -194,3 +194,13 @@
 	}
 	return text;
 }
+
+function joinPath(uri: vscode.Uri, ...pathFragment: string[]): vscode.Uri {
+	// Reimplementation of
+	// https://github.com/microsoft/vscode/blob/b251bd952b84a3bdf68dad0141c37137dac55d64/src/vs/base/common/uri.ts#L346-L357
+	// with Node.JS path. This is a temporary workaround for https://github.com/eclipse-theia/theia/issues/8752.
+	if (!uri.path) {
+		throw new Error('[UriError]: cannot call joinPaths on URI without path');
+	}
+	return uri.with({ path: vscode.Uri.file(path.join(uri.fsPath, ...pathFragment)).path });
+}

test/integration/welcome.test.ts

diff --git a/test/integration/welcome.test.ts b/test/integration/welcome.test.ts
index c85ede7..48aff48 100644
--- a/test/integration/welcome.test.ts
+++ b/test/integration/welcome.test.ts
@@ -3,8 +3,11 @@
  * Licensed under the MIT License. See LICENSE in the project root for license information.
  *--------------------------------------------------------*/
 
+import vscode = require('vscode');
 import * as assert from 'assert';
 import { shouldShowGoWelcomePage } from '../../src/goMain';
+import { extensionId } from '../../src/const';
+import { WelcomePanel } from '../../src/welcome';
 
 suite('WelcomePanel Tests', () => {
 	// 0:showVersions, 1:newVersion, 2:oldVersion, 3:expected
@@ -55,3 +58,13 @@
 		});
 	});
 });
+
+suite('joinPath Tests', () => {
+	test('WelcomePanel dataroot is set as expected', () => {
+		const uri = vscode.extensions.getExtension(extensionId).extensionUri;
+		WelcomePanel.createOrShow(uri);
+		const got = WelcomePanel.currentPanel.dataroot;
+		const want = vscode.Uri.joinPath(uri, 'media');
+		assert.strictEqual(got.toString(), want.toString());
+	});
+});