Merge pull request #1487 from github/aeisenberg/queries-check

Fix a bug in cli config parsing

Author: aeisenberg

lib/analyze.js

@@ -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) {

lib/analyze.js.map

@@ -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;