Extract resolve-tools-input to module

Author: oscarsj

lib/init-action.js

@@ -46,42 +46,6 @@ export const getOptionalInput = function (name: string): string | undefined {
   return value.length > 0 ? value : undefined;
 };
 
-/**
- * Resolves the effective tools input by combining workflow input and repository properties.
- * The explicit `tools` workflow input takes precedence. If none is provided,
- * fall back to the repository property (if set).
- *
- * @param repositoryProperties - The loaded repository properties object
- * @param toolsPropertyName - The name of the tools property to look up
- * @param logger - Logger for outputting resolution messages
- * @returns The effective tools input value
- */
-export function resolveToolsInput(
-  repositoryProperties: Record<string, any>,
-  toolsPropertyName: string,
-  logger: Logger,
-): string | undefined {
-  const toolsWorkflowInput = getOptionalInput("tools");
-  const toolsPropertyValue: string | undefined =
-    repositoryProperties[toolsPropertyName];
-  const effectiveToolsInput = toolsWorkflowInput ?? toolsPropertyValue;
-
-  // Log the source of the tools input for transparency
-  if (effectiveToolsInput) {
-    if (toolsWorkflowInput) {
-      logger.info(
-        `Setting tools: ${effectiveToolsInput} based on workflow input.`,
-      );
-    } else {
-      logger.info(
-        `Setting tools: ${effectiveToolsInput} based on the '${toolsPropertyName}' repository property.`,
-      );
-    }
-  }
-
-  return effectiveToolsInput;
-}
-
 export function getTemporaryDirectory(): string {
   const value = process.env["CODEQL_ACTION_TEMP"];
   return value !== undefined && value !== ""

lib/setup-codeql-action.js

@@ -14,7 +14,6 @@ import {
   getRequiredInput,
   getTemporaryDirectory,
   persistInputs,
-  resolveToolsInput,
 } from "./actions-util";
 import { AnalysisKind, getAnalysisKinds } from "./analyses";
 import { getGitHubVersion, GitHubApiCombinedDetails } from "./api-client";
@@ -66,6 +65,7 @@ import {
 } from "./overlay/caching";
 import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
 import { getRepositoryNwo } from "./repository";
+import { resolveToolsInput } from "./resolve-tools-input";
 import { ToolsSource } from "./setup-codeql";
 import {
   ActionName,
@@ -307,7 +307,6 @@ async function run(startedAt: Date) {
     // fall back to the 'github-codeql-tools' repository property (if set).
     effectiveToolsInput = resolveToolsInput(
       repositoryPropertiesResult.orElse({}),
-      RepositoryPropertyName.TOOLS,
       logger,
     );
 

src/actions-util.ts

@@ -0,0 +1,42 @@
+import { getOptionalInput } from "./actions-util";
+import {
+  RepositoryProperties,
+  RepositoryPropertyName,
+} from "./feature-flags/properties";
+import { Logger } from "./logging";
+
+/**
+ * Resolves the effective tools input by combining workflow input and repository properties.
+ * The explicit `tools` workflow input takes precedence. If none is provided,
+ * fall back to the repository property (if set).
+ *
+ * @param repositoryProperties - The loaded repository properties object
+ * @param logger - Logger for outputting resolution messages
+ * @returns The effective tools input value
+ */
+export function resolveToolsInput(
+  repositoryProperties: RepositoryProperties,
+  logger: Logger,
+): string | undefined {
+  const toolsWorkflowInput = getOptionalInput("tools");
+  const toolsPropertyValue: string | undefined =
+    RepositoryPropertyName.TOOLS in repositoryProperties
+      ? repositoryProperties[RepositoryPropertyName.TOOLS]
+      : undefined;
+  const effectiveToolsInput = toolsWorkflowInput ?? toolsPropertyValue;
+
+  // Log the source of the tools input for transparency
+  if (effectiveToolsInput) {
+    if (toolsWorkflowInput) {
+      logger.info(
+        `Setting tools: ${effectiveToolsInput} based on workflow input.`,
+      );
+    } else {
+      logger.info(
+        `Setting tools: ${effectiveToolsInput} based on the '${RepositoryPropertyName.TOOLS}' repository property.`,
+      );
+    }
+  }
+
+  return effectiveToolsInput;
+}

src/init-action.ts

@@ -6,19 +6,16 @@ import {
   getOptionalInput,
   getRequiredInput,
   getTemporaryDirectory,
-  resolveToolsInput,
 } from "./actions-util";
 import { getGitHubVersion } from "./api-client";
 import { CodeQL } from "./codeql";
 import { EnvVar } from "./environment";
 import { initFeatures } from "./feature-flags";
-import {
-  loadRepositoryProperties,
-  RepositoryPropertyName,
-} from "./feature-flags/properties";
+import { loadRepositoryProperties } from "./feature-flags/properties";
 import { initCodeQL } from "./init";
 import { getActionsLogger, Logger } from "./logging";
 import { getRepositoryNwo } from "./repository";
+import { resolveToolsInput } from "./resolve-tools-input";
 import { ToolsSource } from "./setup-codeql";
 import {
   ActionName,
@@ -157,8 +154,9 @@ async function run(startedAt: Date): Promise<void> {
     // The explicit `tools` workflow input takes precedence. If none is provided,
     // fall back to the 'github-codeql-tools' repository property (if set).
     effectiveToolsInput = resolveToolsInput(
-      repositoryPropertiesResult,
-      RepositoryPropertyName.TOOLS,
+      repositoryPropertiesResult.isSuccess()
+        ? repositoryPropertiesResult.value
+        : {},
       logger,
     );