Finalize notebookDebugOptions API (#163316)

* Finalize notebookDebugOptions API Fix #147264 * Backcompat for the option from vscode-jupyter * Undo comment * Fix build
microsoft · Oct 12, 2022 · cf47b76 · cf47b76
1 parent fdb8812
commit cf47b76
Show file tree

Hide file tree

Showing 15 changed files with 77 additions and 63 deletions.
diff --git a/extensions/vscode-api-tests/package.json b/extensions/vscode-api-tests/package.json
@@ -20,7 +20,6 @@
     "notebookCellExecutionState",
     "notebookContentProvider",
     "notebookControllerKind",
-    "notebookDebugOptions",
     "notebookDeprecated",
     "notebookLiveShare",
     "notebookMessaging",

diff --git a/src/vs/workbench/api/browser/mainThreadDebugService.ts b/src/vs/workbench/api/browser/mainThreadDebugService.ts
@@ -230,9 +230,12 @@ export class MainThreadDebugService implements MainThreadDebugServiceShape, IDeb
 			lifecycleManagedByParent: options.lifecycleManagedByParent,
 			repl: options.repl,
 			compact: options.compact,
-			debugUI: options.debugUI,
 			compoundRoot: parentSession?.compoundRoot,
-			saveBeforeRestart: saveBeforeStart
+			saveBeforeRestart: saveBeforeStart,
+
+			suppressDebugStatusbar: options.suppressDebugStatusbar,
+			suppressDebugToolbar: options.suppressDebugToolbar,
+			suppressDebugView: options.suppressDebugView,
 		};
 		try {
 			return this.debugService.startDebugging(launch, nameOrConfig, debugOptions, saveBeforeStart);

diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -1226,9 +1226,9 @@ export interface IStartDebuggingOptions {
 	repl?: IDebugSessionReplMode;
 	noDebug?: boolean;
 	compact?: boolean;
-	debugUI?: {
-		simple?: boolean;
-	};
+	suppressDebugToolbar?: boolean;
+	suppressDebugStatusbar?: boolean;
+	suppressDebugView?: boolean;
 	suppressSaveBeforeStart?: boolean;
 }
 

diff --git a/src/vs/workbench/api/common/extHostDebugService.ts b/src/vs/workbench/api/common/extHostDebugService.ts
@@ -285,8 +285,12 @@ export abstract class ExtHostDebugServiceBase implements IExtHostDebugService, E
 			repl: options.consoleMode === DebugConsoleMode.MergeWithParent ? 'mergeWithParent' : 'separate',
 			noDebug: options.noDebug,
 			compact: options.compact,
-			debugUI: options.debugUI,
-			suppressSaveBeforeStart: options.suppressSaveBeforeStart
+			suppressSaveBeforeStart: options.suppressSaveBeforeStart,
+
+			// Check debugUI for back-compat, #147264
+			suppressDebugStatusbar: options.suppressDebugStatusbar ?? (options as any).debugUI?.simple,
+			suppressDebugToolbar: options.suppressDebugToolbar ?? (options as any).debugUI?.simple,
+			suppressDebugView: options.suppressDebugView ?? (options as any).debugUI?.simple,
 		});
 	}
 

diff --git a/src/vs/workbench/contrib/debug/browser/callStackView.ts b/src/vs/workbench/contrib/debug/browser/callStackView.ts
@@ -695,10 +695,6 @@ class ThreadsRenderer implements ICompressibleTreeRenderer<IThread, FuzzyScore,
 		templateData.elementDisposable.clear();
 	}
 
-	disposeCompressedElements(node: ITreeNode<ICompressedTreeNode<IThread>, FuzzyScore>, index: number, templateData: IThreadTemplateData, height: number | undefined): void {
-		templateData.elementDisposable.clear();
-	}
-
 	disposeTemplate(templateData: IThreadTemplateData): void {
 		templateData.templateDisposable.dispose();
 	}

diff --git a/src/vs/workbench/contrib/debug/browser/debugService.ts b/src/vs/workbench/contrib/debug/browser/debugService.ts
@@ -571,7 +571,7 @@ export class DebugService implements IDebugService {
 
 		const openDebug = this.configurationService.getValue<IDebugConfiguration>('debug').openDebug;
 		// Open debug viewlet based on the visibility of the side bar and openDebug setting. Do not open for 'run without debug'
-		if (!configuration.resolved.noDebug && (openDebug === 'openOnSessionStart' || (openDebug !== 'neverOpen' && this.viewModel.firstSessionStart)) && !session.isSimpleUI) {
+		if (!configuration.resolved.noDebug && (openDebug === 'openOnSessionStart' || (openDebug !== 'neverOpen' && this.viewModel.firstSessionStart)) && !session.suppressDebugView) {
 			await this.paneCompositeService.openPaneComposite(VIEWLET_ID, ViewContainerLocation.Sidebar);
 		}
 

diff --git a/src/vs/workbench/contrib/debug/browser/debugSession.ts b/src/vs/workbench/contrib/debug/browser/debugSession.ts
@@ -172,10 +172,19 @@ export class DebugSession implements IDebugSession {
 		return this._options.compoundRoot;
 	}
 
-	get isSimpleUI(): boolean {
-		return this._options.debugUI?.simple ?? false;
+	get suppressDebugStatusbar(): boolean {
+		return this._options.suppressDebugStatusbar ?? false;
 	}
 
+	get suppressDebugToolbar(): boolean {
+		return this._options.suppressDebugToolbar ?? false;
+	}
+
+	get suppressDebugView(): boolean {
+		return this._options.suppressDebugView ?? false;
+	}
+
+
 	get autoExpandLazyVariables(): boolean {
 		// This tiny helper avoids converting the entire debug model to use service injection
 		return this.configurationService.getValue<IDebugConfiguration>('debug').autoExpandLazyVariables;
@@ -971,7 +980,7 @@ export class DebugSession implements IDebugSession {
 						}
 
 						if (thread.stoppedDetails) {
-							if (thread.stoppedDetails.reason === 'breakpoint' && this.configurationService.getValue<IDebugConfiguration>('debug').openDebug === 'openOnDebugBreak' && !this.isSimpleUI) {
+							if (thread.stoppedDetails.reason === 'breakpoint' && this.configurationService.getValue<IDebugConfiguration>('debug').openDebug === 'openOnDebugBreak' && !this.suppressDebugView) {
 								await this.paneCompositeService.openPaneComposite(VIEWLET_ID, ViewContainerLocation.Sidebar);
 							}
 

diff --git a/src/vs/workbench/contrib/debug/browser/debugToolBar.ts b/src/vs/workbench/contrib/debug/browser/debugToolBar.ts
@@ -99,7 +99,13 @@ export class DebugToolBar extends Themable implements IWorkbenchContribution {
 		this.updateScheduler = this._register(new RunOnceScheduler(() => {
 			const state = this.debugService.state;
 			const toolBarLocation = this.configurationService.getValue<IDebugConfiguration>('debug').toolBarLocation;
-			if (state === State.Inactive || toolBarLocation === 'docked' || toolBarLocation === 'hidden' || this.debugService.getViewModel().focusedSession?.isSimpleUI || (state === State.Initializing && this.debugService.initializingOptions?.debugUI?.simple)) {
+			if (
+				state === State.Inactive ||
+				toolBarLocation === 'docked' ||
+				toolBarLocation === 'hidden' ||
+				this.debugService.getModel().getSessions().every(s => s.suppressDebugToolbar) ||
+				(state === State.Initializing && this.debugService.initializingOptions?.suppressDebugToolbar)
+			) {
 				return this.hide();
 			}
 

diff --git a/src/vs/workbench/contrib/debug/browser/statusbarColorProvider.ts b/src/vs/workbench/contrib/debug/browser/statusbarColorProvider.ts
@@ -69,7 +69,7 @@ export class StatusBarColorProvider implements IWorkbenchContribution {
 	}
 
 	protected update(): void {
-		this.enabled = isStatusbarInDebugMode(this.debugService.state, this.debugService.getViewModel().focusedSession);
+		this.enabled = isStatusbarInDebugMode(this.debugService.state, this.debugService.getModel().getSessions());
 	}
 
 	dispose(): void {
@@ -78,12 +78,8 @@ export class StatusBarColorProvider implements IWorkbenchContribution {
 	}
 }
 
-export function isStatusbarInDebugMode(state: State, session: IDebugSession | undefined): boolean {
-	if (state === State.Inactive || state === State.Initializing || session?.isSimpleUI) {
-		return false;
-	}
-	const isRunningWithoutDebug = session?.configuration?.noDebug;
-	if (isRunningWithoutDebug) {
+export function isStatusbarInDebugMode(state: State, sessions: IDebugSession[]): boolean {
+	if (state === State.Inactive || state === State.Initializing || sessions.every(s => s.suppressDebugStatusbar || s.configuration?.noDebug)) {
 		return false;
 	}
 

diff --git a/src/vs/workbench/contrib/debug/common/debug.ts b/src/vs/workbench/contrib/debug/common/debug.ts
@@ -203,11 +203,11 @@ export interface IDebugSessionOptions {
 	repl?: IDebugSessionReplMode;
 	compoundRoot?: DebugCompoundRoot;
 	compact?: boolean;
-	debugUI?: {
-		simple?: boolean;
-	};
 	startedByUser?: boolean;
 	saveBeforeRestart?: boolean;
+	suppressDebugToolbar?: boolean;
+	suppressDebugStatusbar?: boolean;
+	suppressDebugView?: boolean;
 }
 
 export interface IDataBreakpointInfoResponse {
@@ -300,8 +300,10 @@ export interface IDebugSession extends ITreeElement {
 	readonly compoundRoot: DebugCompoundRoot | undefined;
 	readonly saveBeforeRestart: boolean;
 	readonly name: string;
-	readonly isSimpleUI: boolean;
 	readonly autoExpandLazyVariables: boolean;
+	readonly suppressDebugToolbar: boolean;
+	readonly suppressDebugStatusbar: boolean;
+	readonly suppressDebugView: boolean;
 
 	setSubId(subId: string | undefined): void;
 

diff --git a/src/vs/workbench/contrib/debug/test/browser/baseDebugView.test.ts b/src/vs/workbench/contrib/debug/test/browser/baseDebugView.test.ts
@@ -133,11 +133,17 @@ suite('Debug - Base Debug View', () => {
 	test('statusbar in debug mode', () => {
 		const model = createMockDebugModel();
 		const session = createMockSession(model);
-		assert.strictEqual(isStatusbarInDebugMode(State.Inactive, undefined), false);
-		assert.strictEqual(isStatusbarInDebugMode(State.Initializing, session), false);
-		assert.strictEqual(isStatusbarInDebugMode(State.Running, session), true);
-		assert.strictEqual(isStatusbarInDebugMode(State.Stopped, session), true);
+		const session2 = createMockSession(model, undefined, { suppressDebugStatusbar: true });
+		assert.strictEqual(isStatusbarInDebugMode(State.Inactive, []), false);
+		assert.strictEqual(isStatusbarInDebugMode(State.Initializing, [session]), false);
+		assert.strictEqual(isStatusbarInDebugMode(State.Running, [session]), true);
+		assert.strictEqual(isStatusbarInDebugMode(State.Stopped, [session]), true);
+
+		assert.strictEqual(isStatusbarInDebugMode(State.Running, [session2]), false);
+		assert.strictEqual(isStatusbarInDebugMode(State.Running, [session, session2]), true);
+
 		session.configuration.noDebug = true;
-		assert.strictEqual(isStatusbarInDebugMode(State.Running, session), false);
+		assert.strictEqual(isStatusbarInDebugMode(State.Running, [session]), false);
+		assert.strictEqual(isStatusbarInDebugMode(State.Running, [session, session2]), false);
 	});
 });
diff --git a/src/vs/workbench/contrib/debug/test/browser/mockDebug.ts b/src/vs/workbench/contrib/debug/test/browser/mockDebug.ts
@@ -168,6 +168,9 @@ export class MockDebugService implements IDebugService {
 }
 
 export class MockSession implements IDebugSession {
+	readonly suppressDebugToolbar = false;
+	readonly suppressDebugStatusbar = false;
+	readonly suppressDebugView = false;
 	readonly autoExpandLazyVariables = false;
 
 	getMemory(memoryReference: string): IMemoryRegion {

diff --git a/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts b/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts
@@ -42,7 +42,6 @@ export const allApiProposals = Object.freeze({
 	notebookContentProvider: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookContentProvider.d.ts',
 	notebookControllerAffinityHidden: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookControllerAffinityHidden.d.ts',
 	notebookControllerKind: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookControllerKind.d.ts',
-	notebookDebugOptions: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookDebugOptions.d.ts',
 	notebookDeprecated: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookDeprecated.d.ts',
 	notebookEditor: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookEditor.d.ts',
 	notebookKernelSource: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.notebookKernelSource.d.ts',

diff --git a/src/vscode-dts/vscode.d.ts b/src/vscode-dts/vscode.d.ts
@@ -14828,6 +14828,26 @@ declare module 'vscode' {
 		 * If compact is true, debug sessions with a single child are hidden in the CALL STACK view to make the tree more compact.
 		 */
 		compact?: boolean;
+
+		/**
+		 * When true, a save will not be triggered for open editors when starting a debug session, regardless of the value of the `debug.saveBeforeStart` setting.
+		 */
+		suppressSaveBeforeStart?: boolean;
+
+		/**
+		 * When true, the debug toolbar will not be shown for this session.
+		 */
+		suppressDebugToolbar?: boolean;
+
+		/**
+		 * When true, the window statusbar color will not be changed for this session.
+		 */
+		suppressDebugStatusbar?: boolean;
+
+		/**
+		 * When true, the debug viewlet will not be automatically revealed for this session.
+		 */
+		suppressDebugView?: boolean;
 	}
 
 	/**

diff --git a/src/vscode-dts/vscode.proposed.notebookDebugOptions.d.ts b/src/vscode-dts/vscode.proposed.notebookDebugOptions.d.ts