Split out waiting for processing.

2026-01-04 21:50:17 +08:00 · 2021-11-17 13:20:36 +00:00
parent e0b9b9a248
commit 4eef7ef32c
9 changed files with 185 additions and 134 deletions
--- a/src/analyze-action.ts
+++ b/src/analyze-action.ts
@@ -18,7 +18,7 @@ import { uploadDatabases } from "./database-upload";
 import { getActionsLogger } from "./logging";
 import { parseRepositoryNwo } from "./repository";
 import * as upload_lib from "./upload-lib";
-import { UploadStatusReport } from "./upload-lib";
+import { UploadResult } from "./upload-lib";
 import * as util from "./util";
 import { bundleDb, codeQlVersionAbove, DEBUG_ARTIFACT_NAME } from "./util";

@@ -58,7 +58,7 @@ export async function sendStatusReport(

 async function run() {
  const startedAt = new Date();
-  let uploadStats: UploadStatusReport | undefined = undefined;
+  let uploadResult: UploadResult | undefined = undefined;
  let runStats: QueriesStatusReport | undefined = undefined;
  let config: Config | undefined = undefined;
  util.initializeEnvironment(util.Mode.actions, pkg.version);
@@ -163,7 +163,7 @@ async function run() {
    core.setOutput("db-locations", dbLocations);

    if (runStats && actionsUtil.getRequiredInput("upload") === "true") {
-      uploadStats = await upload_lib.uploadFromActions(
+      uploadResult = await upload_lib.uploadFromActions(
        outputDir,
        config.gitHubVersion,
        apiDetails,
@@ -178,6 +178,18 @@ async function run() {
    );
    await uploadDatabases(repositoryNwo, config, apiDetails, logger); // Possibly upload the database bundles for remote queries

+    if (
+      uploadResult !== undefined &&
+      actionsUtil.getRequiredInput("wait-for-processing") === "true"
+    ) {
+      await upload_lib.waitForProcessing(
+        parseRepositoryNwo(util.getRequiredEnvParam("GITHUB_REPOSITORY")),
+        uploadResult.sarifID,
+        apiDetails,
+        getActionsLogger()
+      );
+    }
+
    if (config.debugMode) {
      // Upload the database bundles as an Actions artifact for debugging
      const toUpload: string[] = [];
@@ -227,8 +239,11 @@ async function run() {
    }
  }

-  if (runStats && uploadStats) {
-    await sendStatusReport(startedAt, { ...runStats, ...uploadStats });
+  if (runStats && uploadResult) {
+    await sendStatusReport(startedAt, {
+      ...runStats,
+      ...uploadResult.statusReport,
+    });
  } else if (runStats) {
    await sendStatusReport(startedAt, { ...runStats });
  } else {
--- a/src/upload-lib.ts
+++ b/src/upload-lib.ts
@@ -123,6 +123,11 @@ export interface UploadStatusReport {
  num_results_in_sarif?: number;
 }

+export interface UploadResult {
+  statusReport: UploadStatusReport;
+  sarifID: string;
+}
+
 // Recursively walks a directory and returns all SARIF files it finds.
 // Does not follow symlinks.
 export function findSarifFilesInDir(sarifPath: string): string[] {
@@ -149,7 +154,7 @@ export async function uploadFromActions(
  gitHubVersion: util.GitHubVersion,
  apiDetails: api.GitHubApiDetails,
  logger: Logger
-): Promise<UploadStatusReport> {
+): Promise<UploadResult> {
  return await uploadFiles(
    getSarifFilePaths(sarifPath),
    parseRepositoryNwo(util.getRequiredEnvParam("GITHUB_REPOSITORY")),
@@ -161,7 +166,6 @@ export async function uploadFromActions(
    actionsUtil.getWorkflowRunID(),
    actionsUtil.getRequiredInput("checkout_path"),
    actionsUtil.getRequiredInput("matrix"),
-    actionsUtil.getRequiredInput("wait-for-processing") === "true",
    gitHubVersion,
    apiDetails,
    logger
@@ -181,7 +185,7 @@ export async function uploadFromRunner(
  gitHubVersion: util.GitHubVersion,
  apiDetails: api.GitHubApiDetails,
  logger: Logger
-): Promise<UploadStatusReport> {
+): Promise<UploadResult> {
  return await uploadFiles(
    getSarifFilePaths(sarifPath),
    repositoryNwo,
@@ -193,7 +197,6 @@ export async function uploadFromRunner(
    undefined,
    sourceRoot,
    undefined,
-    false,
    gitHubVersion,
    apiDetails,
    logger
@@ -327,9 +330,6 @@ export function buildPayload(
  }
 }

-const STATUS_CHECK_FREQUENCY_MILLISECONDS = 5 * 1000;
-const STATUS_CHECK_TIMEOUT_MILLISECONDS = 2 * 60 * 1000;
-
 // Uploads the given set of sarif files.
 // Returns true iff the upload occurred and succeeded
 async function uploadFiles(
@@ -343,11 +343,10 @@ async function uploadFiles(
  workflowRunID: number | undefined,
  sourceRoot: string,
  environment: string | undefined,
-  waitForProcessing: boolean,
  gitHubVersion: util.GitHubVersion,
  apiDetails: api.GitHubApiDetails,
  logger: Logger
-): Promise<UploadStatusReport> {
+): Promise<UploadResult> {
  logger.startGroup("Uploading results");
  logger.info(`Processing sarif files: ${JSON.stringify(sarifFiles)}`);

@@ -407,66 +406,78 @@ async function uploadFiles(

  logger.endGroup();

-  if (waitForProcessing) {
-    logger.startGroup("Waiting for processing to finish");
-    const client = api.getApiClient(apiDetails);
+  return {
+    statusReport: {
+      raw_upload_size_bytes: rawUploadSizeBytes,
+      zipped_upload_size_bytes: zippedUploadSizeBytes,
+      num_results_in_sarif: numResultInSarif,
+    },
+    sarifID,
+  };
+}

-    const statusCheckingStarted = Date.now();
-    // eslint-disable-next-line no-constant-condition
-    while (true) {
-      if (
-        Date.now() >
-        statusCheckingStarted + STATUS_CHECK_TIMEOUT_MILLISECONDS
-      ) {
-        // If the analysis hasn't finished processing in the allotted time, we continue anyway rather than failing.
-        // It's possible the analysis will eventually finish processing, but it's not worth spending more Actions time waiting.
-        logger.warning(
-          "Timed out waiting for analysis to finish processing. Continuing."
-        );
+const STATUS_CHECK_FREQUENCY_MILLISECONDS = 5 * 1000;
+const STATUS_CHECK_TIMEOUT_MILLISECONDS = 2 * 60 * 1000;
+
+// Waits until either the analysis is successfully processed, a processing error is reported, or STATUS_CHECK_TIMEOUT_MILLISECONDS elapses.
+export async function waitForProcessing(
+  repositoryNwo: RepositoryNwo,
+  sarifID: string,
+  apiDetails: api.GitHubApiDetails,
+  logger: Logger
+): Promise<void> {
+  logger.startGroup("Waiting for processing to finish");
+  const client = api.getApiClient(apiDetails);
+
+  const statusCheckingStarted = Date.now();
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    if (
+      Date.now() >
+      statusCheckingStarted + STATUS_CHECK_TIMEOUT_MILLISECONDS
+    ) {
+      // If the analysis hasn't finished processing in the allotted time, we continue anyway rather than failing.
+      // It's possible the analysis will eventually finish processing, but it's not worth spending more Actions time waiting.
+      logger.warning(
+        "Timed out waiting for analysis to finish processing. Continuing."
+      );
+      break;
+    }
+    // We put the delay at the start of the loop, since it's unlikely that the analysis will have succeeded immediately. We might as well wait preemptively.
+    await util.delay(STATUS_CHECK_FREQUENCY_MILLISECONDS);
+    try {
+      const response = await client.request(
+        "GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id",
+        {
+          owner: repositoryNwo.owner,
+          repo: repositoryNwo.repo,
+          sarif_id: sarifID,
+        }
+      );
+      const status = response.data.processing_status;
+      logger.info(`Analysis upload status is ${status}.`);
+      if (status === "complete") {
        break;
-      }
-      // We put the delay at the start of the loop, since it's unlikely that the analysis will have succeeded immediately. We might as well wait preemptively.
-      await util.delay(STATUS_CHECK_FREQUENCY_MILLISECONDS);
-      try {
-        const response = await client.request(
-          "GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id",
-          {
-            owner: repositoryNwo.owner,
-            repo: repositoryNwo.repo,
-            sarif_id: sarifID,
-          }
+      } else if (status === "failed") {
+        throw new Error(
+          `Code Scanning could not process the submitted SARIF file:\n${response.data.errors}`
        );
-        const status = response.data.processing_status;
-        logger.info(`Analysis upload status is ${status}.`);
-        if (status === "complete") {
-          break;
-        } else if (status === "failed") {
-          throw new Error(
-            `Code Scanning could not process the submitted SARIF file:\n${response.data.errors}`
-          );
-        }
-      } catch (e) {
-        if (util.isHTTPError(e)) {
-          switch (e.status) {
-            case 404:
-              logger.debug("Analysis is not found yet...");
-              break;
-            default:
-              throw e;
-          }
-        } else {
-          throw e;
+      }
+    } catch (e) {
+      if (util.isHTTPError(e)) {
+        switch (e.status) {
+          case 404:
+            logger.debug("Analysis is not found yet...");
+            break;
+          default:
+            throw e;
        }
+      } else {
+        throw e;
      }
    }
-    logger.endGroup();
  }
-
-  return {
-    raw_upload_size_bytes: rawUploadSizeBytes,
-    zipped_upload_size_bytes: zippedUploadSizeBytes,
-    num_results_in_sarif: numResultInSarif,
-  };
+  logger.endGroup();
 }

 export function validateUniqueCategory(category: string | undefined) {
--- a/src/upload-sarif-action.ts
+++ b/src/upload-sarif-action.ts
@@ -2,6 +2,7 @@ import * as core from "@actions/core";

 import * as actionsUtil from "./actions-util";
 import { getActionsLogger } from "./logging";
+import { parseRepositoryNwo } from "./repository";
 import * as upload_lib from "./upload-lib";
 import {
  getGitHubVersion,
@@ -56,13 +57,21 @@ async function run() {

    const gitHubVersion = await getGitHubVersion(apiDetails);

-    const uploadStats = await upload_lib.uploadFromActions(
+    const uploadResult = await upload_lib.uploadFromActions(
      actionsUtil.getRequiredInput("sarif_file"),
      gitHubVersion,
      apiDetails,
      getActionsLogger()
    );
-    await sendSuccessStatusReport(startedAt, uploadStats);
+    if (actionsUtil.getRequiredInput("wait-for-processing") === "true") {
+      await upload_lib.waitForProcessing(
+        parseRepositoryNwo(getRequiredEnvParam("GITHUB_REPOSITORY")),
+        uploadResult.sarifID,
+        apiDetails,
+        getActionsLogger()
+      );
+    }
+    await sendSuccessStatusReport(startedAt, uploadResult.statusReport);
  } catch (error) {
    const message = error instanceof Error ? error.message : String(error);
    const stack = error instanceof Error ? error.stack : String(error);