Refactor the commandRunner

Split commandRunner into two functions: commandRunner and
commandRunnerWithProgress.

Also, take advantage of default arguments for ProgressOptions.

And updates changelog.

Author: aeisenberg

extensions/ql-vscode/CHANGELOG.md

@@ -4,11 +4,9 @@
 
 - Add friendly welcome message when the databases view is empty.
 - Add open query, open results, and remove query commands in the query history view title bar.
-- Max number of simultaneous queries launchable by runQueries command is now configurable by changing the `codeQL.runningQueries.maxQueries` setting.
+- The maximum number of simultaneous queries launchable by the `CodeQL: Run Queries in Selected Files` command is now configurable by changing the `codeQL.runningQueries.maxQueries` setting.
 - Allow simultaneously run queries to be canceled in a single-click.
 - Prevent multiple upgrade dialogs from appearing when running simultaneous queries on upgradeable databases.
-- Allow simultaneously run queries to be canceled in a single-click.
-- Max number of simultaneous queries launchable by runQueries command is now configurable by changing the codeQL.runningQueries.maxQueries setting.
 - Fix sorting of results. Some pages of results would have the wrong sort order and columns.
 - Remember previous sort order when reloading query results.
 - Fix proper escaping of backslashes in SARIF message strings.

extensions/ql-vscode/src/astViewer.ts

@@ -20,7 +20,6 @@ import { showLocation } from './interface-utils';
 import { isStringLoc, isWholeFileLoc, isLineColumnLoc } from './bqrs-utils';
 import { commandRunner } from './helpers';
 
-
 export interface AstItem {
   id: BqrsId;
   label?: string;

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

@@ -44,7 +44,7 @@ export class TemplateQueryDefinitionProvider implements vscode.DefinitionProvide
   }
 
   private async getDefinitions(uriString: string): Promise<vscode.LocationLink[]> {
-    return await withProgress({
+    return withProgress({
       location: vscode.ProgressLocation.Notification,
       cancellable: true,
       title: 'Finding definitions'
@@ -91,7 +91,7 @@ export class TemplateQueryReferenceProvider implements vscode.ReferenceProvider
   }
 
   private async getReferences(uriString: string): Promise<FullLocationLink[]> {
-    return await withProgress({
+    return withProgress({
       location: vscode.ProgressLocation.Notification,
       cancellable: true,
       title: 'Finding references'

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

@@ -9,8 +9,7 @@ import {
   TreeItem,
   Uri,
   window,
-  env,
-  ProgressLocation
+  env
 } from 'vscode';
 import * as fs from 'fs-extra';
 
@@ -23,6 +22,7 @@ import {
 } from './databases';
 import {
   commandRunner,
+  commandRunnerWithProgress,
   getOnDiskWorkspaceFolders,
   ProgressCallback,
   showAndLogErrorMessage
@@ -233,79 +233,66 @@ export class DatabaseUI extends DisposableObject {
 
     logger.log('Registering database panel commands.');
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQL.setCurrentDatabase',
         this.handleSetCurrentDatabase,
         {
-          location: ProgressLocation.Notification,
           title: 'Importing database from archive',
-          cancellable: false,
         }
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQL.upgradeCurrentDatabase',
         this.handleUpgradeCurrentDatabase,
         {
-          location: ProgressLocation.Notification,
           title: 'Upgrading current database',
           cancellable: true,
         }
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQL.clearCache',
         this.handleClearCache,
         {
-          location: ProgressLocation.Notification,
           title: 'Clearing Cache',
-          cancellable: false,
         })
     );
 
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseFolder',
         this.handleChooseDatabaseFolder,
         {
-          location: ProgressLocation.Notification,
           title: 'Adding database from folder',
-          cancellable: false,
         }
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseArchive',
         this.handleChooseDatabaseArchive,
         {
-          location: ProgressLocation.Notification,
           title: 'Adding database from archive',
-          cancellable: false,
         }
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseInternet',
         this.handleChooseDatabaseInternet,
         {
-          location: ProgressLocation.Notification,
           title: 'Adding database from URL',
-          cancellable: false,
         }
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseLgtm',
         this.handleChooseDatabaseLgtm,
         {
-          location: ProgressLocation.Notification,
           title: 'Adding database from LGTM',
-          cancellable: false,
         })
     );
     ctx.subscriptions.push(
@@ -333,11 +320,10 @@ export class DatabaseUI extends DisposableObject {
       )
     );
     ctx.subscriptions.push(
-      commandRunner(
+      commandRunnerWithProgress(
         'codeQLDatabases.upgradeDatabase',
         this.handleUpgradeDatabase,
         {
-          location: ProgressLocation.Notification,
           title: 'Upgrading database',
           cancellable: true,
         }
@@ -522,9 +508,9 @@ export class DatabaseUI extends DisposableObject {
   };
 
   private handleSetCurrentDatabase = async (
-    uri: Uri,
     progress: ProgressCallback,
     token: CancellationToken,
+    uri: Uri,
   ): Promise<void> => {
     try {
       // Assume user has selected an archive if the file has a .zip extension

extensions/ql-vscode/src/extension.ts

@@ -165,12 +165,10 @@ export async function activate(ctx: ExtensionContext): Promise<void> {
           }
         } else {
           const progressOptions: ProgressOptions = {
-            location: ProgressLocation.Notification,
             title: progressTitle,
-            cancellable: false,
+            location: ProgressLocation.Notification,
           };
 
-          // Avoid using commandRunner here because this function is called upon extension activation
           await helpers.withProgress(progressOptions, progress =>
             distributionManager.installExtensionManagedDistributionRelease(result.updatedRelease, progress));
 
@@ -459,22 +457,21 @@ async function activateWithInstalledDistribution(
 
   logger.log('Registering top-level command palette commands.');
   ctx.subscriptions.push(
-    helpers.commandRunner(
+    helpers.commandRunnerWithProgress(
       'codeQL.runQuery',
       async (
         progress: helpers.ProgressCallback,
         token: CancellationToken,
         uri: Uri | undefined
       ) => await compileAndRunQuery(false, uri, progress, token),
       {
-        location: ProgressLocation.Notification,
         title: 'Running query',
         cancellable: true
       }
     )
   );
   ctx.subscriptions.push(
-    helpers.commandRunner(
+    helpers.commandRunnerWithProgress(
       'codeQL.runQueries',
       async (
         progress: helpers.ProgressCallback,
@@ -533,31 +530,32 @@ async function activateWithInstalledDistribution(
         ));
       },
       {
-        location: ProgressLocation.Notification,
         title: 'Running queries',
         cancellable: true
       })
   );
   ctx.subscriptions.push(
-    helpers.commandRunner(
+    helpers.commandRunnerWithProgress(
       'codeQL.quickEval',
       async (
         progress: helpers.ProgressCallback,
         token: CancellationToken,
         uri: Uri | undefined
       ) => await compileAndRunQuery(true, uri, progress, token),
       {
-        location: ProgressLocation.Notification,
         title: 'Running query',
         cancellable: true
       })
   );
   ctx.subscriptions.push(
-    helpers.commandRunner('codeQL.quickQuery', async (
+    helpers.commandRunnerWithProgress('codeQL.quickQuery', async (
       progress: helpers.ProgressCallback,
       token: CancellationToken
     ) =>
-      displayQuickQuery(ctx, cliServer, databaseUI, progress, token)
+      displayQuickQuery(ctx, cliServer, databaseUI, progress, token),
+      {
+        title: 'Run Quick Query'
+      }
     )
   );
 
@@ -586,28 +584,24 @@ async function activateWithInstalledDistribution(
     )
   );
   ctx.subscriptions.push(
-    helpers.commandRunner('codeQL.chooseDatabaseLgtm', (
+    helpers.commandRunnerWithProgress('codeQL.chooseDatabaseLgtm', (
       progress: helpers.ProgressCallback,
       token: CancellationToken
     ) =>
       databaseUI.handleChooseDatabaseLgtm(progress, token),
       {
-        location: ProgressLocation.Notification,
         title: 'Adding database from LGTM',
-        cancellable: false,
       })
   );
   ctx.subscriptions.push(
-    helpers.commandRunner('codeQL.chooseDatabaseInternet', (
+    helpers.commandRunnerWithProgress('codeQL.chooseDatabaseInternet', (
       progress: helpers.ProgressCallback,
       token: CancellationToken
     ) =>
       databaseUI.handleChooseDatabaseInternet(progress, token),
 
       {
-        location: ProgressLocation.Notification,
         title: 'Adding database from URL',
-        cancellable: false,
       })
   );
 
@@ -627,7 +621,7 @@ async function activateWithInstalledDistribution(
   );
 
   const astViewer = new AstViewer(ctx);
-  ctx.subscriptions.push(helpers.commandRunner('codeQL.viewAst', async (
+  ctx.subscriptions.push(helpers.commandRunnerWithProgress('codeQL.viewAst', async (
     progress: helpers.ProgressCallback,
     token: CancellationToken
   ) => {
@@ -637,7 +631,6 @@ async function activateWithInstalledDistribution(
       astViewer.updateRoots(await ast.getRoots(), ast.db, ast.fileName);
     }
   }, {
-    location: ProgressLocation.Notification,
     cancellable: true,
     title: 'Calculate AST'
   }));