From 8f32d0ca46189db4ae0a2fd81e62ea4adb47996d Mon Sep 17 00:00:00 2001 From: moyo1997 <54333118+moyo1997@users.noreply.github.com> Date: Tue, 30 Jul 2024 10:27:29 -0700 Subject: [PATCH] evaluate inherit presets based on presets that should be visible from file (#3941) * initial changes * modify other preset flows * fix unused import * remove unused import * check for default preset * acocunt for userpresets * remove extra condition --------- Co-authored-by: Garrett Campbell --- src/preset.ts | 49 ++++++++++++++++++++++++++++------------ src/presetsController.ts | 32 +++++++++++++------------- 2 files changed, 50 insertions(+), 31 deletions(-) diff --git a/src/preset.ts b/src/preset.ts index 2fa86e78..eae1d7d5 100644 --- a/src/preset.ts +++ b/src/preset.ts @@ -1130,10 +1130,14 @@ export async function expandConfigurePreset(folder: string, name: string, worksp * calling configurePresets() or userConfigurePresets(). Getting the presets plus included map is useful on Select Preset when we want to be able to * apply the Vs Dev Env to the preset and want the entire list of unexpanded presets, including the inlcuded presets. */ -async function expandConfigurePresetImpl(folder: string, name: string, allowUserPreset: boolean = false, usePresetsPlusIncluded: boolean = false, errorHandler?: ExpansionErrorHandler): Promise { +async function expandConfigurePresetImpl(folder: string, name: string, allowUserPreset: boolean = false, usePresetsPlusIncluded: boolean = false, errorHandler?: ExpansionErrorHandler, inheritedByPreset?: ConfigurePreset): Promise { let preset = getPresetByName(configurePresets(folder, usePresetsPlusIncluded), name); if (preset) { - return expandConfigurePresetHelper(folder, preset, false, usePresetsPlusIncluded, errorHandler); + const presetList = inheritedByPreset ? inheritedByPreset.__file!.configurePresets : configurePresets(folder, usePresetsPlusIncluded); + const validInherit = presetList !== undefined && presetList.filter(p => p.name === name).length > 0; + if (validInherit) { + return expandConfigurePresetHelper(folder, preset, false, usePresetsPlusIncluded, errorHandler); + } } if (allowUserPreset) { @@ -1195,7 +1199,7 @@ async function expandConfigurePresetHelper(folder: string, preset: ConfigurePres preset.inherits = [preset.inherits]; } for (const parentName of preset.inherits) { - const parent = await expandConfigurePresetImpl(folder, parentName, allowUserPreset, usePresetsPlusIncluded, errorHandler); + const parent = await expandConfigurePresetImpl(folder, parentName, allowUserPreset, usePresetsPlusIncluded, errorHandler, preset); if (parent) { // Inherit environment inheritedEnv = EnvironmentUtils.mergePreserveNull([parent.environment, inheritedEnv]); @@ -1530,10 +1534,14 @@ export async function expandBuildPreset(folder: string, name: string, workspaceF return expandedPreset; } -async function expandBuildPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, parallelJobs?: number, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler): Promise { +async function expandBuildPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, parallelJobs?: number, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler, inheritedByPreset?: BuildPreset): Promise { let preset = getPresetByName(buildPresets(folder), name); if (preset) { - return expandBuildPresetHelper(folder, preset, workspaceFolder, sourceDir, parallelJobs, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + const presetList = inheritedByPreset ? inheritedByPreset.__file!.buildPresets : buildPresets(folder); + const validInherit = presetList !== undefined && presetList.filter(p => p.name === name).length > 0; + if (validInherit) { + return expandBuildPresetHelper(folder, preset, workspaceFolder, sourceDir, parallelJobs, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + } } if (allowUserPreset) { @@ -1590,7 +1598,7 @@ async function expandBuildPresetHelper(folder: string, preset: BuildPreset, work preset.inherits = [preset.inherits]; } for (const parentName of preset.inherits) { - const parent = await expandBuildPresetImpl(folder, parentName, workspaceFolder, sourceDir, parallelJobs, preferredGeneratorName, allowUserPreset, undefined, enableTryApplyDevEnv, errorHandler); + const parent = await expandBuildPresetImpl(folder, parentName, workspaceFolder, sourceDir, parallelJobs, preferredGeneratorName, allowUserPreset, undefined, enableTryApplyDevEnv, errorHandler, preset); if (parent) { // Inherit environment inheritedEnv = EnvironmentUtils.mergePreserveNull([parent.environment, inheritedEnv]); @@ -1727,10 +1735,14 @@ export async function expandTestPreset(folder: string, name: string, workspaceFo return expandedPreset; } -async function expandTestPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler): Promise { +async function expandTestPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler, inheritedByPreset?: TestPreset): Promise { let preset = getPresetByName(testPresets(folder), name); if (preset) { - return expandTestPresetHelper(folder, preset, workspaceFolder, sourceDir, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + const presetList = inheritedByPreset ? inheritedByPreset.__file!.testPresets : testPresets(folder); + const validInherit = presetList !== undefined && presetList.filter(p => p.name === name).length > 0; + if (validInherit) { + return expandTestPresetHelper(folder, preset, workspaceFolder, sourceDir, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + } } if (allowUserPreset) { @@ -1784,7 +1796,7 @@ async function expandTestPresetHelper(folder: string, preset: TestPreset, worksp preset.inherits = [preset.inherits]; } for (const parentName of preset.inherits) { - const parent = await expandTestPresetImpl(folder, parentName, workspaceFolder, sourceDir, preferredGeneratorName, allowUserPreset, undefined, false, errorHandler); + const parent = await expandTestPresetImpl(folder, parentName, workspaceFolder, sourceDir, preferredGeneratorName, allowUserPreset, undefined, false, errorHandler, preset); if (parent) { // Inherit environment inheritedEnv = EnvironmentUtils.mergePreserveNull([parent.environment, inheritedEnv]); @@ -1865,10 +1877,14 @@ export async function expandPackagePreset(folder: string, name: string, workspac return expandedPreset; } -async function expandPackagePresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler): Promise { +async function expandPackagePresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, preferredGeneratorName?: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler, inheritedByPreset?: PackagePreset): Promise { let preset = getPresetByName(packagePresets(folder), name); if (preset) { - return expandPackagePresetHelper(folder, preset, workspaceFolder, sourceDir, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + const presetList = inheritedByPreset ? inheritedByPreset.__file!.packagePresets : packagePresets(folder); + const validInherit = presetList !== undefined && presetList.filter(p => p.name === name).length > 0; + if (validInherit) { + return expandPackagePresetHelper(folder, preset, workspaceFolder, sourceDir, preferredGeneratorName, false, enableTryApplyDevEnv, errorHandler); + } } if (allowUserPreset) { @@ -1922,7 +1938,7 @@ async function expandPackagePresetHelper(folder: string, preset: PackagePreset, preset.inherits = [preset.inherits]; } for (const parentName of preset.inherits) { - const parent = await expandPackagePresetImpl(folder, parentName, workspaceFolder, sourceDir, preferredGeneratorName, allowUserPreset, undefined, enableTryApplyDevEnv, errorHandler); + const parent = await expandPackagePresetImpl(folder, parentName, workspaceFolder, sourceDir, preferredGeneratorName, allowUserPreset, undefined, enableTryApplyDevEnv, errorHandler, preset); if (parent) { // Inherit environment inheritedEnv = EnvironmentUtils.mergePreserveNull([parent.environment, inheritedEnv]); @@ -1986,10 +2002,14 @@ export async function expandWorkflowPreset(folder: string, name: string, workspa return expandedPreset; } -async function expandWorkflowPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler): Promise { +async function expandWorkflowPresetImpl(folder: string, name: string, workspaceFolder: string, sourceDir: string, allowUserPreset: boolean = false, configurePreset?: string, enableTryApplyDevEnv: boolean = true, errorHandler?: ExpansionErrorHandler, inheritedByPreset?: WorkflowPreset): Promise { let preset = getPresetByName(workflowPresets(folder), name); if (preset) { - return expandWorkflowPresetHelper(folder, preset, workspaceFolder, sourceDir, false, enableTryApplyDevEnv, errorHandler); + const presetList = inheritedByPreset ? inheritedByPreset.__file!.workflowPresets : workflowPresets(folder); + const validInherit = presetList !== undefined && presetList.filter(p => p.name === name).length > 0; + if (validInherit) { + return expandWorkflowPresetHelper(folder, preset, workspaceFolder, sourceDir, false, enableTryApplyDevEnv, errorHandler); + } } if (allowUserPreset) { @@ -2014,7 +2034,6 @@ async function expandWorkflowPresetImpl(folder: string, name: string, workspaceF }; return expandWorkflowPresetHelper(folder, preset, workspaceFolder, sourceDir, true, enableTryApplyDevEnv, errorHandler); } - log.error(localize('workflow.preset.not.found', 'Could not find workflow preset with name {0}', name)); errorHandler?.tempErrorList.push([localize('workflow.preset.not.found', 'Could not find workflow preset'), name]); return null; diff --git a/src/presetsController.ts b/src/presetsController.ts index 27522cdb..e3bff981 100644 --- a/src/presetsController.ts +++ b/src/presetsController.ts @@ -186,7 +186,7 @@ export class PresetsController { if (presetsFile) { // Private fields must be set after validation, otherwise validation would fail. this.populatePrivatePresetsFields(presetsFile, file); - await this.mergeIncludeFiles(presetsFile, presetsFile, file, referencedFiles); + await this.mergeIncludeFiles(presetsFile, file, referencedFiles); const copyOfPresetsFile = lodash.cloneDeep(presetsFile); // add the include files to the original presets file @@ -1594,8 +1594,8 @@ export class PresetsController { setFile(presetsFile.packagePresets); } - private async mergeIncludeFiles(rootPresetsFile: preset.PresetsFile | undefined, presetsFile: preset.PresetsFile | undefined, file: string, referencedFiles: Set): Promise { - if (!rootPresetsFile || !presetsFile || !presetsFile.include) { + private async mergeIncludeFiles(presetsFile: preset.PresetsFile | undefined, file: string, referencedFiles: Set): Promise { + if (!presetsFile || !presetsFile.include) { return; } @@ -1630,29 +1630,29 @@ export class PresetsController { // Private fields must be set after validation, otherwise validation would fail. this.populatePrivatePresetsFields(includeFile, fullIncludePath); - if (includeFile.cmakeMinimumRequired) { - if (!rootPresetsFile.cmakeMinimumRequired || util.versionLess(rootPresetsFile.cmakeMinimumRequired, includeFile.cmakeMinimumRequired)) { - rootPresetsFile.cmakeMinimumRequired = includeFile.cmakeMinimumRequired; - } - } + // Recursively merge included files + await this.mergeIncludeFiles(includeFile, fullIncludePath, referencedFiles); + if (includeFile.configurePresets) { - rootPresetsFile.configurePresets = includeFile.configurePresets.concat(rootPresetsFile.configurePresets || []); + presetsFile.configurePresets = includeFile.configurePresets.concat(presetsFile.configurePresets || []); } if (includeFile.buildPresets) { - rootPresetsFile.buildPresets = includeFile.buildPresets.concat(rootPresetsFile.buildPresets || []); + presetsFile.buildPresets = includeFile.buildPresets.concat(presetsFile.buildPresets || []); } if (includeFile.testPresets) { - rootPresetsFile.testPresets = includeFile.testPresets.concat(rootPresetsFile.testPresets || []); + presetsFile.testPresets = includeFile.testPresets.concat(presetsFile.testPresets || []); } if (includeFile.packagePresets) { - rootPresetsFile.packagePresets = includeFile.packagePresets.concat(rootPresetsFile.packagePresets || []); + presetsFile.packagePresets = includeFile.packagePresets.concat(presetsFile.packagePresets || []); } if (includeFile.workflowPresets) { - rootPresetsFile.workflowPresets = includeFile.workflowPresets.concat(rootPresetsFile.workflowPresets || []); + presetsFile.workflowPresets = includeFile.workflowPresets.concat(presetsFile.workflowPresets || []); + } + if (includeFile.cmakeMinimumRequired) { + if (!presetsFile.cmakeMinimumRequired || util.versionLess(presetsFile.cmakeMinimumRequired, includeFile.cmakeMinimumRequired)) { + presetsFile.cmakeMinimumRequired = includeFile.cmakeMinimumRequired; + } } - - // Recursively merge included files - await this.mergeIncludeFiles(rootPresetsFile, includeFile, fullIncludePath, referencedFiles); } }