mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-02-14 12:08:36 -05:00
Merge from vscode 8e0f348413f4f616c23a88ae30030efa85811973 (#6381)
* Merge from vscode 8e0f348413f4f616c23a88ae30030efa85811973 * disable strict null check
This commit is contained in:
Anthony Dresser
281
src/vs/workbench/contrib/debug/common/debugger.ts
Normal file
281
src/vs/workbench/contrib/debug/common/debugger.ts
Normal file
@@ -0,0 +1,281 @@
|
||||
/*---------------------------------------------------------------------------------------------
|
||||
* Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
* Licensed under the Source EULA. See License.txt in the project root for license information.
|
||||
*--------------------------------------------------------------------------------------------*/
|
||||
|
||||
import * as nls from 'vs/nls';
|
||||
import * as strings from 'vs/base/common/strings';
|
||||
import * as objects from 'vs/base/common/objects';
|
||||
import { isObject } from 'vs/base/common/types';
|
||||
import { IJSONSchema, IJSONSchemaSnippet } from 'vs/base/common/jsonSchema';
|
||||
import { IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
|
||||
import { IConfig, IDebuggerContribution, INTERNAL_CONSOLE_OPTIONS_SCHEMA, IConfigurationManager, IDebugAdapter, ITerminalSettings, IDebugger, IDebugSession, IDebugHelperService } from 'vs/workbench/contrib/debug/common/debug';
|
||||
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
|
||||
import { IConfigurationResolverService } from 'vs/workbench/services/configurationResolver/common/configurationResolver';
|
||||
import * as ConfigurationResolverUtils from 'vs/workbench/services/configurationResolver/common/configurationResolverUtils';
|
||||
import { TelemetryService } from 'vs/platform/telemetry/common/telemetryService';
|
||||
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
|
||||
import { memoize } from 'vs/base/common/decorators';
|
||||
import { TaskDefinitionRegistry } from 'vs/workbench/contrib/tasks/common/taskDefinitionRegistry';
|
||||
import { ITextResourcePropertiesService } from 'vs/editor/common/services/resourceConfiguration';
|
||||
import { URI } from 'vs/base/common/uri';
|
||||
import { Schemas } from 'vs/base/common/network';
|
||||
import { isDebuggerMainContribution } from 'vs/workbench/contrib/debug/common/debugUtils';
|
||||
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
|
||||
|
||||
export class Debugger implements IDebugger {
|
||||
|
||||
private debuggerContribution: IDebuggerContribution;
|
||||
private mergedExtensionDescriptions: IExtensionDescription[] = [];
|
||||
private mainExtensionDescription: IExtensionDescription | undefined;
|
||||
|
||||
constructor(private configurationManager: IConfigurationManager, dbgContribution: IDebuggerContribution, extensionDescription: IExtensionDescription,
|
||||
@IConfigurationService private readonly configurationService: IConfigurationService,
|
||||
@ITextResourcePropertiesService private readonly resourcePropertiesService: ITextResourcePropertiesService,
|
||||
@IConfigurationResolverService private readonly configurationResolverService: IConfigurationResolverService,
|
||||
@ITelemetryService private readonly telemetryService: ITelemetryService,
|
||||
@IDebugHelperService private readonly debugHelperService: IDebugHelperService
|
||||
) {
|
||||
this.debuggerContribution = { type: dbgContribution.type };
|
||||
this.merge(dbgContribution, extensionDescription);
|
||||
}
|
||||
|
||||
public merge(otherDebuggerContribution: IDebuggerContribution, extensionDescription: IExtensionDescription): void {
|
||||
|
||||
/**
|
||||
* Copies all properties of source into destination. The optional parameter "overwrite" allows to control
|
||||
* if existing non-structured properties on the destination should be overwritten or not. Defaults to true (overwrite).
|
||||
*/
|
||||
function mixin(destination: any, source: any, overwrite: boolean, level = 0): any {
|
||||
|
||||
if (!isObject(destination)) {
|
||||
return source;
|
||||
}
|
||||
|
||||
if (isObject(source)) {
|
||||
Object.keys(source).forEach(key => {
|
||||
if (isObject(destination[key]) && isObject(source[key])) {
|
||||
mixin(destination[key], source[key], overwrite, level + 1);
|
||||
} else {
|
||||
if (key in destination) {
|
||||
if (overwrite) {
|
||||
if (level === 0 && key === 'type') {
|
||||
// don't merge the 'type' property
|
||||
} else {
|
||||
destination[key] = source[key];
|
||||
}
|
||||
}
|
||||
} else {
|
||||
destination[key] = source[key];
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return destination;
|
||||
}
|
||||
|
||||
// only if not already merged
|
||||
if (this.mergedExtensionDescriptions.indexOf(extensionDescription) < 0) {
|
||||
|
||||
// remember all extensions that have been merged for this debugger
|
||||
this.mergedExtensionDescriptions.push(extensionDescription);
|
||||
|
||||
// merge new debugger contribution into existing contributions (and don't overwrite values in built-in extensions)
|
||||
mixin(this.debuggerContribution, otherDebuggerContribution, extensionDescription.isBuiltin);
|
||||
|
||||
// remember the extension that is considered the "main" debugger contribution
|
||||
if (isDebuggerMainContribution(otherDebuggerContribution)) {
|
||||
this.mainExtensionDescription = extensionDescription;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public createDebugAdapter(session: IDebugSession): Promise<IDebugAdapter> {
|
||||
return this.configurationManager.activateDebuggers('onDebugAdapterProtocolTracker', this.type).then(_ => {
|
||||
const da = this.configurationManager.createDebugAdapter(session);
|
||||
if (da) {
|
||||
return Promise.resolve(da);
|
||||
}
|
||||
throw new Error(nls.localize('cannot.find.da', "Cannot find debug adapter for type '{0}'.", this.type));
|
||||
});
|
||||
}
|
||||
|
||||
substituteVariables(folder: IWorkspaceFolder | undefined, config: IConfig): Promise<IConfig> {
|
||||
return this.configurationManager.substituteVariables(this.type, folder, config).then(config => {
|
||||
return this.configurationResolverService.resolveWithInteractionReplace(folder, config, 'launch', this.variables);
|
||||
});
|
||||
}
|
||||
|
||||
runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined> {
|
||||
const config = this.configurationService.getValue<ITerminalSettings>('terminal');
|
||||
return this.configurationManager.runInTerminal(this.type, args, config);
|
||||
}
|
||||
|
||||
get label(): string {
|
||||
return this.debuggerContribution.label || this.debuggerContribution.type;
|
||||
}
|
||||
|
||||
get type(): string {
|
||||
return this.debuggerContribution.type;
|
||||
}
|
||||
|
||||
get variables(): { [key: string]: string } | undefined {
|
||||
return this.debuggerContribution.variables;
|
||||
}
|
||||
|
||||
get configurationSnippets(): IJSONSchemaSnippet[] | undefined {
|
||||
return this.debuggerContribution.configurationSnippets;
|
||||
}
|
||||
|
||||
get languages(): string[] | undefined {
|
||||
return this.debuggerContribution.languages;
|
||||
}
|
||||
|
||||
hasInitialConfiguration(): boolean {
|
||||
return !!this.debuggerContribution.initialConfigurations;
|
||||
}
|
||||
|
||||
hasConfigurationProvider(): boolean {
|
||||
return this.configurationManager.hasDebugConfigurationProvider(this.type);
|
||||
}
|
||||
|
||||
getInitialConfigurationContent(initialConfigs?: IConfig[]): Promise<string> {
|
||||
// at this point we got some configs from the package.json and/or from registered DebugConfigurationProviders
|
||||
let initialConfigurations = this.debuggerContribution.initialConfigurations || [];
|
||||
if (initialConfigs) {
|
||||
initialConfigurations = initialConfigurations.concat(initialConfigs);
|
||||
}
|
||||
|
||||
const eol = this.resourcePropertiesService.getEOL(URI.from({ scheme: Schemas.untitled, path: '1' })) === '\r\n' ? '\r\n' : '\n';
|
||||
const configs = JSON.stringify(initialConfigurations, null, '\t').split('\n').map(line => '\t' + line).join(eol).trim();
|
||||
const comment1 = nls.localize('launch.config.comment1', "Use IntelliSense to learn about possible attributes.");
|
||||
const comment2 = nls.localize('launch.config.comment2', "Hover to view descriptions of existing attributes.");
|
||||
const comment3 = nls.localize('launch.config.comment3', "For more information, visit: {0}", 'https://go.microsoft.com/fwlink/?linkid=830387');
|
||||
|
||||
let content = [
|
||||
'{',
|
||||
`\t// ${comment1}`,
|
||||
`\t// ${comment2}`,
|
||||
`\t// ${comment3}`,
|
||||
`\t"version": "0.2.0",`,
|
||||
`\t"configurations": ${configs}`,
|
||||
'}'
|
||||
].join(eol);
|
||||
|
||||
// fix formatting
|
||||
const editorConfig = this.configurationService.getValue<any>();
|
||||
if (editorConfig.editor && editorConfig.editor.insertSpaces) {
|
||||
content = content.replace(new RegExp('\t', 'g'), strings.repeat(' ', editorConfig.editor.tabSize));
|
||||
}
|
||||
|
||||
return Promise.resolve(content);
|
||||
}
|
||||
|
||||
public getMainExtensionDescriptor(): IExtensionDescription {
|
||||
return this.mainExtensionDescription || this.mergedExtensionDescriptions[0];
|
||||
}
|
||||
|
||||
@memoize
|
||||
getCustomTelemetryService(): Promise<TelemetryService | undefined> {
|
||||
|
||||
const aiKey = this.debuggerContribution.aiKey;
|
||||
|
||||
if (!aiKey) {
|
||||
return Promise.resolve(undefined);
|
||||
}
|
||||
|
||||
return this.telemetryService.getTelemetryInfo().then(info => {
|
||||
const telemetryInfo: { [key: string]: string } = Object.create(null);
|
||||
telemetryInfo['common.vscodemachineid'] = info.machineId;
|
||||
telemetryInfo['common.vscodesessionid'] = info.sessionId;
|
||||
return telemetryInfo;
|
||||
}).then(data => {
|
||||
const args = [`${this.getMainExtensionDescriptor().publisher}.${this.type}`, JSON.stringify(data), aiKey];
|
||||
return this.debugHelperService.createTelemetryService(this.configurationService, args);
|
||||
});
|
||||
}
|
||||
|
||||
getSchemaAttributes(): IJSONSchema[] | null {
|
||||
|
||||
if (!this.debuggerContribution.configurationAttributes) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// fill in the default configuration attributes shared by all adapters.
|
||||
const taskSchema = TaskDefinitionRegistry.getJsonSchema();
|
||||
return Object.keys(this.debuggerContribution.configurationAttributes).map(request => {
|
||||
const attributes: IJSONSchema = this.debuggerContribution.configurationAttributes[request];
|
||||
const defaultRequired = ['name', 'type', 'request'];
|
||||
attributes.required = attributes.required && attributes.required.length ? defaultRequired.concat(attributes.required) : defaultRequired;
|
||||
attributes.additionalProperties = false;
|
||||
attributes.type = 'object';
|
||||
if (!attributes.properties) {
|
||||
attributes.properties = {};
|
||||
}
|
||||
const properties = attributes.properties;
|
||||
properties['type'] = {
|
||||
enum: [this.type],
|
||||
description: nls.localize('debugType', "Type of configuration."),
|
||||
pattern: '^(?!node2)',
|
||||
errorMessage: nls.localize('debugTypeNotRecognised', "The debug type is not recognized. Make sure that you have a corresponding debug extension installed and that it is enabled."),
|
||||
patternErrorMessage: nls.localize('node2NotSupported', "\"node2\" is no longer supported, use \"node\" instead and set the \"protocol\" attribute to \"inspector\".")
|
||||
};
|
||||
properties['name'] = {
|
||||
type: 'string',
|
||||
description: nls.localize('debugName', "Name of configuration; appears in the launch configuration drop down menu."),
|
||||
default: 'Launch'
|
||||
};
|
||||
properties['request'] = {
|
||||
enum: [request],
|
||||
description: nls.localize('debugRequest', "Request type of configuration. Can be \"launch\" or \"attach\"."),
|
||||
};
|
||||
properties['debugServer'] = {
|
||||
type: 'number',
|
||||
description: nls.localize('debugServer', "For debug extension development only: if a port is specified VS Code tries to connect to a debug adapter running in server mode"),
|
||||
default: 4711
|
||||
};
|
||||
properties['preLaunchTask'] = {
|
||||
anyOf: [taskSchema, {
|
||||
type: ['string', 'null'],
|
||||
}],
|
||||
default: '',
|
||||
description: nls.localize('debugPrelaunchTask', "Task to run before debug session starts.")
|
||||
};
|
||||
properties['postDebugTask'] = {
|
||||
anyOf: [taskSchema, {
|
||||
type: ['string', 'null'],
|
||||
}],
|
||||
default: '',
|
||||
description: nls.localize('debugPostDebugTask', "Task to run after debug session ends.")
|
||||
};
|
||||
properties['internalConsoleOptions'] = INTERNAL_CONSOLE_OPTIONS_SCHEMA;
|
||||
// Clear out windows, linux and osx fields to not have cycles inside the properties object
|
||||
delete properties['windows'];
|
||||
delete properties['osx'];
|
||||
delete properties['linux'];
|
||||
|
||||
const osProperties = objects.deepClone(properties);
|
||||
properties['windows'] = {
|
||||
type: 'object',
|
||||
description: nls.localize('debugWindowsConfiguration', "Windows specific launch configuration attributes."),
|
||||
properties: osProperties
|
||||
};
|
||||
properties['osx'] = {
|
||||
type: 'object',
|
||||
description: nls.localize('debugOSXConfiguration', "OS X specific launch configuration attributes."),
|
||||
properties: osProperties
|
||||
};
|
||||
properties['linux'] = {
|
||||
type: 'object',
|
||||
description: nls.localize('debugLinuxConfiguration', "Linux specific launch configuration attributes."),
|
||||
properties: osProperties
|
||||
};
|
||||
Object.keys(properties).forEach(name => {
|
||||
// Use schema allOf property to get independent error reporting #21113
|
||||
ConfigurationResolverUtils.applyDeprecatedVariableMessage(properties[name]);
|
||||
});
|
||||
return attributes;
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user