Merge pull request #3791 from github/sam-robson/overlay-fallback

fix: fall back to non-overlay analysis when diff-informed analysis is unavailable

Author: sam-robson

lib/init-action.js

@@ -88,6 +88,10 @@ export function writeDiffRangesJsonFile(
   );
 }
 
+export function hasDiffRangesJsonFile(): boolean {
+  return fs.existsSync(actionsUtil.getDiffRangesJsonFilePath());
+}
+
 export function readDiffRangesJsonFile(
   logger: Logger,
 ): DiffThunkRange[] | undefined {

src/diff-informed-analysis-utils.ts

@@ -40,6 +40,8 @@ import {
 import {
   getDiffInformedAnalysisBranches,
   getPullRequestEditedDiffRanges,
+  hasDiffRangesJsonFile,
+  shouldPerformDiffInformedAnalysis,
   writeDiffRangesJsonFile,
 } from "./diff-informed-analysis-utils";
 import { EnvVar } from "./environment";
@@ -438,6 +440,30 @@ async function run(startedAt: Date) {
     return;
   }
 
+  // If overlay is enabled and diff-informed analysis should have run but
+  // failed to produce output, revert to non-overlay analysis. Overlay
+  // without diff-informed is an untested combination that can produce
+  // inaccurate results.
+  try {
+    if (
+      config.overlayDatabaseMode === OverlayDatabaseMode.Overlay &&
+      (await shouldPerformDiffInformedAnalysis(codeql, features, logger)) &&
+      !hasDiffRangesJsonFile()
+    ) {
+      logger.warning(
+        "Diff-informed analysis is not available for this pull request. " +
+          `Reverting overlay database mode to ${OverlayDatabaseMode.None}.`,
+      );
+      config.overlayDatabaseMode = OverlayDatabaseMode.None;
+    }
+  } catch (e) {
+    logger.warning(
+      `Failed to determine diff-informed analysis availability, ` +
+        `reverting overlay database mode to ${OverlayDatabaseMode.None}: ${getErrorMessage(e)}`,
+    );
+    config.overlayDatabaseMode = OverlayDatabaseMode.None;
+  }
+
   let overlayBaseDatabaseStats: OverlayBaseDatabaseDownloadStats | undefined;
   let dependencyCachingStatus: DependencyCacheRestoreStatusReport | undefined;
   try {