feat: Remove side log location when query removed

When removing query history item from view, also remove the side log.

Log files can be large, so ensure they don't stick around.

Last piece of #236 and #234.

Author: aeisenberg

extensions/ql-vscode/src/logging.ts

@@ -25,7 +25,7 @@ export interface Logger {
    * Remove the log at the specified location
    * @param location log to remove
    */
-  removeAdditionalLogLocation(location: string): void;
+  removeAdditionalLogLocation(location: string | undefined): void;
 
   /**
    * The base location location where all side log files are stored.
@@ -93,9 +93,11 @@ export class OutputChannelLogger extends DisposableObject implements Logger {
     this.outputChannel.show(preserveFocus);
   }
 
-  removeAdditionalLogLocation(location: string): void {
-    if (this.additionalLogLocationPath) {
-      const logPath = path.join(this.additionalLogLocationPath, location);
+  removeAdditionalLogLocation(location: string | undefined): void {
+    if (this.additionalLogLocationPath && location) {
+      const logPath = location.startsWith(this.additionalLogLocationPath)
+        ? location
+        : path.join(this.additionalLogLocationPath, location);
       const additional = this.additionalLocations.get(logPath);
       if (additional) {
         this.disposeAndStopTracking(additional);

extensions/ql-vscode/src/query-history.ts

@@ -145,6 +145,7 @@ export class QueryHistoryManager {
 
   async handleRemoveHistoryItem(queryHistoryItem: CompletedQuery) {
     this.treeDataProvider.remove(queryHistoryItem);
+    queryHistoryItem.dispose();
     const current = this.treeDataProvider.getCurrent();
     if (current !== undefined) {
       this.treeView.reveal(current);

extensions/ql-vscode/src/query-results.ts

@@ -16,6 +16,7 @@ export class CompletedQuery implements QueryWithResults {
   readonly database: DatabaseInfo;
   readonly logFileLocation?: string
   options: QueryHistoryItemOptions;
+  dispose: () => void;
 
   /**
    * Map from result set name to SortedResultSetInfo.
@@ -32,16 +33,18 @@ export class CompletedQuery implements QueryWithResults {
   interpretedResultsSortState: InterpretedResultsSortState | undefined;
 
   constructor(
-    evalaution: QueryWithResults,
+    evaluation: QueryWithResults,
     public config: QueryHistoryConfig,
   ) {
-    this.query = evalaution.query;
-    this.result = evalaution.result;
-    this.database = evalaution.database;
-    this.logFileLocation = evalaution.logFileLocation;
+    this.query = evaluation.query;
+    this.result = evaluation.result;
+    this.database = evaluation.database;
+    this.logFileLocation = evaluation.logFileLocation;
+    this.options = evaluation.options;
+    this.dispose = evaluation.dispose;
+
     this.time = new Date().toLocaleString();
     this.sortedResultsInfo = new Map();
-    this.options = evalaution.options;
   }
 
   get databaseName(): string {

extensions/ql-vscode/src/run-queries.ts

@@ -143,7 +143,6 @@ export class QueryInfo {
         }
       };
 
-
       compiled = await helpers.withProgress({
         location: vscode.ProgressLocation.Notification,
         title: "Compiling Query",
@@ -175,6 +174,7 @@ export interface QueryWithResults {
   readonly database: DatabaseInfo;
   readonly options: QueryHistoryItemOptions;
   readonly logFileLocation?: string;
+  readonly dispose: () => void;
 }
 
 export async function clearCacheInDatabase(
@@ -464,7 +464,10 @@ export async function compileAndRunQueryAgainstDatabase(
         databaseUri: db.databaseUri.toString(true)
       },
       options: historyItemOptions,
-      logFileLocation: result.logFileLocation
+      logFileLocation: result.logFileLocation,
+      dispose: () => {
+        qs.logger.removeAdditionalLogLocation(result.logFileLocation);
+      }
     };
   } else {
     // Error dialogs are limited in size and scrollability,
@@ -516,5 +519,6 @@ function createSyntheticResult(
       databaseUri: db.databaseUri.toString(true)
     },
     options: historyItemOptions,
+    dispose: () => { /**/ },
   };
 }