Merge branch 'main' into aeisenberg/open-query-logger

Author: aeisenberg

extensions/ql-vscode/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Fix a bug where database upgrades could not be resolved if some of the target pack's dependencies are outside of the workspace. [#1138](https://github.com/github/vscode-codeql/pull/1138)
 - Open the query server logs for query errors (instead of the extension log). This will make it easier to track down query errors. [#1158](https://github.com/github/vscode-codeql/pull/1158)
+- Fix a bug where queries took a long time to run if there are no folders in the workspace. [#1157](https://github.com/github/vscode-codeql/pull/1157)
 
 ## 1.5.11 - 10 February 2022
 

extensions/ql-vscode/src/cli.ts

@@ -514,8 +514,7 @@ export class CodeQLCliServer implements Disposable {
   async resolveLibraryPath(workspaces: string[], queryPath: string): Promise<QuerySetup> {
     const subcommandArgs = [
       '--query', queryPath,
-      '--additional-packs',
-      workspaces.join(path.delimiter)
+      ...this.getAdditionalPacksArg(workspaces)
     ];
     return await this.runJsonCodeQlCliCommand<QuerySetup>(['resolve', 'library-path'], subcommandArgs, 'Resolving library paths');
   }
@@ -528,8 +527,7 @@ export class CodeQLCliServer implements Disposable {
     const subcommandArgs = [
       '--format', 'bylanguage',
       queryUri.fsPath,
-      '--additional-packs',
-      workspaces.join(path.delimiter)
+      ...this.getAdditionalPacksArg(workspaces)
     ];
     return JSON.parse(await this.runCodeQlCliCommand(['resolve', 'queries'], subcommandArgs, 'Resolving query by language'));
   }
@@ -584,7 +582,7 @@ export class CodeQLCliServer implements Disposable {
   ): AsyncGenerator<TestCompleted, void, unknown> {
 
     const subcommandArgs = this.cliConfig.additionalTestArguments.concat([
-      '--additional-packs', workspaces.join(path.delimiter),
+      ...this.getAdditionalPacksArg(workspaces),
       '--threads',
       this.cliConfig.numberTestThreads.toString(),
       ...testPaths
@@ -606,8 +604,12 @@ export class CodeQLCliServer implements Disposable {
 
   /** Resolves the ML models that should be available when evaluating a query. */
   async resolveMlModels(additionalPacks: string[]): Promise<MlModelsInfo> {
-    return await this.runJsonCodeQlCliCommand<MlModelsInfo>(['resolve', 'ml-models'], ['--additional-packs',
-      additionalPacks.join(path.delimiter)], 'Resolving ML models', false);
+    return await this.runJsonCodeQlCliCommand<MlModelsInfo>(
+      ['resolve', 'ml-models'],
+      this.getAdditionalPacksArg(additionalPacks),
+      'Resolving ML models',
+      false
+    );
   }
 
   /**
@@ -772,7 +774,7 @@ export class CodeQLCliServer implements Disposable {
    * @returns A list of database upgrade script directories
    */
   async resolveUpgrades(dbScheme: string, searchPath: string[], allowDowngradesIfPossible: boolean, targetDbScheme?: string): Promise<UpgradesInfo> {
-    const args = ['--additional-packs', searchPath.join(path.delimiter), '--dbscheme', dbScheme];
+    const args = [...this.getAdditionalPacksArg(searchPath), '--dbscheme', dbScheme];
     if (targetDbScheme) {
       args.push('--target-dbscheme', targetDbScheme);
       if (allowDowngradesIfPossible && await this.cliConstraints.supportsDowngrades()) {
@@ -794,7 +796,7 @@ export class CodeQLCliServer implements Disposable {
    * @returns A dictionary mapping qlpack name to the directory it comes from
    */
   resolveQlpacks(additionalPacks: string[], searchPath?: string[]): Promise<QlpacksInfo> {
-    const args = ['--additional-packs', additionalPacks.join(path.delimiter)];
+    const args = this.getAdditionalPacksArg(additionalPacks);
     if (searchPath?.length) {
       args.push('--search-path', path.join(...searchPath));
     }
@@ -840,7 +842,7 @@ export class CodeQLCliServer implements Disposable {
    * @returns A list of query files found.
    */
   async resolveQueriesInSuite(suite: string, additionalPacks: string[], searchPath?: string[]): Promise<string[]> {
-    const args = ['--additional-packs', additionalPacks.join(path.delimiter)];
+    const args = this.getAdditionalPacksArg(additionalPacks);
     if (searchPath !== undefined) {
       args.push('--search-path', path.join(...searchPath));
     }
@@ -873,8 +875,7 @@ export class CodeQLCliServer implements Disposable {
       '-o',
       outputPath,
       dir,
-      '--additional-packs',
-      workspaceFolders.join(path.delimiter)
+      ...this.getAdditionalPacksArg(workspaceFolders)
     ];
     if (!precompile && await this.cliConstraints.supportsNoPrecompile()) {
       args.push('--no-precompile');
@@ -929,6 +930,12 @@ export class CodeQLCliServer implements Disposable {
         throw new Error('No distribution found');
     }
   }
+
+  private getAdditionalPacksArg(paths: string[]): string[] {
+    return paths.length
+      ? ['--additional-packs', paths.join(path.delimiter)]
+      : [];
+  }
 }
 
 /**

extensions/ql-vscode/src/remote-queries/gh-actions-api-client.ts

@@ -7,16 +7,27 @@ import { logger } from '../logging';
 import { RemoteQueryWorkflowResult } from './remote-query-workflow-result';
 import { DownloadLink } from './download-link';
 import { RemoteQuery } from './remote-query';
-import { RemoteQueryResultIndex, RemoteQueryResultIndexItem } from './remote-query-result-index';
+import { RemoteQueryFailureIndexItem, RemoteQueryResultIndex, RemoteQuerySuccessIndexItem } from './remote-query-result-index';
 
-interface ApiResultIndexItem {
+interface ApiSuccessIndexItem {
   nwo: string;
   id: string;
   results_count: number;
   bqrs_file_size: number;
   sarif_file_size?: number;
 }
 
+interface ApiFailureIndexItem {
+  nwo: string;
+  id: string;
+  error: string;
+}
+
+interface ApiResultIndex {
+  successes: ApiSuccessIndexItem[];
+  failures: ApiFailureIndexItem[];
+}
+
 export async function getRemoteQueryIndex(
   credentials: Credentials,
   remoteQuery: RemoteQuery
@@ -31,9 +42,9 @@ export async function getRemoteQueryIndex(
 
   const artifactList = await listWorkflowRunArtifacts(credentials, owner, repoName, workflowRunId);
   const resultIndexArtifactId = getArtifactIDfromName('result-index', workflowUri, artifactList);
-  const resultIndexItems = await getResultIndexItems(credentials, owner, repoName, resultIndexArtifactId);
+  const resultIndex = await getResultIndex(credentials, owner, repoName, resultIndexArtifactId);
 
-  const items = resultIndexItems.map(item => {
+  const successes = resultIndex?.successes.map(item => {
     const artifactId = getArtifactIDfromName(item.id, workflowUri, artifactList);
 
     return {
@@ -42,13 +53,22 @@ export async function getRemoteQueryIndex(
       nwo: item.nwo,
       resultCount: item.results_count,
       bqrsFileSize: item.bqrs_file_size,
-      sarifFileSize: item.sarif_file_size,
-    } as RemoteQueryResultIndexItem;
+      sarifFileSize: item.sarif_file_size
+    } as RemoteQuerySuccessIndexItem;
+  });
+
+  const failures = resultIndex?.failures.map(item => {
+    return {
+      id: item.id.toString(),
+      nwo: item.nwo,
+      error: item.error
+    } as RemoteQueryFailureIndexItem;
   });
 
   return {
     artifactsUrlPath,
-    items
+    successes: successes || [],
+    failures: failures || []
   };
 }
 
@@ -81,17 +101,17 @@ export async function downloadArtifactFromLink(
  * @param workflowRunId The ID of the workflow run to get the result index for.
  * @returns An object containing the result index.
  */
-async function getResultIndexItems(
+async function getResultIndex(
   credentials: Credentials,
   owner: string,
   repo: string,
   artifactId: number
-): Promise<ApiResultIndexItem[]> {
+): Promise<ApiResultIndex | undefined> {
   const artifactPath = await downloadArtifact(credentials, owner, repo, artifactId);
   const indexFilePath = path.join(artifactPath, 'index.json');
   if (!(await fs.pathExists(indexFilePath))) {
     void showAndLogWarningMessage('Could not find an `index.json` file in the result artifact.');
-    return [];
+    return undefined;
   }
   const resultIndex = await fs.readFile(path.join(artifactPath, 'index.json'), 'utf8');
 

extensions/ql-vscode/src/remote-queries/remote-queries-interface.ts

@@ -82,7 +82,8 @@ export class RemoteQueriesInterfaceManager {
       totalResultCount: totalResultCount,
       executionTimestamp: this.formatDate(query.executionStartTime),
       executionDuration: executionDuration,
-      analysisSummaries: analysisSummaries
+      analysisSummaries: analysisSummaries,
+      analysisFailures: queryResult.analysisFailures,
     };
   }
 

extensions/ql-vscode/src/remote-queries/remote-queries-manager.ts

@@ -128,7 +128,8 @@ export class RemoteQueriesManager {
   }
 
   private mapQueryResult(executionEndTime: Date, resultIndex: RemoteQueryResultIndex, queryId: string): RemoteQueryResult {
-    const analysisSummaries = resultIndex.items.map(item => ({
+
+    const analysisSummaries = resultIndex.successes.map(item => ({
       nwo: item.nwo,
       resultCount: item.resultCount,
       fileSizeInBytes: item.sarifFileSize ? item.sarifFileSize : item.bqrsFileSize,
@@ -139,10 +140,15 @@ export class RemoteQueriesManager {
         queryId,
       } as DownloadLink
     }));
+    const analysisFailures = resultIndex.failures.map(item => ({
+      nwo: item.nwo,
+      error: item.error
+    }));
 
     return {
       executionEndTime,
       analysisSummaries,
+      analysisFailures
     };
   }
 

extensions/ql-vscode/src/remote-queries/remote-query-result-index.ts

@@ -1,13 +1,21 @@
 export interface RemoteQueryResultIndex {
   artifactsUrlPath: string;
-  items: RemoteQueryResultIndexItem[];
+  successes: RemoteQuerySuccessIndexItem[];
+  failures: RemoteQueryFailureIndexItem[];
 }
 
-export interface RemoteQueryResultIndexItem {
+export interface RemoteQuerySuccessIndexItem {
   id: string;
   artifactId: number;
   nwo: string;
   resultCount: number;
   bqrsFileSize: number;
   sarifFileSize?: number;
 }
+
+export interface RemoteQueryFailureIndexItem {
+  id: string;
+  artifactId: number;
+  nwo: string;
+  error: string;
+}

extensions/ql-vscode/src/remote-queries/remote-query-result.ts

@@ -1,8 +1,10 @@
 import { DownloadLink } from './download-link';
+import { AnalysisFailure } from './shared/analysis-failure';
 
 export interface RemoteQueryResult {
   executionEndTime: Date;
   analysisSummaries: AnalysisSummary[];
+  analysisFailures: AnalysisFailure[];
 }
 
 export interface AnalysisSummary {

extensions/ql-vscode/src/remote-queries/sample-data.ts

@@ -83,6 +83,16 @@ export const sampleRemoteQueryResult: RemoteQueryResult = {
         queryId: 'query.ql-123-xyz'
       }
     }
+  ],
+  analysisFailures: [
+    {
+      nwo: 'big-corp/repo5',
+      error: 'Error message'
+    },
+    {
+      nwo: 'big-corp/repo6',
+      error: 'Error message'
+    },
   ]
 };
 

extensions/ql-vscode/src/remote-queries/shared/analysis-failure.ts

@@ -0,0 +1,4 @@
+export interface AnalysisFailure {
+  nwo: string,
+  error: string
+}

extensions/ql-vscode/src/remote-queries/shared/remote-query-result.ts

@@ -1,4 +1,5 @@
 import { DownloadLink } from '../download-link';
+import { AnalysisFailure } from './analysis-failure';
 
 export interface RemoteQueryResult {
   queryTitle: string;
@@ -10,7 +11,8 @@ export interface RemoteQueryResult {
   totalResultCount: number;
   executionTimestamp: string;
   executionDuration: string;
-  analysisSummaries: AnalysisSummary[]
+  analysisSummaries: AnalysisSummary[],
+  analysisFailures: AnalysisFailure[];
 }
 
 export interface AnalysisSummary {