Treat status reports as non-critical

Change `sendStatusReport` to `void`

Author: jsoref

CHANGELOG.md

@@ -6,7 +6,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the
 
 ## [UNRELEASED]
 
-No user facing changes.
+- The upload-sarif action should not fail if it can't write to the telemetry api endpoint [#2121](https://github.com/github/codeql-action/pull/2121)
 
 ## 3.24.0 - 02 Feb 2024
 

lib/analyze-action-env.test.js

@@ -1,6 +1,6 @@
 {
   "name": "codeql",
-  "version": "3.24.1",
+  "version": "3.25.0",
   "private": true,
   "description": "CodeQL action",
   "scripts": {

lib/analyze-action-env.test.js.map

@@ -30,7 +30,7 @@ test("analyze action with RAM & threads from environment variables", async (t) =
     sinon
       .stub(statusReport, "createStatusReportBase")
       .resolves({} as statusReport.StatusReportBase);
-    sinon.stub(statusReport, "sendStatusReport").resolves(true);
+    sinon.stub(statusReport, "sendStatusReport").resolves();
     sinon.stub(actionsUtil, "isAnalyzingDefaultBranch").resolves(true);
 
     const gitHubVersion: util.GitHubVersion = {

lib/analyze-action-input.test.js

@@ -30,7 +30,7 @@ test("analyze action with RAM & threads from action inputs", async (t) => {
     sinon
       .stub(statusReport, "createStatusReportBase")
       .resolves({} as statusReport.StatusReportBase);
-    sinon.stub(statusReport, "sendStatusReport").resolves(true);
+    sinon.stub(statusReport, "sendStatusReport").resolves();
     const gitHubVersion: util.GitHubVersion = {
       type: util.GitHubVariant.DOTCOM,
     };

lib/analyze-action-input.test.js.map

@@ -182,18 +182,15 @@ async function run() {
 
   const logger = getActionsLogger();
   try {
-    if (
-      !(await statusReport.sendStatusReport(
-        await createStatusReportBase(
-          "finish",
-          "starting",
-          startedAt,
-          await util.checkDiskUsage(logger),
-        ),
-      ))
-    ) {
-      return;
-    }
+    await statusReport.sendStatusReport(
+      await createStatusReportBase(
+        "finish",
+        "starting",
+        startedAt,
+        await util.checkDiskUsage(logger),
+      ),
+    );
+
     config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
     if (config === undefined) {
       throw new Error(

lib/analyze-action.js

@@ -63,18 +63,14 @@ async function run() {
   let currentLanguage: Language | undefined = undefined;
   let languages: Language[] | undefined = undefined;
   try {
-    if (
-      !(await sendStatusReport(
-        await createStatusReportBase(
-          "autobuild",
-          "starting",
-          startedAt,
-          await checkDiskUsage(logger),
-        ),
-      ))
-    ) {
-      return;
-    }
+    await sendStatusReport(
+      await createStatusReportBase(
+        "autobuild",
+        "starting",
+        startedAt,
+        await checkDiskUsage(logger),
+      ),
+    );
 
     const gitHubVersion = await getGitHubVersion();
     checkGitHubVersionInRange(gitHubVersion, logger);

lib/analyze-action.js.map

@@ -229,18 +229,14 @@ async function run() {
   core.exportVariable(EnvVar.JOB_RUN_UUID, uuidV4());
 
   try {
-    if (
-      !(await sendStatusReport(
-        await createStatusReportBase(
-          "init",
-          "starting",
-          startedAt,
-          await checkDiskUsage(logger),
-        ),
-      ))
-    ) {
-      return;
-    }
+    await sendStatusReport(
+      await createStatusReportBase(
+        "init",
+        "starting",
+        startedAt,
+        await checkDiskUsage(logger),
+      ),
+    );
 
     const codeQLDefaultVersionInfo = await features.getDefaultCliVersion(
       gitHubVersion.type,

lib/autobuild-action.js

@@ -32,18 +32,14 @@ async function run() {
   const logger = getActionsLogger();
 
   try {
-    if (
-      !(await sendStatusReport(
-        await createStatusReportBase(
-          ACTION_NAME,
-          "starting",
-          startedAt,
-          await checkDiskUsage(logger),
-        ),
-      ))
-    ) {
-      return;
-    }
+    await sendStatusReport(
+      await createStatusReportBase(
+        ACTION_NAME,
+        "starting",
+        startedAt,
+        await checkDiskUsage(logger),
+      ),
+    );
 
     const gitHubVersion = await getGitHubVersion();
     checkGitHubVersionInRange(gitHubVersion, logger);

lib/autobuild-action.js.map

@@ -282,10 +282,6 @@ export async function createStatusReportBase(
   return statusReport;
 }
 
-const GENERIC_403_MSG =
-  "The repo on which this action is running is not opted-in to CodeQL code scanning.";
-const GENERIC_404_MSG =
-  "Not authorized to use the CodeQL code scanning feature on this repo.";
 const OUT_OF_DATE_MSG =
   "CodeQL Action is out-of-date. Please upgrade to the latest version of codeql-action.";
 const INCOMPATIBLE_MSG =
@@ -298,19 +294,24 @@ const INCOMPATIBLE_MSG =
  * as failed if the status report failed. This is only expected to be used
  * when sending a 'starting' report.
  *
- * Returns whether sending the status report was successful of not.
+ * This API it calls is private and it is not critical that it succeed:
+ * https://github.com/github/codeql/issues/15462#issuecomment-1919186317
+ *
+ * Do not worry about whether a report is/isn't submitted.
+ * Just go about your business.
+ * The side effects of this call are not relevant to your program.
  */
 export async function sendStatusReport<S extends StatusReportBase>(
   statusReport: S,
-): Promise<boolean> {
+): Promise<void> {
   setJobStatusIfUnsuccessful(statusReport.status);
 
   const statusReportJSON = JSON.stringify(statusReport);
   core.debug(`Sending status report: ${statusReportJSON}`);
   // If in test mode we don't want to upload the results
   if (isInTestMode()) {
     core.debug("In test mode. Status reports are not uploaded.");
-    return true;
+    return;
   }
 
   const nwo = getRequiredEnvParam("GITHUB_REPOSITORY");
@@ -326,8 +327,6 @@ export async function sendStatusReport<S extends StatusReportBase>(
         data: statusReportJSON,
       },
     );
-
-    return true;
   } catch (e) {
     console.log(e);
     if (isHTTPError(e)) {
@@ -337,19 +336,19 @@ export async function sendStatusReport<S extends StatusReportBase>(
             getWorkflowEventName() === "push" &&
             process.env["GITHUB_ACTOR"] === "dependabot[bot]"
           ) {
-            core.setFailed(
+            core.warning(
               'Workflows triggered by Dependabot on the "push" event run with read-only access. ' +
                 "Uploading Code Scanning results requires write access. " +
                 'To use Code Scanning with Dependabot, please ensure you are using the "pull_request" event for this workflow and avoid triggering on the "push" event for Dependabot branches. ' +
                 "See https://docs.github.com/en/code-security/secure-coding/configuring-code-scanning#scanning-on-push for more information on how to configure these events.",
             );
           } else {
-            core.setFailed(e.message || GENERIC_403_MSG);
+            core.warning(e.message);
           }
-          return false;
+          return;
         case 404:
-          core.setFailed(GENERIC_404_MSG);
-          return false;
+          core.warning(e.message);
+          return;
         case 422:
           // schema incompatibility when reporting status
           // this means that this action version is no longer compatible with the API
@@ -359,15 +358,14 @@ export async function sendStatusReport<S extends StatusReportBase>(
           } else {
             core.debug(OUT_OF_DATE_MSG);
           }
-          return true;
+          return;
       }
     }
 
     // something else has gone wrong and the request/response will be logged by octokit
     // it's possible this is a transient error and we should continue scanning
-    core.error(
+    core.warning(
       "An unexpected error occurred when sending code scanning status report.",
     );
-    return true;
   }
 }

lib/init-action.js

@@ -16,6 +16,11 @@ import { parseRepositoryNwo, RepositoryNwo } from "./repository";
 import * as util from "./util";
 import { SarifFile, UserError, wrapError } from "./util";
 
+const GENERIC_403_MSG =
+  "The repo on which this action is running is not opted-in to CodeQL code scanning.";
+const GENERIC_404_MSG =
+  "Not authorized to use the CodeQL code scanning feature on this repo.";
+
 // Takes a list of paths to sarif files and combines them together,
 // returning the contents of the combined sarif file.
 function combineSarifFiles(sarifFiles: string[]): SarifFile {
@@ -107,19 +112,35 @@ async function uploadPayload(
 
   const client = api.getApiClient();
 
-  const response = await client.request(
-    "PUT /repos/:owner/:repo/code-scanning/analysis",
-    {
-      owner: repositoryNwo.owner,
-      repo: repositoryNwo.repo,
-      data: payload,
-    },
-  );
-
-  logger.debug(`response status: ${response.status}`);
-  logger.info("Successfully uploaded results");
+  try {
+    const response = await client.request(
+      "PUT /repos/:owner/:repo/code-scanning/analysis",
+      {
+        owner: repositoryNwo.owner,
+        repo: repositoryNwo.repo,
+        data: payload,
+      },
+    );
 
-  return response.data.id;
+    logger.debug(`response status: ${response.status}`);
+    logger.info("Successfully uploaded results");
+    return response.data.id;
+  } catch (e) {
+    if (util.isHTTPError(e)) {
+      switch (e.status) {
+        case 403:
+          core.warning(e.message || GENERIC_403_MSG);
+          break;
+        case 404:
+          core.warning(e.message || GENERIC_404_MSG);
+          break;
+        default:
+          core.warning(e.message);
+          break;
+      }
+    }
+    throw e;
+  }
 }
 
 export interface UploadStatusReport {

lib/init-action.js.map

@@ -50,18 +50,14 @@ async function run() {
   const gitHubVersion = await getGitHubVersion();
   checkActionVersion(getActionVersion(), gitHubVersion);
 
-  if (
-    !(await sendStatusReport(
-      await createStatusReportBase(
-        "upload-sarif",
-        "starting",
-        startedAt,
-        await checkDiskUsage(),
-      ),
-    ))
-  ) {
-    return;
-  }
+  await sendStatusReport(
+    await createStatusReportBase(
+      "upload-sarif",
+      "starting",
+      startedAt,
+      await checkDiskUsage(),
+    ),
+  );
 
   try {
     const uploadResult = await upload_lib.uploadFromActions(