Skip to content

The open alternative to Salesforce, designed for AI.

Improve sensitive config variable masking and editing UX (#19578)

Félix Malfait4c57352450af
diff --git a/packages/twenty-front/src/modules/settings/admin-panel/config-variables/components/ConfigVariableValueInput.tsx b/packages/twenty-front/src/modules/settings/admin-panel/config-variables/components/ConfigVariableValueInput.tsx
index fe24ce1bf0e..e20ae3c6cff 100644
--- a/packages/twenty-front/src/modules/settings/admin-panel/config-variables/components/ConfigVariableValueInput.tsx
+++ b/packages/twenty-front/src/modules/settings/admin-panel/config-variables/components/ConfigVariableValueInput.tsx
@@ -41,7 +41,11 @@ export const ConfigVariableValueInput = ({
options={variable.options}
disabled={disabled}
placeholder={
- disabled ? t`Undefined` : t`Enter a value to store in database`
+ disabled
+ ? t`Undefined`
+ : variable.isSensitive
+ ? t`Enter a new secret value`
+ : t`Enter a value to store in database`
}
/>
) : (
diff --git a/packages/twenty-front/src/modules/settings/admin-panel/config-variables/hooks/useConfigVariableForm.ts b/packages/twenty-front/src/modules/settings/admin-panel/config-variables/hooks/useConfigVariableForm.ts
index 5c4a57504a4..7935d653822 100644
--- a/packages/twenty-front/src/modules/settings/admin-panel/config-variables/hooks/useConfigVariableForm.ts
+++ b/packages/twenty-front/src/modules/settings/admin-panel/config-variables/hooks/useConfigVariableForm.ts
@@ -9,6 +9,19 @@ type FormValues = {
value: ConfigVariableValue;
};
+const hasMeaningfulValue = (value: ConfigVariableValue): boolean => {
+ if (value === null || value === undefined) {
+ return false;
+ }
+ if (typeof value === 'string') {
+ return value.trim() !== '';
+ }
+ if (Array.isArray(value)) {
+ return value.length > 0;
+ }
+ return true;
+};
+
export const useConfigVariableForm = (variable?: ConfigVariable) => {
const validationSchema = z.object({
value: z.union([
@@ -22,9 +35,10 @@ export const useConfigVariableForm = (variable?: ConfigVariable) => {
});
const {
+ control,
handleSubmit,
- setValue,
- formState: { isSubmitting },
+ reset,
+ formState: { isSubmitting, isDirty },
watch,
} = useForm<FormValues>({
resolver: zodResolver(validationSchema),
@@ -32,27 +46,19 @@ export const useConfigVariableForm = (variable?: ConfigVariable) => {
});
const currentValue = watch('value');
- const hasValueChanged = currentValue !== variable?.value;
- const isValueValid = !!(
- variable &&
+ const isValueValid =
+ variable !== undefined &&
!variable.isEnvOnly &&
- hasValueChanged &&
- ((typeof currentValue === 'string' && currentValue.trim() !== '') ||
- typeof currentValue === 'boolean' ||
- typeof currentValue === 'number' ||
- (Array.isArray(currentValue) && currentValue.length > 0) ||
- (typeof currentValue === 'object' &&
- currentValue !== null &&
- !Array.isArray(currentValue)))
- );
+ isDirty &&
+ hasMeaningfulValue(currentValue);
return {
+ control,
handleSubmit,
- setValue,
+ reset,
isSubmitting,
- watch,
currentValue,
- hasValueChanged,
+ hasValueChanged: isDirty,
isValueValid,
};
};
diff --git a/packages/twenty-front/src/pages/settings/admin-panel/SettingsAdminConfigVariableDetails.tsx b/packages/twenty-front/src/pages/settings/admin-panel/SettingsAdminConfigVariableDetails.tsx
index 838f366ca4b..f377ed701f4 100644
--- a/packages/twenty-front/src/pages/settings/admin-panel/SettingsAdminConfigVariableDetails.tsx
+++ b/packages/twenty-front/src/pages/settings/admin-panel/SettingsAdminConfigVariableDetails.tsx
@@ -1,6 +1,7 @@
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { useState } from 'react';
+import { Controller } from 'react-hook-form';
import { Form, useParams } from 'react-router-dom';
import { isConfigVariablesInDbEnabledState } from '@/client-config/states/isConfigVariablesInDbEnabledState';
@@ -76,10 +77,10 @@ export const SettingsAdminConfigVariableDetails = () => {
useConfigVariableActions(variable?.name ?? '');
const {
+ control,
handleSubmit,
- setValue,
+ reset,
isSubmitting,
- watch,
hasValueChanged,
isValueValid,
} = useConfigVariableForm(variable);
@@ -97,22 +98,19 @@ export const SettingsAdminConfigVariableDetails = () => {
};
const handleEditClick = () => {
+ if (variable.isSensitive) {
+ reset({ value: '' });
+ }
setIsEditing(true);
};
const handleXButtonClick = () => {
- if (isFromDatabase && hasValueChanged) {
- setValue('value', variable.value);
- setIsEditing(false);
- return;
- }
-
if (isFromDatabase && !hasValueChanged) {
openModal(RESET_VARIABLE_MODAL_ID);
return;
}
- setValue('value', variable.value);
+ reset({ value: variable.value });
setIsEditing(false);
};
@@ -155,11 +153,17 @@ export const SettingsAdminConfigVariableDetails = () => {
<StyledFormContainer>
<Form onSubmit={handleSubmit(onSubmit)}>
<StyledRow>
- <ConfigVariableValueInput
- variable={variable}
- value={watch('value')}
- onChange={(value) => setValue('value', value)}
- disabled={isEnvOnly || !isEditing}
+ <Controller
+ control={control}
+ name="value"
+ render={({ field }) => (
+ <ConfigVariableValueInput
+ variable={variable}
+ value={field.value}
+ onChange={field.onChange}
+ disabled={isEnvOnly || !isEditing}
+ />
+ )}
/>
{!isEditing ? (
@@ -177,9 +181,7 @@ export const SettingsAdminConfigVariableDetails = () => {
variant="secondary"
position="left"
type="submit"
- disabled={
- isSubmitting || !isValueValid || !hasValueChanged
- }
+ disabled={isSubmitting || !isValueValid}
/>
<Button
Icon={IconX}
diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/twenty-config.service.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/twenty-config.service.ts
index f5d46223fa6..cac52dfe90e 100644
--- a/packages/twenty-server/src/engine/core-modules/twenty-config/twenty-config.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/twenty-config.service.ts
@@ -121,7 +121,7 @@ export class TwentyConfigService {
let value = this.get(typedKey) ?? '';
const source = this.determineConfigSource(typedKey, value, envMetadata);
- value = this.maskSensitiveValue(typedKey, value);
+ value = this.maskSensitiveValue(typedKey, value, envMetadata);
result[key] = {
value,
@@ -147,7 +147,7 @@ export class TwentyConfigService {
let value = this.get(key) ?? '';
const source = this.determineConfigSource(key, value, metadata);
- value = this.maskSensitiveValue(key, value);
+ value = this.maskSensitiveValue(key, value, metadata);
return {
value,
@@ -248,26 +248,47 @@ export class TwentyConfigService {
key: T,
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
value: any,
+ metadata: ConfigVariablesMetadataOptions,
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
): any {
- if (!isString(value) || !(key in CONFIG_VARIABLES_MASKING_CONFIG)) {
- return value;
+ if (key in CONFIG_VARIABLES_MASKING_CONFIG) {
+ if (!isString(value)) {
+ return value;
+ }
+
+ const varMaskingConfig =
+ CONFIG_VARIABLES_MASKING_CONFIG[
+ key as keyof typeof CONFIG_VARIABLES_MASKING_CONFIG
+ ];
+ const options =
+ varMaskingConfig.strategy ===
+ ConfigVariablesMaskingStrategies.LAST_N_CHARS
+ ? { chars: varMaskingConfig.chars }
+ : undefined;
+
+ return configVariableMaskSensitiveData(value, varMaskingConfig.strategy, {
+ ...options,
+ variableName: key as string,
+ });
}
- const varMaskingConfig =
- CONFIG_VARIABLES_MASKING_CONFIG[
- key as keyof typeof CONFIG_VARIABLES_MASKING_CONFIG
- ];
- const options =
- varMaskingConfig.strategy ===
- ConfigVariablesMaskingStrategies.LAST_N_CHARS
- ? { chars: varMaskingConfig.chars }
- : undefined;
-
- return configVariableMaskSensitiveData(value, varMaskingConfig.strategy, {
- ...options,
- variableName: key as string,
- });
+ if (metadata?.isSensitive) {
+ if (!value && value !== false && value !== 0) {
+ return value;
+ }
+
+ if (isString(value)) {
+ return configVariableMaskSensitiveData(
+ value,
+ ConfigVariablesMaskingStrategies.LAST_N_CHARS,
+ { chars: 4, variableName: key as string },
+ );
+ }
+
+ return '********';
+ }
+
+ return value;
}
validateConfigVariableExists(key: string): boolean {