feat: Adds command to show query log in editor

Right clicking on the history page will now have a new option to show
the associated log.

Closes #236
Closes #234

Author: aeisenberg

extensions/ql-vscode/package.json

@@ -208,6 +208,10 @@
         "command": "codeQLQueryHistory.itemClicked",
         "title": "Query History Item"
       },
+      {
+        "command": "codeQLQueryHistory.showQueryLog",
+        "title": "Show Query Log"
+      },
       {
         "command": "codeQLQueryResults.nextPathStep",
         "title": "CodeQL: Show Next Step on Path"
@@ -272,6 +276,11 @@
           "group": "9_qlCommands",
           "when": "view == codeQLQueryHistory"
         },
+        {
+          "command": "codeQLQueryHistory.showQueryLog",
+          "group": "9_qlCommands",
+          "when": "view == codeQLQueryHistory"
+        },
         {
           "command": "codeQLTests.showOutputDifferences",
           "group": "qltest@1",
@@ -328,6 +337,10 @@
           "command": "codeQLQueryHistory.itemClicked",
           "when": "false"
         },
+        {
+          "command": "codeQLQueryHistory.showQueryLog",
+          "when": "false"
+        },
         {
           "command": "codeQLQueryHistory.setLabel",
           "when": "false"

extensions/ql-vscode/src/logging.ts

@@ -26,6 +26,11 @@ export interface Logger {
    * @param location log to remove
    */
   removeAdditionalLogLocation(location: string): void;
+
+  /**
+   * The base location location where all side log files are stored.
+   */
+  getBaseLocation(): string | undefined;
 }
 
 export type ProgressReporter = Progress<{ message: string }>;
@@ -98,6 +103,10 @@ export class OutputChannelLogger extends DisposableObject implements Logger {
       }
     }
   }
+
+  getBaseLocation() {
+    return this.additionalLogLocationPath;
+  }
 }
 
 class AdditionalLogLocation extends Disposable {

extensions/ql-vscode/src/messages.ts

@@ -778,6 +778,11 @@ export interface EvaluationResult {
    * An error message if an error happened
    */
   message?: string;
+
+  /**
+   * Full path to file with all log messages emitted while this query was active, if one exists
+   */
+  logFileLocation?: string;
 }
 
 export type QueryResultType = number;

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

@@ -4,6 +4,7 @@ import { ExtensionContext, window as Window } from 'vscode';
 import { CompletedQuery } from './query-results';
 import { QueryHistoryConfig } from './config';
 import { QueryWithResults } from './run-queries';
+import * as helpers from './helpers';
 
 /**
  * query-history.ts
@@ -187,6 +188,20 @@ export class QueryHistoryManager {
     }
   }
 
+  async handleShowQueryLog(queryHistoryItem: CompletedQuery) {
+    if (queryHistoryItem.logFileLocation) {
+      try {
+        await vscode.window.showTextDocument(vscode.Uri.parse(queryHistoryItem.logFileLocation), {
+          viewColumn: vscode.ViewColumn.Beside
+        });
+      } catch (e) {
+        helpers.showAndLogErrorMessage(`Could not open log file ${queryHistoryItem.logFileLocation}`);
+      }
+    } else {
+      helpers.showAndLogWarningMessage('No log file available');
+    }
+  }
+
   constructor(
     ctx: ExtensionContext,
     private queryHistoryConfigListener: QueryHistoryConfig,
@@ -208,6 +223,7 @@ export class QueryHistoryManager {
     ctx.subscriptions.push(vscode.commands.registerCommand('codeQLQueryHistory.openQuery', this.handleOpenQuery));
     ctx.subscriptions.push(vscode.commands.registerCommand('codeQLQueryHistory.removeHistoryItem', this.handleRemoveHistoryItem.bind(this)));
     ctx.subscriptions.push(vscode.commands.registerCommand('codeQLQueryHistory.setLabel', this.handleSetLabel.bind(this)));
+    ctx.subscriptions.push(vscode.commands.registerCommand('codeQLQueryHistory.showQueryLog', this.handleShowQueryLog.bind(this)));
     ctx.subscriptions.push(vscode.commands.registerCommand('codeQLQueryHistory.itemClicked', async (item) => {
       return this.handleItemClicked(item);
     }));

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

@@ -14,6 +14,7 @@ export class CompletedQuery implements QueryWithResults {
   readonly query: QueryInfo;
   readonly result: messages.EvaluationResult;
   readonly database: DatabaseInfo;
+  readonly logFileLocation?: string
   options: QueryHistoryItemOptions;
 
   /**
@@ -37,6 +38,7 @@ export class CompletedQuery implements QueryWithResults {
     this.query = evalaution.query;
     this.result = evalaution.result;
     this.database = evalaution.database;
+    this.logFileLocation = evalaution.logFileLocation;
     this.time = new Date().toLocaleString();
     this.sortedResultsInfo = new Map();
     this.options = evalaution.options;

extensions/ql-vscode/src/queryserver-client.ts

@@ -129,6 +129,10 @@ export class QueryServerClient extends DisposableObject {
         this.logger.log(`No callback associated with run id ${res.runId}, continuing without executing any callback`);
       }
       else {
+        const baseLocation = this.logger.getBaseLocation();
+        if (baseLocation && this.activeQueryName) {
+          res.logFileLocation = path.join(baseLocation, this.activeQueryName);
+        }
         this.evaluationResultCallbacks[res.runId](res);
       }
       return {};

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

@@ -174,6 +174,7 @@ export interface QueryWithResults {
   readonly result: messages.EvaluationResult;
   readonly database: DatabaseInfo;
   readonly options: QueryHistoryItemOptions;
+  readonly logFileLocation?: string;
 }
 
 export async function clearCacheInDatabase(
@@ -462,7 +463,8 @@ export async function compileAndRunQueryAgainstDatabase(
         name: db.name,
         databaseUri: db.databaseUri.toString(true)
       },
-      options: historyItemOptions
+      options: historyItemOptions,
+      logFileLocation: result.logFileLocation
     };
   } else {
     // Error dialogs are limited in size and scrollability,

extensions/ql-vscode/test/pure-tests/query-test.ts

@@ -107,7 +107,8 @@ describe('using the query server', function() {
     const logger: Logger = {
       log: async (s: string) => console.log('logger says', s),
       show: () => { /**/ },
-      removeAdditionalLogLocation: async () => { /**/ }
+      removeAdditionalLogLocation: async () => { /**/ },
+      getBaseLocation: () => ''
     };
     cliServer = new cli.CodeQLCliServer({
       async getCodeQlPathWithoutVersionCheck(): Promise<string | undefined> {