Add unit tests for query-results.ts

Author: aeisenberg

extensions/ql-vscode/src/helpers.ts

@@ -2,10 +2,15 @@ import * as fs from 'fs-extra';
 import * as glob from 'glob-promise';
 import * as yaml from 'js-yaml';
 import * as path from 'path';
-import { CancellationToken, ExtensionContext, ProgressOptions, window as Window, workspace } from 'vscode';
+import {
+  CancellationToken,
+  ExtensionContext,
+  ProgressOptions,
+  window as Window,
+  workspace
+} from 'vscode';
 import { CodeQLCliServer } from './cli';
 import { logger } from './logging';
-import { QueryInfo } from './run-queries';
 
 export interface ProgressUpdate {
   /**
@@ -145,24 +150,6 @@ export function getOnDiskWorkspaceFolders() {
   return diskWorkspaceFolders;
 }
 
-/**
- * Gets a human-readable name for an evaluated query.
- * Uses metadata if it exists, and defaults to the query file name.
- */
-export function getQueryName(query: QueryInfo) {
-  // Queries run through quick evaluation are not usually the entire query file.
-  // Label them differently and include the line numbers.
-  if (query.quickEvalPosition !== undefined) {
-    const { line, endLine, fileName } = query.quickEvalPosition;
-    const lineInfo = line === endLine ? `${line}` : `${line}-${endLine}`;
-    return `Quick evaluation of ${path.basename(fileName)}:${lineInfo}`;
-  } else if (query.metadata && query.metadata.name) {
-    return query.metadata.name;
-  } else {
-    return path.basename(query.program.queryPath);
-  }
-}
-
 /**
  * Provides a utility method to invoke a function only if a minimum time interval has elapsed since
  * the last invocation of that function.

extensions/ql-vscode/src/interface.ts

@@ -365,14 +365,16 @@ export class InterfaceManager extends DisposableObject {
 
     // Use sorted results path if it exists. This may happen if we are
     // reloading the results view after it has been sorted in the past.
-    const resultsPath = results.sortedResultsInfo.get(selectedTable)?.resultsPath
-      || results.query.resultsPaths.resultsPath;
+    const resultsPath = results.getResultsPath(selectedTable);
 
     const chunk = await this.cliServer.bqrsDecode(
       resultsPath,
       schema.name,
       {
-        // always use the first page. –
+        // Always send the first page.
+        // It may not wind up being the page we actually show,
+        // if there are interpreted results, but speculatively
+        // send anyway.
         offset: schema.pagination?.offsets[0],
         pageSize: RAW_RESULTS_PAGE_SIZE
       }
@@ -433,8 +435,7 @@ export class InterfaceManager extends DisposableObject {
   }
 
   private async getResultSetSchemas(results: CompletedQuery, selectedTable = ''): Promise<ResultSetSchema[]> {
-    const resultsPath = results.sortedResultsInfo.get(selectedTable)?.resultsPath
-        || results.query.resultsPaths.resultsPath;
+    const resultsPath = results.getResultsPath(selectedTable);
     const schemas = await this.cliServer.bqrsInfo(
       resultsPath,
       RAW_RESULTS_PAGE_SIZE
@@ -470,21 +471,8 @@ export class InterfaceManager extends DisposableObject {
     if (schema === undefined)
       throw new Error(`Query result set '${selectedTable}' not found.`);
 
-    const getResultsPath = () => {
-      if (sorted) {
-        const resultsPath = results.sortedResultsInfo.get(selectedTable)?.resultsPath;
-        if (resultsPath === undefined) {
-          throw new Error(`Can't find sorted results for table ${selectedTable}`);
-        }
-        return resultsPath;
-      }
-      else {
-        return results.query.resultsPaths.resultsPath;
-      }
-    };
-
     const chunk = await this.cliServer.bqrsDecode(
-      getResultsPath(),
+      results.getResultsPath(selectedTable, sorted),
       schema.name,
       {
         offset: schema.pagination?.offsets[pageNumber],

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

@@ -2,7 +2,6 @@ import { env } from 'vscode';
 
 import { QueryWithResults, tmpDir, QueryInfo } from './run-queries';
 import * as messages from './messages';
-import * as helpers from './helpers';
 import * as cli from './cli';
 import * as sarif from 'sarif';
 import * as fs from 'fs-extra';
@@ -53,7 +52,7 @@ export class CompletedQuery implements QueryWithResults {
     return this.database.name;
   }
   get queryName(): string {
-    return helpers.getQueryName(this.query);
+    return getQueryName(this.query);
   }
 
   get statusString(): string {
@@ -72,6 +71,13 @@ export class CompletedQuery implements QueryWithResults {
     }
   }
 
+  getResultsPath(selectedTable: string, useSorted = true): string {
+    if (!useSorted) {
+      return this.query.resultsPaths.resultsPath;
+    }
+    return this.sortedResultsInfo.get(selectedTable)?.resultsPath
+      || this.query.resultsPaths.resultsPath;
+  }
 
   interpolate(template: string): string {
     const { databaseName, queryName, time, statusString } = this;
@@ -89,9 +95,8 @@ export class CompletedQuery implements QueryWithResults {
   }
 
   getLabel(): string {
-    if (this.options.label !== undefined)
-      return this.options.label;
-    return this.config.format;
+      return this.options?.label
+        || this.config.format;
   }
 
   get didRunSuccessfully(): boolean {
@@ -102,7 +107,11 @@ export class CompletedQuery implements QueryWithResults {
     return this.interpolate(this.getLabel());
   }
 
-  async updateSortState(server: cli.CodeQLCliServer, resultSetName: string, sortState: RawResultsSortState | undefined): Promise<void> {
+  async updateSortState(
+    server: cli.CodeQLCliServer,
+    resultSetName: string,
+    sortState?: RawResultsSortState
+  ): Promise<void> {
     if (sortState === undefined) {
       this.sortedResultsInfo.delete(resultSetName);
       return;
@@ -113,19 +122,50 @@ export class CompletedQuery implements QueryWithResults {
       sortState
     };
 
-    await server.sortBqrs(this.query.resultsPaths.resultsPath, sortedResultSetInfo.resultsPath, resultSetName, [sortState.columnIndex], [sortState.sortDirection]);
+    await server.sortBqrs(
+      this.query.resultsPaths.resultsPath,
+      sortedResultSetInfo.resultsPath,
+      resultSetName,
+      [sortState.columnIndex],
+      [sortState.sortDirection]
+    );
     this.sortedResultsInfo.set(resultSetName, sortedResultSetInfo);
   }
 
-  async updateInterpretedSortState(sortState: InterpretedResultsSortState | undefined): Promise<void> {
+  async updateInterpretedSortState(sortState?: InterpretedResultsSortState): Promise<void> {
     this.interpretedResultsSortState = sortState;
   }
 }
 
+
+/**
+ * Gets a human-readable name for an evaluated query.
+ * Uses metadata if it exists, and defaults to the query file name.
+ */
+export function getQueryName(query: QueryInfo) {
+  // Queries run through quick evaluation are not usually the entire query file.
+  // Label them differently and include the line numbers.
+  if (query.quickEvalPosition !== undefined) {
+    const { line, endLine, fileName } = query.quickEvalPosition;
+    const lineInfo = line === endLine ? `${line}` : `${line}-${endLine}`;
+    return `Quick evaluation of ${path.basename(fileName)}:${lineInfo}`;
+  } else if (query.metadata?.name) {
+    return query.metadata.name;
+  } else {
+    return path.basename(query.program.queryPath);
+  }
+}
+
+
 /**
  * Call cli command to interpret results.
  */
-export async function interpretResults(server: cli.CodeQLCliServer, metadata: QueryMetadata | undefined, resultsPaths: ResultsPaths, sourceInfo?: cli.SourceInfo): Promise<sarif.Log> {
+export async function interpretResults(
+  server: cli.CodeQLCliServer,
+  metadata: QueryMetadata | undefined,
+  resultsPaths: ResultsPaths,
+  sourceInfo?: cli.SourceInfo
+): Promise<sarif.Log> {
   const { resultsPath, interpretedResultsPath } = resultsPaths;
   if (await fs.pathExists(interpretedResultsPath)) {
     return JSON.parse(await fs.readFile(interpretedResultsPath, 'utf8'));