-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: extract parameter normalization logic to utility (#1066)
- Loading branch information
Showing
3 changed files
with
311 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| /** | ||
| * normalizeParameters transform given parameters from object into array of objects | ||
| * this method also backfills with default properties | ||
| * @param {Record<string, ParameterValue>} [parameters] Parameter name and value pairs | ||
| * @param {Record<string, ParameterValue>} [defaultParameters] Default parameter name and value pairs | ||
| * @return {Array<Record<string, Parameter>>} Parameter information array | ||
| * @example | ||
| * [{ | ||
| * 0: { | ||
| * name: 'image', | ||
| * value: 'alpine', | ||
| * defaultValues: 'alpine', | ||
| * description: '' | ||
| * }, | ||
| * 1: { | ||
| * name: 'tag', | ||
| * value: '1.0', | ||
| * defaultValues: ['1.0', '2.0', 'latest'], | ||
| * description: 'image version' | ||
| * }, | ||
| * ..., | ||
| * }] | ||
| */ | ||
| export function normalizeParameters(parameters = {}, defaultParameters = {}) { | ||
| /** @type {Array<Record<string, Parameter>>} */ | ||
| const normalizedParameters = []; | ||
|
|
||
| Object.entries(parameters).forEach(([propertyName, propertyVal]) => { | ||
| const value = propertyVal.value || propertyVal; | ||
| const description = propertyVal.description || ''; | ||
| // If no default value is found, fill with build parameter value | ||
| const defaultPropertyVal = Object.hasOwn(defaultParameters, propertyName) | ||
| ? defaultParameters[propertyName] | ||
| : value; | ||
| const defaultPropertyDescription = Object.hasOwn( | ||
| defaultParameters, | ||
| propertyName | ||
| ) | ||
| ? defaultParameters[propertyName].description || description | ||
| : description; | ||
| const defaultValue = defaultPropertyVal.value || defaultPropertyVal; | ||
|
|
||
| normalizedParameters.push({ | ||
| name: propertyName, | ||
| value, | ||
| defaultValues: defaultValue, | ||
| description: defaultPropertyDescription | ||
| }); | ||
| }); | ||
|
|
||
| return normalizedParameters; | ||
| } | ||
|
|
||
| /** | ||
| * Get normalized parameter groups | ||
| * @param {Record<string, ParameterValue>} pipelineParameters Pipeline parameters | ||
| * @param {Record<string, ParameterValue>} defaultPipelineParameters Default pipeline parameters | ||
| * @param {Record<string, JobParameterValue>} jobParameters Job parameters | ||
| * @param {Record<string, JobParameterValue>} defaultJobParameters Default job parameters | ||
| * @param {string|null} startFrom Starting job name (null when from the Start button) | ||
| * @return {Array<Record<string, ParameterGroup>>} Job or Shared name and parameter information pairs | ||
| * @example | ||
| * [ | ||
| * { | ||
| * 0: { | ||
| * isOpen: true, | ||
| * jobName: null, | ||
| * paramGroupTitle: 'Shared', | ||
| * parameters: { | ||
| * 0: { | ||
| * name: 'namespace', | ||
| * value: 'sandbox', | ||
| * defaultValues: '', | ||
| * description: '' | ||
| * }, | ||
| * 1: {...}, | ||
| * } | ||
| * } | ||
| * }, | ||
| * { | ||
| * 1: { | ||
| * isOpen: false, | ||
| * jobName: build, | ||
| * paramGroupTitle: 'Job: build', | ||
| * parameters: {...} | ||
| * } | ||
| * }, | ||
| * { | ||
| * 2: {...} | ||
| * } | ||
| * ] | ||
| */ | ||
| export function getNormalizedParameterGroups( | ||
| pipelineParameters = {}, | ||
| defaultPipelineParameters = {}, | ||
| jobParameters = {}, | ||
| defaultJobParameters = {}, | ||
| startFrom | ||
| ) { | ||
| /** @type {Array<Record<string, ParameterGroup>>} */ | ||
| const normalizedParameterGroups = []; | ||
| /** @type {Array<Record<string, ParameterGroup>>} */ | ||
| const normalizedJobParameterGroups = []; | ||
|
|
||
| Object.entries(jobParameters).forEach(([jobName, parameters]) => { | ||
| const paramGroup = { | ||
| jobName, | ||
| parameters: normalizeParameters( | ||
| parameters, | ||
| defaultJobParameters[jobName] | ||
| ), | ||
| isOpen: false, | ||
| paramGroupTitle: `Job: ${jobName}` | ||
| }; | ||
|
|
||
| if (startFrom === jobName) { | ||
| normalizedParameterGroups.push(paramGroup); | ||
| } else { | ||
| normalizedJobParameterGroups.push(paramGroup); | ||
| } | ||
| }); | ||
|
|
||
| if (Object.keys(pipelineParameters).length > 0) { | ||
| normalizedParameterGroups.push({ | ||
| jobName: null, | ||
| parameters: normalizeParameters( | ||
| pipelineParameters, | ||
| defaultPipelineParameters | ||
| ), | ||
| isOpen: false, | ||
| paramGroupTitle: 'Shared' | ||
| }); | ||
| } | ||
|
|
||
| normalizedParameterGroups[0].isOpen = true; | ||
|
|
||
| return normalizedParameterGroups.concat(normalizedJobParameterGroups); | ||
| } |
Oops, something went wrong.