Add ML-powered query enablement info to analyze finish status report

github · Feb 15, 2022 · c2e40b5 · c2e40b5
1 parent 2c6b76b
commit c2e40b5
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 15 deletions.
diff --git a/lib/actions-util.js.map b/lib/actions-util.js.map
diff --git a/lib/analyze-action-env.test.js b/lib/analyze-action-env.test.js
diff --git a/lib/analyze-action-env.test.js.map b/lib/analyze-action-env.test.js.map
diff --git a/lib/analyze-action-input.test.js b/lib/analyze-action-input.test.js
diff --git a/lib/analyze-action-input.test.js.map b/lib/analyze-action-input.test.js.map
diff --git a/lib/analyze-action.js b/lib/analyze-action.js
diff --git a/lib/analyze-action.js.map b/lib/analyze-action.js.map
diff --git a/src/actions-util.ts b/src/actions-util.ts
@@ -576,6 +576,12 @@ export interface StatusReportBase {
   completed_at?: string;
   /** State this action is currently in. */
   status: ActionStatus;
+  /**
+   * Information about the enablement of the ML-powered JS query pack.
+   *
+   * @see {@link util.getMlPoweredJsQueriesStatus}
+   */
+  ml_powered_javascript_queries?: string;
   /** Cause of the failure (or undefined if status is not failure). */
   cause?: string;
   /** Stack trace of the failure (or undefined if status is not failure). */

diff --git a/src/analyze-action-env.test.ts b/src/analyze-action-env.test.ts
@@ -31,6 +31,7 @@ test("analyze action with RAM & threads from environment variables", async (t) =
     sinon.stub(configUtils, "getConfig").resolves({
       gitHubVersion: { type: util.GitHubVariant.DOTCOM },
       languages: [],
+      packs: [],
     } as unknown as configUtils.Config);
     const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
     requiredInputStub.withArgs("token").returns("fake-token");

diff --git a/src/analyze-action-input.test.ts b/src/analyze-action-input.test.ts
@@ -31,6 +31,7 @@ test("analyze action with RAM & threads from action inputs", async (t) => {
     sinon.stub(configUtils, "getConfig").resolves({
       gitHubVersion: { type: util.GitHubVariant.DOTCOM },
       languages: [],
+      packs: [],
     } as unknown as configUtils.Config);
     const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
     requiredInputStub.withArgs("token").returns("fake-token");

diff --git a/src/analyze-action.ts b/src/analyze-action.ts
@@ -36,6 +36,7 @@ interface FinishStatusReport
 
 export async function sendStatusReport(
   startedAt: Date,
+  config: Config | undefined,
   stats: AnalysisStatusReport | undefined,
   error?: Error
 ) {
@@ -52,6 +53,12 @@ export async function sendStatusReport(
   );
   const statusReport: FinishStatusReport = {
     ...statusReportBase,
+    ...(config
+      ? {
+          ml_powered_javascript_queries:
+            util.getMlPoweredJsQueriesStatus(config),
+        }
+      : {}),
     ...(stats || {}),
   };
   await actionsUtil.sendStatusReport(statusReport);
@@ -220,9 +227,9 @@ async function run() {
 
     if (error instanceof CodeQLAnalysisError) {
       const stats = { ...error.queriesStatusReport };
-      await sendStatusReport(startedAt, stats, error);
+      await sendStatusReport(startedAt, config, stats, error);
     } else {
-      await sendStatusReport(startedAt, undefined, error);
+      await sendStatusReport(startedAt, config, undefined, error);
     }
 
     return;
@@ -279,14 +286,14 @@ async function run() {
   }
 
   if (runStats && uploadResult) {
-    await sendStatusReport(startedAt, {
+    await sendStatusReport(startedAt, config, {
       ...runStats,
       ...uploadResult.statusReport,
     });
   } else if (runStats) {
-    await sendStatusReport(startedAt, { ...runStats });
+    await sendStatusReport(startedAt, config, { ...runStats });
   } else {
-    await sendStatusReport(startedAt, undefined);
+    await sendStatusReport(startedAt, config, undefined);
   }
 }