1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as assert from 'assert';
import { Schemas } from 'vs/base/common/network';
import { URI } from 'vs/base/common/uri';
import { mock } from 'vs/base/test/common/mock';
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
import { NullLogService } from 'vs/platform/log/common/log';
import { MainThreadWebviewManager } from 'vs/workbench/api/browser/mainThreadWebviewManager';
import { IExtHostContext } from 'vs/workbench/services/extensions/common/extHostCustomers';
import { NullApiDeprecationService } from 'vs/workbench/api/common/extHostApiDeprecationService';
import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
import { ExtHostWebviews } from 'vs/workbench/api/common/extHostWebview';
import { ExtHostWebviewPanels } from 'vs/workbench/api/common/extHostWebviewPanels';
import { decodeAuthority, webviewResourceBaseHost } from 'vs/workbench/common/webview';
import { EditorGroupColumn } from 'vs/workbench/services/editor/common/editorGroupColumn';
import type * as vscode from 'vscode';
import { SingleProxyRPCProtocol } from 'vs/workbench/api/test/common/testRPCProtocol';
suite('ExtHostWebview', () => {
let rpcProtocol: (IExtHostRpcService & IExtHostContext) | undefined;
setup(() => {
const shape = createNoopMainThreadWebviews();
rpcProtocol = SingleProxyRPCProtocol(shape);
});
test('Cannot register multiple serializers for the same view type', async () => {
const viewType = 'view.type';
const extHostWebviews = new ExtHostWebviews(rpcProtocol!, { authority: undefined, isRemote: false }, undefined, new NullLogService(), NullApiDeprecationService);
const extHostWebviewPanels = new ExtHostWebviewPanels(rpcProtocol!, extHostWebviews, undefined);
let lastInvokedDeserializer: vscode.WebviewPanelSerializer | undefined = undefined;
class NoopSerializer implements vscode.WebviewPanelSerializer {
async deserializeWebviewPanel(_webview: vscode.WebviewPanel, _state: any): Promise<void> {
lastInvokedDeserializer = this;
}
}
const extension = {} as IExtensionDescription;
const serializerA = new NoopSerializer();
const serializerB = new NoopSerializer();
const serializerARegistration = extHostWebviewPanels.registerWebviewPanelSerializer(extension, viewType, serializerA);
await extHostWebviewPanels.$deserializeWebviewPanel('x', viewType, {
title: 'title',
state: {},
panelOptions: {},
webviewOptions: {},
active: true,
}, 0 as EditorGroupColumn);
assert.strictEqual(lastInvokedDeserializer, serializerA);
assert.throws(
() => extHostWebviewPanels.registerWebviewPanelSerializer(extension, viewType, serializerB),
'Should throw when registering two serializers for the same view');
serializerARegistration.dispose();
extHostWebviewPanels.registerWebviewPanelSerializer(extension, viewType, serializerB);
await extHostWebviewPanels.$deserializeWebviewPanel('x', viewType, {
title: 'title',
state: {},
panelOptions: {},
webviewOptions: {},
active: true,
}, 0 as EditorGroupColumn);
assert.strictEqual(lastInvokedDeserializer, serializerB);
});
test('asWebviewUri for local file paths', () => {
const webview = createWebview(rpcProtocol, /* remoteAuthority */undefined);
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file:///Users/codey/file.html')).toString()),
`https://file%2B.vscode-resource.${webviewResourceBaseHost}/Users/codey/file.html`,
'Unix basic'
);
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file:///Users/codey/file.html#frag')).toString()),
`https://file%2B.vscode-resource.${webviewResourceBaseHost}/Users/codey/file.html#frag`,
'Unix should preserve fragment'
);
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file:///Users/codey/f%20ile.html')).toString()),
`https://file%2B.vscode-resource.${webviewResourceBaseHost}/Users/codey/f%20ile.html`,
'Unix with encoding'
);
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file://localhost/Users/codey/file.html')).toString()),
`https://file%2Blocalhost.vscode-resource.${webviewResourceBaseHost}/Users/codey/file.html`,
'Unix should preserve authority'
);
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file:///c:/codey/file.txt')).toString()),
`https://file%2B.vscode-resource.${webviewResourceBaseHost}/c%3A/codey/file.txt`,
'Windows C drive'
);
});
test('asWebviewUri for remote file paths', () => {
const webview = createWebview(rpcProtocol, /* remoteAuthority */ 'remote');
assert.strictEqual(
(webview.webview.asWebviewUri(URI.parse('file:///Users/codey/file.html')).toString()),
`https://vscode-remote%2Bremote.vscode-resource.${webviewResourceBaseHost}/Users/codey/file.html`,
'Unix basic'
);
});
test('asWebviewUri for remote with / and + in name', () => {
const webview = createWebview(rpcProtocol, /* remoteAuthority */ 'remote');
const authority = 'ssh-remote+localhost=foo/bar';
const sourceUri = URI.from({
scheme: 'vscode-remote',
authority: authority,
path: '/Users/cody/x.png'
});
const webviewUri = webview.webview.asWebviewUri(sourceUri);
assert.strictEqual(
webviewUri.toString(),
`https://vscode-remote%2Bssh-002dremote-002blocalhost-003dfoo-002fbar.vscode-resource.vscode-cdn.net/Users/cody/x.png`,
'Check transform');
assert.strictEqual(
decodeAuthority(webviewUri.authority),
`vscode-remote+${authority}.vscode-resource.vscode-cdn.net`,
'Check decoded authority'
);
});
test('asWebviewUri for remote with port in name', () => {
const webview = createWebview(rpcProtocol, /* remoteAuthority */ 'remote');
const authority = 'localhost:8080';
const sourceUri = URI.from({
scheme: 'vscode-remote',
authority: authority,
path: '/Users/cody/x.png'
});
const webviewUri = webview.webview.asWebviewUri(sourceUri);
assert.strictEqual(
webviewUri.toString(),
`https://vscode-remote%2Blocalhost-003a8080.vscode-resource.vscode-cdn.net/Users/cody/x.png`,
'Check transform');
assert.strictEqual(
decodeAuthority(webviewUri.authority),
`vscode-remote+${authority}.vscode-resource.vscode-cdn.net`,
'Check decoded authority'
);
});
});
function createWebview(rpcProtocol: (IExtHostRpcService & IExtHostContext) | undefined, remoteAuthority: string | undefined) {
const extHostWebviews = new ExtHostWebviews(rpcProtocol!, {
authority: remoteAuthority,
isRemote: !!remoteAuthority,
}, undefined, new NullLogService(), NullApiDeprecationService);
const extHostWebviewPanels = new ExtHostWebviewPanels(rpcProtocol!, extHostWebviews, undefined);
const webview = extHostWebviewPanels.createWebviewPanel({
extensionLocation: URI.from({
scheme: remoteAuthority ? Schemas.vscodeRemote : Schemas.file,
authority: remoteAuthority,
path: '/ext/path',
})
} as IExtensionDescription, 'type', 'title', 1, {});
return webview;
}
function createNoopMainThreadWebviews() {
return new class extends mock<MainThreadWebviewManager>() {
$createWebviewPanel() { /* noop */ }
$registerSerializer() { /* noop */ }
$unregisterSerializer() { /* noop */ }
};
}
|
