Add logging and telemetry for mode

Author: oscarsj

lib/entry-points.js

@@ -1,6 +1,10 @@
 import test from "ava";
 
-import { resolveToolsInput } from "../config/resolve-tools-input";
+import {
+  EffectiveToolsInputSource,
+  resolveToolsInput,
+  resolveToolsInputWithMetadata,
+} from "../config/resolve-tools-input";
 import {
   RepositoryPropertyName,
   ToolsModeRepositoryPropertyValue,
@@ -56,7 +60,7 @@ test("resolveToolsInput returns repository property when only repository propert
   t.is(loggedMessages.length, 1);
   t.is(
     loggedMessages[0].message,
-    "Setting tools: toolcache based on the 'github-codeql-tools' repository property.",
+    "Setting tools: toolcache based on the 'github-codeql-tools' repository property (mode: 'enforce').",
   );
 });
 
@@ -95,7 +99,7 @@ test("resolveToolsInput treats empty string workflow input as not set", (t) => {
   t.is(loggedMessages.length, 1);
   t.is(
     loggedMessages[0].message,
-    "Setting tools: toolcache based on the 'github-codeql-tools' repository property.",
+    "Setting tools: toolcache based on the 'github-codeql-tools' repository property (mode: 'enforce').",
   );
 });
 
@@ -135,7 +139,7 @@ test("resolveToolsInput returns repository property when workflow input is not s
   t.is(loggedMessages.length, 1);
   t.is(
     loggedMessages[0].message,
-    "Setting tools: toolcache based on the 'github-codeql-tools' repository property.",
+    "Setting tools: toolcache based on the 'github-codeql-tools' repository property (mode: 'enforce').",
   );
 });
 
@@ -169,7 +173,7 @@ test("resolveToolsInput applies tools property in enforce mode for static workfl
   t.is(loggedMessages.length, 1);
   t.is(
     loggedMessages[0].message,
-    "Setting tools: toolcache based on the 'github-codeql-tools' repository property.",
+    "Setting tools: toolcache based on the 'github-codeql-tools' repository property (mode: 'enforce').",
   );
 });
 
@@ -188,7 +192,7 @@ test("resolveToolsInput applies tools property in dynamic mode for dynamic workf
   t.is(loggedMessages.length, 1);
   t.is(
     loggedMessages[0].message,
-    "Setting tools: toolcache based on the 'github-codeql-tools' repository property.",
+    "Setting tools: toolcache based on the 'github-codeql-tools' repository property (mode: 'dynamic').",
   );
 });
 
@@ -215,3 +219,54 @@ test("resolveToolsInput ignores tools property in dynamic mode for static workfl
     "Ignoring 'github-codeql-tools' repository property because 'github-codeql-tools-mode' is set to 'dynamic' and this is not a dynamic workflow.",
   );
 });
+
+test("resolveToolsInputWithMetadata reports workflow input source", (t) => {
+  const logger = getRecordingLogger([]);
+
+  const result = resolveToolsInputWithMetadata("latest", false, {}, logger);
+
+  t.is(result.effectiveToolsInput, "latest");
+  t.is(result.effectiveToolsInputSource, EffectiveToolsInputSource.WorkflowInput);
+  t.is(result.toolsRepoPropertyMode, undefined);
+});
+
+test("resolveToolsInputWithMetadata reports repository property source and mode", (t) => {
+  const logger = getRecordingLogger([]);
+
+  const result = resolveToolsInputWithMetadata(
+    undefined,
+    false,
+    {
+      [RepositoryPropertyName.TOOLS]: "toolcache",
+      [RepositoryPropertyName.TOOLS_MODE]:
+        ToolsModeRepositoryPropertyValue.Enforce,
+    },
+    logger,
+  );
+
+  t.is(result.effectiveToolsInput, "toolcache");
+  t.is(
+    result.effectiveToolsInputSource,
+    EffectiveToolsInputSource.RepositoryProperty,
+  );
+  t.is(result.toolsRepoPropertyMode, ToolsModeRepositoryPropertyValue.Enforce);
+});
+
+test("resolveToolsInputWithMetadata reports dynamic-mode skip on static workflows", (t) => {
+  const logger = getRecordingLogger([]);
+
+  const result = resolveToolsInputWithMetadata(
+    undefined,
+    false,
+    {
+      [RepositoryPropertyName.TOOLS]: "toolcache",
+      [RepositoryPropertyName.TOOLS_MODE]:
+        ToolsModeRepositoryPropertyValue.Dynamic,
+    },
+    logger,
+  );
+
+  t.is(result.effectiveToolsInput, undefined);
+  t.is(result.effectiveToolsInputSource, EffectiveToolsInputSource.None);
+  t.is(result.toolsRepoPropertyMode, ToolsModeRepositoryPropertyValue.Dynamic);
+});

src/config/resolve-tools-input.test.ts

@@ -5,6 +5,18 @@ import {
 } from "../feature-flags/properties";
 import { Logger } from "../logging";
 
+export enum EffectiveToolsInputSource {
+  WorkflowInput = "workflow-input",
+  RepositoryProperty = "repository-property",
+  None = "none",
+}
+
+export type ResolvedToolsInput = {
+  effectiveToolsInput: string | undefined;
+  effectiveToolsInputSource: EffectiveToolsInputSource;
+  toolsRepoPropertyMode: ToolsModeRepositoryPropertyValue | undefined;
+};
+
 /**
  * Resolves the effective tools input by combining the workflow input and repository properties.
  * The explicit `tools` workflow input takes precedence. If none is provided,
@@ -24,11 +36,29 @@ export function resolveToolsInput(
   repositoryProperties: RepositoryProperties,
   logger: Logger,
 ): string | undefined {
+  return resolveToolsInputWithMetadata(
+    toolsWorkflowInput,
+    isDynamicWorkflow,
+    repositoryProperties,
+    logger,
+  ).effectiveToolsInput;
+}
+
+export function resolveToolsInputWithMetadata(
+  toolsWorkflowInput: string | undefined,
+  isDynamicWorkflow: boolean,
+  repositoryProperties: RepositoryProperties,
+  logger: Logger,
+): ResolvedToolsInput {
   if (toolsWorkflowInput) {
     logger.info(
       `Setting tools: ${toolsWorkflowInput} based on workflow input.`,
     );
-    return toolsWorkflowInput;
+    return {
+      effectiveToolsInput: toolsWorkflowInput,
+      effectiveToolsInputSource: EffectiveToolsInputSource.WorkflowInput,
+      toolsRepoPropertyMode: undefined,
+    };
   }
 
   const toolsPropertyValue = repositoryProperties[RepositoryPropertyName.TOOLS];
@@ -44,15 +74,27 @@ export function resolveToolsInput(
     logger.info(
       `Ignoring '${RepositoryPropertyName.TOOLS}' repository property because '${RepositoryPropertyName.TOOLS_MODE}' is set to '${toolsMode}' and this is not a dynamic workflow.`,
     );
-    return undefined;
+    return {
+      effectiveToolsInput: undefined,
+      effectiveToolsInputSource: EffectiveToolsInputSource.None,
+      toolsRepoPropertyMode: toolsMode,
+    };
   }
 
   if (toolsPropertyValue) {
     logger.info(
-      `Setting tools: ${toolsPropertyValue} based on the '${RepositoryPropertyName.TOOLS}' repository property.`,
+      `Setting tools: ${toolsPropertyValue} based on the '${RepositoryPropertyName.TOOLS}' repository property (mode: '${toolsMode}').`,
     );
-    return toolsPropertyValue;
+    return {
+      effectiveToolsInput: toolsPropertyValue,
+      effectiveToolsInputSource: EffectiveToolsInputSource.RepositoryProperty,
+      toolsRepoPropertyMode: toolsMode,
+    };
   }
 
-  return undefined;
+  return {
+    effectiveToolsInput: undefined,
+    effectiveToolsInputSource: EffectiveToolsInputSource.None,
+    toolsRepoPropertyMode: undefined,
+  };
 }