Merge pull request #2202 from github/robertbrignull/extract_progress

Move withProgress and associated code to a separate file

Author: robertbrignull

extensions/ql-vscode/src/ast-cfg-commands.ts

@@ -1,5 +1,5 @@
 import { Uri, window } from "vscode";
-import { withProgress } from "./commandRunner";
+import { withProgress } from "./progress";
 import { AstViewer } from "./astViewer";
 import {
   TemplatePrintAstProvider,

extensions/ql-vscode/src/commandRunner.ts

@@ -1,11 +1,4 @@
-import {
-  CancellationToken,
-  ProgressOptions as VSCodeProgressOptions,
-  window as Window,
-  commands,
-  Disposable,
-  ProgressLocation,
-} from "vscode";
+import { CancellationToken, commands, Disposable } from "vscode";
 import {
   showAndLogExceptionWithTelemetry,
   showAndLogWarningMessage,
@@ -14,51 +7,22 @@ import { extLogger } from "./common";
 import { asError, getErrorMessage, getErrorStack } from "./pure/helpers-pure";
 import { telemetryListener } from "./telemetry";
 import { redactableError } from "./pure/errors";
-
-export class UserCancellationException extends Error {
-  /**
-   * @param message The error message
-   * @param silent If silent is true, then this exception will avoid showing a warning message to the user.
-   */
-  constructor(message?: string, public readonly silent = false) {
-    super(message);
-  }
-}
-
-export interface ProgressUpdate {
-  /**
-   * The current step
-   */
-  step: number;
-  /**
-   * The maximum step. This *should* be constant for a single job.
-   */
-  maxStep: number;
-  /**
-   * The current progress message
-   */
-  message: string;
-}
-
-export type ProgressCallback = (p: ProgressUpdate) => void;
-
-// Make certain properties within a type optional
-type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-
-export type ProgressOptions = Optional<VSCodeProgressOptions, "location">;
+import {
+  UserCancellationException,
+  withProgress,
+  ProgressOptions,
+  ProgressCallback,
+} from "./progress";
 
 /**
- * A task that reports progress.
+ * A task that handles command invocations from `commandRunner`.
+ * Arguments passed to the command handler are passed along,
+ * untouched to this `NoProgressTask` instance.
  *
- * @param progress a progress handler function. Call this
- * function with a `ProgressUpdate` instance in order to
- * denote some progress being achieved on this task.
- * @param token a cancellation token
+ * @param args arguments passed to this task passed on from
+ * `commands.registerCommand`.
  */
-export type ProgressTask<R> = (
-  progress: ProgressCallback,
-  token: CancellationToken,
-) => Thenable<R>;
+export type NoProgressTask = (...args: any[]) => Promise<any>;
 
 /**
  * A task that handles command invocations from `commandRunner`
@@ -75,64 +39,12 @@ export type ProgressTask<R> = (
  * @param args arguments passed to this task passed on from
  * `commands.registerCommand`.
  */
-export type ProgressTaskWithArgs<R> = (
+type ProgressTaskWithArgs<R> = (
   progress: ProgressCallback,
   token: CancellationToken,
   ...args: any[]
 ) => Thenable<R>;
 
-/**
- * A task that handles command invocations from `commandRunner`.
- * Arguments passed to the command handler are passed along,
- * untouched to this `NoProgressTask` instance.
- *
- * @param args arguments passed to this task passed on from
- * `commands.registerCommand`.
- */
-export type NoProgressTask = (...args: any[]) => Promise<any>;
-
-/**
- * This mediates between the kind of progress callbacks we want to
- * write (where we *set* current progress position and give
- * `maxSteps`) and the kind vscode progress api expects us to write
- * (which increment progress by a certain amount out of 100%).
- *
- * Where possible, the `commandRunner` function below should be used
- * instead of this function. The commandRunner is meant for wrapping
- * top-level commands and provides error handling and other support
- * automatically.
- *
- * Only use this function if you need a progress monitor and the
- * control flow does not always come from a command (eg- during
- * extension activation, or from an internal language server
- * request).
- */
-export function withProgress<R>(
-  task: ProgressTask<R>,
-  {
-    location = ProgressLocation.Notification,
-    title,
-    cancellable,
-  }: ProgressOptions = {},
-): Thenable<R> {
-  let progressAchieved = 0;
-  return Window.withProgress(
-    {
-      location,
-      title,
-      cancellable,
-    },
-    (progress, token) => {
-      return task((p) => {
-        const { message, step, maxStep } = p;
-        const increment = (100 * (step - progressAchieved)) / maxStep;
-        progressAchieved = step;
-        progress.report({ message, increment });
-      }, token);
-    },
-  );
-}
-
 /**
  * A generic wrapper for command registration. This wrapper adds uniform error handling for commands.
  *
@@ -216,48 +128,3 @@ export function commandRunnerWithProgress<R>(
     outputLogger,
   );
 }
-
-/**
- * Displays a progress monitor that indicates how much progess has been made
- * reading from a stream.
- *
- * @param readable The stream to read progress from
- * @param messagePrefix A prefix for displaying the message
- * @param totalNumBytes Total number of bytes in this stream
- * @param progress The progress callback used to set messages
- */
-export function reportStreamProgress(
-  readable: NodeJS.ReadableStream,
-  messagePrefix: string,
-  totalNumBytes?: number,
-  progress?: ProgressCallback,
-) {
-  if (progress && totalNumBytes) {
-    let numBytesDownloaded = 0;
-    const bytesToDisplayMB = (numBytes: number): string =>
-      `${(numBytes / (1024 * 1024)).toFixed(1)} MB`;
-    const updateProgress = () => {
-      progress({
-        step: numBytesDownloaded,
-        maxStep: totalNumBytes,
-        message: `${messagePrefix} [${bytesToDisplayMB(
-          numBytesDownloaded,
-        )} of ${bytesToDisplayMB(totalNumBytes)}]`,
-      });
-    };
-
-    // Display the progress straight away rather than waiting for the first chunk.
-    updateProgress();
-
-    readable.on("data", (data) => {
-      numBytesDownloaded += data.length;
-      updateProgress();
-    });
-  } else if (progress) {
-    progress({
-      step: 1,
-      maxStep: 2,
-      message: `${messagePrefix} (Size unknown)`,
-    });
-  }
-}

extensions/ql-vscode/src/contextual/locationFinder.ts

@@ -11,7 +11,7 @@ import {
 import { CodeQLCliServer } from "../cli";
 import { DatabaseManager, DatabaseItem } from "../local-databases";
 import fileRangeFromURI from "./fileRangeFromURI";
-import { ProgressCallback } from "../commandRunner";
+import { ProgressCallback } from "../progress";
 import { KeyType } from "./keyType";
 import {
   qlpackOfDatabase,

extensions/ql-vscode/src/contextual/queryResolver.ts

@@ -16,7 +16,7 @@ import { DatabaseItem } from "../local-databases";
 import { extLogger } from "../common";
 import { createInitialQueryInfo } from "../run-queries-shared";
 import { CancellationToken, Uri } from "vscode";
-import { ProgressCallback } from "../commandRunner";
+import { ProgressCallback } from "../progress";
 import { QueryRunner } from "../queryRunner";
 import { redactableError } from "../pure/errors";
 import { QLPACK_FILENAMES } from "../pure/ql";

extensions/ql-vscode/src/contextual/templateProvider.ts

@@ -18,7 +18,7 @@ import {
 import { CodeQLCliServer } from "../cli";
 import { DatabaseManager } from "../local-databases";
 import { CachedOperation } from "../helpers";
-import { ProgressCallback, withProgress } from "../commandRunner";
+import { ProgressCallback, withProgress } from "../progress";
 import AstBuilder from "./astBuilder";
 import { KeyType } from "./keyType";
 import {

extensions/ql-vscode/src/databaseFetcher.ts

@@ -18,7 +18,7 @@ import { retry } from "@octokit/plugin-retry";
 
 import { DatabaseManager, DatabaseItem } from "./local-databases";
 import { showAndLogInformationMessage, tmpDir } from "./helpers";
-import { reportStreamProgress, ProgressCallback } from "./commandRunner";
+import { reportStreamProgress, ProgressCallback } from "./progress";
 import { extLogger } from "./common";
 import { getErrorMessage } from "./pure/helpers-pure";
 import {

extensions/ql-vscode/src/databases/ui/db-panel.ts

@@ -7,7 +7,7 @@ import {
   window,
   workspace,
 } from "vscode";
-import { UserCancellationException } from "../../commandRunner";
+import { UserCancellationException } from "../../progress";
 import {
   getNwoFromGitHubUrl,
   isValidGitHubNwo,

extensions/ql-vscode/src/distribution.ts

@@ -14,7 +14,7 @@ import {
 } from "./helpers";
 import { extLogger } from "./common";
 import { getCodeQlCliVersion } from "./cli-version";
-import { ProgressCallback, reportStreamProgress } from "./commandRunner";
+import { ProgressCallback, reportStreamProgress } from "./progress";
 import {
   codeQlLauncherName,
   deprecatedCodeQlLauncherName,

extensions/ql-vscode/src/extension.ts

@@ -89,7 +89,8 @@ import { QLTestAdapterFactory } from "./test-adapter";
 import { TestUIService } from "./test-ui";
 import { CompareView } from "./compare/compare-view";
 import { initializeTelemetry } from "./telemetry";
-import { commandRunner, ProgressCallback, withProgress } from "./commandRunner";
+import { commandRunner } from "./commandRunner";
+import { ProgressCallback, withProgress } from "./progress";
 import { CodeQlStatusBarHandler } from "./status-bar";
 import { getPackagingCommands } from "./packaging";
 import { HistoryItemLabelProvider } from "./query-history/history-item-label-provider";

extensions/ql-vscode/src/helpers.ts

@@ -19,7 +19,7 @@ import {
   commands,
 } from "vscode";
 import { CodeQLCliServer, QlpacksInfo } from "./cli";
-import { UserCancellationException } from "./commandRunner";
+import { UserCancellationException } from "./progress";
 import { extLogger, OutputChannelLogger } from "./common";
 import { QueryMetadata } from "./pure/interface-types";
 import { telemetryListener } from "./telemetry";