init-action: check packs for overlay compatibility

Author: cklin

src/init-action.ts

@@ -35,6 +35,7 @@ import { EnvVar } from "./environment";
 import { Feature, featureConfig, Features } from "./feature-flags";
 import {
   checkInstallPython311,
+  checkPacksForOverlayCompatibility,
   cleanupDatabaseClusterDirectory,
   initCodeQL,
   initConfig,
@@ -733,6 +734,36 @@ async function run() {
       logger,
     );
 
+    // To check custom query packs for compatibility with overlay analysis, we
+    // need to first initialize the database cluster, which downloads the
+    // user-specified custom query packs. But we also want to check custom query
+    // pack compatibility first, because database cluster initialization depends
+    // on the overlay database mode. The solution is to initialize the database
+    // cluster first, check custom query pack compatibility, and if we need to
+    // revert to `OverlayDatabaseMode.None`, re-initialize the database cluster
+    // with the new overlay database mode.
+    if (
+      config.augmentationProperties.overlayDatabaseMode !==
+        OverlayDatabaseMode.None &&
+      !(await checkPacksForOverlayCompatibility(codeql, config, logger))
+    ) {
+      logger.info(
+        "Reverting overlay database mode to None due to incompatible packs.",
+      );
+      config.augmentationProperties.overlayDatabaseMode =
+        OverlayDatabaseMode.None;
+      cleanupDatabaseClusterDirectory(config, logger);
+      await runDatabaseInitCluster(
+        databaseInitEnvironment,
+        codeql,
+        config,
+        sourceRoot,
+        "Runner.Worker.exe",
+        qlconfigFile,
+        logger,
+      );
+    }
+
     const tracerConfig = await getCombinedTracerConfig(codeql, config);
     if (tracerConfig !== undefined) {
       for (const [key, value] of Object.entries(tracerConfig.env)) {