Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Less strict connection field env variable names #3759

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions frontend/src/concepts/connectionTypes/__tests__/utils.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -258,13 +258,14 @@ describe('isValidEnvVar', () => {
expect(isValidEnvVar('NAME')).toBe(true);
expect(isValidEnvVar('UNDERSCORE_NAME')).toBe(true);
expect(isValidEnvVar('has_digits_1234')).toBe(true);
expect(isValidEnvVar('.dockerconfigjson')).toBe(true);
});

it('should be invalid env var', () => {
expect(isValidEnvVar('.dot')).toBe(false);
expect(isValidEnvVar('has-dash')).toBe(false);
expect(isValidEnvVar('1_digit_as_first_char')).toBe(false);
expect(isValidEnvVar('has space')).toBe(false);
expect(isValidEnvVar('has+=')).toBe(false);
expect(isValidEnvVar('has!$@#*')).toBe(false);
expect(isValidEnvVar('')).toBe(false);
});
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const UriFormField: React.FC<FieldProps<UriField>> = ({
: (_e, v) => {
onChange(v);
if (!isValid) {
setIsValid(validateUrl(value));
setIsValid(validateUrl(v));
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/concepts/connectionTypes/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ export const fieldNameToEnvVar = (name: string): string => {
return allUppercase;
};

export const ENV_VAR_NAME_REGEX = new RegExp('^[_a-zA-Z][_a-zA-Z0-9]*$');
export const ENV_VAR_NAME_REGEX = new RegExp('^[-_.a-zA-Z0-9]+$');
export const isValidEnvVar = (name: string): boolean => ENV_VAR_NAME_REGEX.test(name);

export const isUriConnectionType = (connectionType: ConnectionTypeConfigMapObj): boolean =>
Expand Down
7 changes: 2 additions & 5 deletions frontend/src/concepts/connectionTypes/validationUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
isDuplicateExtension,
} from '~/concepts/connectionTypes/fields/fieldUtils';
import { ConnectionTypeFieldType } from '~/concepts/connectionTypes/types';
import { ENV_VAR_NAME_REGEX, isConnectionTypeDataField } from '~/concepts/connectionTypes/utils';
import { isConnectionTypeDataField } from '~/concepts/connectionTypes/utils';

const baseFieldSchema = z.object({
name: z.string().min(1, { message: 'Name is required' }),
Expand All @@ -17,10 +17,7 @@ const baseFieldPropertiesSchema = z.object({
});

const baseDataFieldPropertiesSchema = baseFieldSchema.extend({
envVar: z.string().regex(ENV_VAR_NAME_REGEX, {
message:
'Must start with a letter or underscore. Valid characters include letters, numbers, and underscores ( _ ).',
}),
envVar: z.string(),
required: z.boolean().optional(),
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,7 @@ import {
TextInput,
} from '@patternfly/react-core';
import { Modal } from '@patternfly/react-core/deprecated';
import {
ExclamationCircleIcon,
OutlinedQuestionCircleIcon,
WarningTriangleIcon,
} from '@patternfly/react-icons';
import { OutlinedQuestionCircleIcon, WarningTriangleIcon } from '@patternfly/react-icons';
import DashboardModalFooter from '~/concepts/dashboard/DashboardModalFooter';
import {
ConnectionTypeDataField,
Expand Down Expand Up @@ -81,7 +77,7 @@ export const ConnectionTypeDataFieldModal: React.FC<Props> = ({

const isEnvVarValid = !envVar || isValidEnvVar(envVar);

const isValid = isPropertiesValid && !!name && !!envVar && isEnvVarValid;
const isValid = isPropertiesValid && !!name && !!envVar;

// Cast from specific type to generic type
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions,@typescript-eslint/no-explicit-any
Expand Down Expand Up @@ -183,16 +179,16 @@ export const ConnectionTypeDataFieldModal: React.FC<Props> = ({
setData('envVar', value);
}}
data-testid="field-env-var-input"
validated={!isEnvVarValid ? 'error' : isEnvVarConflict ? 'warning' : 'default'}
validated={!isEnvVarValid || isEnvVarConflict ? 'warning' : 'default'}
/>
<FormHelperText>
<HelperText>
<HelperTextItem
variant={isEnvVarValid ? 'default' : 'error'}
icon={isEnvVarValid ? undefined : <ExclamationCircleIcon />}
variant={isEnvVarValid ? 'default' : 'warning'}
icon={isEnvVarValid ? undefined : <WarningTriangleIcon />}
>
Must start with a letter or underscore. Valid characters include letters, numbers,
and underscores ( _ ).
For highest compatibility, field must consist of alphanumeric characters, ( - ), ( _
), or ( . )
</HelperTextItem>
</HelperText>
{isEnvVarConflict ? (
Expand Down
Loading