Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-04 00:18:01 +01:00
Code Issues Projects Releases Wiki Activity

fix: relax validation for required params (#1238)

Browse Source 
* fix: relax validation for required params

* refactor: inline parameter type checkers
This commit is contained in:
olav 2022-08-22 16:35:51 +02:00 committed by GitHub
parent b2bb60bec5
commit 0afb1eadcc
2 changed files with 48 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
frontend/src/utils/validateParameterValue.test.ts
View File

@ -1,55 +1,39 @@
import { validateParameterValue } from 'utils/validateParameterValue'; import { validateParameterValue } from 'utils/validateParameterValue';
test('validateParameterValue string', () => { test('validateParameterValue string', () => {
expect( const fn = validateParameterValue;
validateParameterValue( expect(fn({ type: 'string', required: false }, '')).toBeUndefined();
{ type: 'string', name: 'a', description: 'b', required: false }, expect(fn({ type: 'string', required: false }, 'a')).toBeUndefined();
'' expect(fn({ type: 'string', required: true }, '')).not.toBeUndefined();
) expect(fn({ type: 'string', required: true }, 'a')).toBeUndefined();
).toBeUndefined(); });
expect(
validateParameterValue( test('validateParameterValue list', () => {
{ type: 'string', name: 'a', description: 'b', required: false }, const fn = validateParameterValue;
'a' expect(fn({ type: 'list', required: false }, '')).toBeUndefined();
) expect(fn({ type: 'list', required: false }, 'a,b')).toBeUndefined();
).toBeUndefined(); expect(fn({ type: 'list', required: true }, '')).not.toBeUndefined();
expect( expect(fn({ type: 'list', required: true }, 'a,b')).toBeUndefined();
validateParameterValue(
{ type: 'string', name: 'a', description: 'b', required: true },
''
)
).not.toBeUndefined();
expect(
validateParameterValue(
{ type: 'string', name: 'a', description: 'b', required: true },
'b'
)
).toBeUndefined();
}); });
test('validateParameterValue number', () => { test('validateParameterValue number', () => {
expect( const fn = validateParameterValue;
validateParameterValue( expect(fn({ type: 'number', required: false }, '')).toBeUndefined();
{ type: 'number', name: 'a', description: 'b', required: false }, expect(fn({ type: 'number', required: false }, 'a')).not.toBeUndefined();
'' expect(fn({ type: 'number', required: false }, '1')).toBeUndefined();
) expect(fn({ type: 'number', required: true }, '')).not.toBeUndefined();
).toBeUndefined(); expect(fn({ type: 'number', required: true }, 'a')).not.toBeUndefined();
expect( expect(fn({ type: 'number', required: true }, '1')).toBeUndefined();
validateParameterValue( });
{ type: 'number', name: 'a', description: 'b', required: false },
'a' test('validateParameterValue boolean', () => {
) const fn = validateParameterValue;
).not.toBeUndefined(); expect(fn({ type: 'boolean', required: false }, '')).toBeUndefined();
expect( expect(fn({ type: 'boolean', required: false }, 'true')).toBeUndefined();
validateParameterValue( expect(fn({ type: 'boolean', required: false }, 'false')).toBeUndefined();
{ type: 'number', name: 'a', description: 'b', required: true }, expect(fn({ type: 'boolean', required: false }, 'a')).not.toBeUndefined();
'' expect(fn({ type: 'boolean', required: true }, '')).toBeUndefined();
) expect(fn({ type: 'boolean', required: true }, 'true')).toBeUndefined();
).not.toBeUndefined(); expect(fn({ type: 'boolean', required: true }, 'false')).toBeUndefined();
expect( expect(fn({ type: 'boolean', required: true }, 'a')).not.toBeUndefined();
validateParameterValue(
{ type: 'number', name: 'a', description: 'b', required: true },
'1'
)
).toBeUndefined();
}); });

19
frontend/src/utils/validateParameterValue.ts
View File

@ -4,20 +4,33 @@ import {
} from 'interfaces/strategy'; } from 'interfaces/strategy';
export const validateParameterValue = ( export const validateParameterValue = (
definition: IStrategyParameter, definition: Pick<IStrategyParameter, 'type' | 'required'>,
value: IFeatureStrategyParameters[string] value: IFeatureStrategyParameters[string]
): string | undefined => { ): string | undefined => {
const { type, required } = definition; const { type, required } = definition;
if (required && value === '') { // The components for booleans and percentages can't yet show error messages.
// We should not enforce `required` until these errors can be shown in the UI.
const shouldValidateRequired =
type === 'string' || type === 'list' || type === 'number';
if (shouldValidateRequired && required && value === '') {
return 'Field is required'; return 'Field is required';
} }
if (type === 'number' && !isValidNumberOrEmpty(value)) { const shouldValidateNumeric = type === 'percentage' || type === 'number';
if (shouldValidateNumeric && !isValidNumberOrEmpty(value)) {
return 'Not a valid number.'; return 'Not a valid number.';
} }
if (type === 'boolean' && !isValidBooleanOrEmpty(value)) {
return 'Not a valid boolean.';
}
}; };
const isValidNumberOrEmpty = (value: string | number | undefined): boolean => { const isValidNumberOrEmpty = (value: string | number | undefined): boolean => {
return value === '' || /^\d+$/.test(String(value)); return value === '' || /^\d+$/.test(String(value));
}; };
const isValidBooleanOrEmpty = (value: string | number | undefined): boolean => {
return value === '' || value === 'true' || value === 'false';
};