report progress to screen reader users (microsoft#210589)

Author: meganrogge

src/vs/base/browser/ui/progressbar/progressAccessibilitySignal.ts

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { IDisposable } from 'vs/base/common/lifecycle';
+
+export interface IScopedAccessibilityProgressSignalDelegate extends IDisposable { }
+
+const nullScopedAccessibilityProgressSignalFactory = () => ({
+	msLoopTime: -1,
+	msDelayTime: -1,
+	dispose: () => { },
+});
+let progressAccessibilitySignalSchedulerFactory: (msDelayTime: number, msLoopTime?: number) => IScopedAccessibilityProgressSignalDelegate = nullScopedAccessibilityProgressSignalFactory;
+
+export function setProgressAcccessibilitySignalScheduler(progressAccessibilitySignalScheduler: (msDelayTime: number, msLoopTime?: number) => IScopedAccessibilityProgressSignalDelegate) {
+	progressAccessibilitySignalSchedulerFactory = progressAccessibilitySignalScheduler;
+}
+
+export function getProgressAcccessibilitySignalScheduler(msDelayTime: number, msLoopTime?: number): IScopedAccessibilityProgressSignalDelegate {
+	return progressAccessibilitySignalSchedulerFactory(msDelayTime, msLoopTime);
+}

src/vs/base/browser/ui/progressbar/progressbar.ts

@@ -4,8 +4,9 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { hide, show } from 'vs/base/browser/dom';
+import { getProgressAcccessibilitySignalScheduler } from 'vs/base/browser/ui/progressbar/progressAccessibilitySignal';
 import { RunOnceScheduler } from 'vs/base/common/async';
-import { Disposable } from 'vs/base/common/lifecycle';
+import { Disposable, IDisposable, MutableDisposable } from 'vs/base/common/lifecycle';
 import { isNumber } from 'vs/base/common/types';
 import 'vs/css!./progressbar';
 
@@ -41,12 +42,15 @@ export class ProgressBar extends Disposable {
 	 */
 	private static readonly LONG_RUNNING_INFINITE_THRESHOLD = 10000;
 
+	private static readonly PROGRESS_SIGNAL_DEFAULT_DELAY = 3000;
+
 	private workedVal: number;
 	private element!: HTMLElement;
 	private bit!: HTMLElement;
 	private totalWork: number | undefined;
 	private showDelayedScheduler: RunOnceScheduler;
 	private longRunningScheduler: RunOnceScheduler;
+	private readonly progressSignal = this._register(new MutableDisposable<IDisposable>());
 
 	constructor(container: HTMLElement, options?: IProgressBarOptions) {
 		super();
@@ -81,6 +85,7 @@ export class ProgressBar extends Disposable {
 		this.totalWork = undefined;
 
 		this.longRunningScheduler.cancel();
+		this.progressSignal.clear();
 	}
 
 	/**
@@ -201,6 +206,7 @@ export class ProgressBar extends Disposable {
 
 	show(delay?: number): void {
 		this.showDelayedScheduler.cancel();
+		this.progressSignal.value = getProgressAcccessibilitySignalScheduler(ProgressBar.PROGRESS_SIGNAL_DEFAULT_DELAY);
 
 		if (typeof delay === 'number') {
 			this.showDelayedScheduler.schedule(delay);
@@ -211,6 +217,8 @@ export class ProgressBar extends Disposable {
 
 	hide(): void {
 		hide(this.element);
+
 		this.showDelayedScheduler.cancel();
+		this.progressSignal.clear();
 	}
 }

src/vs/platform/accessibilitySignal/browser/progressAccessibilitySignalScheduler.ts

@@ -7,16 +7,18 @@ import { RunOnceScheduler } from 'vs/base/common/async';
 import { Disposable, IDisposable } from 'vs/base/common/lifecycle';
 import { AccessibilitySignal, IAccessibilitySignalService } from 'vs/platform/accessibilitySignal/browser/accessibilitySignalService';
 
+const PROGRESS_SIGNAL_LOOP_DELAY = 5000;
+
 /**
  * Schedules a signal to play while progress is happening.
  */
 export class AccessibilityProgressSignalScheduler extends Disposable {
 	private _scheduler: RunOnceScheduler;
 	private _signalLoop: IDisposable | undefined;
-	constructor(msLoopTime: number, msDelayTime: number, @IAccessibilitySignalService private readonly _accessibilitySignalService: IAccessibilitySignalService) {
+	constructor(msDelayTime: number, msLoopTime: number | undefined, @IAccessibilitySignalService private readonly _accessibilitySignalService: IAccessibilitySignalService) {
 		super();
 		this._scheduler = new RunOnceScheduler(() => {
-			this._signalLoop = this._accessibilitySignalService.playSignalLoop(AccessibilitySignal.chatResponsePending, msLoopTime);
+			this._signalLoop = this._accessibilitySignalService.playSignalLoop(AccessibilitySignal.chatResponsePending, msLoopTime ?? PROGRESS_SIGNAL_LOOP_DELAY);
 		}, msDelayTime);
 		this._scheduler.schedule();
 	}

src/vs/workbench/browser/workbench.ts

@@ -46,6 +46,8 @@ import { PixelRatio } from 'vs/base/browser/pixelRatio';
 import { IHoverService, WorkbenchHoverDelegate } from 'vs/platform/hover/browser/hover';
 import { setHoverDelegateFactory } from 'vs/base/browser/ui/hover/hoverDelegateFactory';
 import { setBaseLayerHoverDelegate } from 'vs/base/browser/ui/hover/hoverDelegate2';
+import { AccessibilityProgressSignalScheduler } from 'vs/platform/accessibilitySignal/browser/progressAccessibilitySignalScheduler';
+import { setProgressAcccessibilitySignalScheduler } from 'vs/base/browser/ui/progressbar/progressAccessibilitySignal';
 
 export interface IWorkbenchOptions {
 
@@ -327,8 +329,9 @@ export class Workbench extends Layout {
 
 	private renderWorkbench(instantiationService: IInstantiationService, notificationService: NotificationService, storageService: IStorageService, configurationService: IConfigurationService): void {
 
-		// ARIA
+		// ARIA & Signals
 		setARIAContainer(this.mainContainer);
+		setProgressAcccessibilitySignalScheduler((msDelayTime: number, msLoopTime?: number) => instantiationService.createInstance(AccessibilityProgressSignalScheduler, msDelayTime, msLoopTime));
 
 		// State specific classes
 		const platformClass = isWindows ? 'windows' : isLinux ? 'linux' : 'mac';

src/vs/workbench/contrib/chat/browser/chatAccessibilityService.ts

@@ -11,7 +11,6 @@ import { AccessibilityProgressSignalScheduler } from 'vs/platform/accessibilityS
 import { IChatAccessibilityService } from 'vs/workbench/contrib/chat/browser/chat';
 import { IChatResponseViewModel } from 'vs/workbench/contrib/chat/common/chatViewModel';
 
-const CHAT_RESPONSE_PENDING_AUDIO_CUE_LOOP_MS = 5000;
 const CHAT_RESPONSE_PENDING_ALLOWANCE_MS = 4000;
 export class ChatAccessibilityService extends Disposable implements IChatAccessibilityService {
 
@@ -27,7 +26,7 @@ export class ChatAccessibilityService extends Disposable implements IChatAccessi
 	acceptRequest(): number {
 		this._requestId++;
 		this._accessibilitySignalService.playSignal(AccessibilitySignal.chatRequestSent, { allowManyInParallel: true });
-		this._pendingSignalMap.set(this._requestId, this._instantiationService.createInstance(AccessibilityProgressSignalScheduler, CHAT_RESPONSE_PENDING_AUDIO_CUE_LOOP_MS, CHAT_RESPONSE_PENDING_ALLOWANCE_MS));
+		this._pendingSignalMap.set(this._requestId, this._instantiationService.createInstance(AccessibilityProgressSignalScheduler, CHAT_RESPONSE_PENDING_ALLOWANCE_MS, undefined));
 		return this._requestId;
 	}
 	acceptResponse(response: IChatResponseViewModel | string | undefined, requestId: number): void {