From 87c5b58925cff033edb2bd0991042f0031eaf878 Mon Sep 17 00:00:00 2001 From: "Michael B. Gale" Date: Tue, 2 Sep 2025 18:20:56 +0100 Subject: [PATCH] Remove `augmentationProperties` from `Config` --- lib/init-action.js | 4 ++-- src/codeql.test.ts | 3 +-- src/config-utils.test.ts | 10 +++++----- src/config-utils.ts | 14 +++++--------- src/testing-utils.ts | 6 +----- 5 files changed, 14 insertions(+), 23 deletions(-) diff --git a/lib/init-action.js b/lib/init-action.js index fe6f4a6a1..ac9358f21 100644 --- a/lib/init-action.js +++ b/lib/init-action.js @@ -87601,11 +87601,11 @@ async function initConfig(inputs) { tempDir ); } - const config = await getDefaultConfig(inputs); + const { augmentationProperties, ...config } = await getDefaultConfig(inputs); config.originalUserInput = userConfig; config.computedConfig = generateCodeScanningConfig( userConfig, - config.augmentationProperties + augmentationProperties ); const { overlayDatabaseMode, useOverlayDatabaseCaching } = await getOverlayDatabaseMode( inputs.codeql, diff --git a/src/codeql.test.ts b/src/codeql.test.ts index e6df746c7..ece6ab878 100644 --- a/src/codeql.test.ts +++ b/src/codeql.test.ts @@ -503,11 +503,10 @@ const injectedConfigMacro = test.macro({ ...stubConfig, ...configOverride, tempDir, - augmentationProperties, }; thisStubConfig.computedConfig = generateCodeScanningConfig( thisStubConfig.originalUserInput, - thisStubConfig.augmentationProperties, + augmentationProperties, ); await codeqlObject.databaseInitCluster( diff --git a/src/config-utils.test.ts b/src/config-utils.test.ts index b133f500b..a67e3cf65 100644 --- a/src/config-utils.test.ts +++ b/src/config-utils.test.ts @@ -157,8 +157,8 @@ test("load empty config", async (t) => { }), ); - t.deepEqual( - config, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const { augmentationProperties, ...expectedConfig } = await configUtils.getDefaultConfig( createTestInitConfigInputs({ languagesInput: languages, @@ -166,8 +166,9 @@ test("load empty config", async (t) => { codeql, logger, }), - ), - ); + ); + + t.deepEqual(config, expectedConfig); }); }); @@ -344,7 +345,6 @@ test("load non-empty input", async (t) => { debugMode: false, debugArtifactName: "my-artifact", debugDatabaseName: "my-db", - augmentationProperties: configUtils.defaultAugmentationProperties, trapCaches: {}, trapCacheDownloadTime: 0, dependencyCachingEnabled: CachingKind.None, diff --git a/src/config-utils.ts b/src/config-utils.ts index 64a1c93b9..e8c97a854 100644 --- a/src/config-utils.ts +++ b/src/config-utils.ts @@ -144,12 +144,6 @@ export interface Config { * Specifies the name of the database in the debugging artifact. */ debugDatabaseName: string; - - /** - * Describes how to augment the user configuration with inputs from the action. - */ - augmentationProperties: AugmentationProperties; - /** * The configuration we computed by combining `originalUserInput` with `augmentationProperties`, * as well as adjustments made to it based on unsupported or required options. @@ -536,7 +530,9 @@ export async function getDefaultConfig({ githubVersion, features, logger, -}: InitConfigInputs): Promise { +}: InitConfigInputs): Promise< + Config & { augmentationProperties: AugmentationProperties } +> { const analysisKinds = await parseAnalysisKinds(analysisKindsInput); // For backwards compatibility, add Code Quality to the enabled analysis kinds @@ -1104,14 +1100,14 @@ export async function initConfig(inputs: InitConfigInputs): Promise { ); } - const config = await getDefaultConfig(inputs); + const { augmentationProperties, ...config } = await getDefaultConfig(inputs); config.originalUserInput = userConfig; // Compute the full Code Scanning configuration that combines the configuration from the // configuration file / `config` input with other inputs, such as `queries`. config.computedConfig = generateCodeScanningConfig( userConfig, - config.augmentationProperties, + augmentationProperties, ); // The choice of overlay database mode depends on the selection of languages diff --git a/src/testing-utils.ts b/src/testing-utils.ts index 6e1763b00..a12c99585 100644 --- a/src/testing-utils.ts +++ b/src/testing-utils.ts @@ -11,7 +11,7 @@ import * as apiClient from "./api-client"; import { GitHubApiDetails } from "./api-client"; import { CachingKind } from "./caching-utils"; import * as codeql from "./codeql"; -import { AugmentationProperties, Config } from "./config-utils"; +import { Config } from "./config-utils"; import * as defaults from "./defaults.json"; import { CodeQLDefaultVersionInfo, @@ -370,10 +370,6 @@ export function createTestConfig(overrides: Partial): Config { debugMode: false, debugArtifactName: DEFAULT_DEBUG_ARTIFACT_NAME, debugDatabaseName: DEFAULT_DEBUG_DATABASE_NAME, - augmentationProperties: { - packsInputCombines: false, - queriesInputCombines: false, - } satisfies AugmentationProperties, trapCaches: {}, trapCacheDownloadTime: 0, dependencyCachingEnabled: CachingKind.None,