Refactor extension context subscriptions

Use DiposableObject more consistently and ensure all commands are
added as a disposable to the ExtensionContext.

Author: aeisenberg

extensions/ql-vscode/src/astViewer.ts

@@ -1,6 +1,5 @@
 import {
   window,
-  ExtensionContext,
   TreeDataProvider,
   EventEmitter,
   Event,
@@ -19,6 +18,7 @@ import { UrlValue, BqrsId } from './bqrs-cli-types';
 import { showLocation } from './interface-utils';
 import { isStringLoc, isWholeFileLoc, isLineColumnLoc } from './bqrs-utils';
 import { commandRunner } from './helpers';
+import { DisposableObject } from './vscode-utils/disposable-object';
 
 export interface AstItem {
   id: BqrsId;
@@ -33,7 +33,7 @@ export interface ChildAstItem extends AstItem {
   parent: ChildAstItem | AstItem;
 }
 
-class AstViewerDataProvider implements TreeDataProvider<AstItem> {
+class AstViewerDataProvider  extends DisposableObject implements TreeDataProvider<AstItem> {
 
   public roots: AstItem[] = [];
   public db: DatabaseItem | undefined;
@@ -44,10 +44,13 @@ class AstViewerDataProvider implements TreeDataProvider<AstItem> {
     this._onDidChangeTreeData.event;
 
   constructor() {
-    commandRunner('codeQLAstViewer.gotoCode',
-    async (item: AstItem) => {
-      await showLocation(item.fileLocation);
-    });
+    super();
+    this.push(
+      commandRunner('codeQLAstViewer.gotoCode',
+      async (item: AstItem) => {
+        await showLocation(item.fileLocation);
+      })
+    );
   }
 
   refresh(): void {
@@ -96,23 +99,28 @@ class AstViewerDataProvider implements TreeDataProvider<AstItem> {
   }
 }
 
-export class AstViewer {
+export class AstViewer extends DisposableObject {
   private treeView: TreeView<AstItem>;
   private treeDataProvider: AstViewerDataProvider;
   private currentFile: string | undefined;
 
-  constructor(ctx: ExtensionContext) {
+  constructor() {
+    super();
+
     this.treeDataProvider = new AstViewerDataProvider();
     this.treeView = window.createTreeView('codeQLAstViewer', {
       treeDataProvider: this.treeDataProvider,
       showCollapseAll: true
     });
 
-    commandRunner('codeQLAstViewer.clear', async () => {
-      this.clear();
-    });
-
-    ctx.subscriptions.push(window.onDidChangeTextEditorSelection(this.updateTreeSelection, this));
+    this.push(this.treeView);
+    this.push(this.treeDataProvider);
+    this.push(
+      commandRunner('codeQLAstViewer.clear', async () => {
+        this.clear();
+      })
+    );
+    this.push(window.onDidChangeTextEditorSelection(this.updateTreeSelection, this));
   }
 
   updateRoots(roots: AstItem[], db: DatabaseItem, fileName: string) {

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

@@ -3,7 +3,6 @@ import { DisposableObject } from './vscode-utils/disposable-object';
 import {
   Event,
   EventEmitter,
-  ExtensionContext,
   ProviderResult,
   TreeDataProvider,
   TreeItem,
@@ -83,8 +82,8 @@ class DatabaseTreeDataProvider extends DisposableObject
   private currentDatabaseItem: DatabaseItem | undefined;
 
   constructor(
-    private ctx: ExtensionContext,
-    private databaseManager: DatabaseManager
+    private databaseManager: DatabaseManager,
+    private readonly extensionPath: string
   ) {
     super();
 
@@ -131,12 +130,12 @@ class DatabaseTreeDataProvider extends DisposableObject
     const item = new TreeItem(element.name);
     if (element === this.currentDatabaseItem) {
       item.iconPath = joinThemableIconPath(
-        this.ctx.extensionPath,
+        this.extensionPath,
         SELECTED_DATABASE_ICON
       );
     } else if (element.error !== undefined) {
       item.iconPath = joinThemableIconPath(
-        this.ctx.extensionPath,
+        this.extensionPath,
         INVALID_DATABASE_ICON
       );
     }
@@ -213,16 +212,16 @@ export class DatabaseUI extends DisposableObject {
   private treeDataProvider: DatabaseTreeDataProvider;
 
   public constructor(
-    ctx: ExtensionContext,
     private cliserver: cli.CodeQLCliServer,
     private databaseManager: DatabaseManager,
     private readonly queryServer: qsClient.QueryServerClient | undefined,
-    private readonly storagePath: string
+    private readonly storagePath: string,
+    readonly extensionPath: string
   ) {
     super();
 
     this.treeDataProvider = this.push(
-      new DatabaseTreeDataProvider(ctx, databaseManager)
+      new DatabaseTreeDataProvider(databaseManager, extensionPath)
     );
     this.push(
       window.createTreeView('codeQLDatabases', {
@@ -232,7 +231,7 @@ export class DatabaseUI extends DisposableObject {
     );
 
     logger.log('Registering database panel commands.');
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQL.setCurrentDatabase',
         this.handleSetCurrentDatabase,
@@ -241,7 +240,7 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQL.upgradeCurrentDatabase',
         this.handleUpgradeCurrentDatabase,
@@ -251,7 +250,7 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQL.clearCache',
         this.handleClearCache,
@@ -260,7 +259,7 @@ export class DatabaseUI extends DisposableObject {
         })
     );
 
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseFolder',
         this.handleChooseDatabaseFolder,
@@ -269,7 +268,7 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseArchive',
         this.handleChooseDatabaseArchive,
@@ -278,7 +277,7 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseInternet',
         this.handleChooseDatabaseInternet,
@@ -287,39 +286,39 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQLDatabases.chooseDatabaseLgtm',
         this.handleChooseDatabaseLgtm,
         {
           title: 'Adding database from LGTM',
         })
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.setCurrentDatabase',
         this.handleMakeCurrentDatabase
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.sortByName',
         this.handleSortByName
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.sortByDateAdded',
         this.handleSortByDateAdded
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.removeDatabase',
         this.handleRemoveDatabase
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunnerWithProgress(
         'codeQLDatabases.upgradeDatabase',
         this.handleUpgradeDatabase,
@@ -329,13 +328,13 @@ export class DatabaseUI extends DisposableObject {
         }
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.renameDatabase',
         this.handleRenameDatabase
       )
     );
-    ctx.subscriptions.push(
+    this.push(
       commandRunner(
         'codeQLDatabases.openDatabaseFolder',
         this.handleOpenFolder

extensions/ql-vscode/src/extension.ts

@@ -338,11 +338,11 @@ async function activateWithInstalledDistribution(
   ctx.subscriptions.push(dbm);
   logger.log('Initializing database panel.');
   const databaseUI = new DatabaseUI(
-    ctx,
     cliServer,
     dbm,
     qs,
-    getContextStoragePath(ctx)
+    getContextStoragePath(ctx),
+    ctx.extensionPath
   );
   ctx.subscriptions.push(databaseUI);
 
@@ -352,13 +352,14 @@ async function activateWithInstalledDistribution(
     showResultsForCompletedQuery(item, WebviewReveal.Forced);
 
   const qhm = new QueryHistoryManager(
-    ctx,
     qs,
+    ctx.extensionPath,
     queryHistoryConfigurationListener,
     showResults,
     async (from: CompletedQuery, to: CompletedQuery) =>
       showResultsForComparison(from, to),
   );
+  ctx.subscriptions.push(qhm);
   logger.log('Initializing results panel interface.');
   const intm = new InterfaceManager(ctx, dbm, cliServer, queryServerLogger);
   ctx.subscriptions.push(intm);
@@ -621,7 +622,8 @@ async function activateWithInstalledDistribution(
     new TemplateQueryReferenceProvider(cliServer, qs, dbm)
   );
 
-  const astViewer = new AstViewer(ctx);
+  const astViewer = new AstViewer();
+  ctx.subscriptions.push(astViewer);
   ctx.subscriptions.push(helpers.commandRunnerWithProgress('codeQL.viewAst', async (
     progress: helpers.ProgressCallback,
     token: CancellationToken