Fix a bug in cli config parsing

When the config specifies queries in external repositories and no other
queries and cli config parsing is enabled, the analyze job is not able
to find any queries to run and it fails. This PR fixes the problem.

Also add some logging statements when writing a copy of the user config
file.

lib/analyze.js

@@ -127,12 +127,6 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
         const queries = config.queries[language];
         const queryFilters = validateQueryFilters(config.originalUserInput["query-filters"]);
         const packsWithVersion = config.packs[language] || [];
-        const hasBuiltinQueries = (queries === null || queries === void 0 ? void 0 : queries.builtin.length) > 0;
-        const hasCustomQueries = (queries === null || queries === void 0 ? void 0 : queries.custom.length) > 0;
-        const hasPackWithCustomQueries = packsWithVersion.length > 0;
-        if (!hasBuiltinQueries && !hasCustomQueries && !hasPackWithCustomQueries) {
-            throw new Error(`Unable to analyze ${language} as no queries were selected for this language`);
-        }
         try {
             if (await util.useCodeScanningConfigInCli(codeql, featureEnablement)) {
                 // If we are using the code scanning config in the CLI,
@@ -158,6 +152,14 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
             }
             else {
                 // config was generated by the action, so must be interpreted by the action.
+                const hasBuiltinQueries = (queries === null || queries === void 0 ? void 0 : queries.builtin.length) > 0;
+                const hasCustomQueries = (queries === null || queries === void 0 ? void 0 : queries.custom.length) > 0;
+                const hasPackWithCustomQueries = packsWithVersion.length > 0;
+                if (!hasBuiltinQueries &&
+                    !hasCustomQueries &&
+                    !hasPackWithCustomQueries) {
+                    throw new Error(`Unable to analyze ${language} as no queries were selected for this language`);
+                }
                 logger.startGroup(`Running queries for ${language}`);
                 const querySuitePaths = [];
                 if (queries["builtin"].length > 0) {

lib/codeql.js

@@ -518,7 +518,7 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 ...getExtraOptionsFromEnv(["database", "init"]),
             ]);
         },
-        async databaseInitCluster(config, sourceRoot, processName, featureEnablement) {
+        async databaseInitCluster(config, sourceRoot, processName, featureEnablement, logger) {
             const extraArgs = config.languages.map((language) => `--language=${language}`);
             if (config.languages.filter((l) => (0, languages_1.isTracedLanguage)(l)).length > 0) {
                 extraArgs.push("--begin-tracing");
@@ -537,7 +537,7 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 }
             }
             // A config file is only generated if the CliConfigFileEnabled feature flag is enabled.
-            const configLocation = await generateCodeScanningConfig(codeql, config, featureEnablement);
+            const configLocation = await generateCodeScanningConfig(codeql, config, featureEnablement, logger);
             // Only pass external repository token if a config file is going to be parsed by the CLI.
             let externalRepositoryToken;
             if (configLocation) {
@@ -923,7 +923,7 @@ async function runTool(cmd, args = [], opts = {}) {
  * @param config The configuration to use.
  * @returns the path to the generated user configuration file.
  */
-async function generateCodeScanningConfig(codeql, config, featureEnablement) {
+async function generateCodeScanningConfig(codeql, config, featureEnablement, logger) {
     var _a;
     if (!(await util.useCodeScanningConfigInCli(codeql, featureEnablement))) {
         return;
@@ -982,6 +982,10 @@ async function generateCodeScanningConfig(codeql, config, featureEnablement) {
             augmentedConfig.packs["javascript"].push(packString);
         }
     }
+    logger.info(`Writing augmented user configuration file to ${configLocation}`);
+    logger.startGroup("Augmented user configuration file contents");
+    logger.info(yaml.dump(augmentedConfig));
+    logger.endGroup();
     fs.writeFileSync(configLocation, yaml.dump(augmentedConfig));
     return configLocation;
 }

src/analyze.ts

@@ -222,16 +222,6 @@ export async function runQueries(
     );
     const packsWithVersion = config.packs[language] || [];
 
-    const hasBuiltinQueries = queries?.builtin.length > 0;
-    const hasCustomQueries = queries?.custom.length > 0;
-    const hasPackWithCustomQueries = packsWithVersion.length > 0;
-
-    if (!hasBuiltinQueries && !hasCustomQueries && !hasPackWithCustomQueries) {
-      throw new Error(
-        `Unable to analyze ${language} as no queries were selected for this language`
-      );
-    }
-
     try {
       if (await util.useCodeScanningConfigInCli(codeql, featureEnablement)) {
         // If we are using the code scanning config in the CLI,
@@ -262,6 +252,21 @@ export async function runQueries(
         logger.info(analysisSummary);
       } else {
         // config was generated by the action, so must be interpreted by the action.
+
+        const hasBuiltinQueries = queries?.builtin.length > 0;
+        const hasCustomQueries = queries?.custom.length > 0;
+        const hasPackWithCustomQueries = packsWithVersion.length > 0;
+
+        if (
+          !hasBuiltinQueries &&
+          !hasCustomQueries &&
+          !hasPackWithCustomQueries
+        ) {
+          throw new Error(
+            `Unable to analyze ${language} as no queries were selected for this language`
+          );
+        }
+
         logger.startGroup(`Running queries for ${language}`);
         const querySuitePaths: string[] = [];
         if (queries["builtin"].length > 0) {

src/codeql.ts

@@ -855,7 +855,8 @@ async function getCodeQLForCmd(
       config: Config,
       sourceRoot: string,
       processName: string | undefined,
-      featureEnablement: FeatureEnablement
+      featureEnablement: FeatureEnablement,
+      logger: Logger
     ) {
       const extraArgs = config.languages.map(
         (language) => `--language=${language}`
@@ -888,7 +889,8 @@ async function getCodeQLForCmd(
       const configLocation = await generateCodeScanningConfig(
         codeql,
         config,
-        featureEnablement
+        featureEnablement,
+        logger
       );
       // Only pass external repository token if a config file is going to be parsed by the CLI.
       let externalRepositoryToken: string | undefined;
@@ -1386,7 +1388,8 @@ async function runTool(
 async function generateCodeScanningConfig(
   codeql: CodeQL,
   config: Config,
-  featureEnablement: FeatureEnablement
+  featureEnablement: FeatureEnablement,
+  logger: Logger
 ): Promise<string | undefined> {
   if (!(await util.useCodeScanningConfigInCli(codeql, featureEnablement))) {
     return;
@@ -1448,6 +1451,10 @@ async function generateCodeScanningConfig(
       augmentedConfig.packs["javascript"].push(packString);
     }
   }
+  logger.info(`Writing augmented user configuration file to ${configLocation}`);
+  logger.startGroup("Augmented user configuration file contents");
+  logger.info(yaml.dump(augmentedConfig));
+  logger.endGroup();
 
   fs.writeFileSync(configLocation, yaml.dump(augmentedConfig));
   return configLocation;