Merge pull request #1353 from github/aeisenberg/sort-remote-results

Add sorting to variant analysis results

Author: aeisenberg

.github/workflows/main.yml

@@ -118,13 +118,17 @@ jobs:
       - name: Run integration tests (Linux)
         if: matrix.os == 'ubuntu-latest'
         working-directory: extensions/ql-vscode
+        env:
+          VSCODE_CODEQL_GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
         run: |
           sudo apt-get install xvfb
           /usr/bin/xvfb-run npm run integration
 
       - name: Run integration tests (Windows)
         if: matrix.os == 'windows-latest'
         working-directory: extensions/ql-vscode
+        env:
+          VSCODE_CODEQL_GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
         run: |
           npm run integration
 

extensions/ql-vscode/src/authentication.ts

@@ -35,7 +35,25 @@ export class Credentials {
     return c;
   }
 
-  private async createOctokit(createIfNone: boolean): Promise<Octokit.Octokit | undefined> {
+  /**
+   * Initializes an instance of credentials with an octokit instance using
+   * a token from the user's GitHub account. This method is meant to be
+   * used non-interactive environments such as tests.
+   *
+   * @param overrideToken The GitHub token to use for authentication.
+   * @returns An instance of credentials.
+   */
+  static async initializeWithToken(overrideToken: string) {
+    const c = new Credentials();
+    c.octokit = await c.createOctokit(false, overrideToken);
+    return c;
+  }
+
+  private async createOctokit(createIfNone: boolean, overrideToken?: string): Promise<Octokit.Octokit | undefined> {
+    if (overrideToken) {
+      return new Octokit.Octokit({ auth: overrideToken });
+    }
+
     const session = await vscode.authentication.getSession(GITHUB_AUTH_PROVIDER_ID, SCOPES, { createIfNone });
 
     if (session) {

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

@@ -116,7 +116,9 @@ export class AnalysesResultsManager {
     const analysisResults: AnalysisResults = {
       nwo: analysis.nwo,
       status: 'InProgress',
-      interpretedResults: []
+      interpretedResults: [],
+      resultCount: analysis.resultCount,
+      starCount: analysis.starCount,
     };
     const queryId = analysis.downloadLink.queryId;
     const resultsForQuery = this.internalGetAnalysesResults(queryId);

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

@@ -1,13 +1,14 @@
 import * as unzipper from 'unzipper';
 import * as path from 'path';
 import * as fs from 'fs-extra';
-import { showAndLogWarningMessage, tmpDir } from '../helpers';
+import { showAndLogErrorMessage, showAndLogWarningMessage, tmpDir } from '../helpers';
 import { Credentials } from '../authentication';
 import { logger } from '../logging';
 import { RemoteQueryWorkflowResult } from './remote-query-workflow-result';
 import { DownloadLink, createDownloadPath } from './download-link';
 import { RemoteQuery } from './remote-query';
 import { RemoteQueryFailureIndexItem, RemoteQueryResultIndex, RemoteQuerySuccessIndexItem } from './remote-query-result-index';
+import { getErrorMessage } from '../pure/helpers-pure';
 
 interface ApiSuccessIndexItem {
   nwo: string;
@@ -332,3 +333,71 @@ export async function createGist(
   }
   return response.data.html_url;
 }
+
+const stargazersQuery = `query Stars($repos: String!, $pageSize: Int!, $cursor: String) {
+  search(
+    query: $repos
+    type: REPOSITORY
+    first: $pageSize
+    after: $cursor
+  ) {
+    edges {
+      node {
+        ... on Repository {
+          name
+          owner {
+            login
+          }
+          stargazerCount
+        }
+      }
+      cursor
+    }
+  }
+}`;
+
+type StargazersQueryResponse = {
+  search: {
+    edges: {
+      cursor: string;
+      node: {
+        name: string;
+        owner: {
+          login: string;
+        };
+        stargazerCount: number;
+      }
+    }[]
+  }
+};
+
+export async function getStargazers(credentials: Credentials, nwos: string[], pageSize = 100): Promise<Record<string, number>> {
+  const octokit = await credentials.getOctokit();
+  const repos = `repo:${nwos.join(' repo:')} fork:true`;
+  let cursor = null;
+  const stargazers: Record<string, number> = {};
+  try {
+    do {
+      const response: StargazersQueryResponse = await octokit.graphql({
+        query: stargazersQuery,
+        repos,
+        pageSize,
+        cursor
+      });
+      cursor = response.search.edges.length === pageSize ? response.search.edges[pageSize - 1].cursor : null;
+
+      for (const edge of response.search.edges) {
+        const node = edge.node;
+        const owner = node.owner.login;
+        const name = node.name;
+        const stargazerCount = node.stargazerCount;
+        stargazers[`${owner}/${name}`] = stargazerCount;
+      }
+
+    } while (cursor);
+  } catch (e) {
+    void showAndLogErrorMessage(`Error retrieving repository metadata for variant analysis: ${getErrorMessage(e)}`);
+  }
+
+  return stargazers;
+}

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

@@ -306,7 +306,8 @@ export class RemoteQueriesInterfaceManager {
       databaseSha: analysisResult.databaseSha || 'HEAD',
       resultCount: analysisResult.resultCount,
       downloadLink: analysisResult.downloadLink,
-      fileSize: this.formatFileSize(analysisResult.fileSizeInBytes)
+      fileSize: this.formatFileSize(analysisResult.fileSizeInBytes),
+      starCount: analysisResult.starCount
     }));
   }
 }

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

@@ -12,7 +12,7 @@ import { runRemoteQuery } from './run-remote-query';
 import { RemoteQueriesInterfaceManager } from './remote-queries-interface';
 import { RemoteQuery } from './remote-query';
 import { RemoteQueriesMonitor } from './remote-queries-monitor';
-import { getRemoteQueryIndex } from './gh-actions-api-client';
+import { getRemoteQueryIndex, getStargazers } from './gh-actions-api-client';
 import { RemoteQueryResultIndex } from './remote-query-result-index';
 import { RemoteQueryResult } from './remote-query-result';
 import { DownloadLink } from './download-link';
@@ -181,8 +181,12 @@ export class RemoteQueriesManager extends DisposableObject {
       results => this.interfaceManager.setAnalysisResults(results, queryResult.queryId));
   }
 
-  private mapQueryResult(executionEndTime: number, resultIndex: RemoteQueryResultIndex, queryId: string): RemoteQueryResult {
-
+  private mapQueryResult(
+    executionEndTime: number,
+    resultIndex: RemoteQueryResultIndex,
+    queryId: string,
+    stargazers: Record<string, number>
+  ): RemoteQueryResult {
     const analysisSummaries = resultIndex.successes.map(item => ({
       nwo: item.nwo,
       databaseSha: item.sha || 'HEAD',
@@ -193,6 +197,7 @@ export class RemoteQueriesManager extends DisposableObject {
         urlPath: `${resultIndex.artifactsUrlPath}/${item.artifactId}`,
         innerFilePath: item.sarifFileSize ? 'results.sarif' : 'results.bqrs',
         queryId,
+        starCount: stargazers[item.nwo]
       } as DownloadLink
     }));
     const analysisFailures = resultIndex.failures.map(item => ({
@@ -279,7 +284,8 @@ export class RemoteQueriesManager extends DisposableObject {
       queryItem.completed = true;
       queryItem.status = QueryStatus.Completed;
       queryItem.failureReason = undefined;
-      const queryResult = this.mapQueryResult(executionEndTime, resultIndex, queryItem.queryId);
+      const stargazers = await this.getStargazersCount(resultIndex, credentials);
+      const queryResult = this.mapQueryResult(executionEndTime, resultIndex, queryItem.queryId, stargazers);
 
       await this.storeJsonFile(queryItem, 'query-result.json', queryResult);
 
@@ -303,7 +309,12 @@ export class RemoteQueriesManager extends DisposableObject {
     }
   }
 
-  // Pulled from the analysis results manager, so that we can get access to 
+  private async getStargazersCount(resultIndex: RemoteQueryResultIndex, credentials: Credentials) {
+    const nwos = resultIndex.successes.map(s => s.nwo);
+    return await getStargazers(credentials, nwos);
+  }
+
+  // Pulled from the analysis results manager, so that we can get access to
   // analyses results from the "export results" command.
   public getAnalysesResults(queryId: string): AnalysisResults[] {
     return [...this.analysesResultsManager.getAnalysesResults(queryId)];

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

@@ -2,16 +2,17 @@ import { DownloadLink } from './download-link';
 import { AnalysisFailure } from './shared/analysis-failure';
 
 export interface RemoteQueryResult {
-  executionEndTime: number; // Can't use a Date here since it needs to be serialized and desserialized.
-  analysisSummaries: AnalysisSummary[];
-  analysisFailures: AnalysisFailure[];
-  queryId: string;
+  executionEndTime: number, // Can't use a Date here since it needs to be serialized and desserialized.
+  analysisSummaries: AnalysisSummary[],
+  analysisFailures: AnalysisFailure[],
+  queryId: string,
 }
 
 export interface AnalysisSummary {
   nwo: string,
   databaseSha: string,
   resultCount: number,
   downloadLink: DownloadLink,
-  fileSizeInBytes: number
+  fileSizeInBytes: number,
+  starCount?: number,
 }

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

@@ -7,6 +7,8 @@ export interface AnalysisResults {
   status: AnalysisResultStatus;
   interpretedResults: AnalysisAlert[];
   rawResults?: AnalysisRawResults;
+  resultCount: number,
+  starCount?: number,
 }
 
 export interface AnalysisRawResults {

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

@@ -2,19 +2,19 @@ import { DownloadLink } from '../download-link';
 import { AnalysisFailure } from './analysis-failure';
 
 export interface RemoteQueryResult {
-  queryTitle: string;
-  queryFileName: string;
-  queryFilePath: string;
-  queryText: string;
-  language: string;
-  workflowRunUrl: string;
-  totalRepositoryCount: number;
-  affectedRepositoryCount: number;
-  totalResultCount: number;
-  executionTimestamp: string;
-  executionDuration: string;
-  analysisSummaries: AnalysisSummary[];
-  analysisFailures: AnalysisFailure[];
+  queryTitle: string,
+  queryFileName: string,
+  queryFilePath: string,
+  queryText: string,
+  language: string,
+  workflowRunUrl: string,
+  totalRepositoryCount: number,
+  affectedRepositoryCount: number,
+  totalResultCount: number,
+  executionTimestamp: string,
+  executionDuration: string,
+  analysisSummaries: AnalysisSummary[],
+  analysisFailures: AnalysisFailure[],
 }
 
 export interface AnalysisSummary {
@@ -23,4 +23,5 @@ export interface AnalysisSummary {
   resultCount: number,
   downloadLink: DownloadLink,
   fileSize: string,
+  starCount?: number,
 }