Add ML-powered queries enablement to init status report

We report this information in the `init` status report rather than the
`analyze` status report so we can gather data about timeouts.

lib/config-utils.js

@@ -135,7 +135,7 @@ async function addBuiltinSuiteQueries(languages, codeQL, resultMap, packs, suite
             packs.javascript = [];
         }
         packs.javascript.push({
-            packName: "codeql/javascript-experimental-atm-queries",
+            packName: util_1.ML_POWERED_JS_QUERIES_PACK_NAME,
             version: "~0.0.2",
         });
     }

lib/init-action.js

@@ -56,6 +56,7 @@ async function sendSuccessStatusReport(startedAt, config, toolsVersion) {
         ...statusReportBase,
         disable_default_queries: disableDefaultQueries,
         languages,
+        ml_powered_js_queries: (0, util_1.getMlPoweredJsQueriesStatus)(config),
         paths,
         paths_ignore: pathsIgnore,
         queries: queries.join(","),

lib/util.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkNotWindows11 = exports.isGoodVersion = exports.delay = exports.bundleDb = exports.codeQlVersionAbove = exports.isHTTPError = exports.HTTPError = exports.getRequiredEnvParam = exports.isActions = exports.getMode = exports.enrichEnvironment = exports.initializeEnvironment = exports.Mode = exports.assertNever = exports.getGitHubAuth = exports.apiVersionInRange = exports.DisallowedAPIVersionReason = exports.checkGitHubVersionInRange = exports.getGitHubVersion = exports.GitHubVariant = exports.parseGitHubUrl = exports.getCodeQLDatabasePath = exports.getThreadsFlag = exports.getThreadsFlagValue = exports.getAddSnippetsFlag = exports.getMemoryFlag = exports.getMemoryFlagValue = exports.withTmpDir = exports.getToolNames = exports.getExtraOptionsEnvParam = exports.DEFAULT_DEBUG_DATABASE_NAME = exports.DEFAULT_DEBUG_ARTIFACT_NAME = exports.GITHUB_DOTCOM_URL = void 0;
+exports.getMlPoweredJsQueriesStatus = exports.ML_POWERED_JS_QUERIES_PACK_NAME = exports.checkNotWindows11 = exports.isGoodVersion = exports.delay = exports.bundleDb = exports.codeQlVersionAbove = exports.isHTTPError = exports.HTTPError = exports.getRequiredEnvParam = exports.isActions = exports.getMode = exports.enrichEnvironment = exports.initializeEnvironment = exports.Mode = exports.assertNever = exports.getGitHubAuth = exports.apiVersionInRange = exports.DisallowedAPIVersionReason = exports.checkGitHubVersionInRange = exports.getGitHubVersion = exports.GitHubVariant = exports.parseGitHubUrl = exports.getCodeQLDatabasePath = exports.getThreadsFlag = exports.getThreadsFlagValue = exports.getAddSnippetsFlag = exports.getMemoryFlag = exports.getMemoryFlagValue = exports.withTmpDir = exports.getToolNames = exports.getExtraOptionsEnvParam = exports.DEFAULT_DEBUG_DATABASE_NAME = exports.DEFAULT_DEBUG_ARTIFACT_NAME = exports.GITHUB_DOTCOM_URL = void 0;
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
@@ -524,4 +524,25 @@ function checkNotWindows11() {
     }
 }
 exports.checkNotWindows11 = checkNotWindows11;
+exports.ML_POWERED_JS_QUERIES_PACK_NAME = "codeql/javascript-experimental-atm-queries";
+/** Get information about ML-powered JS queries to populate status reports with.
+ *
+ * This will be:
+ *
+ * - The version string if the analysis will use a specific version of the pack
+ * - "latest" if the analysis will use the latest version of the pack
+ * - "false" if the analysis won't run any ML-powered JS queries, or if the analysis will run
+ *   multiple ML-powered JS query packs
+ *
+ * This function lives here rather than in `init-action.ts` so it's easier to test, since tests for
+ * `init-action.ts` would each need to live in their own file. See `analyze-action-env.ts` for an
+ * explanation as to why this is.
+ */
+function getMlPoweredJsQueriesStatus(config) {
+    const mlPoweredJsQueryPacks = (config.packs.javascript || []).filter((pack) => pack.packName === exports.ML_POWERED_JS_QUERIES_PACK_NAME);
+    return mlPoweredJsQueryPacks.length === 1
+        ? mlPoweredJsQueryPacks[0].version || "latest"
+        : "false";
+}
+exports.getMlPoweredJsQueriesStatus = getMlPoweredJsQueriesStatus;
 //# sourceMappingURL=util.js.map

lib/util.test.js

@@ -204,4 +204,49 @@ async function mockStdInForAuthExpectError(t, mockLogger, ...text) {
     const stdin = stream.Readable.from(text);
     await t.throwsAsync(async () => util.getGitHubAuth(mockLogger, undefined, true, stdin));
 }
+const ML_POWERED_JS_STATUS_TESTS = [
+    [[], "false"],
+    [[{ packName: util.ML_POWERED_JS_QUERIES_PACK_NAME }], "latest"],
+    [
+        [{ packName: util.ML_POWERED_JS_QUERIES_PACK_NAME, version: "0.0.2" }],
+        "0.0.2",
+    ],
+    [
+        [
+            { packName: "someOtherPack" },
+            { packName: util.ML_POWERED_JS_QUERIES_PACK_NAME },
+        ],
+        "latest",
+    ],
+];
+for (const [packs, expectedStatus] of ML_POWERED_JS_STATUS_TESTS) {
+    const packDescriptions = `[${packs
+        .map((pack) => JSON.stringify(pack))
+        .join(", ")}]`;
+    (0, ava_1.default)(`ML-powered JS queries status report is "${expectedStatus}" for packs = ${packDescriptions}`, (t) => {
+        return util.withTmpDir(async (tmpDir) => {
+            const config = {
+                languages: [],
+                queries: {},
+                paths: [],
+                pathsIgnore: [],
+                originalUserInput: {},
+                tempDir: tmpDir,
+                toolCacheDir: tmpDir,
+                codeQLCmd: "",
+                gitHubVersion: {
+                    type: util.GitHubVariant.DOTCOM,
+                },
+                dbLocation: "",
+                packs: {
+                    javascript: packs,
+                },
+                debugMode: false,
+                debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
+                debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
+            };
+            t.is(util.getMlPoweredJsQueriesStatus(config), expectedStatus);
+        });
+    });
+}
 //# sourceMappingURL=util.test.js.map

src/config-utils.ts

@@ -15,7 +15,11 @@ import { FeatureFlag, FeatureFlags } from "./feature-flags";
 import { Language, parseLanguage } from "./languages";
 import { Logger } from "./logging";
 import { RepositoryNwo } from "./repository";
-import { codeQlVersionAbove, GitHubVersion } from "./util";
+import {
+  codeQlVersionAbove,
+  GitHubVersion,
+  ML_POWERED_JS_QUERIES_PACK_NAME,
+} from "./util";
 
 // Property names from the user-supplied config file.
 const NAME_PROPERTY = "name";
@@ -298,7 +302,7 @@ async function addBuiltinSuiteQueries(
       packs.javascript = [];
     }
     packs.javascript.push({
-      packName: "codeql/javascript-experimental-atm-queries",
+      packName: ML_POWERED_JS_QUERIES_PACK_NAME,
       version: "~0.0.2",
     });
   }

src/init-action.ts

@@ -38,6 +38,7 @@ import {
   DEFAULT_DEBUG_ARTIFACT_NAME,
   DEFAULT_DEBUG_DATABASE_NAME,
   checkNotWindows11,
+  getMlPoweredJsQueriesStatus,
 } from "./util";
 
 // eslint-disable-next-line import/no-commonjs
@@ -52,6 +53,12 @@ interface InitSuccessStatusReport extends StatusReportBase {
    * This may be from the workflow file or may be calculated from repository contents
    */
   languages: string;
+  /**
+   * Information about the enablement of the ML-powered JS query pack.
+   *
+   * @see {@link getMlPoweredJsQueriesStatus}
+   */
+  ml_powered_js_queries: string;
   /** Comma-separated list of paths, from the 'paths' config field. */
   paths: string;
   /** Comma-separated list of paths, from the 'paths-ignore' config field. */
@@ -107,6 +114,7 @@ async function sendSuccessStatusReport(
     ...statusReportBase,
     disable_default_queries: disableDefaultQueries,
     languages,
+    ml_powered_js_queries: getMlPoweredJsQueriesStatus(config),
     paths,
     paths_ignore: pathsIgnore,
     queries: queries.join(","),

src/util.test.ts

@@ -7,6 +7,7 @@ import test, { ExecutionContext } from "ava";
 import * as sinon from "sinon";
 
 import * as api from "./api-client";
+import { Config, PackWithVersion } from "./config-utils";
 import { getRunnerLogger, Logger } from "./logging";
 import { setupTests } from "./testing-utils";
 import * as util from "./util";
@@ -291,3 +292,51 @@ async function mockStdInForAuthExpectError(
     util.getGitHubAuth(mockLogger, undefined, true, stdin)
   );
 }
+
+const ML_POWERED_JS_STATUS_TESTS: Array<[PackWithVersion[], string]> = [
+  [[], "false"],
+  [[{ packName: util.ML_POWERED_JS_QUERIES_PACK_NAME }], "latest"],
+  [
+    [{ packName: util.ML_POWERED_JS_QUERIES_PACK_NAME, version: "0.0.2" }],
+    "0.0.2",
+  ],
+  [
+    [
+      { packName: "someOtherPack" },
+      { packName: util.ML_POWERED_JS_QUERIES_PACK_NAME },
+    ],
+    "latest",
+  ],
+];
+
+for (const [packs, expectedStatus] of ML_POWERED_JS_STATUS_TESTS) {
+  const packDescriptions = `[${packs
+    .map((pack) => JSON.stringify(pack))
+    .join(", ")}]`;
+  test(`ML-powered JS queries status report is "${expectedStatus}" for packs = ${packDescriptions}`, (t) => {
+    return util.withTmpDir(async (tmpDir) => {
+      const config: Config = {
+        languages: [],
+        queries: {},
+        paths: [],
+        pathsIgnore: [],
+        originalUserInput: {},
+        tempDir: tmpDir,
+        toolCacheDir: tmpDir,
+        codeQLCmd: "",
+        gitHubVersion: {
+          type: util.GitHubVariant.DOTCOM,
+        } as util.GitHubVersion,
+        dbLocation: "",
+        packs: {
+          javascript: packs,
+        },
+        debugMode: false,
+        debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
+        debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
+      };
+
+      t.is(util.getMlPoweredJsQueriesStatus(config), expectedStatus);
+    });
+  });
+}

src/util.ts

@@ -627,3 +627,28 @@ export function checkNotWindows11() {
     );
   }
 }
+
+export const ML_POWERED_JS_QUERIES_PACK_NAME =
+  "codeql/javascript-experimental-atm-queries";
+
+/** Get information about ML-powered JS queries to populate status reports with.
+ *
+ * This will be:
+ *
+ * - The version string if the analysis will use a specific version of the pack
+ * - "latest" if the analysis will use the latest version of the pack
+ * - "false" if the analysis won't run any ML-powered JS queries, or if the analysis will run
+ *   multiple ML-powered JS query packs
+ *
+ * This function lives here rather than in `init-action.ts` so it's easier to test, since tests for
+ * `init-action.ts` would each need to live in their own file. See `analyze-action-env.ts` for an
+ * explanation as to why this is.
+ */
+export function getMlPoweredJsQueriesStatus(config: Config) {
+  const mlPoweredJsQueryPacks = (config.packs.javascript || []).filter(
+    (pack) => pack.packName === ML_POWERED_JS_QUERIES_PACK_NAME
+  );
+  return mlPoweredJsQueryPacks.length === 1
+    ? mlPoweredJsQueryPacks[0].version || "latest"
+    : "false";
+}