refactor: address review feedback on overlay fallback

Author: sam-robson

lib/init-action.js

@@ -2201,79 +2201,70 @@ test.serial(
   },
 );
 
-test.serial(
-  "applyIncrementalAnalysisSettings: no-op when mode is not Overlay and diff-informed is unavailable",
-  (t) => {
-    const config = createTestConfig({});
-    config.overlayDatabaseMode = OverlayDatabaseMode.None;
-    const logger = getRunnerLogger(true);
-
-    configUtils.applyIncrementalAnalysisSettings(
-      config,
-      { shouldRun: false, isAvailable: false },
-      logger,
-    );
-
-    t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
-    t.deepEqual(config.extraQueryExclusions, []);
-  },
-);
+test("applyIncrementalAnalysisSettings: no-op when mode is not Overlay and diff-informed is unavailable", (t) => {
+  const config = createTestConfig({});
+  config.overlayDatabaseMode = OverlayDatabaseMode.None;
+  const logger = getRunnerLogger(true);
+
+  configUtils.applyIncrementalAnalysisSettings(
+    config,
+    { shouldRun: false, hasDiffRanges: false },
+    logger,
+  );
 
-test.serial(
-  "applyIncrementalAnalysisSettings: keeps overlay mode and adds exclusions when diff-informed analysis is disabled",
-  (t) => {
-    const config = createTestConfig({});
-    config.overlayDatabaseMode = OverlayDatabaseMode.Overlay;
-    const logger = getRunnerLogger(true);
+  t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
+  t.deepEqual(config.extraQueryExclusions, []);
+});
 
-    configUtils.applyIncrementalAnalysisSettings(
-      config,
-      { shouldRun: false, isAvailable: false },
-      logger,
-    );
+test("applyIncrementalAnalysisSettings: keeps overlay mode and adds exclusions when diff-informed analysis shouldn't run", (t) => {
+  const config = createTestConfig({});
+  config.overlayDatabaseMode = OverlayDatabaseMode.Overlay;
+  const logger = getRunnerLogger(true);
 
-    t.is(config.overlayDatabaseMode, OverlayDatabaseMode.Overlay);
-    t.deepEqual(config.extraQueryExclusions, [
-      { exclude: { tags: "exclude-from-incremental" } },
-    ]);
-  },
-);
+  configUtils.applyIncrementalAnalysisSettings(
+    config,
+    { shouldRun: false, hasDiffRanges: false },
+    logger,
+  );
 
-test.serial(
-  "applyIncrementalAnalysisSettings: reverts to None without exclusions when diff-informed analysis is unavailable",
-  (t) => {
-    const config = createTestConfig({});
-    config.overlayDatabaseMode =
-      OverlayDatabaseMode.Overlay as OverlayDatabaseMode;
-    const logger = getRunnerLogger(true);
+  t.is(config.overlayDatabaseMode, OverlayDatabaseMode.Overlay);
+  t.deepEqual(config.extraQueryExclusions, [
+    { exclude: { tags: "exclude-from-incremental" } },
+  ]);
+});
 
-    configUtils.applyIncrementalAnalysisSettings(
-      config,
-      { shouldRun: true, isAvailable: false },
-      logger,
-    );
+test("applyIncrementalAnalysisSettings: disables overlay analysis when diff-informed analysis is unavailable", (t) => {
+  const config = createTestConfig({});
+  // Cast needed so TypeScript doesn't narrow `overlayDatabaseMode` to the
+  // literal `Overlay` type, which would then reject the `None` assertion
+  // below after the function under test mutates the field.
+  config.overlayDatabaseMode =
+    OverlayDatabaseMode.Overlay as OverlayDatabaseMode;
+  const logger = getRunnerLogger(true);
+
+  configUtils.applyIncrementalAnalysisSettings(
+    config,
+    { shouldRun: true, hasDiffRanges: false },
+    logger,
+  );
 
-    t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
-    t.deepEqual(config.extraQueryExclusions, []);
-  },
-);
+  t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
+  t.deepEqual(config.extraQueryExclusions, []);
+});
 
-test.serial(
-  "applyIncrementalAnalysisSettings: adds exclusions for diff-informed-only runs",
-  (t) => {
-    const config = createTestConfig({});
-    config.overlayDatabaseMode = OverlayDatabaseMode.None;
-    const logger = getRunnerLogger(true);
+test("applyIncrementalAnalysisSettings: adds exclusions for diff-informed-only runs", (t) => {
+  const config = createTestConfig({});
+  config.overlayDatabaseMode = OverlayDatabaseMode.None;
+  const logger = getRunnerLogger(true);
 
-    configUtils.applyIncrementalAnalysisSettings(
-      config,
-      { shouldRun: true, isAvailable: true },
-      logger,
-    );
+  configUtils.applyIncrementalAnalysisSettings(
+    config,
+    { shouldRun: true, hasDiffRanges: true },
+    logger,
+  );
 
-    t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
-    t.deepEqual(config.extraQueryExclusions, [
-      { exclude: { tags: "exclude-from-incremental" } },
-    ]);
-  },
-);
+  t.is(config.overlayDatabaseMode, OverlayDatabaseMode.None);
+  t.deepEqual(config.extraQueryExclusions, [
+    { exclude: { tags: "exclude-from-incremental" } },
+  ]);
+});

src/config-utils.test.ts

@@ -1085,8 +1085,11 @@ function hasQueryCustomisation(userConfig: UserConfig): boolean {
  * If overlay mode was selected for a PR but diff-informed analysis should have
  * run and could not be prepared, fall back to a full non-overlay analysis.
  * Query exclusions for incremental-only queries are applied only when the final
- * configuration still uses overlay analysis or diff-informed analysis is
- * actually available.
+ * configuration still uses overlay analysis or the diff ranges are available.
+ *
+ * Note that `overlayDatabaseMode === Overlay` does not imply
+ * `diffInformedAnalysis.shouldRun`: the two are configured independently
+ * so we handle each combination explicitly.
  */
 export function applyIncrementalAnalysisSettings(
   config: Config,
@@ -1096,9 +1099,9 @@ export function applyIncrementalAnalysisSettings(
   if (
     config.overlayDatabaseMode === OverlayDatabaseMode.Overlay &&
     diffInformedAnalysis.shouldRun &&
-    !diffInformedAnalysis.isAvailable
+    !diffInformedAnalysis.hasDiffRanges
   ) {
-    logger.warning(
+    logger.info(
       "Diff-informed analysis is not available for this pull request. " +
         `Reverting overlay database mode to ${OverlayDatabaseMode.None}.`,
     );
@@ -1107,7 +1110,7 @@ export function applyIncrementalAnalysisSettings(
 
   if (
     config.overlayDatabaseMode === OverlayDatabaseMode.Overlay ||
-    diffInformedAnalysis.isAvailable
+    diffInformedAnalysis.hasDiffRanges
   ) {
     config.extraQueryExclusions.push({
       exclude: { tags: "exclude-from-incremental" },