Use clearer name for csp webview element

mjbvz · mjbvz · commit c01a3a718d5d · 2019-07-09T11:45:20.000-07:00
microsoft#76489
diff --git a/extensions/markdown-language-features/src/features/preview.ts b/extensions/markdown-language-features/src/features/preview.ts
@@ -424,7 +424,7 @@ export class MarkdownPreview extends Disposable {
 			const self = this;
 			const resourceProvider: WebviewResourceProvider = {
 				toWebviewResource: (resource) => this.editor.webview.toWebviewResource(resource),
-				get cspRule() { return self.editor.webview.cspRule; }
+				get cspSource() { return self.editor.webview.cspSource; }
 			};
 			const content = await this._contentProvider.provideTextDocumentContent(document, resourceProvider, this._previewConfigurations, this.line, this.state);
 			// Another call to `doUpdate` may have happened.
diff --git a/extensions/markdown-language-features/src/features/previewContentProvider.ts b/extensions/markdown-language-features/src/features/previewContentProvider.ts
@@ -200,7 +200,7 @@ export class MarkdownContentProvider {
 		resource: vscode.Uri,
 		nonce: string
 	): string {
-		const rule = provider.cspRule;
+		const rule = provider.cspSource;
 		switch (this.cspArbiter.getSecurityLevelForResource(resource)) {
 			case MarkdownPreviewSecurityLevel.AllowInsecureContent:
 				return `<meta http-equiv="Content-Security-Policy" content="default-src 'none'; img-src 'self' ${rule} http: https: data:; media-src 'self' ${rule} http: https: data:; script-src 'nonce-${nonce}'; style-src 'self' ${rule} 'unsafe-inline' http: https: data:; font-src 'self' ${rule} http: https: data:;">`;
diff --git a/extensions/markdown-language-features/src/util/resources.ts b/extensions/markdown-language-features/src/util/resources.ts
@@ -8,5 +8,5 @@ import * as vscode from 'vscode';
 export interface WebviewResourceProvider {
 	toWebviewResource(resource: vscode.Uri): vscode.Uri;
 
-	readonly cspRule: string;
+	readonly cspSource: string;
 }
diff --git a/src/vs/platform/environment/common/environment.ts b/src/vs/platform/environment/common/environment.ts
@@ -172,5 +172,5 @@ export interface IEnvironmentService {
 
 	webviewEndpoint?: string;
 	readonly webviewResourceRoot: string;
-	readonly webviewCspRule: string;
+	readonly webviewCspSource: string;
 }
diff --git a/src/vs/platform/environment/node/environmentService.ts b/src/vs/platform/environment/node/environmentService.ts
@@ -279,7 +279,7 @@ export class EnvironmentService implements IEnvironmentService {
 	get driverVerbose(): boolean { return !!this._args['driver-verbose']; }
 
 	readonly webviewResourceRoot = 'vscode-resource:{{resource}}';
-	readonly webviewCspRule = 'vscode-resource:';
+	readonly webviewCspSource = 'vscode-resource:';
 
 	constructor(private _args: ParsedArgs, private _execPath: string) {
 		if (!process.env['VSCODE_LOGS']) {
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -1586,7 +1586,7 @@ declare module 'vscode' {
 		/**
 		 * Content security policy rule for webview resources.
 		 */
-		readonly cspRule: string;
+		readonly cspSource: string;
 	}
 
 	//#endregion
diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -60,7 +60,7 @@ export interface IEnvironment {
 	globalStorageHome: URI;
 	userHome: URI;
 	webviewResourceRoot: string;
-	webviewCspRule: string;
+	webviewCspSource: string;
 }
 
 export interface IStaticWorkspaceData {
diff --git a/src/vs/workbench/api/common/extHostCodeInsets.ts b/src/vs/workbench/api/common/extHostCodeInsets.ts
@@ -69,8 +69,8 @@ export class ExtHostEditorInsets implements ExtHostEditorInsetsShape {
 				return toWebviewResource(that._initData, this._uuid, resource);
 			}
 
-			get cspRule(): string {
-				return that._initData.webviewCspRule;
+			get cspSource(): string {
+				return that._initData.webviewCspSource;
 			}
 
 			set options(value: vscode.WebviewOptions) {
diff --git a/src/vs/workbench/api/common/extHostWebview.ts b/src/vs/workbench/api/common/extHostWebview.ts
@@ -41,8 +41,8 @@ export class ExtHostWebview implements vscode.Webview {
 		return toWebviewResource(this._initData, this._uuid, resource);
 	}
 
-	public get cspRule(): string {
-		return this._initData.webviewCspRule;
+	public get cspSource(): string {
+		return this._initData.webviewCspSource;
 	}
 
 	public get html(): string {
diff --git a/src/vs/workbench/api/common/shared/webview.ts b/src/vs/workbench/api/common/shared/webview.ts
@@ -8,7 +8,7 @@ import * as vscode from 'vscode';
 
 export interface WebviewInitData {
 	readonly webviewResourceRoot: string;
-	readonly webviewCspRule: string;
+	readonly webviewCspSource: string;
 }
 
 export function toWebviewResource(
diff --git a/src/vs/workbench/services/environment/browser/environmentService.ts b/src/vs/workbench/services/environment/browser/environmentService.ts
@@ -150,7 +150,7 @@ export class BrowserWorkbenchEnvironmentService implements IEnvironmentService {
 		return this.webviewEndpoint ? this.webviewEndpoint + '/vscode-resource{{resource}}' : 'vscode-resource:{{resource}}';
 	}
 
-	get webviewCspRule(): string {
+	get webviewCspSource(): string {
 		return this.webviewEndpoint ? this.webviewEndpoint : 'vscode-resource:';
 	}
 }
diff --git a/src/vs/workbench/services/extensions/common/remoteExtensionHostClient.ts b/src/vs/workbench/services/extensions/common/remoteExtensionHostClient.ts
@@ -191,7 +191,7 @@ export class RemoteExtensionHostClient extends Disposable implements IExtensionH
 					globalStorageHome: remoteExtensionHostData.globalStorageHome,
 					userHome: remoteExtensionHostData.userHome,
 					webviewResourceRoot: this._environmentService.webviewResourceRoot,
-					webviewCspRule: this._environmentService.webviewCspRule,
+					webviewCspSource: this._environmentService.webviewCspSource,
 				},
 				workspace: this._contextService.getWorkbenchState() === WorkbenchState.EMPTY ? null : {
 					configuration: workspace.configuration,
diff --git a/src/vs/workbench/services/extensions/electron-browser/extensionHost.ts b/src/vs/workbench/services/extensions/electron-browser/extensionHost.ts
@@ -401,7 +401,7 @@ export class ExtensionHostProcessWorker implements IExtensionHostStarter {
 						globalStorageHome: URI.file(this._environmentService.globalStorageHome),
 						userHome: URI.file(this._environmentService.userHome),
 						webviewResourceRoot: this._environmentService.webviewResourceRoot,
-						webviewCspRule: this._environmentService.webviewCspRule,
+						webviewCspSource: this._environmentService.webviewCspSource,
 					},
 					workspace: this._contextService.getWorkbenchState() === WorkbenchState.EMPTY ? undefined : {
 						configuration: withNullAsUndefined(workspace.configuration),
diff --git a/src/vs/workbench/test/electron-browser/api/extHostWebview.test.ts b/src/vs/workbench/test/electron-browser/api/extHostWebview.test.ts
@@ -18,7 +18,7 @@ suite('ExtHostWebview', () => {
 		const viewType = 'view.type';
 
 		const shape = createNoopMainThreadWebviews();
-		const extHostWebviews = new ExtHostWebviews(SingleProxyRPCProtocol(shape), { webviewCspRule: '', webviewResourceRoot: '' });
+		const extHostWebviews = new ExtHostWebviews(SingleProxyRPCProtocol(shape), { webviewCspSource: '', webviewResourceRoot: '' });
 
 		let lastInvokedDeserializer: vscode.WebviewPanelSerializer | undefined = undefined;
 
@@ -51,7 +51,7 @@ suite('ExtHostWebview', () => {
 	test('toWebviewResource for desktop vscode-resource scheme', () => {
 		const shape = createNoopMainThreadWebviews();
 		const extHostWebviews = new ExtHostWebviews(SingleProxyRPCProtocol(shape), {
-			webviewCspRule: '',
+			webviewCspSource: '',
 			webviewResourceRoot: 'vscode-resource:{{resource}}'
 		});
 		const webview = extHostWebviews.createWebviewPanel({} as any, 'type', 'title', 1, {});
@@ -91,7 +91,7 @@ suite('ExtHostWebview', () => {
 		const shape = createNoopMainThreadWebviews();
 
 		const extHostWebviews = new ExtHostWebviews(SingleProxyRPCProtocol(shape), {
-			webviewCspRule: '',
+			webviewCspSource: '',
 			webviewResourceRoot: `https://{{uuid}}.webview.contoso.com/commit{{resource}}`
 		});
 		const webview = extHostWebviews.createWebviewPanel({} as any, 'type', 'title', 1, {});

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@ import * as vscode from 'vscode';`
`8`	`8`	`export interface WebviewResourceProvider {`
`9`	`9`	`toWebviewResource(resource: vscode.Uri): vscode.Uri;`
`10`	`10`
`11`		`- readonly cspRule: string;`
	`11`	`+ readonly cspSource: string;`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -172,5 +172,5 @@ export interface IEnvironmentService {`
`172`	`172`
`173`	`173`	`webviewEndpoint?: string;`
`174`	`174`	`readonly webviewResourceRoot: string;`
`175`		`- readonly webviewCspRule: string;`
	`175`	`+ readonly webviewCspSource: string;`
`176`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1586,7 +1586,7 @@ declare module 'vscode' {`
`1586`	`1586`	`/**`
`1587`	`1587`	`* Content security policy rule for webview resources.`
`1588`	`1588`	`*/`
`1589`		`- readonly cspRule: string;`
	`1589`	`+ readonly cspSource: string;`
`1590`	`1590`	`}`
`1591`	`1591`
`1592`	`1592`	`//#endregion`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ export interface IEnvironment {`
`60`	`60`	`globalStorageHome: URI;`
`61`	`61`	`userHome: URI;`
`62`	`62`	`webviewResourceRoot: string;`
`63`		`- webviewCspRule: string;`
	`63`	`+ webviewCspSource: string;`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`export interface IStaticWorkspaceData {`
Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,8 @@ export class ExtHostEditorInsets implements ExtHostEditorInsetsShape {`
`69`	`69`	`return toWebviewResource(that._initData, this._uuid, resource);`
`70`	`70`	`}`
`71`	`71`
`72`		`- get cspRule(): string {`
`73`		`- return that._initData.webviewCspRule;`
	`72`	`+ get cspSource(): string {`
	`73`	`+ return that._initData.webviewCspSource;`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`set options(value: vscode.WebviewOptions) {`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ export class ExtHostWebview implements vscode.Webview {`
`41`	`41`	`return toWebviewResource(this._initData, this._uuid, resource);`
`42`	`42`	`}`
`43`	`43`
`44`		`- public get cspRule(): string {`
`45`		`- return this._initData.webviewCspRule;`
	`44`	`+ public get cspSource(): string {`
	`45`	`+ return this._initData.webviewCspSource;`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`public get html(): string {`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import * as vscode from 'vscode';`
`8`	`8`
`9`	`9`	`export interface WebviewInitData {`
`10`	`10`	`readonly webviewResourceRoot: string;`
`11`		`- readonly webviewCspRule: string;`
	`11`	`+ readonly webviewCspSource: string;`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`export function toWebviewResource(`