Skip to content

The open alternative to Salesforce, designed for AI.

App preferences: reset on empty value, error state, missing configuration warning (#28091)

nitin0fd9c1bc42f7
diff --git a/packages/twenty-agent-skills/references/develop-app/layout.md b/packages/twenty-agent-skills/references/develop-app/layout.md
index db6f6f50dcf..37a6c6eea8f 100644
--- a/packages/twenty-agent-skills/references/develop-app/layout.md
+++ b/packages/twenty-agent-skills/references/develop-app/layout.md
@@ -60,7 +60,7 @@ To add an entry to an app's settings menu, declare it with `defineSettingsMenuIt
The menu item points at the component, not the reverse, so one component can back several items. Declare as many as the app needs. Each renders as a tab on the app's page under Settings > Apps, after the built-in General tab, in `position` order.
-`scope` is `WORKSPACE` (configured once for the whole workspace, the default) or `USER` (configured by each member for themselves). A `USER` item renders as a tab on the app's page under the member's Settings > App preferences, but that page is not enabled in every workspace yet — where it is not, the item is persisted and synced but nothing displays it, so say so rather than relying on a `USER` item for a settings entry every workspace needs visible now. To store something per person, a `USER` item should use an application variable declared with `scope: 'USER'`, which `getApplicationVariable` returns with the viewing member's value unless it is secret; the component saves it with `updateMyUserApplicationVariable`, which writes the viewing member's value only, refuses a token with nobody behind it, and needs `SystemPermissionFlag.CONNECTED_ACCOUNTS` in the app's default role, if it declares one (and in the member's role, since the component's token is the intersection of both), and since a `USER` item replaces the generated Variables form like a `WORKSPACE` item does, it should let the member set every user variable the app needs; a variable without that scope holds one value shared by the whole workspace.
+`scope` is `WORKSPACE` (configured once for the whole workspace, the default) or `USER` (configured by each member for themselves). A `USER` item renders as a tab on the app's page under the member's Settings > App preferences, but that page is not enabled in every workspace yet — where it is not, the item is persisted and synced but nothing displays it, so say so rather than relying on a `USER` item for a settings entry every workspace needs visible now. To store something per person, a `USER` item should use an application variable declared with `scope: 'USER'`, which `getApplicationVariable` returns with the viewing member's value unless it is secret; the component saves it with `updateMyUserApplicationVariable`, which writes the viewing member's value only (an empty value resets it to the variable's default), refuses a token with nobody behind it, and needs `SystemPermissionFlag.CONNECTED_ACCOUNTS` in the app's default role, if it declares one (and in the member's role, since the component's token is the intersection of both), and since a `USER` item replaces the generated Variables form like a `WORKSPACE` item does, it should let the member set every user variable the app needs; a variable without that scope holds one value shared by the whole workspace.
Items sort by ascending `position`, which is a decimal so an item can be slotted between two existing ones. Two items of one app cannot share a position in the same scope, and `General` is reserved for the built-in item.
diff --git a/packages/twenty-docs/developers/extend/apps/config/application.mdx b/packages/twenty-docs/developers/extend/apps/config/application.mdx
index 50fc3387811..355fa502bf0 100644
--- a/packages/twenty-docs/developers/extend/apps/config/application.mdx
+++ b/packages/twenty-docs/developers/extend/apps/config/application.mdx
@@ -160,7 +160,7 @@ A variable's scope is set when it is created and cannot change. To change it, de
User variables can be `isSecret`, `isRequired`, or both. For example, a personal API key can declare `scope: 'USER', isSecret: true, isRequired: true`. Values are encrypted at rest.
-For user variables, `isRequired` describes a per-member requirement. It does not affect the workspace configuration warning. Personal configuration warnings and enforcement are not available yet.
+For user variables, `isRequired` describes a per-member requirement. A member with no value for it, their own or a default, sees your app marked **Missing configuration** in App preferences, with a banner naming the variables. It does not affect the workspace configuration warning, and nothing enforces it at runtime: your code still decides what an unset value means.
A user variable is injected with the value of the member your code runs for, or its default until they set their own:
@@ -185,7 +185,7 @@ const { myUserApplicationVariables } = await client.query({
Values are strings, in the same format as `process.env` (see [Variable types](#variable-types)).
-`updateMyUserApplicationVariable` saves a member's own value. It takes your app's `applicationUniversalIdentifier` and writes the value of the person behind the token: the member's own session, or your app's token when a member is behind it, such as in a front component or a logic function run for a member. Your app's token can only name your own app, and a token with nobody behind it, such as in a cron job or an install hook, is refused.
+`updateMyUserApplicationVariable` saves a member's own value. It takes your app's `applicationUniversalIdentifier` and writes the value of the person behind the token: the member's own session, or your app's token when a member is behind it, such as in a front component or a logic function run for a member. Your app's token can only name your own app, and a token with nobody behind it, such as in a cron job or an install hook, is refused. An empty value removes the member's own value, so they read the default again, or an empty string for a variable without one.
It needs no `APPLICATIONS` permission, but it needs `CONNECTED_ACCOUNTS`: on the member's role, and, when your app's token makes the call, on your app's default role too, if it declares one. If your app saves user variables, add `SystemPermissionFlag.CONNECTED_ACCOUNTS` to `permissionFlagUniversalIdentifiers` in its [role](/developers/extend/apps/config/roles).
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppStatusCell.tsx b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppStatusCell.tsx
index 1f0337a3b6a..11a173002cf 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppStatusCell.tsx
+++ b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppStatusCell.tsx
@@ -2,6 +2,7 @@ import { useMyAccountGroups } from '@/settings/app-preferences/hooks/useMyAccoun
import { type AppPreferencesRow } from '@/settings/app-preferences/types/AppPreferencesRow';
import { getNativeAccountAppsUsingAccount } from '@/settings/app-preferences/utils/getNativeAccountAppsUsingAccount';
import { useLingui } from '@lingui/react/macro';
+import { isNonEmptyArray } from 'twenty-shared/utils';
import { Status } from 'twenty-ui/primitives/data-display';
type SettingsAppPreferencesAppStatusCellProps = {
@@ -14,8 +15,14 @@ export const SettingsAppPreferencesAppStatusCell = ({
const { t } = useLingui();
const { groups, loading } = useMyAccountGroups();
- if (item.type !== 'native') {
- return null;
+ if (item.type === 'installed') {
+ if (
+ !isNonEmptyArray(item.applicationWithPreferences.missingRequiredVariables)
+ ) {
+ return null;
+ }
+
+ return <Status color="red">{t`Missing configuration`}</Status>;
}
const hasAccount = groups.some((group) =>
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppsSection.tsx b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppsSection.tsx
index 12c985baf7c..c2adaee9830 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppsSection.tsx
+++ b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesAppsSection.tsx
@@ -3,16 +3,24 @@ import { SettingsAppPreferencesAppStatusCell } from '@/settings/app-preferences/
import { useApplicationsWithPreferences } from '@/settings/app-preferences/hooks/useApplicationsWithPreferences';
import { useEnabledNativeAccountApps } from '@/settings/app-preferences/hooks/useEnabledNativeAccountApps';
import { type AppPreferencesRow } from '@/settings/app-preferences/types/AppPreferencesRow';
+import { SettingsApplicationLoadErrorBanner } from '@/settings/applications/components/SettingsApplicationLoadErrorBanner';
import { SettingsTableListSection } from '@/settings/components/SettingsTableListSection';
+import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { SettingsPath } from 'twenty-shared/types';
+import { themeCssVariables } from 'twenty-ui/theme';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
+const StyledToolbar = styled.div`
+ padding-bottom: ${themeCssVariables.spacing[2]};
+`;
+
export const SettingsAppPreferencesAppsSection = () => {
const { t } = useLingui();
const navigateSettings = useNavigateSettings();
const { enabledNativeAccountApps } = useEnabledNativeAccountApps();
- const { applicationsWithPreferences } = useApplicationsWithPreferences();
+ const { applicationsWithPreferences, hasApplicationsLoadError, refetch } =
+ useApplicationsWithPreferences();
const rows: AppPreferencesRow[] = [
...enabledNativeAccountApps.map((nativeAccountApp): AppPreferencesRow => ({
@@ -33,6 +41,16 @@ export const SettingsAppPreferencesAppsSection = () => {
<SettingsTableListSection<AppPreferencesRow>
title={t`App preferences`}
description={t`Choose your preferences for the apps installed on your workspace by the admin`}
+ toolbar={
+ hasApplicationsLoadError ? (
+ <StyledToolbar>
+ <SettingsApplicationLoadErrorBanner
+ message={t`Your installed apps could not be loaded. Check your connection and try again.`}
+ onRetry={() => refetch().catch(() => undefined)}
+ />
+ </StyledToolbar>
+ ) : undefined
+ }
items={rows}
columns={[
{ label: t`App`, Cell: SettingsAppPreferencesAppNameCell },
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesSections.tsx b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesSections.tsx
index 4a5b6ea01a0..cd5bb01d3a3 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesSections.tsx
+++ b/packages/twenty-front/src/modules/settings/app-preferences/components/SettingsAppPreferencesSections.tsx
@@ -7,7 +7,8 @@ import { isNonEmptyArray } from 'twenty-shared/utils';
export const SettingsAppPreferencesSections = () => {
const { enabledNativeAccountApps } = useEnabledNativeAccountApps();
- const { applicationsWithPreferences } = useApplicationsWithPreferences();
+ const { applicationsWithPreferences, hasApplicationsLoadError } =
+ useApplicationsWithPreferences();
const hasNativeAccountApps = isNonEmptyArray(enabledNativeAccountApps);
@@ -15,9 +16,8 @@ export const SettingsAppPreferencesSections = () => {
<>
<SettingsAccountGroupsSection />
{(hasNativeAccountApps ||
- isNonEmptyArray(applicationsWithPreferences)) && (
- <SettingsAppPreferencesAppsSection />
- )}
+ isNonEmptyArray(applicationsWithPreferences) ||
+ hasApplicationsLoadError) && <SettingsAppPreferencesAppsSection />}
{!hasNativeAccountApps && <SettingsAccountsBlocklistSection />}
</>
);
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/hooks/useApplicationsWithPreferences.ts b/packages/twenty-front/src/modules/settings/app-preferences/hooks/useApplicationsWithPreferences.ts
index cfcfeb31dfe..0283d774a08 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/hooks/useApplicationsWithPreferences.ts
+++ b/packages/twenty-front/src/modules/settings/app-preferences/hooks/useApplicationsWithPreferences.ts
@@ -2,23 +2,29 @@ import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { getApplicationsWithPreferences } from '@/settings/app-preferences/utils/getApplicationsWithPreferences';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useQuery } from '@apollo/client/react';
+import { isDefined } from 'twenty-shared/utils';
import { MyApplicationPreferencesDocument } from '~/generated-metadata/graphql';
export const useApplicationsWithPreferences = () => {
const currentWorkspace = useAtomStateValue(currentWorkspaceState);
- const { data, loading, refetch } = useQuery(
+ const { data, loading, error, refetch } = useQuery(
MyApplicationPreferencesDocument,
{
fetchPolicy: 'cache-and-network',
},
);
+ const hasLoadedApplicationsWithPreferences = isDefined(data);
+
return {
applicationsWithPreferences: getApplicationsWithPreferences({
applicationPreferences: data?.myApplicationPreferences ?? [],
currentWorkspace,
}),
loading,
+ hasApplicationsLoadError:
+ isDefined(error) && !hasLoadedApplicationsWithPreferences,
+ error,
refetch,
};
};
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/types/ApplicationWithPreferences.ts b/packages/twenty-front/src/modules/settings/app-preferences/types/ApplicationWithPreferences.ts
index 612ab60c31e..657f6975fe8 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/types/ApplicationWithPreferences.ts
+++ b/packages/twenty-front/src/modules/settings/app-preferences/types/ApplicationWithPreferences.ts
@@ -8,4 +8,5 @@ export type ApplicationWithPreferences = {
application: CurrentWorkspace['installedApplications'][number];
settingsMenuItems: MyApplicationPreferences['settingsMenuItems'];
variables: MyApplicationPreferences['variables'];
+ missingRequiredVariables: MyApplicationPreferences['variables'];
};
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/utils/__tests__/getApplicationsWithPreferences.test.ts b/packages/twenty-front/src/modules/settings/app-preferences/utils/__tests__/getApplicationsWithPreferences.test.ts
index dc2dcfe89c4..7a27a6518f4 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/utils/__tests__/getApplicationsWithPreferences.test.ts
+++ b/packages/twenty-front/src/modules/settings/app-preferences/utils/__tests__/getApplicationsWithPreferences.test.ts
@@ -44,18 +44,22 @@ const buildVariable = ({
key,
value = '',
isDeprecated = false,
+ isRequired = false,
+ isSecret = false,
}: {
key: string;
value?: string;
isDeprecated?: boolean;
+ isRequired?: boolean;
+ isSecret?: boolean;
}) => ({
key,
value,
isDeprecated,
label: '',
description: '',
- isSecret: false,
- isRequired: false,
+ isSecret,
+ isRequired,
type: 'TEXT',
options: null,
});
@@ -156,6 +160,67 @@ describe('getApplicationsWithPreferences', () => {
]);
});
+ it('should flag the required variables the member has no value for, own or default', () => {
+ const [result] = getApplicationsWithPreferences({
+ applicationPreferences: [
+ {
+ applicationId: RECORDER_APPLICATION_ID,
+ settingsMenuItems: [],
+ variables: [
+ buildVariable({ key: 'WORKSPACE_ROOM', isRequired: true }),
+ buildVariable({ key: 'API_TOKEN', isRequired: true }),
+ buildVariable({ key: 'NICKNAME' }),
+ buildVariable({
+ key: 'LANGUAGE',
+ value: 'en',
+ isRequired: true,
+ }),
+ buildVariable({
+ key: 'PERSONAL_API_KEY',
+ value: 'sk-1********',
+ isRequired: true,
+ isSecret: true,
+ }),
+ buildVariable({
+ key: 'OLD_TOKEN',
+ isRequired: true,
+ isDeprecated: true,
+ }),
+ ],
+ },
+ ],
+ currentWorkspace: CURRENT_WORKSPACE,
+ });
+
+ expect(result.missingRequiredVariables.map(({ key }) => key)).toEqual([
+ 'API_TOKEN',
+ 'WORKSPACE_ROOM',
+ ]);
+ });
+
+ it('should flag a required secret the member has not saved yet', () => {
+ const [result] = getApplicationsWithPreferences({
+ applicationPreferences: [
+ {
+ applicationId: RECORDER_APPLICATION_ID,
+ settingsMenuItems: [],
+ variables: [
+ buildVariable({
+ key: 'PERSONAL_API_KEY',
+ isRequired: true,
+ isSecret: true,
+ }),
+ ],
+ },
+ ],
+ currentWorkspace: CURRENT_WORKSPACE,
+ });
+
+ expect(result.missingRequiredVariables.map(({ key }) => key)).toEqual([
+ 'PERSONAL_API_KEY',
+ ]);
+ });
+
it('should leave out an application with nothing left to show', () => {
const result = getApplicationsWithPreferences({
applicationPreferences: [
diff --git a/packages/twenty-front/src/modules/settings/app-preferences/utils/getApplicationsWithPreferences.ts b/packages/twenty-front/src/modules/settings/app-preferences/utils/getApplicationsWithPreferences.ts
index 2ffa4a41e2e..9b74b9f0028 100644
--- a/packages/twenty-front/src/modules/settings/app-preferences/utils/getApplicationsWithPreferences.ts
+++ b/packages/twenty-front/src/modules/settings/app-preferences/utils/getApplicationsWithPreferences.ts
@@ -1,6 +1,7 @@
import { getApplicationDisplayName } from '@/applications/utils/getApplicationDisplayName';
import { type CurrentWorkspace } from '@/auth/states/currentWorkspaceState';
import { getDisplayedApplicationVariables } from '@/settings/applications/utils/getDisplayedApplicationVariables';
+import { getMissingRequiredApplicationVariables } from '@/settings/applications/utils/getMissingRequiredApplicationVariables';
import { sortSettingsMenuItemsByPosition } from '@/settings/applications/utils/sortSettingsMenuItemsByPosition';
import { type ApplicationWithPreferences } from '@/settings/app-preferences/types/ApplicationWithPreferences';
import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
@@ -43,6 +44,8 @@ export const getApplicationsWithPreferences = ({
application,
settingsMenuItems: sortSettingsMenuItemsByPosition(settingsMenuItems),
variables: displayedVariables,
+ missingRequiredVariables:
+ getMissingRequiredApplicationVariables(displayedVariables),
},
];
})
diff --git a/packages/twenty-front/src/pages/settings/applications/components/SettingsApplicationLoadErrorBanner.tsx b/packages/twenty-front/src/modules/settings/applications/components/SettingsApplicationLoadErrorBanner.tsx
similarity index 100%
rename from packages/twenty-front/src/pages/settings/applications/components/SettingsApplicationLoadErrorBanner.tsx
rename to packages/twenty-front/src/modules/settings/applications/components/SettingsApplicationLoadErrorBanner.tsx
diff --git a/packages/twenty-front/src/pages/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx b/packages/twenty-front/src/modules/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx
similarity index 88%
rename from packages/twenty-front/src/pages/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx
rename to packages/twenty-front/src/modules/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx
index e4aad26a944..cca6c9ca93a 100644
--- a/packages/twenty-front/src/pages/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx
+++ b/packages/twenty-front/src/modules/settings/applications/components/SettingsApplicationMissingConfigurationBanner.tsx
@@ -2,7 +2,7 @@ import { t } from '@lingui/core/macro';
import { InlineBanner } from 'twenty-ui/components/feedback';
import { IconAlertCircle } from 'twenty-ui/icon';
import { type ApplicationVariable } from '~/generated-metadata/graphql';
-import { getApplicationVariableDisplayLabel } from '~/pages/settings/applications/utils/getApplicationVariableDisplayLabel';
+import { getApplicationVariableDisplayLabel } from '@/settings/applications/utils/getApplicationVariableDisplayLabel';
type SettingsApplicationMissingConfigurationBannerProps = {
missingApplicationVariables: Pick<ApplicationVariable, 'key' | 'label'>[];
diff --git a/packages/twenty-front/src/pages/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx b/packages/twenty-front/src/modules/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx
similarity index 91%
rename from packages/twenty-front/src/pages/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx
rename to packages/twenty-front/src/modules/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx
index 13797eec5f0..6c5a8358593 100644
--- a/packages/twenty-front/src/pages/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx
+++ b/packages/twenty-front/src/modules/settings/applications/components/__tests__/SettingsApplicationMissingConfigurationBanner.test.tsx
@@ -3,7 +3,7 @@ import { I18nProvider } from '@lingui/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
-import { SettingsApplicationMissingConfigurationBanner } from '~/pages/settings/applications/components/SettingsApplicationMissingConfigurationBanner';
+import { SettingsApplicationMissingConfigurationBanner } from '@/settings/applications/components/SettingsApplicationMissingConfigurationBanner';
const renderBanner = ({
missingApplicationVariables = [{ key: 'API_KEY', label: 'API key' }],
diff --git a/packages/twenty-front/src/modules/settings/applications/constants/ApplicationVariablesTabId.ts b/packages/twenty-front/src/modules/settings/applications/constants/ApplicationVariablesTabId.ts
new file mode 100644
index 00000000000..059f6b416c0
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/applications/constants/ApplicationVariablesTabId.ts
@@ -0,0 +1 @@
+export const APPLICATION_VARIABLES_TAB_ID = 'variables';
diff --git a/packages/twenty-front/src/modules/settings/applications/utils/__tests__/getApplicationConfigurationTabId.test.ts b/packages/twenty-front/src/modules/settings/applications/utils/__tests__/getApplicationConfigurationTabId.test.ts
new file mode 100644
index 00000000000..e2148e193f7
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/applications/utils/__tests__/getApplicationConfigurationTabId.test.ts
@@ -0,0 +1,34 @@
+import { APPLICATION_VARIABLES_TAB_ID } from '@/settings/applications/constants/ApplicationVariablesTabId';
+import { getApplicationConfigurationTabId } from '@/settings/applications/utils/getApplicationConfigurationTabId';
+
+describe('getApplicationConfigurationTabId', () => {
+ it('should point to the variables tab when there is one', () => {
+ expect(
+ getApplicationConfigurationTabId({
+ hasVariablesTab: true,
+ settingsMenuItems: [],
+ }),
+ ).toBe(APPLICATION_VARIABLES_TAB_ID);
+ });
+
+ it('should point to the first settings item otherwise', () => {
+ expect(
+ getApplicationConfigurationTabId({
+ hasVariablesTab: false,
+ settingsMenuItems: [
+ { universalIdentifier: 'first-settings' },
+ { universalIdentifier: 'second-settings' },
+ ],
+ }),
+ ).toBe('first-settings');
+ });
+
+ it('should have no configuration tab without variables or settings items', () => {
+ expect(
+ getApplicationConfigurationTabId({
+ hasVariablesTab: false,
+ settingsMenuItems: [],
+ }),
+ ).toBeUndefined();
+ });
+});
diff --git a/packages/twenty-front/src/pages/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts b/packages/twenty-front/src/modules/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts
similarity index 92%
rename from packages/twenty-front/src/pages/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts
rename to packages/twenty-front/src/modules/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts
index a77c9ee53f7..f69011cd9f7 100644
--- a/packages/twenty-front/src/pages/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts
+++ b/packages/twenty-front/src/modules/settings/applications/utils/__tests__/getMissingRequiredApplicationVariables.test.ts
@@ -1,4 +1,4 @@
-import { getMissingRequiredApplicationVariables } from '~/pages/settings/applications/utils/getMissingRequiredApplicationVariables';
+import { getMissingRequiredApplicationVariables } from '@/settings/applications/utils/getMissingRequiredApplicationVariables';
const buildVariable = (
overrides: Partial<{
diff --git a/packages/twenty-front/src/modules/settings/applications/utils/getApplicationConfigurationTabId.ts b/packages/twenty-front/src/modules/settings/applications/utils/getApplicationConfigurationTabId.ts
new file mode 100644
index 00000000000..275b0ecba78
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/applications/utils/getApplicationConfigurationTabId.ts
@@ -0,0 +1,13 @@
+import { APPLICATION_VARIABLES_TAB_ID } from '@/settings/applications/constants/ApplicationVariablesTabId';
+import { type SettingsMenuItem } from '~/generated-metadata/graphql';
+
+export const getApplicationConfigurationTabId = ({
+ hasVariablesTab,
+ settingsMenuItems,
+}: {
+ hasVariablesTab: boolean;
+ settingsMenuItems: Pick<SettingsMenuItem, 'universalIdentifier'>[];
+}): string | undefined =>
+ hasVariablesTab
+ ? APPLICATION_VARIABLES_TAB_ID
+ : settingsMenuItems.at(0)?.universalIdentifier;
diff --git a/packages/twenty-front/src/pages/settings/applications/utils/getApplicationVariableDisplayLabel.ts b/packages/twenty-front/src/modules/settings/applications/utils/getApplicationVariableDisplayLabel.ts
similarity index 100%
rename from packages/twenty-front/src/pages/settings/applications/utils/getApplicationVariableDisplayLabel.ts
rename to packages/twenty-front/src/modules/settings/applications/utils/getApplicationVariableDisplayLabel.ts
diff --git a/packages/twenty-front/src/pages/settings/applications/utils/getMissingRequiredApplicationVariables.ts b/packages/twenty-front/src/modules/settings/applications/utils/getMissingRequiredApplicationVariables.ts
similarity index 100%
rename from packages/twenty-front/src/pages/settings/applications/utils/getMissingRequiredApplicationVariables.ts
rename to packages/twenty-front/src/modules/settings/applications/utils/getMissingRequiredApplicationVariables.ts
diff --git a/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferences.tsx b/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferences.tsx
index a9fc199054a..79f5b42e305 100644
--- a/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferences.tsx
+++ b/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferences.tsx
@@ -1,6 +1,10 @@
import { useApplicationsWithPreferences } from '@/settings/app-preferences/hooks/useApplicationsWithPreferences';
+import { SettingsApplicationLoadErrorBanner } from '@/settings/applications/components/SettingsApplicationLoadErrorBanner';
+import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsSkeletonLoader } from '@/settings/components/SettingsSkeletonLoader';
+import { SettingsPageLayout } from '@/settings/components/layout/SettingsPageLayout';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
+import { useLingui } from '@lingui/react/macro';
import { Navigate, useParams } from 'react-router-dom';
import { SettingsPath } from 'twenty-shared/types';
import { getSettingsPath, isDefined } from 'twenty-shared/utils';
@@ -8,11 +12,12 @@ import { FeatureFlagKey } from '~/generated-metadata/graphql';
import { SettingsApplicationPreferencesDetail } from '~/pages/settings/accounts/SettingsApplicationPreferencesDetail';
export const SettingsApplicationPreferences = () => {
+ const { t } = useLingui();
const isAppPreferencesEnabled = useIsFeatureEnabled(
FeatureFlagKey.IS_APP_PREFERENCES_ENABLED,
);
const { applicationId } = useParams<{ applicationId: string }>();
- const { applicationsWithPreferences, loading, refetch } =
+ const { applicationsWithPreferences, loading, error, refetch } =
useApplicationsWithPreferences();
const applicationWithPreferences = applicationsWithPreferences.find(
@@ -32,5 +37,29 @@ export const SettingsApplicationPreferences = () => {
return <SettingsSkeletonLoader />;
}
+ if (isAppPreferencesEnabled && isDefined(error)) {
+ return (
+ <SettingsPageLayout
+ title={t`App preferences`}
+ links={[
+ {
+ children: t`User`,
+ href: getSettingsPath(SettingsPath.ProfilePage),
+ },
+ {
+ children: t`App preferences`,
+ href: getSettingsPath(SettingsPath.Accounts),
+ },
+ ]}
+ >
+ <SettingsPageContainer>
+ <SettingsApplicationLoadErrorBanner
+ onRetry={() => refetch().catch(() => undefined)}
+ />
+ </SettingsPageContainer>
+ </SettingsPageLayout>
+ );
+ }
+
return <Navigate to={getSettingsPath(SettingsPath.Accounts)} replace />;
};
diff --git a/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferencesDetail.tsx b/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferencesDetail.tsx
index f80c6b927f1..92a2fa32c9b 100644
--- a/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferencesDetail.tsx
+++ b/packages/twenty-front/src/pages/settings/accounts/SettingsApplicationPreferencesDetail.tsx
@@ -4,6 +4,8 @@ import { getApplicationDisplayName } from '@/applications/utils/getApplicationDi
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { SETTINGS_APPLICATION_PREFERENCES_TAB_LIST_COMPONENT_ID } from '@/settings/app-preferences/constants/SettingsApplicationPreferencesTabListComponentId';
import { type ApplicationWithPreferences } from '@/settings/app-preferences/types/ApplicationWithPreferences';
+import { APPLICATION_VARIABLES_TAB_ID } from '@/settings/applications/constants/ApplicationVariablesTabId';
+import { getApplicationConfigurationTabId } from '@/settings/applications/utils/getApplicationConfigurationTabId';
import { hasApplicationVariablesTab } from '@/settings/applications/utils/hasApplicationVariablesTab';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsPageLayout } from '@/settings/components/layout/SettingsPageLayout';
@@ -13,8 +15,13 @@ import type { SingleTabProps } from '@/ui/layout/tab-list/types/SingleTabProps';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useMutation } from '@apollo/client/react';
import { useLingui } from '@lingui/react/macro';
+import { useNavigate } from 'react-router-dom';
import { SettingsPath } from 'twenty-shared/types';
-import { getSettingsPath, isDefined } from 'twenty-shared/utils';
+import {
+ getSettingsPath,
+ isDefined,
+ isNonEmptyArray,
+} from 'twenty-shared/utils';
import { IconDeviceFloppy, IconVariable, useIcons } from 'twenty-ui/icon';
import { Button } from 'twenty-ui/primitives/input';
import {
@@ -24,8 +31,7 @@ import {
import { useApplicationVariablesDraft } from '@/settings/applications/hooks/useApplicationVariablesDraft';
import { SettingsApplicationCustomSettingsSection } from '@/settings/applications/components/SettingsApplicationCustomSettingsSection';
import { SettingsApplicationDetailVariablesTab } from '@/settings/applications/components/SettingsApplicationDetailVariablesTab';
-
-const VARIABLES_TAB_ID = 'variables';
+import { SettingsApplicationMissingConfigurationBanner } from '@/settings/applications/components/SettingsApplicationMissingConfigurationBanner';
type SettingsApplicationPreferencesDetailProps = {
applicationWithPreferences: ApplicationWithPreferences;
@@ -33,12 +39,18 @@ type SettingsApplicationPreferencesDetailProps = {
};
export const SettingsApplicationPreferencesDetail = ({
- applicationWithPreferences: { application, settingsMenuItems, variables },
+ applicationWithPreferences: {
+ application,
+ settingsMenuItems,
+ variables,
+ missingRequiredVariables,
+ },
refetchApplicationsWithPreferences,
}: SettingsApplicationPreferencesDetailProps) => {
const { t } = useLingui();
const { getIcon } = useIcons();
const currentWorkspace = useAtomStateValue(currentWorkspaceState);
+ const navigate = useNavigate();
const [updateMyUserApplicationVariable] = useMutation(
UpdateMyUserApplicationVariableDocument,
@@ -73,7 +85,13 @@ export const SettingsApplicationPreferencesDetail = ({
const tabs: SingleTabProps[] = [
...(hasVariablesTab
- ? [{ id: VARIABLES_TAB_ID, title: t`Variables`, Icon: IconVariable }]
+ ? [
+ {
+ id: APPLICATION_VARIABLES_TAB_ID,
+ title: t`Variables`,
+ Icon: IconVariable,
+ },
+ ]
: []),
...settingsMenuItems.map((settingsMenuItem) => ({
id: settingsMenuItem.universalIdentifier,
@@ -94,6 +112,11 @@ export const SettingsApplicationPreferencesDetail = ({
currentWorkspace,
});
+ const configurationTabId = getApplicationConfigurationTabId({
+ hasVariablesTab,
+ settingsMenuItems,
+ });
+
const activeSettingsMenuItem = settingsMenuItems.find(
(settingsMenuItem) => settingsMenuItem.universalIdentifier === activeTabId,
);
@@ -115,7 +138,7 @@ export const SettingsApplicationPreferencesDetail = ({
{ children: appName },
]}
actionButton={
- activeTabId === VARIABLES_TAB_ID ? (
+ activeTabId === APPLICATION_VARIABLES_TAB_ID ? (
<Button
startIcon={<IconDeviceFloppy />}
variant="solid"
@@ -137,7 +160,23 @@ export const SettingsApplicationPreferencesDetail = ({
}
>
<SettingsPageContainer overflow="visible">
- {activeTabId === VARIABLES_TAB_ID && (
+ {isNonEmptyArray(missingRequiredVariables) &&
+ isDefined(configurationTabId) && (
+ <SettingsApplicationMissingConfigurationBanner
+ missingApplicationVariables={missingRequiredVariables}
+ onConfigure={() =>
+ navigate(
+ getSettingsPath(
+ SettingsPath.ApplicationPreferences,
+ { applicationId: application.id },
+ undefined,
+ configurationTabId,
+ ),
+ )
+ }
+ />
+ )}
+ {activeTabId === APPLICATION_VARIABLES_TAB_ID && (
<SettingsApplicationDetailVariablesTab
applicationVariables={draftApplicationVariables}
onVariableChange={setApplicationVariableValue}
diff --git a/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsAccounts.stories.tsx b/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsAccounts.stories.tsx
index 62d01031f84..2196f1b8a8f 100644
--- a/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsAccounts.stories.tsx
+++ b/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsAccounts.stories.tsx
@@ -28,6 +28,7 @@ import {
} from '~/pages/settings/accounts/__stories__/mockedAccountGroups';
import {
APPLICATION_PREFERENCES_GRAPHQL_HANDLERS,
+ failNextApplicationPreferencesRequest,
seedApplicationPreferencesStory,
} from '~/pages/settings/accounts/__stories__/mockedApplicationPreferences';
@@ -379,6 +380,65 @@ export const AppPreferencesListInstalledApps: Story = {
},
};
+export const AppPreferencesListFlagsMissingConfiguration: Story = {
+ ...accountGroupsStory,
+ beforeEach: seedApplicationPreferencesStory,
+ parameters: {
+ msw: { handlers: APPLICATION_PREFERENCES_GRAPHQL_HANDLERS },
+ },
+ play: async ({ canvasElement }) => {
+ await within(canvasElement).findByText('Fathom', undefined, {
+ timeout: 3000,
+ });
+
+ expect(
+ getTableRow(canvasElement, 'Fathom').getByText('Missing configuration'),
+ ).toBeVisible();
+ expect(
+ getTableRow(canvasElement, 'Granola').queryByText(
+ 'Missing configuration',
+ ),
+ ).not.toBeInTheDocument();
+ },
+};
+
+export const AppPreferencesListLoadErrorOffersRetry: Story = {
+ ...accountGroupsStory,
+ beforeEach: async () => {
+ await seedApplicationPreferencesStory();
+ failNextApplicationPreferencesRequest();
+ },
+ parameters: {
+ msw: { handlers: APPLICATION_PREFERENCES_GRAPHQL_HANDLERS },
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByText(
+ 'Your installed apps could not be loaded. Check your connection and try again.',
+ undefined,
+ { timeout: 3000 },
+ ),
+ ).toBeVisible();
+ expect(
+ canvas.getByRole('link', { name: 'Gmail and Calendar' }),
+ ).toBeVisible();
+ expect(canvas.queryByText('Fathom')).not.toBeInTheDocument();
+
+ await userEvent.click(canvas.getByRole('button', { name: 'Retry' }));
+
+ expect(
+ await canvas.findByText('Fathom', undefined, { timeout: 3000 }),
+ ).toBeVisible();
+ expect(
+ canvas.queryByText(
+ 'Your installed apps could not be loaded. Check your connection and try again.',
+ ),
+ ).not.toBeInTheDocument();
+ },
+};
+
export const InstalledAppsKeepBlocklistWhenNoNativeAppIsEnabled: Story = {
...accountGroupsStory,
beforeEach: async () => {
diff --git a/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsApplicationPreferences.stories.tsx b/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsApplicationPreferences.stories.tsx
index bb81fa2940d..d5c3fbce597 100644
--- a/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsApplicationPreferences.stories.tsx
+++ b/packages/twenty-front/src/pages/settings/accounts/__stories__/SettingsApplicationPreferences.stories.tsx
@@ -17,6 +17,7 @@ import {
import {
APPLICATION_PREFERENCES_GRAPHQL_HANDLERS,
GRANOLA_USER_SETTINGS_FRONT_COMPONENT_ID,
+ failNextApplicationPreferencesRequest,
findApplicationsGatedQuery,
findOneFrontComponent,
seedApplicationPreferencesStory,
@@ -87,6 +88,84 @@ export const VariablesTabSavesOnlyEditedValues: Story = {
},
};
+export const ClearedValueFallsBackToTheDefault: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ const recordMyMeetingsInput = await canvas.findByDisplayValue(
+ 'always',
+ undefined,
+ { timeout: 3000 },
+ );
+ const saveButton = canvas.getByRole('button', { name: 'Save settings' });
+
+ await userEvent.clear(recordMyMeetingsInput);
+
+ await waitFor(() => expect(saveButton).toBeEnabled());
+ await userEvent.click(saveButton);
+
+ await waitFor(() =>
+ expect(updateMyUserApplicationVariable.mock.calls).toEqual([
+ [
+ {
+ applicationUniversalIdentifier: FATHOM_APPLICATION_ID,
+ key: 'RECORD_MY_MEETINGS',
+ value: '',
+ },
+ ],
+ ]),
+ );
+ await waitFor(() => expect(recordMyMeetingsInput).toHaveValue('always'), {
+ timeout: 3000,
+ });
+ expect(saveButton).toBeDisabled();
+ },
+};
+
+export const MissingRequiredValueShowsBannerUntilSaved: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByText(
+ 'Missing configuration: Meeting language',
+ undefined,
+ { timeout: 3000 },
+ ),
+ ).toBeVisible();
+
+ const meetingLanguageRow = canvas
+ .getByText('Meeting language')
+ .closest<HTMLElement>('div:has(input)');
+
+ if (!isDefined(meetingLanguageRow)) {
+ throw new Error('Missing the Meeting language row');
+ }
+
+ await userEvent.type(within(meetingLanguageRow).getByRole('textbox'), 'fr');
+
+ const saveButton = canvas.getByRole('button', { name: 'Save settings' });
+
+ await waitFor(() => expect(saveButton).toBeEnabled());
+ await userEvent.click(saveButton);
+
+ await waitFor(() =>
+ expect(
+ canvas.queryByText('Missing configuration: Meeting language'),
+ ).not.toBeInTheDocument(),
+ );
+ expect(updateMyUserApplicationVariable.mock.calls).toEqual([
+ [
+ {
+ applicationUniversalIdentifier: FATHOM_APPLICATION_ID,
+ key: 'MEETING_LANGUAGE',
+ value: 'fr',
+ },
+ ],
+ ]);
+ },
+};
+
export const SavedSecretIsReplacedNotAppended: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
@@ -214,6 +293,37 @@ export const UnknownAppGoesBackToAccounts: Story = {
},
};
+export const LoadErrorOffersRetryInsteadOfGoingBack: Story = {
+ beforeEach: async () => {
+ await seedApplicationPreferencesStory();
+ failNextApplicationPreferencesRequest();
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByText(
+ 'This application could not be loaded. Check your connection and try again.',
+ undefined,
+ { timeout: 3000 },
+ ),
+ ).toBeVisible();
+ expect(canvas.queryByText(/Navigated to/)).not.toBeInTheDocument();
+
+ await userEvent.click(canvas.getByRole('button', { name: 'Retry' }));
+
+ expect(
+ await canvas.findByRole('link', { name: 'Variables' }, { timeout: 3000 }),
+ ).toBeVisible();
+ expect(
+ canvas.queryByText(
+ 'This application could not be loaded. Check your connection and try again.',
+ ),
+ ).not.toBeInTheDocument();
+ expect(canvas.queryByText(/Navigated to/)).not.toBeInTheDocument();
+ },
+};
+
export const FlagOffGoesBackToAccounts: Story = {
beforeEach: async () => {
await seedApplicationPreferencesStory();
diff --git a/packages/twenty-front/src/pages/settings/accounts/__stories__/mockedApplicationPreferences.ts b/packages/twenty-front/src/pages/settings/accounts/__stories__/mockedApplicationPreferences.ts
index f0b9a73ae5c..29190fbb090 100644
--- a/packages/twenty-front/src/pages/settings/accounts/__stories__/mockedApplicationPreferences.ts
+++ b/packages/twenty-front/src/pages/settings/accounts/__stories__/mockedApplicationPreferences.ts
@@ -1,4 +1,6 @@
+import { isNonEmptyString } from '@sniptt/guards';
import { HttpResponse, graphql } from 'msw';
+import { getWorker } from 'msw-storybook-addon';
import { fn } from 'storybook/test';
import {
@@ -20,12 +22,14 @@ const buildUserApplicationVariable = ({
value = '',
isSecret = false,
isDeprecated = false,
+ isRequired = false,
}: {
key: string;
label: string;
value?: string;
isSecret?: boolean;
isDeprecated?: boolean;
+ isRequired?: boolean;
}) => ({
__typename: 'UserApplicationVariableValue',
key,
@@ -34,7 +38,7 @@ const buildUserApplicationVariable = ({
description: '',
isSecret,
isDeprecated,
- isRequired: false,
+ isRequired,
type: 'TEXT',
options: null,
});
@@ -94,6 +98,12 @@ const buildApplicationPreferences = () => [
label: 'Old flag',
isDeprecated: true,
}),
+ buildUserApplicationVariable({
+ key: 'MEETING_LANGUAGE',
+ label: 'Meeting language',
+ value: savedValueByKey.get('MEETING_LANGUAGE'),
+ isRequired: true,
+ }),
],
},
{
@@ -131,15 +141,38 @@ const buildApplicationPreferences = () => [
},
];
+export const failNextApplicationPreferencesRequest = () => {
+ getWorker().use(
+ graphql.query(
+ 'MyApplicationPreferences',
+ () =>
+ HttpResponse.json({
+ errors: [
+ {
+ message: 'Internal server error',
+ extensions: { code: 'INTERNAL_SERVER_ERROR' },
+ },
+ ],
+ }),
+ { once: true },
+ ),
+ );
+};
+
export const APPLICATION_PREFERENCES_GRAPHQL_HANDLERS = [
- graphql.query('MyApplicationPreferences', () =>
- HttpResponse.json({
+ graphql.query('MyApplicationPreferences', () => {
+ return HttpResponse.json({
data: { myApplicationPreferences: buildApplicationPreferences() },
- }),
- ),
+ });
+ }),
graphql.mutation('UpdateMyUserApplicationVariable', ({ variables }) => {
updateMyUserApplicationVariable(variables);
- savedValueByKey.set(variables.key, variables.value);
+
+ if (!isNonEmptyString(variables.value)) {
+ savedValueByKey.delete(variables.key);
+ } else {
+ savedValueByKey.set(variables.key, variables.value);
+ }
return HttpResponse.json({
data: { updateMyUserApplicationVariable: true },
diff --git a/packages/twenty-front/src/pages/settings/applications/SettingsApplicationDetails.tsx b/packages/twenty-front/src/pages/settings/applications/SettingsApplicationDetails.tsx
index c63fda2f719..e47785533fb 100644
--- a/packages/twenty-front/src/pages/settings/applications/SettingsApplicationDetails.tsx
+++ b/packages/twenty-front/src/pages/settings/applications/SettingsApplicationDetails.tsx
@@ -9,6 +9,8 @@ import { useUpgradeApplication } from '@/marketplace/hooks/useUpgradeApplication
import { useUninstallApplication } from '@/settings/applications/hooks/useUninstallApplication';
import { getDisplayedApplicationVariables } from '@/settings/applications/utils/getDisplayedApplicationVariables';
import { getSettingsMenuItemsForScope } from '@/settings/applications/utils/getSettingsMenuItemsForScope';
+import { APPLICATION_VARIABLES_TAB_ID } from '@/settings/applications/constants/ApplicationVariablesTabId';
+import { getApplicationConfigurationTabId } from '@/settings/applications/utils/getApplicationConfigurationTabId';
import { hasApplicationVariablesTab } from '@/settings/applications/utils/hasApplicationVariablesTab';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsSectionSkeletonLoader } from '@/settings/components/SettingsSectionSkeletonLoader';
@@ -48,8 +50,8 @@ import {
} from '~/generated-metadata/graphql';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
import { SettingsApplicationHealthBanner } from '~/pages/settings/applications/components/SettingsApplicationHealthBanner';
-import { SettingsApplicationMissingConfigurationBanner } from '~/pages/settings/applications/components/SettingsApplicationMissingConfigurationBanner';
-import { SettingsApplicationLoadErrorBanner } from '~/pages/settings/applications/components/SettingsApplicationLoadErrorBanner';
+import { SettingsApplicationMissingConfigurationBanner } from '@/settings/applications/components/SettingsApplicationMissingConfigurationBanner';
+import { SettingsApplicationLoadErrorBanner } from '@/settings/applications/components/SettingsApplicationLoadErrorBanner';
import { SettingsApplicationNotFound } from '~/pages/settings/applications/components/SettingsApplicationNotFound';
import { CUSTOM_APPLICATION_ILLUSTRATIONS } from '~/pages/settings/applications/constants/CustomApplicationIllustrations';
import { STANDARD_APPLICATION_ILLUSTRATIONS } from '~/pages/settings/applications/constants/StandardApplicationIllustrations';
@@ -63,13 +65,12 @@ import { getApplicationHealthBanner } from '~/pages/settings/applications/utils/
import { getApplicationLookupStatus } from '~/pages/settings/applications/utils/getApplicationLookupStatus';
import { hasApplicationUpdate } from '~/pages/settings/applications/utils/hasApplicationUpdate';
import { isUuidFormat } from '~/pages/settings/applications/utils/isUuidFormat';
-import { getMissingRequiredApplicationVariables } from '~/pages/settings/applications/utils/getMissingRequiredApplicationVariables';
+import { getMissingRequiredApplicationVariables } from '@/settings/applications/utils/getMissingRequiredApplicationVariables';
import { getSettingsMenuItemDisplayTitle } from '~/pages/settings/applications/utils/getSettingsMenuItemDisplayTitle';
const APPLICATION_DETAIL_ID = 'application-detail-id';
const GENERAL_TAB_ID = 'general';
-const VARIABLES_TAB_ID = 'variables';
export const SettingsApplicationDetails = () => {
const { applicationId = '' } = useParams<{ applicationId: string }>();
@@ -237,7 +238,13 @@ export const SettingsApplicationDetails = () => {
const tabs: SingleTabProps[] = [
{ id: GENERAL_TAB_ID, title: t`General`, Icon: IconSettings },
...(hasVariablesTab
- ? [{ id: VARIABLES_TAB_ID, title: t`Variables`, Icon: IconVariable }]
+ ? [
+ {
+ id: APPLICATION_VARIABLES_TAB_ID,
+ title: t`Variables`,
+ Icon: IconVariable,
+ },
+ ]
: []),
...workspaceSettingsMenuItems.map((settingsMenuItem) => ({
id: settingsMenuItem.universalIdentifier,
@@ -255,9 +262,10 @@ export const SettingsApplicationDetails = () => {
tabs.map((tab) => tab.id),
);
- const configurationTabId = hasVariablesTab
- ? VARIABLES_TAB_ID
- : workspaceSettingsMenuItems.at(0)?.universalIdentifier;
+ const configurationTabId = getApplicationConfigurationTabId({
+ hasVariablesTab,
+ settingsMenuItems: workspaceSettingsMenuItems,
+ });
const configurationTabLocation = isDefined(configurationTabId)
? getSettingsPath(
@@ -336,7 +344,7 @@ export const SettingsApplicationDetails = () => {
uninstallProgress={uninstallProgress}
/>
);
- case VARIABLES_TAB_ID:
+ case APPLICATION_VARIABLES_TAB_ID:
return (
<SettingsApplicationDetailVariablesTab
applicationVariables={draftApplicationVariables}
@@ -392,7 +400,7 @@ export const SettingsApplicationDetails = () => {
{ children: displayName },
]}
actionButton={
- activeTabId === VARIABLES_TAB_ID ? (
+ activeTabId === APPLICATION_VARIABLES_TAB_ID ? (
<Button
startIcon={<IconDeviceFloppy />}
variant="solid"
diff --git a/packages/twenty-front/src/pages/settings/applications/SettingsAvailableApplicationDetails.tsx b/packages/twenty-front/src/pages/settings/applications/SettingsAvailableApplicationDetails.tsx
index 324165941c8..8b9f8c0a672 100644
--- a/packages/twenty-front/src/pages/settings/applications/SettingsAvailableApplicationDetails.tsx
+++ b/packages/twenty-front/src/pages/settings/applications/SettingsAvailableApplicationDetails.tsx
@@ -25,7 +25,7 @@ import {
} from '~/generated-metadata/graphql';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
import { SettingsApplicationDetailAbout } from '~/pages/settings/applications/components/SettingsApplicationDetailAbout';
-import { SettingsApplicationLoadErrorBanner } from '~/pages/settings/applications/components/SettingsApplicationLoadErrorBanner';
+import { SettingsApplicationLoadErrorBanner } from '@/settings/applications/components/SettingsApplicationLoadErrorBanner';
import { SettingsApplicationNotFound } from '~/pages/settings/applications/components/SettingsApplicationNotFound';
import { getApplicationLookupStatus } from '~/pages/settings/applications/utils/getApplicationLookupStatus';
import { isUuidFormat } from '~/pages/settings/applications/utils/isUuidFormat';
diff --git a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsAvailableTab.tsx b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsAvailableTab.tsx
index bbcab646698..f4ec6901158 100644
--- a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsAvailableTab.tsx
+++ b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsAvailableTab.tsx
@@ -15,7 +15,7 @@ import { Dropdown } from 'twenty-ui/components/navigation';
import { SettingsRow } from 'twenty-ui/components/settings';
import { IconSparkles } from 'twenty-ui/icon';
import { themeCssVariables } from 'twenty-ui/theme';
-import { SettingsApplicationLoadErrorBanner } from '~/pages/settings/applications/components/SettingsApplicationLoadErrorBanner';
+import { SettingsApplicationLoadErrorBanner } from '@/settings/applications/components/SettingsApplicationLoadErrorBanner';
import { SettingsAvailableApplicationCard } from '~/pages/settings/applications/components/SettingsAvailableApplicationCard';
import { filterMarketplaceApps } from '~/pages/settings/applications/utils/filterMarketplaceApps';
import { SettingsSearchFilterTrigger } from '@/settings/components/SettingsSearchFilterTrigger';
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts
index 6dd12be95cd..67e00ce8ad4 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts
@@ -1,5 +1,6 @@
import { Injectable } from '@nestjs/common';
+import { isNonEmptyString } from '@sniptt/guards';
import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import {
@@ -219,17 +220,24 @@ export class UserApplicationVariableValueService {
key,
});
- await this.userApplicationVariableValueRepository.upsert(
- workspaceId,
- {
+ if (!isNonEmptyString(plainTextValue)) {
+ await this.userApplicationVariableValueRepository.delete(workspaceId, {
applicationVariableId: flatApplicationVariable.id,
userWorkspaceId,
- value: this.secretEncryptionService.encryptVersioned(plainTextValue, {
- workspaceId,
- }),
- },
- ['applicationVariableId', 'userWorkspaceId'],
- );
+ });
+ } else {
+ await this.userApplicationVariableValueRepository.upsert(
+ workspaceId,
+ {
+ applicationVariableId: flatApplicationVariable.id,
+ userWorkspaceId,
+ value: this.secretEncryptionService.encryptVersioned(plainTextValue, {
+ workspaceId,
+ }),
+ },
+ ['applicationVariableId', 'userWorkspaceId'],
+ );
+ }
await this.workspaceCacheService.invalidateAndRecompute(workspaceId, [
'userApplicationVariableValueMaps',
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/__tests__/to-user-application-variable-values.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/__tests__/to-user-application-variable-values.util.spec.ts
index 482d0a7d5fe..a0131556559 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/__tests__/to-user-application-variable-values.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/__tests__/to-user-application-variable-values.util.spec.ts
@@ -103,4 +103,34 @@ describe('toUserApplicationVariableValues', () => {
['PERSONAL_API_KEY', 'masked enc:key'],
]);
});
+
+ it('should fall back to the default when the stored value is empty', () => {
+ const values = toUserApplicationVariableValues({
+ flatUserApplicationVariables: FLAT_USER_APPLICATION_VARIABLES,
+ userApplicationVariableValueMaps: {
+ byApplicationVariableId: {
+ 'record-my-meetings-id': {
+ [USER_WORKSPACE_ID]: 'enc:empty' as EncryptedString,
+ },
+ 'nickname-id': {
+ [USER_WORKSPACE_ID]: 'enc:empty' as EncryptedString,
+ },
+ 'personal-api-key-id': {
+ [USER_WORKSPACE_ID]: 'enc:empty' as EncryptedString,
+ },
+ },
+ },
+ userWorkspaceId: USER_WORKSPACE_ID,
+ shouldMaskSecret: true,
+ getDisplayValue: ({ value, isSecret }) =>
+ value === 'enc:empty' ? '' : getDisplayValue({ value, isSecret }),
+ });
+
+ expect(values.map(({ key, value }) => [key, value])).toEqual([
+ ['RECORD_MY_MEETINGS', 'off'],
+ ['LANGUAGE', 'en'],
+ ['NICKNAME', ''],
+ ['PERSONAL_API_KEY', ''],
+ ]);
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/to-user-application-variable-values.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/to-user-application-variable-values.util.ts
index 20711faf5cf..f95d6a87d86 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/to-user-application-variable-values.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/utils/to-user-application-variable-values.util.ts
@@ -1,3 +1,4 @@
+import { isNonEmptyString } from '@sniptt/guards';
import { isDefined } from 'twenty-shared/utils';
import { type UserApplicationVariableValueDTO } from 'src/engine/core-modules/application/application-variable/dtos/user-application-variable-value.dto';
@@ -40,6 +41,13 @@ export const toUserApplicationVariableValues = ({
flatApplicationVariable.id
]?.[userWorkspaceId];
+ const displayedUserValue = isDefined(userValue)
+ ? getDisplayValue({
+ value: userValue,
+ isSecret: flatApplicationVariable.isSecret && shouldMaskSecret,
+ })
+ : undefined;
+
return {
key: flatApplicationVariable.key,
label: flatApplicationVariable.label,
@@ -50,11 +58,8 @@ export const toUserApplicationVariableValues = ({
isRequired: flatApplicationVariable.isRequired,
isDeprecated: flatApplicationVariable.isDeprecated,
// Secrets have no default, so the fallback never needs masking.
- value: isDefined(userValue)
- ? getDisplayValue({
- value: userValue,
- isSecret: flatApplicationVariable.isSecret && shouldMaskSecret,
- })
+ value: isNonEmptyString(displayedUserValue)
+ ? displayedUserValue
: (flatApplicationVariable.defaultValue ?? ''),
};
});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-secrets.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-secrets.integration-spec.ts
index fb834d3fefa..a81b3e1e19a 100644
--- a/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-secrets.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-secrets.integration-spec.ts
@@ -1,4 +1,5 @@
import { myUserApplicationVariables } from 'test/integration/metadata/suites/application/utils/my-user-application-variables.util';
+import { findStoredUserApplicationVariableValues } from 'test/integration/metadata/suites/application/utils/find-stored-user-application-variable-values.util';
import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';
import {
type ApplicationWithVariable,
@@ -75,14 +76,10 @@ describe('Secret user application variable values should succeed', () => {
expectToFail: false,
});
- const storedValues: { value: string }[] = await global.testDataSource.query(
- `SELECT "userValue"."value"
- FROM "core"."userApplicationVariableValue" "userValue"
- JOIN "core"."applicationVariable" "variable"
- ON "variable"."id" = "userValue"."applicationVariableId"
- WHERE "variable"."applicationId" = $1`,
- [application.id],
- );
+ const storedValues = await findStoredUserApplicationVariableValues({
+ applicationId: application.id,
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JONY,
+ });
expect(storedValues).toHaveLength(1);
expect(storedValues[0].value).toMatch(/^enc:v2:/);
@@ -173,5 +170,12 @@ describe('Secret user application variable values should succeed', () => {
expect(jonyValues?.variables).toEqual([
{ key: application.variableKey, value: '' },
]);
+
+ const storedJonyValues = await findStoredUserApplicationVariableValues({
+ applicationId: application.id,
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JONY,
+ });
+
+ expect(storedJonyValues).toHaveLength(0);
});
});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-values.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-values.integration-spec.ts
index a17af80ecff..2372f329c04 100644
--- a/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-values.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/application/successful-user-application-variable-values.integration-spec.ts
@@ -1,4 +1,6 @@
+import { myApplicationPreferences } from 'test/integration/metadata/suites/application/utils/my-application-preferences.util';
import { myUserApplicationVariables } from 'test/integration/metadata/suites/application/utils/my-user-application-variables.util';
+import { findStoredUserApplicationVariableValues } from 'test/integration/metadata/suites/application/utils/find-stored-user-application-variable-values.util';
import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';
import {
type ApplicationWithVariable,
@@ -365,4 +367,115 @@ describe('User application variable values should succeed', () => {
{ key: application.variableKey, value: 'jony-from-app' },
]);
});
+
+ it('should give a member the default again once they clear their value', async () => {
+ const { data: updateData } = await updateMyUserApplicationVariable({
+ input: {
+ applicationUniversalIdentifier: defaultApplication.universalIdentifier,
+ key: defaultApplication.variableKey,
+ value: '',
+ },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(updateData.updateMyUserApplicationVariable).toBe(true);
+
+ const { data } = await myUserApplicationVariables({
+ input: {},
+ token: defaultApplicationToken,
+ expectToFail: false,
+ });
+
+ expect(data.myUserApplicationVariables).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JONY,
+ variables: [{ key: defaultApplication.variableKey, value: 'true' }],
+ }),
+ ]),
+ );
+
+ const { data: preferencesData } = await myApplicationPreferences({
+ input: {},
+ gqlFields: `
+ applicationId
+ variables {
+ key
+ value
+ }
+ `,
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(
+ preferencesData.myApplicationPreferences.find(
+ ({ applicationId }) => applicationId === defaultApplication.id,
+ )?.variables,
+ ).toEqual([{ key: defaultApplication.variableKey, value: 'true' }]);
+ });
+
+ it('should leave an empty value once a member clears a value without default', async () => {
+ await updateMyUserApplicationVariable({
+ input: {
+ applicationUniversalIdentifier: application.universalIdentifier,
+ key: application.variableKey,
+ value: '',
+ },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ const { data } = await myUserApplicationVariables({
+ input: {},
+ token: applicationToken,
+ expectToFail: false,
+ });
+
+ const jonyValues = data.myUserApplicationVariables.find(
+ ({ userWorkspaceId }) =>
+ userWorkspaceId === USER_WORKSPACE_DATA_SEED_IDS.JONY,
+ );
+
+ expect(jonyValues?.variables).toEqual([
+ { key: application.variableKey, value: '' },
+ ]);
+ });
+
+ it('should accept clearing a value a member never set', async () => {
+ const { data: updateData } = await updateMyUserApplicationVariable({
+ input: {
+ applicationUniversalIdentifier: defaultApplication.universalIdentifier,
+ key: defaultApplication.variableKey,
+ value: '',
+ },
+ token: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(updateData.updateMyUserApplicationVariable).toBe(true);
+
+ const { data } = await myUserApplicationVariables({
+ input: {},
+ token: defaultApplicationToken,
+ expectToFail: false,
+ });
+
+ expect(data.myUserApplicationVariables).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JANE,
+ variables: [{ key: defaultApplication.variableKey, value: 'true' }],
+ }),
+ ]),
+ );
+
+ const storedJaneValues = await findStoredUserApplicationVariableValues({
+ applicationId: defaultApplication.id,
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JANE,
+ });
+
+ expect(storedJaneValues).toHaveLength(0);
+ });
});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/find-stored-user-application-variable-values.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/find-stored-user-application-variable-values.util.ts
new file mode 100644
index 00000000000..7b974793fcd
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/find-stored-user-application-variable-values.util.ts
@@ -0,0 +1,16 @@
+export const findStoredUserApplicationVariableValues = async ({
+ applicationId,
+ userWorkspaceId,
+}: {
+ applicationId: string;
+ userWorkspaceId: string;
+}): Promise<{ value: string }[]> =>
+ global.testDataSource.query(
+ `SELECT "userValue"."value"
+ FROM "core"."userApplicationVariableValue" "userValue"
+ JOIN "core"."applicationVariable" "variable"
+ ON "variable"."id" = "userValue"."applicationVariableId"
+ WHERE "variable"."applicationId" = $1
+ AND "userValue"."userWorkspaceId" = $2`,
+ [applicationId, userWorkspaceId],
+ );