mirror of
https://github.com/Microsoft/vscode
synced 2024-10-30 09:08:46 +00:00
Web: implement browser extension debug service properly (fixes #81493)
This commit is contained in:
parent
715cdf7c63
commit
07ee925337
5 changed files with 195 additions and 56 deletions
|
@ -202,27 +202,41 @@ class PollingURLCallbackProvider extends Disposable implements IURLCallbackProvi
|
||||||
|
|
||||||
class WorkspaceProvider implements IWorkspaceProvider {
|
class WorkspaceProvider implements IWorkspaceProvider {
|
||||||
|
|
||||||
constructor(public readonly workspace: IWorkspace) { }
|
static QUERY_PARAM_EMPTY_WINDOW = 'ew';
|
||||||
|
static QUERY_PARAM_FOLDER = 'folder';
|
||||||
|
static QUERY_PARAM_WORKSPACE = 'workspace';
|
||||||
|
|
||||||
async open(workspace: IWorkspace, options?: { reuse?: boolean }): Promise<void> {
|
constructor(
|
||||||
if (options && options.reuse && this.isSame(this.workspace, workspace)) {
|
public readonly workspace: IWorkspace,
|
||||||
return; // return early if workspace is not changing and we are reusing window
|
public readonly environment: ReadonlyMap<string, string>
|
||||||
|
) { }
|
||||||
|
|
||||||
|
async open(workspace: IWorkspace, options?: { reuse?: boolean, environment?: Map<string, string> }): Promise<void> {
|
||||||
|
if (options && options.reuse && !options.environment && this.isSame(this.workspace, workspace)) {
|
||||||
|
return; // return early if workspace and environment is not changing and we are reusing window
|
||||||
}
|
}
|
||||||
|
|
||||||
// Empty
|
// Empty
|
||||||
let targetHref: string | undefined = undefined;
|
let targetHref: string | undefined = undefined;
|
||||||
if (!workspace) {
|
if (!workspace) {
|
||||||
targetHref = `${document.location.origin}${document.location.pathname}?ew=true`;
|
targetHref = `${document.location.origin}${document.location.pathname}?${WorkspaceProvider.QUERY_PARAM_EMPTY_WINDOW}=true`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Folder
|
// Folder
|
||||||
else if (isFolderToOpen(workspace)) {
|
else if (isFolderToOpen(workspace)) {
|
||||||
targetHref = `${document.location.origin}${document.location.pathname}?folder=${workspace.folderUri.path}`;
|
targetHref = `${document.location.origin}${document.location.pathname}?${WorkspaceProvider.QUERY_PARAM_FOLDER}=${workspace.folderUri.path}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Workspace
|
// Workspace
|
||||||
else if (isWorkspaceToOpen(workspace)) {
|
else if (isWorkspaceToOpen(workspace)) {
|
||||||
targetHref = `${document.location.origin}${document.location.pathname}?workspace=${workspace.workspaceUri.path}`;
|
targetHref = `${document.location.origin}${document.location.pathname}?${WorkspaceProvider.QUERY_PARAM_WORKSPACE}=${workspace.workspaceUri.path}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Environment
|
||||||
|
if (options && options.environment) {
|
||||||
|
for (const [key, value] of options.environment) {
|
||||||
|
targetHref += `&${key}=${encodeURIComponent(value)}`;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (targetHref) {
|
if (targetHref) {
|
||||||
|
@ -255,21 +269,53 @@ class WorkspaceProvider implements IWorkspaceProvider {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const configElement = document.getElementById('vscode-workbench-web-configuration');
|
(function () {
|
||||||
const configElementAttribute = configElement ? configElement.getAttribute('data-settings') : undefined;
|
|
||||||
if (!configElement || !configElementAttribute) {
|
|
||||||
throw new Error('Missing web configuration element');
|
|
||||||
}
|
|
||||||
|
|
||||||
const options: IWorkbenchConstructionOptions & { folderUri?: UriComponents, workspaceUri?: UriComponents } = JSON.parse(configElementAttribute);
|
// Find config element in DOM
|
||||||
options.workspaceProvider = new WorkspaceProvider(options.folderUri ? { folderUri: URI.revive(options.folderUri) } : options.workspaceUri ? { workspaceUri: URI.revive(options.workspaceUri) } : undefined);
|
const configElement = document.getElementById('vscode-workbench-web-configuration');
|
||||||
options.urlCallbackProvider = new PollingURLCallbackProvider();
|
const configElementAttribute = configElement ? configElement.getAttribute('data-settings') : undefined;
|
||||||
options.credentialsProvider = new LocalStorageCredentialsProvider();
|
if (!configElement || !configElementAttribute) {
|
||||||
|
throw new Error('Missing web configuration element');
|
||||||
|
}
|
||||||
|
|
||||||
if (Array.isArray(options.staticExtensions)) {
|
const options: IWorkbenchConstructionOptions & { folderUri?: UriComponents, workspaceUri?: UriComponents } = JSON.parse(configElementAttribute);
|
||||||
options.staticExtensions.forEach(extension => {
|
|
||||||
extension.extensionLocation = URI.revive(extension.extensionLocation);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
create(document.body, options);
|
// Determine workspace to open
|
||||||
|
let workspace: IWorkspace;
|
||||||
|
if (options.folderUri) {
|
||||||
|
workspace = { folderUri: URI.revive(options.folderUri) };
|
||||||
|
} else if (options.workspaceUri) {
|
||||||
|
workspace = { workspaceUri: URI.revive(options.workspaceUri) };
|
||||||
|
} else {
|
||||||
|
workspace = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find environmental properties
|
||||||
|
const environment = new Map<string, string>();
|
||||||
|
if (document && document.location && document.location.search) {
|
||||||
|
const query = document.location.search.substring(1);
|
||||||
|
const vars = query.split('&');
|
||||||
|
for (let p of vars) {
|
||||||
|
const pair = p.split('=');
|
||||||
|
if (pair.length === 2) {
|
||||||
|
const [key, value] = pair;
|
||||||
|
if (key !== WorkspaceProvider.QUERY_PARAM_EMPTY_WINDOW && key !== WorkspaceProvider.QUERY_PARAM_FOLDER && key !== WorkspaceProvider.QUERY_PARAM_WORKSPACE) {
|
||||||
|
environment.set(key, decodeURIComponent(value));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
options.workspaceProvider = new WorkspaceProvider(workspace, environment);
|
||||||
|
options.urlCallbackProvider = new PollingURLCallbackProvider();
|
||||||
|
options.credentialsProvider = new LocalStorageCredentialsProvider();
|
||||||
|
|
||||||
|
if (Array.isArray(options.staticExtensions)) {
|
||||||
|
options.staticExtensions.forEach(extension => {
|
||||||
|
extension.extensionLocation = URI.revive(extension.extensionLocation);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Finally create workbench
|
||||||
|
create(document.body, options);
|
||||||
|
})();
|
||||||
|
|
|
@ -5,7 +5,6 @@
|
||||||
|
|
||||||
import { ExtensionHostDebugChannelClient, ExtensionHostDebugBroadcastChannel } from 'vs/platform/debug/common/extensionHostDebugIpc';
|
import { ExtensionHostDebugChannelClient, ExtensionHostDebugBroadcastChannel } from 'vs/platform/debug/common/extensionHostDebugIpc';
|
||||||
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
|
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
|
||||||
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
|
|
||||||
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
|
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
|
||||||
import { IExtensionHostDebugService } from 'vs/platform/debug/common/extensionHostDebug';
|
import { IExtensionHostDebugService } from 'vs/platform/debug/common/extensionHostDebug';
|
||||||
import { IDebugHelperService } from 'vs/workbench/contrib/debug/common/debug';
|
import { IDebugHelperService } from 'vs/workbench/contrib/debug/common/debug';
|
||||||
|
@ -13,17 +12,19 @@ import { IConfigurationService } from 'vs/platform/configuration/common/configur
|
||||||
import { TelemetryService } from 'vs/platform/telemetry/common/telemetryService';
|
import { TelemetryService } from 'vs/platform/telemetry/common/telemetryService';
|
||||||
import { IChannel } from 'vs/base/parts/ipc/common/ipc';
|
import { IChannel } from 'vs/base/parts/ipc/common/ipc';
|
||||||
import { Event } from 'vs/base/common/event';
|
import { Event } from 'vs/base/common/event';
|
||||||
import { IProcessEnvironment } from 'vs/base/common/platform';
|
|
||||||
import { URI } from 'vs/base/common/uri';
|
import { URI } from 'vs/base/common/uri';
|
||||||
|
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
|
||||||
|
import { IWorkspaceProvider, IWorkspace } from 'vs/workbench/services/host/browser/browserHostService';
|
||||||
|
|
||||||
class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient implements IExtensionHostDebugService {
|
class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient implements IExtensionHostDebugService {
|
||||||
|
|
||||||
|
private workspaceProvider: IWorkspaceProvider;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
@IRemoteAgentService remoteAgentService: IRemoteAgentService,
|
@IRemoteAgentService remoteAgentService: IRemoteAgentService,
|
||||||
@IEnvironmentService environmentService: IEnvironmentService
|
@IWorkbenchEnvironmentService environmentService: IWorkbenchEnvironmentService
|
||||||
) {
|
) {
|
||||||
const connection = remoteAgentService.getConnection();
|
const connection = remoteAgentService.getConnection();
|
||||||
|
|
||||||
let channel: IChannel;
|
let channel: IChannel;
|
||||||
if (connection) {
|
if (connection) {
|
||||||
channel = connection.getChannel(ExtensionHostDebugBroadcastChannel.ChannelName);
|
channel = connection.getChannel(ExtensionHostDebugBroadcastChannel.ChannelName);
|
||||||
|
@ -35,11 +36,26 @@ class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient i
|
||||||
|
|
||||||
super(channel);
|
super(channel);
|
||||||
|
|
||||||
|
if (environmentService.options && environmentService.options.workspaceProvider) {
|
||||||
|
this.workspaceProvider = environmentService.options.workspaceProvider;
|
||||||
|
} else {
|
||||||
|
this.workspaceProvider = { open: async () => undefined, workspace: undefined };
|
||||||
|
console.warn('Extension Host Debugging not available due to missing workspace provider.');
|
||||||
|
}
|
||||||
|
|
||||||
|
this.registerListeners(environmentService);
|
||||||
|
}
|
||||||
|
|
||||||
|
private registerListeners(environmentService: IWorkbenchEnvironmentService): void {
|
||||||
|
|
||||||
|
// Reload window on reload request
|
||||||
this._register(this.onReload(event => {
|
this._register(this.onReload(event => {
|
||||||
if (environmentService.isExtensionDevelopment && environmentService.debugExtensionHost.debugId === event.sessionId) {
|
if (environmentService.isExtensionDevelopment && environmentService.debugExtensionHost.debugId === event.sessionId) {
|
||||||
window.location.reload();
|
window.location.reload();
|
||||||
}
|
}
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
// Close window on close request
|
||||||
this._register(this.onClose(event => {
|
this._register(this.onClose(event => {
|
||||||
if (environmentService.isExtensionDevelopment && environmentService.debugExtensionHost.debugId === event.sessionId) {
|
if (environmentService.isExtensionDevelopment && environmentService.debugExtensionHost.debugId === event.sessionId) {
|
||||||
window.close();
|
window.close();
|
||||||
|
@ -47,7 +63,45 @@ class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient i
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
openExtensionDevelopmentHostWindow(args: string[], env: IProcessEnvironment): Promise<void> {
|
async openExtensionDevelopmentHostWindow(args: string[]): Promise<void> {
|
||||||
|
if (!this.workspaceProvider.environment) {
|
||||||
|
// TODO@Ben remove me once environment is adopted
|
||||||
|
return this.openExtensionDevelopmentHostWindowLegacy(args);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find out which workspace to open debug window on
|
||||||
|
let debugWorkspace: IWorkspace = undefined;
|
||||||
|
const folderUriArg = this.findArgument('folder-uri', args);
|
||||||
|
if (folderUriArg) {
|
||||||
|
debugWorkspace = { folderUri: URI.parse(folderUriArg) };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add environment parameters required for debug to work
|
||||||
|
const environment = new Map<string, string>();
|
||||||
|
|
||||||
|
const extensionDevelopmentPath = this.findArgument('extensionDevelopmentPath', args);
|
||||||
|
if (extensionDevelopmentPath) {
|
||||||
|
environment.set('extensionDevelopmentPath', extensionDevelopmentPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
const debugId = this.findArgument('debugId', args);
|
||||||
|
if (debugId) {
|
||||||
|
environment.set('debugId', debugId);
|
||||||
|
}
|
||||||
|
|
||||||
|
const inspectBrkExtensions = this.findArgument('inspect-brk-extensions', args);
|
||||||
|
if (inspectBrkExtensions) {
|
||||||
|
environment.set('inspect-brk-extensions', inspectBrkExtensions);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open debug window as new window. Pass ParsedArgs over.
|
||||||
|
this.workspaceProvider.open(debugWorkspace, {
|
||||||
|
reuse: false, // debugging always requires a new window
|
||||||
|
environment // mandatory properties to enable debugging
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private async openExtensionDevelopmentHostWindowLegacy(args: string[]): Promise<void> {
|
||||||
// we pass the "args" as query parameters of the URL
|
// we pass the "args" as query parameters of the URL
|
||||||
|
|
||||||
let newAddress = `${document.location.origin}${document.location.pathname}?`;
|
let newAddress = `${document.location.origin}${document.location.pathname}?`;
|
||||||
|
@ -73,7 +127,7 @@ class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient i
|
||||||
|
|
||||||
const f = findArgument('folder-uri');
|
const f = findArgument('folder-uri');
|
||||||
if (f) {
|
if (f) {
|
||||||
const u = URI.parse(f[0]);
|
const u = URI.parse(f);
|
||||||
gotFolder = true;
|
gotFolder = true;
|
||||||
addQueryParameter('folder', u.path);
|
addQueryParameter('folder', u.path);
|
||||||
}
|
}
|
||||||
|
@ -84,24 +138,34 @@ class BrowserExtensionHostDebugService extends ExtensionHostDebugChannelClient i
|
||||||
|
|
||||||
const ep = findArgument('extensionDevelopmentPath');
|
const ep = findArgument('extensionDevelopmentPath');
|
||||||
if (ep) {
|
if (ep) {
|
||||||
let u = ep[0];
|
addQueryParameter('extensionDevelopmentPath', ep);
|
||||||
addQueryParameter('edp', u);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const di = findArgument('debugId');
|
const di = findArgument('debugId');
|
||||||
if (di) {
|
if (di) {
|
||||||
addQueryParameter('di', di);
|
addQueryParameter('debugId', di);
|
||||||
}
|
}
|
||||||
|
|
||||||
const ibe = findArgument('inspect-brk-extensions');
|
const ibe = findArgument('inspect-brk-extensions');
|
||||||
if (ibe) {
|
if (ibe) {
|
||||||
addQueryParameter('ibe', ibe);
|
addQueryParameter('inspect-brk-extensions', ibe);
|
||||||
}
|
}
|
||||||
|
|
||||||
window.open(newAddress);
|
window.open(newAddress);
|
||||||
|
|
||||||
return Promise.resolve();
|
return Promise.resolve();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private findArgument(key: string, args: string[]): string | undefined {
|
||||||
|
for (const a of args) {
|
||||||
|
const k = `--${key}=`;
|
||||||
|
if (a.indexOf(k) === 0) {
|
||||||
|
return a.substr(k.length);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
registerSingleton(IExtensionHostDebugService, BrowserExtensionHostDebugService);
|
registerSingleton(IExtensionHostDebugService, BrowserExtensionHostDebugService);
|
||||||
|
|
|
@ -100,32 +100,53 @@ export class BrowserWorkbenchEnvironmentService implements IWorkbenchEnvironment
|
||||||
|
|
||||||
this.untitledWorkspacesHome = URI.from({ scheme: Schemas.untitled, path: 'Workspaces' });
|
this.untitledWorkspacesHome = URI.from({ scheme: Schemas.untitled, path: 'Workspaces' });
|
||||||
|
|
||||||
if (document && document.location && document.location.search) {
|
// Fill in selected extra environmental properties
|
||||||
const map = new Map<string, string>();
|
if (options.workspaceProvider && options.workspaceProvider.environment) {
|
||||||
const query = document.location.search.substring(1);
|
const environment = options.workspaceProvider.environment;
|
||||||
const vars = query.split('&');
|
for (const [key, value] of environment) {
|
||||||
for (let p of vars) {
|
switch (key) {
|
||||||
const pair = p.split('=');
|
case 'extensionDevelopmentPath':
|
||||||
if (pair.length >= 2) {
|
this.extensionDevelopmentLocationURI = [URI.parse(value)];
|
||||||
map.set(pair[0], decodeURIComponent(pair[1]));
|
this.isExtensionDevelopment = true;
|
||||||
|
break;
|
||||||
|
case 'debugId':
|
||||||
|
this.debugExtensionHost.debugId = value;
|
||||||
|
break;
|
||||||
|
case 'inspect-brk-extensions':
|
||||||
|
this.debugExtensionHost.port = parseInt(value);
|
||||||
|
this.debugExtensionHost.break = false;
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
// TODO@Ben remove me once environment is adopted
|
||||||
|
if (document && document.location && document.location.search) {
|
||||||
|
const map = new Map<string, string>();
|
||||||
|
const query = document.location.search.substring(1);
|
||||||
|
const vars = query.split('&');
|
||||||
|
for (let p of vars) {
|
||||||
|
const pair = p.split('=');
|
||||||
|
if (pair.length >= 2) {
|
||||||
|
map.set(pair[0], decodeURIComponent(pair[1]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const edp = map.get('edp');
|
const edp = map.get('extensionDevelopmentPath');
|
||||||
if (edp) {
|
if (edp) {
|
||||||
this.extensionDevelopmentLocationURI = [URI.parse(edp)];
|
this.extensionDevelopmentLocationURI = [URI.parse(edp)];
|
||||||
this.isExtensionDevelopment = true;
|
this.isExtensionDevelopment = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
const di = map.get('di');
|
const di = map.get('debugId');
|
||||||
if (di) {
|
if (di) {
|
||||||
this.debugExtensionHost.debugId = di;
|
this.debugExtensionHost.debugId = di;
|
||||||
}
|
}
|
||||||
|
|
||||||
const ibe = map.get('ibe');
|
const ibe = map.get('inspect-brk-extensions');
|
||||||
if (ibe) {
|
if (ibe) {
|
||||||
this.debugExtensionHost.port = parseInt(ibe);
|
this.debugExtensionHost.port = parseInt(ibe);
|
||||||
this.debugExtensionHost.break = false;
|
this.debugExtensionHost.break = false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -33,13 +33,22 @@ export interface IWorkspaceProvider {
|
||||||
*/
|
*/
|
||||||
readonly workspace: IWorkspace;
|
readonly workspace: IWorkspace;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optionally a set of environmental properties to be used
|
||||||
|
* as environment for the workspace to open.
|
||||||
|
*/
|
||||||
|
readonly environment?: ReadonlyMap<string, string>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Asks to open a workspace in the current or a new window.
|
* Asks to open a workspace in the current or a new window.
|
||||||
*
|
*
|
||||||
* @param workspace the workspace to open.
|
* @param workspace the workspace to open.
|
||||||
* @param options wether to open inside the current window or a new window.
|
* @param options optional options for the workspace to open.
|
||||||
|
* - `reuse`: wether to open inside the current window or a new window
|
||||||
|
* - `environment`: a map of environmental properties that should be
|
||||||
|
* filled into the environment of the workspace to open.
|
||||||
*/
|
*/
|
||||||
open(workspace: IWorkspace, options?: { reuse?: boolean }): Promise<void>;
|
open(workspace: IWorkspace, options?: { reuse?: boolean, environment?: Map<string, string> }): Promise<void>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class BrowserHostService extends Disposable implements IHostService {
|
export class BrowserHostService extends Disposable implements IHostService {
|
||||||
|
|
|
@ -82,7 +82,6 @@ interface IWorkbenchConstructionOptions {
|
||||||
*/
|
*/
|
||||||
logLevel?: LogLevel;
|
logLevel?: LogLevel;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Experimental: Support for update reporting.
|
* Experimental: Support for update reporting.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue