paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

updated validation

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2023-08-30 12:16:43 +02:00
parent c93e9d5bf7
commit 3c5671f193
2 changed files with 22 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/frontend-app-api/src/wiring/parameters.test.ts
+3 -3
View File
@@ -211,7 +211,7 @@ describe('readAppExtensionParameters', () => {
}),
),
).toThrow(
'Invalid extension configuration at app.extensions[0], key must only contain letters, numbers and dots, got core.router/routes',
"Invalid extension configuration at app.extensions[0], extension ID must only contain letters, numbers, dashes, and dots, got 'core.router/routes'",
);
});
});
@@ -260,10 +260,10 @@ describe('expandShorthandExtensionParameters', () => {
disabled: false,
});
expect(() => run('')).toThrowErrorMatchingInlineSnapshot(
`"Invalid extension configuration at app.extensions[1], string shorthand cannot be the empty string"`,
`"Invalid extension configuration at app.extensions[1], extension ID must only contain letters, numbers, dashes, and dots, got ''"`,
);
expect(() => run('core.router/routes')).toThrowErrorMatchingInlineSnapshot(
`"Invalid extension configuration at app.extensions[1], cannot target an extension instance input with the string shorthand (key cannot contain slashes; did you mean 'core.router'?)"`,
`"Invalid extension configuration at app.extensions[1], extension ID must only contain letters, numbers, dashes, and dots, got 'core.router/routes'"`,
);
});
packages/frontend-app-api/src/wiring/parameters.ts
+19 -23
View File
@@ -60,20 +60,20 @@ export function expandShorthandExtensionParameters(
}${prop ? `.${prop}` : ''}, ${msg}`;
}
// Example YAML:
// - entity.card.about
if (typeof arrayEntry === 'string') {
if (arrayEntry.includes('/')) {
const suggestion = arrayEntry.split('/')[0];
function assertValidId(id: string) {
if (!id.match(/^[\.a-zA-Z0-9-]+$/)) {
throw new Error(
errorMsg(
`cannot target an extension instance input with the string shorthand (key cannot contain slashes; did you mean '${suggestion}'?)`,
`extension ID must only contain letters, numbers, dashes, and dots, got '${id}'`,
),
);
}
if (!arrayEntry) {
throw new Error(errorMsg('string shorthand cannot be the empty string'));
}
}
// Example YAML:
// - entity.card.about
if (typeof arrayEntry === 'string') {
assertValidId(arrayEntry);
return {
id: arrayEntry,
disabled: false,
@@ -94,19 +94,15 @@ export function expandShorthandExtensionParameters(
throw new Error(errorMsg(`must have exactly one key, got ${joinedKeys}`));
}
const key = String(keys[0]);
const value = arrayEntry[key];
if (!key.match(/^[\.a-zA-Z0-9]+$/)) {
throw new Error(
errorMsg(`key must only contain letters, numbers and dots, got ${key}`),
);
}
const id = String(keys[0]);
const value = arrayEntry[id];
assertValidId(id);
// Example YAML:
// - catalog.page.cicd: false
if (typeof value === 'boolean') {
return {
id: key,
id,
disabled: !value,
};
}
@@ -120,7 +116,7 @@ export function expandShorthandExtensionParameters(
// width: 1500
// height: 800
if (typeof value !== 'object' || value === null || Array.isArray(value)) {
throw new Error(errorMsg('value must be a boolean or object', key));
throw new Error(errorMsg('value must be a boolean or object', id));
}
const at = value.at;
@@ -128,14 +124,14 @@ export function expandShorthandExtensionParameters(
const config = value.config;
if (at !== undefined && typeof at !== 'string') {
throw new Error(errorMsg('must be a string', key, 'at'));
throw new Error(errorMsg('must be a string', id, 'at'));
} else if (disabled !== undefined && typeof disabled !== 'boolean') {
throw new Error(errorMsg('must be a boolean', key, 'disabled'));
throw new Error(errorMsg('must be a boolean', id, 'disabled'));
} else if (
config !== undefined &&
(typeof config !== 'object' || config === null || Array.isArray(config))
) {
throw new Error(errorMsg('must be an object', key, 'config'));
throw new Error(errorMsg('must be an object', id, 'config'));
}
const unknownKeys = Object.keys(value).filter(
@@ -147,14 +143,14 @@ export function expandShorthandExtensionParameters(
`unknown parameter; expected one of '${knownExtensionParameters.join(
"', '",
)}'`,
key,
id,
unknownKeys.join(', '),
),
);
}
return {
id: key,
id,
at,
disabled,
config,