Fix type of queries in UserConfig to account for string values

Author: mbg

lib/init-action.js

@@ -26,13 +26,29 @@ export interface QuerySpec {
   uses: string;
 }
 
+// We generally accept simple strings or `QuerySpec` objects as inputs for extra queries.
+export type QueryInput = QuerySpec | string;
+
+/**
+ * A helper function for log messages that turns a `QueryInput` into a `string`.
+ *
+ * @param input The `QueryInput` to display.
+ * @returns A string representation of `QueryInput`.
+ */
+export function renderQueryInput(input: QueryInput): string {
+  if (typeof input === "string") {
+    return input;
+  }
+  return input.uses;
+}
+
 /**
  * Format of the config file supplied by the user.
  */
 export interface UserConfig {
   name?: string;
   "disable-default-queries"?: boolean;
-  queries?: QuerySpec[];
+  queries?: QueryInput[];
   "paths-ignore"?: string[];
   paths?: string[];
 
@@ -374,8 +390,8 @@ function combineQueries(
   logger: Logger,
   config: UserConfig,
   augmentationProperties: AugmentationProperties,
-): QuerySpec[] {
-  const result: QuerySpec[] = [];
+): QueryInput[] {
+  const result: QueryInput[] = [];
 
   // Query settings obtained from the repository properties have the highest precedence.
   if (
@@ -440,7 +456,7 @@ export function generateCodeScanningConfig(
     augmentationProperties,
   );
   logger.debug(
-    `Combined queries: ${augmentedConfig.queries?.map((q) => q.uses).join(",")}`,
+    `Combined queries: ${augmentedConfig.queries?.map(renderQueryInput).join(",")}`,
   );
   if (augmentedConfig.queries?.length === 0) {
     delete augmentedConfig.queries;

src/config/db-config.ts

@@ -12,7 +12,11 @@ import {
   isSelfHostedRunner,
 } from "./actions-util";
 import { getAnalysisKey, getApiClient } from "./api-client";
-import { parseRegistriesWithoutCredentials, type Config } from "./config-utils";
+import {
+  parseRegistriesWithoutCredentials,
+  renderQueryInput,
+  type Config,
+} from "./config-utils";
 import { DependencyCacheRestoreStatusReport } from "./dependency-caching";
 import { DocUrl } from "./doc-url";
 import { EnvVar } from "./environment";
@@ -549,7 +553,7 @@ export async function createInitWithConfigStatusReport(
   let queriesInput = getOptionalInput("queries")?.trim();
   if (queriesInput === undefined || queriesInput.startsWith("+")) {
     queries.push(
-      ...(config.originalUserInput.queries || []).map((q) => q.uses),
+      ...(config.originalUserInput.queries || []).map(renderQueryInput),
     );
   }
   if (queriesInput !== undefined) {