|
| 1 | +import { |
| 2 | + CancellationToken, |
| 3 | + ProgressOptions, |
| 4 | + window as Window, |
| 5 | + commands, |
| 6 | + Disposable, |
| 7 | + ProgressLocation |
| 8 | +} from 'vscode'; |
| 9 | +import { showAndLogErrorMessage, showAndLogWarningMessage } from './helpers'; |
| 10 | +import { logger } from './logging'; |
| 11 | +import { sendCommandUsage } from './telemetry'; |
| 12 | + |
| 13 | +export class UserCancellationException extends Error { |
| 14 | + /** |
| 15 | + * @param message The error message |
| 16 | + * @param silent If silent is true, then this exception will avoid showing a warning message to the user. |
| 17 | + */ |
| 18 | + constructor(message?: string, public readonly silent = false) { |
| 19 | + super(message); |
| 20 | + } |
| 21 | +} |
| 22 | + |
| 23 | +export interface ProgressUpdate { |
| 24 | + /** |
| 25 | + * The current step |
| 26 | + */ |
| 27 | + step: number; |
| 28 | + /** |
| 29 | + * The maximum step. This *should* be constant for a single job. |
| 30 | + */ |
| 31 | + maxStep: number; |
| 32 | + /** |
| 33 | + * The current progress message |
| 34 | + */ |
| 35 | + message: string; |
| 36 | +} |
| 37 | + |
| 38 | +export type ProgressCallback = (p: ProgressUpdate) => void; |
| 39 | + |
| 40 | +/** |
| 41 | + * A task that handles command invocations from `commandRunner` |
| 42 | + * and includes a progress monitor. |
| 43 | + * |
| 44 | + * |
| 45 | + * Arguments passed to the command handler are passed along, |
| 46 | + * untouched to this `ProgressTask` instance. |
| 47 | + * |
| 48 | + * @param progress a progress handler function. Call this |
| 49 | + * function with a `ProgressUpdate` instance in order to |
| 50 | + * denote some progress being achieved on this task. |
| 51 | + * @param token a cencellation token |
| 52 | + * @param args arguments passed to this task passed on from |
| 53 | + * `commands.registerCommand`. |
| 54 | + */ |
| 55 | +export type ProgressTask<R> = ( |
| 56 | + progress: ProgressCallback, |
| 57 | + token: CancellationToken, |
| 58 | + ...args: any[] |
| 59 | +) => Thenable<R>; |
| 60 | + |
| 61 | +/** |
| 62 | + * A task that handles command invocations from `commandRunner`. |
| 63 | + * Arguments passed to the command handler are passed along, |
| 64 | + * untouched to this `NoProgressTask` instance. |
| 65 | + * |
| 66 | + * @param args arguments passed to this task passed on from |
| 67 | + * `commands.registerCommand`. |
| 68 | + */ |
| 69 | +type NoProgressTask = ((...args: any[]) => Promise<any>); |
| 70 | + |
| 71 | +/** |
| 72 | + * This mediates between the kind of progress callbacks we want to |
| 73 | + * write (where we *set* current progress position and give |
| 74 | + * `maxSteps`) and the kind vscode progress api expects us to write |
| 75 | + * (which increment progress by a certain amount out of 100%). |
| 76 | + * |
| 77 | + * Where possible, the `commandRunner` function below should be used |
| 78 | + * instead of this function. The commandRunner is meant for wrapping |
| 79 | + * top-level commands and provides error handling and other support |
| 80 | + * automatically. |
| 81 | + * |
| 82 | + * Only use this function if you need a progress monitor and the |
| 83 | + * control flow does not always come from a command (eg- during |
| 84 | + * extension activation, or from an internal language server |
| 85 | + * request). |
| 86 | + */ |
| 87 | +export function withProgress<R>( |
| 88 | + options: ProgressOptions, |
| 89 | + task: ProgressTask<R>, |
| 90 | + ...args: any[] |
| 91 | +): Thenable<R> { |
| 92 | + let progressAchieved = 0; |
| 93 | + return Window.withProgress(options, |
| 94 | + (progress, token) => { |
| 95 | + return task(p => { |
| 96 | + const { message, step, maxStep } = p; |
| 97 | + const increment = 100 * (step - progressAchieved) / maxStep; |
| 98 | + progressAchieved = step; |
| 99 | + progress.report({ message, increment }); |
| 100 | + }, token, ...args); |
| 101 | + }); |
| 102 | +} |
| 103 | + |
| 104 | +/** |
| 105 | + * A generic wrapper for command registration. This wrapper adds uniform error handling for commands. |
| 106 | + * |
| 107 | + * In this variant of the command runner, no progress monitor is used. |
| 108 | + * |
| 109 | + * @param commandId The ID of the command to register. |
| 110 | + * @param task The task to run. It is passed directly to `commands.registerCommand`. Any |
| 111 | + * arguments to the command handler are passed on to the task. |
| 112 | + */ |
| 113 | +export function commandRunner( |
| 114 | + commandId: string, |
| 115 | + task: NoProgressTask, |
| 116 | +): Disposable { |
| 117 | + return commands.registerCommand(commandId, async (...args: any[]) => { |
| 118 | + const startTIme = Date.now(); |
| 119 | + let error: Error | undefined; |
| 120 | + |
| 121 | + try { |
| 122 | + return await task(...args); |
| 123 | + } catch (e) { |
| 124 | + error = e; |
| 125 | + if (e instanceof UserCancellationException) { |
| 126 | + // User has cancelled this action manually |
| 127 | + if (e.silent) { |
| 128 | + logger.log(e.message); |
| 129 | + } else { |
| 130 | + showAndLogWarningMessage(e.message); |
| 131 | + } |
| 132 | + } else { |
| 133 | + showAndLogErrorMessage(e.message || e); |
| 134 | + } |
| 135 | + return undefined; |
| 136 | + } finally { |
| 137 | + const executionTime = Date.now() - startTIme; |
| 138 | + sendCommandUsage(commandId, executionTime, error); |
| 139 | + } |
| 140 | + }); |
| 141 | +} |
| 142 | + |
| 143 | +/** |
| 144 | + * A generic wrapper for command registration. This wrapper adds uniform error handling, |
| 145 | + * progress monitoring, and cancellation for commands. |
| 146 | + * |
| 147 | + * @param commandId The ID of the command to register. |
| 148 | + * @param task The task to run. It is passed directly to `commands.registerCommand`. Any |
| 149 | + * arguments to the command handler are passed on to the task after the progress callback |
| 150 | + * and cancellation token. |
| 151 | + * @param progressOptions Progress options to be sent to the progress monitor. |
| 152 | + */ |
| 153 | +export function commandRunnerWithProgress<R>( |
| 154 | + commandId: string, |
| 155 | + task: ProgressTask<R>, |
| 156 | + progressOptions: Partial<ProgressOptions> |
| 157 | +): Disposable { |
| 158 | + return commands.registerCommand(commandId, async (...args: any[]) => { |
| 159 | + const startTIme = Date.now(); |
| 160 | + let error: Error | undefined; |
| 161 | + const progressOptionsWithDefaults = { |
| 162 | + location: ProgressLocation.Notification, |
| 163 | + ...progressOptions |
| 164 | + }; |
| 165 | + try { |
| 166 | + return await withProgress(progressOptionsWithDefaults, task, ...args); |
| 167 | + } catch (e) { |
| 168 | + error = e; |
| 169 | + if (e instanceof UserCancellationException) { |
| 170 | + // User has cancelled this action manually |
| 171 | + if (e.silent) { |
| 172 | + logger.log(e.message); |
| 173 | + } else { |
| 174 | + showAndLogWarningMessage(e.message); |
| 175 | + } |
| 176 | + } else { |
| 177 | + showAndLogErrorMessage(e.message || e); |
| 178 | + } |
| 179 | + return undefined; |
| 180 | + } finally { |
| 181 | + const executionTime = Date.now() - startTIme; |
| 182 | + sendCommandUsage(commandId, executionTime, error); |
| 183 | + } |
| 184 | + }); |
| 185 | +} |
0 commit comments