Merge branch 'main' into mbg/deprecate-getRunnerLogger

2026-11-08 22:19:50 +00:00 · 2026-10-21 17:01:07 +01:00
parent 8bb7f8f14a c5a2f4b0fe
commit 16aecb7bc0
25 changed files with 465 additions and 266 deletions
--- a/lib/defaults.json
+++ b/lib/defaults.json
@@ -1,6 +1,6 @@
 {
-  "bundleVersion": "codeql-bundle-v2.27.2",
-  "cliVersion": "2.27.2",
-  "priorBundleVersion": "codeql-bundle-v2.27.1",
-  "priorCliVersion": "2.27.1"
+  "bundleVersion": "codeql-bundle-v2.27.3",
+  "cliVersion": "2.27.3",
+  "priorBundleVersion": "codeql-bundle-v2.27.2",
+  "priorCliVersion": "2.27.2"
 }
--- a/lib/entry-points.js
+++ b/lib/entry-points.js
@@ -169889,8 +169889,15 @@ async function delay(milliseconds, opts) {
 function isGoodVersion(versionSpec) {
  return !BROKEN_VERSIONS.includes(versionSpec);
 }
-function shouldSkipSarifUpload() {
-  return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true";
+function shouldSkipGenerateFailedSarif(env = getEnv()) {
+  const skipGenerateFailedSarif = env.getOptional(
+    "CODEQL_ACTION_SKIP_GENERATE_FAILED_SARIF" /* SKIP_GENERATE_FAILED_SARIF */
+  );
+  return skipGenerateFailedSarif !== "false" && (shouldSkipSarifUpload(env) || skipGenerateFailedSarif === "true");
+}
+function shouldSkipSarifUpload(env = getEnv()) {
+  const skipSarifUpload = env.getOptional("CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */);
+  return skipSarifUpload !== "false" && (env.isSkippingUploadsInTests() || skipSarifUpload === "true");
 }
 function getTestingEnvironment() {
  const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || "";
@@ -171804,8 +171811,8 @@ var path6 = __toESM(require("path"));
 var semver3 = __toESM(require_semver2());

 // src/defaults.json
-var bundleVersion = "codeql-bundle-v2.27.2";
-var cliVersion = "2.27.2";
+var bundleVersion = "codeql-bundle-v2.27.3";
+var cliVersion = "2.27.3";

 // src/overlay/index.ts
 var fs5 = __toESM(require("fs"));
@@ -172097,11 +172104,6 @@ var featureConfig = {
    minimumVersion: CODEQL_OVERLAY_MINIMUM_VERSION_RUBY
  },
  // Other overlay-related feature flags
-  ["overlay_analysis_disable_trap_caching" /* OverlayAnalysisDisableTrapCaching */]: {
-    defaultValue: false,
-    envVar: "CODEQL_ACTION_OVERLAY_ANALYSIS_DISABLE_TRAP_CACHING",
-    minimumVersion: void 0
-  },
  ["overlay_analysis_match_codeql_version" /* OverlayAnalysisMatchCodeqlVersion */]: {
    defaultValue: false,
    envVar: "CODEQL_ACTION_OVERLAY_ANALYSIS_MATCH_CODEQL_VERSION",
@@ -174846,11 +174848,11 @@ async function validateOverlayDatabaseMode(overlayDatabaseMode, useOverlayDataba
    overlayModeSetExplicitly
  });
 }
-async function isTrapCachingEnabled(features, overlayDatabaseMode) {
+function isTrapCachingEnabled(overlayDatabaseMode) {
  const trapCaching = getOptionalInput("trap-caching");
  if (trapCaching !== void 0) return trapCaching === "true";
  if (!looksLikeHostedRunner()) return false;
-  if (overlayDatabaseMode !== "none" /* None */ && await features.getValue("overlay_analysis_disable_trap_caching" /* OverlayAnalysisDisableTrapCaching */)) {
+  if (overlayDatabaseMode !== "none" /* None */) {
    return false;
  }
  return true;
@@ -175053,7 +175055,7 @@ async function initConfig(actionState, inputs) {
    inputs.codeql,
    logger2
  );
-  if (await isTrapCachingEnabled(features, config.overlayDatabaseMode)) {
+  if (isTrapCachingEnabled(config.overlayDatabaseMode)) {
    const { trapCaches, trapCacheDownloadTime } = await downloadCacheWithTime(
      inputs.codeql,
      config.languages,
@@ -178551,6 +178553,7 @@ __export(upload_lib_exports, {
  filterAlertsByDiffRange: () => filterAlertsByDiffRange,
  findSarifFilesInDir: () => findSarifFilesInDir,
  getGroupedSarifFilePaths: () => getGroupedSarifFilePaths,
+  getSavedPayloadPath: () => getSavedPayloadPath,
  populateRunAutomationDetails: () => populateRunAutomationDetails,
  postProcessSarifFiles: () => postProcessSarifFiles,
  readSarifFileOrThrow: () => readSarifFileOrThrow,
@@ -180026,7 +180029,7 @@ async function shouldDisableCombineSarifFiles(sarifObjects, githubVersion) {
  }
  return true;
 }
-async function combineSarifFilesUsingCLI(sarifFiles, gitHubVersion, features, logger2) {
+async function combineSarifFilesUsingCLI(sarifFiles, gitHubVersion, features, logger2, config) {
  const env = getEnv();
  logger2.info("Combining SARIF files using the CodeQL CLI");
  const sarifObjects = sarifFiles.map(readSarifFile);
@@ -180047,7 +180050,6 @@ async function combineSarifFilesUsingCLI(sarifFiles, gitHubVersion, features, lo
  }
  let codeQL;
  let tempDir = getTemporaryDirectory();
-  const config = await getConfig(tempDir, logger2);
  if (config !== void 0) {
    codeQL = await getCodeQL(logger2, config.codeQLCmd);
    tempDir = config.tempDir;
@@ -180114,13 +180116,16 @@ function getAutomationID2(category, analysis_key, environment) {
  }
  return computeAutomationID(analysis_key, environment);
 }
+function getSavedPayloadPath(analysisKind) {
+  return path19.join(
+    getTemporaryDirectory(),
+    `payload-${analysisKind}.json`
+  );
+}
 async function uploadPayload(payload, repositoryNwo, logger2, analysis) {
  logger2.info("Uploading results");
  if (shouldSkipSarifUpload()) {
-    const payloadSaveFile = path19.join(
-      getTemporaryDirectory(),
-      `payload-${analysis.kind}.json`
-    );
+    const payloadSaveFile = getSavedPayloadPath(analysis.kind);
    logger2.info(
      `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}`
    );
@@ -180332,7 +180337,7 @@ function buildPayload(commitOid, ref, analysisKey, analysisName, zippedSarif, wo
  }
  return payloadObj;
 }
-async function postProcessSarifFiles(logger2, features, checkoutPath, sarifPaths, category, analysis) {
+async function postProcessSarifFiles(logger2, features, config, checkoutPath, sarifPaths, category, analysis) {
  logger2.info(`Post-processing sarif files: ${JSON.stringify(sarifPaths)}`);
  const gitHubVersion = await getGitHubVersion();
  let sarifLog;
@@ -180346,7 +180351,8 @@ async function postProcessSarifFiles(logger2, features, checkoutPath, sarifPaths
      sarifPaths,
      gitHubVersion,
      features,
-      logger2
+      logger2,
+      config
    );
  } else {
    const sarifPath = sarifPaths[0];
@@ -180379,13 +180385,14 @@ async function writePostProcessedFiles(logger2, pathInput, uploadTarget, postPro
    logger2.debug(`Not writing post-processed SARIF files.`);
  }
 }
-async function uploadFiles(inputSarifPath, checkoutPath, category, features, logger2, uploadTarget) {
+async function uploadFiles(config, inputSarifPath, checkoutPath, category, features, logger2, uploadTarget) {
  const sarifPaths = getSarifFilePaths(
    inputSarifPath,
    uploadTarget.sarifPredicate
  );
  return uploadSpecifiedFiles(
    sarifPaths,
+    config,
    checkoutPath,
    category,
    features,
@@ -180393,10 +180400,11 @@ async function uploadFiles(inputSarifPath, checkoutPath, category, features, log
    uploadTarget
  );
 }
-async function uploadSpecifiedFiles(sarifPaths, checkoutPath, category, features, logger2, uploadTarget) {
+async function uploadSpecifiedFiles(sarifPaths, config, checkoutPath, category, features, logger2, uploadTarget) {
  const processingResults = await postProcessSarifFiles(
    logger2,
    features,
+    config,
    checkoutPath,
    sarifPaths,
    category,
@@ -180481,6 +180489,12 @@ async function waitForProcessing(repositoryNwo, sarifID, logger2, options = {
 }) {
  logger2.startGroup("Waiting for processing to finish");
  try {
+    if (shouldSkipSarifUpload()) {
+      logger2.info(
+        "Nothing to wait for, because SARIF upload is disabled by an environment variable and the SARIF was saved to disk."
+      );
+      return;
+    }
    const client = getApiClient();
    let statusCheckBackoff = STATUS_CHECK_INITIAL_BACKOFF_MILLISECONDS;
    if (process.env["NODE_ENV"] !== "test") {
@@ -180626,7 +180640,7 @@ function filterAlertsByDiffRange(logger2, sarifLog) {
 }

 // src/upload-sarif.ts
-async function postProcessAndUploadSarif(logger2, features, uploadKind, checkoutPath, sarifPath, category, postProcessedOutputPath) {
+async function postProcessAndUploadSarif(logger2, features, config, uploadKind, checkoutPath, sarifPath, category, postProcessedOutputPath) {
  const sarifGroups = await getGroupedSarifFilePaths(
    logger2,
    sarifPath
@@ -180639,6 +180653,7 @@ async function postProcessAndUploadSarif(logger2, features, uploadKind, checkout
    const postProcessingResults = await postProcessSarifFiles(
      logger2,
      features,
+      config,
      checkoutPath,
      sarifFiles,
      category,
@@ -180869,6 +180884,7 @@ async function run(action) {
      uploadResults = await postProcessAndUploadSarif(
        logger2,
        features,
+        config,
        uploadKind,
        checkoutPath,
        outputDir,
@@ -180921,8 +180937,10 @@ async function run(action) {
        logger2
      );
    }
-    if (isInTestMode()) {
-      logger2.debug("In test mode. Waiting for processing is disabled.");
+    if (shouldSkipSarifUpload()) {
+      logger2.debug(
+        "SARIF upload is disabled and nothing was uploaded, so we do not need to wait for processing to finish."
+      );
    } else if (uploadResults?.["code-scanning" /* CodeScanning */] !== void 0 && getRequiredInput("wait-for-processing") === "true") {
      await waitForProcessing(
        getRepositoryNwo(),
@@ -186915,7 +186933,7 @@ async function prepareFailedSarif(logger2, features, config) {
  }
  const jobName = getRequiredEnvParam("GITHUB_JOB");
  const matrix = parseMatrixInput(getRequiredInput("matrix"));
-  if (shouldSkipSarifUpload()) {
+  if (shouldSkipGenerateFailedSarif()) {
    return new Failure({
      upload_failed_run_skipped_because: "SARIF upload is disabled"
    });
@@ -186986,6 +187004,7 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger2)
  const failedSarif = failedSarifResult.value;
  logger2.info(`Uploading failed SARIF file ${failedSarif.sarifFile}`);
  const uploadResult = await uploadFiles(
+    config,
    failedSarif.sarifFile,
    failedSarif.checkoutPath,
    failedSarif.category,
@@ -186999,6 +187018,9 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger2)
    logger2,
    { isUnsuccessfulExecution: true }
  );
+  if (uploadResult.sarifID && shouldSkipSarifUpload()) {
+    await uploadSarifArtifact(logger2, "test-mode-sarif", failedSarif);
+  }
  return uploadResult ? { ...uploadResult.statusReport, sarifID: uploadResult.sarifID } : {};
 }
 async function maybeUploadFailedSarifArtifact(config, features, logger2) {
@@ -187007,19 +187029,25 @@ async function maybeUploadFailedSarifArtifact(config, features, logger2) {
    return failedSarifResult.value;
  }
  const failedSarif = failedSarifResult.value;
-  logger2.info(
-    `Uploading failed SARIF file ${failedSarif.sarifFile} as artifact`
-  );
-  const gitHubVersion = await getGitHubVersion();
-  const client = await getArtifactUploaderClient(logger2, gitHubVersion.type);
-  const suffix = getArtifactSuffix(getOptionalInput("matrix"));
-  const name = sanitizeArtifactName(`sarif-artifact-${suffix}`);
-  await client.uploadArtifact(
-    name,
-    [import_path8.default.normalize(failedSarif.sarifFile)],
-    import_path8.default.normalize("..")
-  );
-  return { sarifID: name };
+  return uploadSarifArtifact(logger2, "sarif-artifact", failedSarif);
+}
+async function uploadSarifArtifact(logger2, prefix, failedSarif) {
+  logger2.startGroup(`Uploading failed SARIF file as artifact`);
+  logger2.info(`Uploading '${failedSarif.sarifFile}' as artifact`);
+  try {
+    const gitHubVersion = await getGitHubVersion();
+    const client = await getArtifactUploaderClient(logger2, gitHubVersion.type);
+    const suffix = getArtifactSuffix(getOptionalInput("matrix"));
+    const name = sanitizeArtifactName(`${prefix}-${suffix}`);
+    await client.uploadArtifact(
+      name,
+      [import_path8.default.normalize(failedSarif.sarifFile)],
+      import_path8.default.normalize(import_path8.default.dirname(failedSarif.sarifFile))
+    );
+    return { sarifID: name };
+  } finally {
+    logger2.endGroup();
+  }
 }
 async function tryUploadSarifIfRunFailed(config, repositoryNwo, features, logger2) {
  if (process.env["CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY" /* ANALYZE_DID_COMPLETE_SUCCESSFULLY */] === "true") {
@@ -187244,6 +187272,9 @@ async function run4(action) {
    const tmpDir = getTemporaryDirectory();
    config = await getConfig(tmpDir, logger2);
    if (config === void 0) {
+      logger2.debug(
+        "Will try to load the configuration file from an aborted 'init' step, since there is no regular one."
+      );
      config = getAbortedInitConfig(action, tmpDir);
    }
    const gitHubVersion = config?.gitHubVersion ?? await getGitHubVersion();
@@ -188462,11 +188493,12 @@ async function run8({ startedAt, logger: logger2 }) {
    const gitHubVersion = await getGitHubVersion();
    checkActionVersion(getActionVersion(), gitHubVersion);
    persistInputs();
+    const tempDir = getTemporaryDirectory();
    const repositoryNwo = getRepositoryNwo();
    const features = initFeatures(
      gitHubVersion,
      repositoryNwo,
-      getTemporaryDirectory(),
+      tempDir,
      logger2
    );
    const startingStatusReportBase = await createStatusReportBase(
@@ -188483,9 +188515,11 @@ async function run8({ startedAt, logger: logger2 }) {
    const sarifPath = getRequiredInput("sarif_file");
    const checkoutPath = getRequiredInput("checkout_path");
    const category = getOptionalInput("category");
+    const maybeConfig = await getConfig(tempDir, logger2);
    const uploadResults = await postProcessAndUploadSarif(
      logger2,
      features,
+      maybeConfig,
      "always",
      checkoutPath,
      sarifPath,