Skip to content

The open alternative to Salesforce, designed for AI.

Align log console access and retention with plans (#27696)

martmullf2d7c03f86c7
diff --git a/packages/twenty-front/src/modules/log-console/components/LogConsoleResults.tsx b/packages/twenty-front/src/modules/log-console/components/LogConsoleResults.tsx
index 13601c0b086..e167d5ab0a5 100644
--- a/packages/twenty-front/src/modules/log-console/components/LogConsoleResults.tsx
+++ b/packages/twenty-front/src/modules/log-console/components/LogConsoleResults.tsx
@@ -24,7 +24,7 @@ import { type LogConsoleSource } from '@/log-console/types/LogConsoleSource';
import { type LogConsoleTimeRange } from '@/log-console/types/LogConsoleTimeRange';
import { getLogConsoleFieldFilters } from '@/log-console/utils/getLogConsoleFieldFilters';
import { getLogConsoleTimeRangeBounds } from '@/log-console/utils/getLogConsoleTimeRangeBounds';
-import { isLogConsoleTimeRangeWithinRetention } from '@/log-console/utils/isLogConsoleTimeRangeWithinRetention';
+import { getLogConsoleTimeRangeWithinRetention } from '@/log-console/utils/getLogConsoleTimeRangeWithinRetention';
import { SettingsEmptyPlaceholder } from '@/settings/components/SettingsEmptyPlaceholder';
import { useEventLogsLiveStream } from '@/settings/event-logs/hooks/useEventLogsLiveStream';
import { useEventLogs } from '@/settings/event-logs/hooks/useQueryEventLogs';
@@ -52,7 +52,7 @@ type LogConsoleResultsProps = {
export const LogConsoleResults = ({ source }: LogConsoleResultsProps) => {
const { t } = useLingui();
const timeZone = useLogConsoleTimeZone();
- const { retentionInDays } = useLogConsoleRetention(source);
+ const { retentionInHours } = useLogConsoleRetention();
const [logConsoleSelectedLog, setLogConsoleSelectedLog] = useAtomState(
logConsoleSelectedLogState,
@@ -71,12 +71,10 @@ export const LogConsoleResults = ({ source }: LogConsoleResultsProps) => {
const [clearedLiveRecordCount, setClearedLiveRecordCount] =
useState<number>();
- const timeRange = isLogConsoleTimeRangeWithinRetention({
+ const timeRange = getLogConsoleTimeRangeWithinRetention({
timeRange: logConsoleTimeRange,
- retentionInDays,
- })
- ? logConsoleTimeRange
- : '24h';
+ retentionInHours,
+ });
const fieldFilters = getLogConsoleFieldFilters({
source,
@@ -223,7 +221,6 @@ export const LogConsoleResults = ({ source }: LogConsoleResultsProps) => {
</IconButton>
)}
<LogConsoleTimeRangeDropdown
- source={source}
timeRange={timeRange}
onTimeRangeChange={changeTimeRange}
/>
diff --git a/packages/twenty-front/src/modules/log-console/components/LogConsoleTimeRangeDropdown.tsx b/packages/twenty-front/src/modules/log-console/components/LogConsoleTimeRangeDropdown.tsx
index 882e37200a5..94b6908e84a 100644
--- a/packages/twenty-front/src/modules/log-console/components/LogConsoleTimeRangeDropdown.tsx
+++ b/packages/twenty-front/src/modules/log-console/components/LogConsoleTimeRangeDropdown.tsx
@@ -1,4 +1,3 @@
-import { plural } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
import { useState } from 'react';
import { SettingsPath } from 'twenty-shared/types';
@@ -16,7 +15,6 @@ import { useDateTimeFormat } from '@/localization/hooks/useDateTimeFormat';
import { LOG_CONSOLE_TIME_RANGE_PRESETS } from '@/log-console/constants/LogConsoleTimeRangePresets';
import { useLogConsoleRetention } from '@/log-console/hooks/useLogConsoleRetention';
import { logConsoleTimeZoneState } from '@/log-console/states/logConsoleTimeZoneState';
-import { type LogConsoleSource } from '@/log-console/types/LogConsoleSource';
import { type LogConsoleTimeRange } from '@/log-console/types/LogConsoleTimeRange';
import { isLogConsoleTimeRangeWithinRetention } from '@/log-console/utils/isLogConsoleTimeRangeWithinRetention';
import { Dropdown } from '@/ui/layout/dropdown/components/Dropdown';
@@ -33,20 +31,22 @@ import { useNavigateSettings } from '~/hooks/useNavigateSettings';
const LOG_CONSOLE_TIME_RANGE_DROPDOWN_ID = 'log-console-time-range';
type LogConsoleTimeRangeDropdownProps = {
- source: LogConsoleSource;
timeRange: LogConsoleTimeRange;
onTimeRangeChange: (timeRange: LogConsoleTimeRange) => void;
};
export const LogConsoleTimeRangeDropdown = ({
- source,
timeRange,
onTimeRangeChange,
}: LogConsoleTimeRangeDropdownProps) => {
const { t } = useLingui();
const { timeZone: memberTimeZone } = useDateTimeFormat();
- const { retentionInDays, retentionDescription } =
- useLogConsoleRetention(source);
+ const {
+ retentionInHours,
+ retentionLabel,
+ retentionDescription,
+ isRetentionConfigurable,
+ } = useLogConsoleRetention();
const [logConsoleTimeZone, setLogConsoleTimeZone] = useAtomState(
logConsoleTimeZoneState,
);
@@ -87,7 +87,7 @@ export const LogConsoleTimeRangeDropdown = ({
const renderTimeRangeItem = (itemTimeRange: LogConsoleTimeRange) => {
const isWithinRetention = isLogConsoleTimeRangeWithinRetention({
timeRange: itemTimeRange,
- retentionInDays,
+ retentionInHours,
});
return (
@@ -167,12 +167,9 @@ export const LogConsoleTimeRangeDropdown = ({
<DropdownMenuSeparator />
<DropdownMenuItemsContainer scrollable={false}>
<ListItemButton
- description={plural(retentionInDays, {
- one: '# day',
- other: '# days',
- })}
+ description={retentionLabel}
descriptionPlacement="end"
- disabled={!source.requiresAuditLogs}
+ disabled={!isRetentionConfigurable}
onClick={openRetentionSettings}
>
{t`Retention`}
diff --git a/packages/twenty-front/src/modules/log-console/components/__stories__/LogConsole.stories.tsx b/packages/twenty-front/src/modules/log-console/components/__stories__/LogConsole.stories.tsx
index f1620c40d7c..ae918857505 100644
--- a/packages/twenty-front/src/modules/log-console/components/__stories__/LogConsole.stories.tsx
+++ b/packages/twenty-front/src/modules/log-console/components/__stories__/LogConsole.stories.tsx
@@ -558,15 +558,18 @@ export const UsageOpen: Story = {
export const TimeRangeMenu: Story = {
beforeEach: () => {
+ jotaiStore.set(currentWorkspaceState.atom, {
+ ...WORKSPACE_WITH_LOGS_CONSOLE,
+ eventLogRetentionDays: 30,
+ });
jotaiStore.set(logConsoleDisplayModeState.atom, 'open');
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
await userEvent.click(
- await canvas.findByRole('tab', { name: 'App logs' }, { timeout: 5000 }),
+ await canvas.findByText('Last 24 hours', {}, { timeout: 5000 }),
);
- await userEvent.click(await canvas.findByText('Last 24 hours'));
expect(
await screen.findByRole('option', { name: 'Last 90 days' }),
diff --git a/packages/twenty-front/src/modules/log-console/components/__tests__/LogConsole.test.tsx b/packages/twenty-front/src/modules/log-console/components/__tests__/LogConsole.test.tsx
index 10f719b5e52..95c5f53e43e 100644
--- a/packages/twenty-front/src/modules/log-console/components/__tests__/LogConsole.test.tsx
+++ b/packages/twenty-front/src/modules/log-console/components/__tests__/LogConsole.test.tsx
@@ -240,6 +240,22 @@ describe('LogConsole', () => {
expect(await screen.findByText('Log results')).toBeInTheDocument();
});
+ it('stays open when developer mode is turned off', async () => {
+ renderWithLogsFeatureFlag(true);
+
+ await userEvent.click(
+ await screen.findByRole('button', { name: 'Developer mode' }),
+ );
+
+ expect(await screen.findByText('Log results')).toBeInTheDocument();
+
+ await userEvent.click(
+ screen.getByRole('button', { name: 'Developer mode' }),
+ );
+
+ expect(screen.getByText('Log results')).toBeInTheDocument();
+ });
+
it('stays hidden when the logs feature flag is off', async () => {
renderWithLogsFeatureFlag(false);
diff --git a/packages/twenty-front/src/modules/log-console/constants/LogConsoleApplicationLogRetentionInDays.ts b/packages/twenty-front/src/modules/log-console/constants/LogConsoleApplicationLogRetentionInDays.ts
deleted file mode 100644
index b8d0a5c327b..00000000000
--- a/packages/twenty-front/src/modules/log-console/constants/LogConsoleApplicationLogRetentionInDays.ts
+++ /dev/null
@@ -1 +0,0 @@
-export const LOG_CONSOLE_APPLICATION_LOG_RETENTION_IN_DAYS = 30;
diff --git a/packages/twenty-front/src/modules/log-console/hooks/useIsLogConsoleAllowed.ts b/packages/twenty-front/src/modules/log-console/hooks/useIsLogConsoleAllowed.ts
index ab4cfbd1aae..4c09320d969 100644
--- a/packages/twenty-front/src/modules/log-console/hooks/useIsLogConsoleAllowed.ts
+++ b/packages/twenty-front/src/modules/log-console/hooks/useIsLogConsoleAllowed.ts
@@ -1,6 +1,4 @@
import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
-import { isAdvancedModeEnabledState } from '@/ui/navigation/navigation-drawer/states/isAdvancedModeEnabledState';
-import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { useIsMobile } from 'twenty-ui/utilities';
import {
@@ -12,16 +10,10 @@ export const useIsLogConsoleAllowed = () => {
const isLogsSettingsSectionEnabled = useIsFeatureEnabled(
FeatureFlagKey.IS_LOGS_SETTINGS_SECTION_ENABLED,
);
- const isAdvancedModeEnabled = useAtomStateValue(isAdvancedModeEnabledState);
const hasSecurityPermission = useHasPermissionFlag(
PermissionFlagType.SECURITY,
);
const isMobile = useIsMobile();
- return (
- isLogsSettingsSectionEnabled &&
- isAdvancedModeEnabled &&
- hasSecurityPermission &&
- !isMobile
- );
+ return isLogsSettingsSectionEnabled && hasSecurityPermission && !isMobile;
};
diff --git a/packages/twenty-front/src/modules/log-console/hooks/useLogConsoleRetention.ts b/packages/twenty-front/src/modules/log-console/hooks/useLogConsoleRetention.ts
index 9fe77e9df72..9db0a50c06b 100644
--- a/packages/twenty-front/src/modules/log-console/hooks/useLogConsoleRetention.ts
+++ b/packages/twenty-front/src/modules/log-console/hooks/useLogConsoleRetention.ts
@@ -1,25 +1,40 @@
+import { plural } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
+import { EVENT_LOG_RETENTION } from 'twenty-shared/constants';
+import { getEventLogRetentionInHours } from 'twenty-shared/utils';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
-import { LOG_CONSOLE_APPLICATION_LOG_RETENTION_IN_DAYS } from '@/log-console/constants/LogConsoleApplicationLogRetentionInDays';
-import { type LogConsoleSource } from '@/log-console/types/LogConsoleSource';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
-import { EventLogTable } from '~/generated-metadata/graphql';
+import { checkIfBillingEntitlementIsEnabledOnWorkspace } from '@/workspace/utils/checkIfBillingEntitlementIsEnabledOnWorkspace';
+import { BillingEntitlementKey } from '~/generated-metadata/graphql';
-export const useLogConsoleRetention = (source: LogConsoleSource) => {
+export const useLogConsoleRetention = () => {
const { t } = useLingui();
const currentWorkspace = useAtomStateValue(currentWorkspaceState);
- const isApplicationLog = source.table === EventLogTable.APPLICATION_LOG;
+ const hasAuditLogsEntitlement = checkIfBillingEntitlementIsEnabledOnWorkspace(
+ BillingEntitlementKey.AUDIT_LOGS,
+ currentWorkspace,
+ );
- const retentionInDays = isApplicationLog
- ? LOG_CONSOLE_APPLICATION_LOG_RETENTION_IN_DAYS
- : (currentWorkspace?.eventLogRetentionDays ?? 90);
+ const retentionInHours = getEventLogRetentionInHours({
+ workspaceRetentionInDays:
+ currentWorkspace?.eventLogRetentionDays ??
+ EVENT_LOG_RETENTION.defaultInDays,
+ hasAuditLogsEntitlement,
+ });
+
+ const retentionInDays = retentionInHours / 24;
+
+ const retentionLabel =
+ retentionInHours < 24
+ ? plural(retentionInHours, { one: '# hour', other: '# hours' })
+ : plural(retentionInDays, { one: '# day', other: '# days' });
return {
- retentionInDays,
- retentionDescription: isApplicationLog
- ? t`App logs are kept ${retentionInDays} days.`
- : t`Audit logs are kept ${retentionInDays} days.`,
+ retentionInHours,
+ retentionLabel,
+ isRetentionConfigurable: hasAuditLogsEntitlement,
+ retentionDescription: t`Logs are kept ${retentionLabel}.`,
};
};
diff --git a/packages/twenty-front/src/modules/log-console/states/logConsoleDisplayModeState.ts b/packages/twenty-front/src/modules/log-console/states/logConsoleDisplayModeState.ts
index c5ed766ebab..5d57a851c71 100644
--- a/packages/twenty-front/src/modules/log-console/states/logConsoleDisplayModeState.ts
+++ b/packages/twenty-front/src/modules/log-console/states/logConsoleDisplayModeState.ts
@@ -4,7 +4,7 @@ export const logConsoleDisplayModeState = createAtomState<
'collapsed' | 'open' | 'closed'
>({
key: 'logConsoleDisplayModeState',
- defaultValue: 'open',
+ defaultValue: 'closed',
useLocalStorage: true,
localStorageOptions: { getOnInit: true },
});
diff --git a/packages/twenty-front/src/modules/log-console/utils/__tests__/getLogConsoleTimeRangeWithinRetention.test.ts b/packages/twenty-front/src/modules/log-console/utils/__tests__/getLogConsoleTimeRangeWithinRetention.test.ts
new file mode 100644
index 00000000000..57732d3a28a
--- /dev/null
+++ b/packages/twenty-front/src/modules/log-console/utils/__tests__/getLogConsoleTimeRangeWithinRetention.test.ts
@@ -0,0 +1,28 @@
+import { getLogConsoleTimeRangeWithinRetention } from '@/log-console/utils/getLogConsoleTimeRangeWithinRetention';
+
+describe('getLogConsoleTimeRangeWithinRetention', () => {
+ it('should keep a time range within retention', () => {
+ expect(
+ getLogConsoleTimeRangeWithinRetention({
+ timeRange: '24h',
+ retentionInHours: 72,
+ }),
+ ).toBe('24h');
+ });
+
+ it('should fall back to the longest preset within retention', () => {
+ expect(
+ getLogConsoleTimeRangeWithinRetention({
+ timeRange: '24h',
+ retentionInHours: 2,
+ }),
+ ).toBe('1h');
+
+ expect(
+ getLogConsoleTimeRangeWithinRetention({
+ timeRange: '7d',
+ retentionInHours: 72,
+ }),
+ ).toBe('24h');
+ });
+});
diff --git a/packages/twenty-front/src/modules/log-console/utils/getLogConsoleTimeRangeWithinRetention.ts b/packages/twenty-front/src/modules/log-console/utils/getLogConsoleTimeRangeWithinRetention.ts
new file mode 100644
index 00000000000..d102c0ae49a
--- /dev/null
+++ b/packages/twenty-front/src/modules/log-console/utils/getLogConsoleTimeRangeWithinRetention.ts
@@ -0,0 +1,30 @@
+import { typedObjectEntries } from 'twenty-shared/utils';
+
+import { LOG_CONSOLE_TIME_RANGE_PRESETS } from '@/log-console/constants/LogConsoleTimeRangePresets';
+import { type LogConsoleTimeRange } from '@/log-console/types/LogConsoleTimeRange';
+import { isLogConsoleTimeRangeWithinRetention } from '@/log-console/utils/isLogConsoleTimeRangeWithinRetention';
+
+export const getLogConsoleTimeRangeWithinRetention = ({
+ timeRange,
+ retentionInHours,
+}: {
+ timeRange: LogConsoleTimeRange;
+ retentionInHours: number;
+}): LogConsoleTimeRange => {
+ if (isLogConsoleTimeRangeWithinRetention({ timeRange, retentionInHours })) {
+ return timeRange;
+ }
+
+ const presetsWithinRetention = typedObjectEntries(
+ LOG_CONSOLE_TIME_RANGE_PRESETS,
+ )
+ .map(([preset]) => preset)
+ .filter((preset) =>
+ isLogConsoleTimeRangeWithinRetention({
+ timeRange: preset,
+ retentionInHours,
+ }),
+ );
+
+ return presetsWithinRetention.at(-1) ?? '15m';
+};
diff --git a/packages/twenty-front/src/modules/log-console/utils/isLogConsoleTimeRangeWithinRetention.ts b/packages/twenty-front/src/modules/log-console/utils/isLogConsoleTimeRangeWithinRetention.ts
index ef0c1fcc64b..589bcd6bf00 100644
--- a/packages/twenty-front/src/modules/log-console/utils/isLogConsoleTimeRangeWithinRetention.ts
+++ b/packages/twenty-front/src/modules/log-console/utils/isLogConsoleTimeRangeWithinRetention.ts
@@ -5,23 +5,23 @@ import { type LogConsoleTimeRange } from '@/log-console/types/LogConsoleTimeRang
export const isLogConsoleTimeRangeWithinRetention = ({
timeRange,
- retentionInDays,
+ retentionInHours,
}: {
timeRange: LogConsoleTimeRange;
- retentionInDays: number;
+ retentionInHours: number;
}) => {
if (timeRange === 'today') {
- return retentionInDays >= 1;
+ return retentionInHours >= 24;
}
if (timeRange === 'yesterday') {
- return retentionInDays >= 2;
+ return retentionInHours >= 48;
}
return (
Temporal.Duration.compare(
LOG_CONSOLE_TIME_RANGE_PRESETS[timeRange].duration,
- { days: retentionInDays },
+ { hours: retentionInHours },
) <= 0
);
};
diff --git a/packages/twenty-front/src/modules/settings/billing/constants/SettingsBillingPlanComparisonRows.ts b/packages/twenty-front/src/modules/settings/billing/constants/SettingsBillingPlanComparisonRows.ts
index 2ec5f25b8ec..efed9a54225 100644
--- a/packages/twenty-front/src/modules/settings/billing/constants/SettingsBillingPlanComparisonRows.ts
+++ b/packages/twenty-front/src/modules/settings/billing/constants/SettingsBillingPlanComparisonRows.ts
@@ -194,6 +194,14 @@ export const SETTINGS_BILLING_PLAN_COMPARISON_ROWS = [
},
type: 'feature',
},
+ {
+ featureLabel: msg`Record change logs`,
+ plans: {
+ [BillingPlanKey.ENTERPRISE]: { kind: 'included' },
+ [BillingPlanKey.PRO]: { kind: 'included' },
+ },
+ type: 'feature',
+ },
{
featureLabel: msg`Audit logs`,
plans: {
@@ -202,6 +210,17 @@ export const SETTINGS_BILLING_PLAN_COMPARISON_ROWS = [
},
type: 'feature',
},
+ {
+ featureLabel: msg`Log retention`,
+ plans: {
+ [BillingPlanKey.ENTERPRISE]: {
+ kind: 'text',
+ text: msg`Custom, up to 3 years`,
+ },
+ [BillingPlanKey.PRO]: { kind: 'text', text: msg`2 hours` },
+ },
+ type: 'feature',
+ },
{
featureLabel: msg`Environments`,
plans: {
@@ -320,6 +339,14 @@ export const SETTINGS_BILLING_PLAN_COMPARISON_ROWS = [
},
type: 'feature',
},
+ {
+ featureLabel: msg`App logs`,
+ plans: {
+ [BillingPlanKey.ENTERPRISE]: { kind: 'included' },
+ [BillingPlanKey.PRO]: { kind: 'included' },
+ },
+ type: 'feature',
+ },
{
featureLabel: msg`Install shared tarball app`,
plans: {
diff --git a/packages/twenty-front/src/modules/settings/event-logs/components/SettingsLogs.tsx b/packages/twenty-front/src/modules/settings/event-logs/components/SettingsLogs.tsx
index 8176dc7b8a1..d44cd0cb798 100644
--- a/packages/twenty-front/src/modules/settings/event-logs/components/SettingsLogs.tsx
+++ b/packages/twenty-front/src/modules/settings/event-logs/components/SettingsLogs.tsx
@@ -111,9 +111,12 @@ export const SettingsLogs = () => {
const [filters, setFilters] = useState<EventLogFiltersState>({});
const [isPaused, setIsPaused] = useState(false);
- const isApplicationLog = selectedTable === EventLogTable.APPLICATION_LOG;
+ const isAvailableOnEveryPlan =
+ selectedTable === EventLogTable.APPLICATION_LOG ||
+ selectedTable === EventLogTable.OBJECT_EVENT;
const canQuery =
- isClickHouseConfigured && (isApplicationLog || hasAuditLogsEntitlement);
+ isClickHouseConfigured &&
+ (isAvailableOnEveryPlan || hasAuditLogsEntitlement);
const { records, totalCount, hasNextPage, loading, error, loadMore } =
useEventLogs(
@@ -168,7 +171,7 @@ export const SettingsLogs = () => {
<SettingsOptionCardContentButton
Icon={IconLock}
title={t`Upgrade to access audit logs`}
- description={t`Only application logs are available on your current plan. Other log types require an Organization subscription.`}
+ description={t`Record changes and app logs are available on your current plan. Other log types require an Organization subscription.`}
Button={
<Button
size="sm"
@@ -189,7 +192,7 @@ export const SettingsLogs = () => {
);
const renderResults = () => {
- if (!isApplicationLog && !hasAuditLogsEntitlement) {
+ if (!isAvailableOnEveryPlan && !hasAuditLogsEntitlement) {
return renderUpgradeCard();
}
diff --git a/packages/twenty-front/src/modules/settings/event-logs/components/SettingsOpenLogConsoleCard.tsx b/packages/twenty-front/src/modules/settings/event-logs/components/SettingsOpenLogConsoleCard.tsx
new file mode 100644
index 00000000000..5c1289e6d39
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/event-logs/components/SettingsOpenLogConsoleCard.tsx
@@ -0,0 +1,42 @@
+import { useLingui } from '@lingui/react/macro';
+
+import { isLogConsoleFullScreenState } from '@/log-console/states/isLogConsoleFullScreenState';
+import { logConsoleDisplayModeState } from '@/log-console/states/logConsoleDisplayModeState';
+import { SettingsOptionCardContentButton } from '@/settings/components/SettingsOptions/SettingsOptionCardContentButton';
+import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
+import { IconHistory, IconTerminal } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
+import { Card } from 'twenty-ui/primitives/surfaces';
+
+export const SettingsOpenLogConsoleCard = () => {
+ const { t } = useLingui();
+ const setLogConsoleDisplayMode = useSetAtomState(logConsoleDisplayModeState);
+ const setIsLogConsoleFullScreen = useSetAtomState(
+ isLogConsoleFullScreenState,
+ );
+
+ const openLogConsole = () => {
+ setIsLogConsoleFullScreen(false);
+ setLogConsoleDisplayMode('open');
+ };
+
+ return (
+ <Card.Root rounded>
+ <SettingsOptionCardContentButton
+ Icon={IconHistory}
+ title={t`Log console`}
+ description={t`Browse record changes, security events, app logs and more`}
+ Button={
+ <Button
+ size="sm"
+ startIcon={<IconTerminal />}
+ onClick={openLogConsole}
+ variant="outline"
+ >
+ {t`Open log console`}
+ </Button>
+ }
+ />
+ </Card.Root>
+ );
+};
diff --git a/packages/twenty-front/src/modules/settings/event-logs/components/__stories__/SettingsOpenLogConsoleCard.stories.tsx b/packages/twenty-front/src/modules/settings/event-logs/components/__stories__/SettingsOpenLogConsoleCard.stories.tsx
new file mode 100644
index 00000000000..734852d2d82
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/event-logs/components/__stories__/SettingsOpenLogConsoleCard.stories.tsx
@@ -0,0 +1,34 @@
+import { isLogConsoleFullScreenState } from '@/log-console/states/isLogConsoleFullScreenState';
+import { logConsoleDisplayModeState } from '@/log-console/states/logConsoleDisplayModeState';
+import { SettingsOpenLogConsoleCard } from '@/settings/event-logs/components/SettingsOpenLogConsoleCard';
+import { jotaiStore } from '@/ui/utilities/state/jotai/jotaiStore';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { expect, userEvent, waitFor, within } from 'storybook/test';
+import { ComponentDecorator } from 'twenty-ui/testing';
+
+const meta: Meta<typeof SettingsOpenLogConsoleCard> = {
+ title: 'Modules/Settings/EventLogs/OpenLogConsoleCard',
+ component: SettingsOpenLogConsoleCard,
+ decorators: [ComponentDecorator],
+ beforeEach: () => {
+ jotaiStore.set(logConsoleDisplayModeState.atom, 'closed');
+ jotaiStore.set(isLogConsoleFullScreenState.atom, true);
+ },
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const OpensLogConsole: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ await userEvent.click(
+ await canvas.findByRole('button', { name: 'Open log console' }),
+ );
+
+ await waitFor(() => {
+ expect(jotaiStore.get(logConsoleDisplayModeState.atom)).toBe('open');
+ expect(jotaiStore.get(isLogConsoleFullScreenState.atom)).toBe(false);
+ });
+ },
+};
diff --git a/packages/twenty-front/src/modules/settings/security/components/SettingsSecuritySettings.tsx b/packages/twenty-front/src/modules/settings/security/components/SettingsSecuritySettings.tsx
index 614917352bd..2c34699c7c1 100644
--- a/packages/twenty-front/src/modules/settings/security/components/SettingsSecuritySettings.tsx
+++ b/packages/twenty-front/src/modules/settings/security/components/SettingsSecuritySettings.tsx
@@ -26,6 +26,7 @@ import { IconClockHour8, IconHistory, IconTrash } from 'twenty-ui/icon';
import { Card } from 'twenty-ui/primitives/surfaces';
import { themeCssVariables } from 'twenty-ui/theme';
import { useDebouncedCallback } from 'use-debounce';
+import { EVENT_LOG_RETENTION } from 'twenty-shared/constants';
import {
BillingEntitlementKey,
UpdateWorkspaceDocument,
@@ -33,6 +34,7 @@ import {
import { OrganizationAdornment } from '@/settings/enterprise/components/OrganizationAdornment';
import { getToastOptionsFromError } from '@/error-handler/utils/getToastOptionsFromError';
+import { checkIfBillingEntitlementIsEnabledOnWorkspace } from '@/workspace/utils/checkIfBillingEntitlementIsEnabledOnWorkspace';
const StyledContainer = styled.div`
width: 100%;
@@ -142,9 +144,14 @@ export const SettingsSecuritySettings = () => {
!hasDirectAuthEnabled &&
hasBypassProviderAvailable;
- const hasEnterpriseAccess =
- currentWorkspace?.hasValidEnterpriseValidityToken === true;
- const isEventLogsEnabled = hasEnterpriseAccess && isClickHouseConfigured;
+ const hasAuditLogsEntitlement = checkIfBillingEntitlementIsEnabledOnWorkspace(
+ BillingEntitlementKey.AUDIT_LOGS,
+ currentWorkspace,
+ );
+ const isEventLogsEnabled = hasAuditLogsEntitlement && isClickHouseConfigured;
+ const minEventLogRetentionInDays = EVENT_LOG_RETENTION.minInDays;
+ const maxEventLogRetentionInDays = EVENT_LOG_RETENTION.maxInDays;
+ const proPlanEventLogRetentionInHours = EVENT_LOG_RETENTION.proPlanInHours;
const hasSsoEntitlement =
currentWorkspace?.billingEntitlements?.some(
(entitlement) =>
@@ -220,17 +227,20 @@ export const SettingsSecuritySettings = () => {
description={t`Configure how long audit logs are retained`}
actions={<OrganizationAdornment />}
/>
- {hasEnterpriseAccess ? (
+ {hasAuditLogsEntitlement ? (
<Card.Root rounded>
{isEventLogsEnabled ? (
<SettingsOptionCardContentCounter
Icon={IconClockHour8}
title={t`Log retention`}
- description={t`Number of days to retain audit logs (30-1095 days)`}
- value={currentWorkspace?.eventLogRetentionDays ?? 90}
+ description={t`Number of days to retain logs (${minEventLogRetentionInDays}-${maxEventLogRetentionInDays} days)`}
+ value={
+ currentWorkspace?.eventLogRetentionDays ??
+ EVENT_LOG_RETENTION.defaultInDays
+ }
onChange={handleEventLogRetentionDaysChange}
- minValue={30}
- maxValue={1095}
+ minValue={minEventLogRetentionInDays}
+ maxValue={maxEventLogRetentionInDays}
showButtons={false}
/>
) : (
@@ -244,7 +254,7 @@ export const SettingsSecuritySettings = () => {
) : (
<SettingsEnterpriseFeatureGateCard
title={t`Organization feature`}
- description={t`Upgrade to Organization to access audit logs.`}
+ description={t`Logs are kept ${proPlanEventLogRetentionInHours} hours on your plan. Upgrade to customize retention.`}
buttonTitle={t`Activate`}
/>
)}
diff --git a/packages/twenty-front/src/pages/settings/general/SettingsGeneral.tsx b/packages/twenty-front/src/pages/settings/general/SettingsGeneral.tsx
index 65a20b71995..0210e210d67 100644
--- a/packages/twenty-front/src/pages/settings/general/SettingsGeneral.tsx
+++ b/packages/twenty-front/src/pages/settings/general/SettingsGeneral.tsx
@@ -1,12 +1,14 @@
import { useLingui } from '@lingui/react/macro';
import { isMultiWorkspaceEnabledState } from '@/client-config/states/isMultiWorkspaceEnabledState';
+import { useIsLogConsoleAllowed } from '@/log-console/hooks/useIsLogConsoleAllowed';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsPageLayout } from '@/settings/components/layout/SettingsPageLayout';
import { SettingsTabBar } from '@/settings/components/layout/SettingsTabBar';
import { useSettingsActiveTabId } from '@/settings/components/layout/useSettingsActiveTabId';
import { SettingsWorkspaceDomainCard } from '@/settings/domains/components/SettingsWorkspaceDomainCard';
import { SettingsLogs } from '@/settings/event-logs/components/SettingsLogs';
+import { SettingsOpenLogConsoleCard } from '@/settings/event-logs/components/SettingsOpenLogConsoleCard';
import { DeleteWorkspace } from '@/settings/profile/components/DeleteWorkspace';
import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
import { SettingsSecuritySettings } from '@/settings/security/components/SettingsSecuritySettings';
@@ -34,6 +36,8 @@ export const SettingsGeneral = () => {
PermissionFlagType.SECURITY,
);
+ const isLogConsoleAllowed = useIsLogConsoleAllowed();
+
const tabs = [
{
id: GENERAL_TAB_GENERAL,
@@ -58,6 +62,14 @@ export const SettingsGeneral = () => {
return <SettingsSecuritySettings />;
}
+ if (activeTabId === GENERAL_TAB_LOGS) {
+ return (
+ <Section.Root>
+ <SettingsOpenLogConsoleCard />
+ </Section.Root>
+ );
+ }
+
return (
<>
<Section.Root>
@@ -101,7 +113,7 @@ export const SettingsGeneral = () => {
}
links={[{ children: t`Workspace` }, { children: t`General` }]}
>
- {activeTabId === GENERAL_TAB_LOGS ? (
+ {activeTabId === GENERAL_TAB_LOGS && !isLogConsoleAllowed ? (
<SettingsLogs />
) : (
<SettingsPageContainer>
diff --git a/packages/twenty-server/src/database/clickhouse/migrations/013-align-application-log-ttl.sql b/packages/twenty-server/src/database/clickhouse/migrations/013-align-application-log-ttl.sql
new file mode 100644
index 00000000000..f1ceb10a5d4
--- /dev/null
+++ b/packages/twenty-server/src/database/clickhouse/migrations/013-align-application-log-ttl.sql
@@ -0,0 +1 @@
+ALTER TABLE applicationLog MODIFY TTL timestamp + INTERVAL 3 YEAR DELETE;
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-47/2-47-instance-command-fast-1791790299002-set-workspace-event-log-retention-default.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-47/2-47-instance-command-fast-1791790299002-set-workspace-event-log-retention-default.ts
new file mode 100644
index 00000000000..c37bd3e540a
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-47/2-47-instance-command-fast-1791790299002-set-workspace-event-log-retention-default.ts
@@ -0,0 +1,19 @@
+import { type QueryRunner } from 'typeorm';
+
+import { RegisteredInstanceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-instance-command.decorator';
+import { type FastInstanceCommand } from 'src/engine/core-modules/upgrade/interfaces/fast-instance-command.interface';
+
+@RegisteredInstanceCommand('2.47.0', 1791790299002)
+export class SetWorkspaceEventLogRetentionDefaultFastInstanceCommand implements FastInstanceCommand {
+ public async up(queryRunner: QueryRunner): Promise<void> {
+ await queryRunner.query(
+ `ALTER TABLE "core"."workspace" ALTER COLUMN "eventLogRetentionDays" SET DEFAULT '3'`,
+ );
+ }
+
+ public async down(queryRunner: QueryRunner): Promise<void> {
+ await queryRunner.query(
+ `ALTER TABLE "core"."workspace" ALTER COLUMN "eventLogRetentionDays" SET DEFAULT '90'`,
+ );
+ }
+}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
index 3ee3021a4a8..398b3fab6de 100644
--- a/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
@@ -239,6 +239,7 @@ import { RestoreAgentEvaluationInputsFastInstanceCommand } from 'src/database/co
import { AddPurchaseToBillingCreditGrantTypeFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-46/2-46-instance-command-fast-1791470452911-add-purchase-to-billing-credit-grant-type';
import { RestoreUsageLimitMeterCompatibilityFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-46/2-46-instance-command-fast-1791538680877-restore-usage-limit-meter-compatibility';
import { DropUsageLimitMeterFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-47/2-47-instance-command-fast-1791720497488-drop-usage-limit-meter';
+import { SetWorkspaceEventLogRetentionDefaultFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-47/2-47-instance-command-fast-1791790299002-set-workspace-event-log-retention-default';
export const INSTANCE_COMMANDS = [
AddViewFieldGroupIdIndexOnViewFieldFastInstanceCommand,
@@ -480,4 +481,5 @@ export const INSTANCE_COMMANDS = [
AddPurchaseToBillingCreditGrantTypeFastInstanceCommand,
RestoreUsageLimitMeterCompatibilityFastInstanceCommand,
DropUsageLimitMeterFastInstanceCommand,
+ SetWorkspaceEventLogRetentionDefaultFastInstanceCommand,
];
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/__tests__/entity-events-to-db.listener.spec.ts b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/__tests__/entity-events-to-db.listener.spec.ts
index 364b8aab9fd..d9424676b11 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/__tests__/entity-events-to-db.listener.spec.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/__tests__/entity-events-to-db.listener.spec.ts
@@ -2,7 +2,7 @@ import { type ObjectRecordUpsertEvent } from 'twenty-shared/database-events';
import { STANDARD_OBJECTS } from 'twenty-shared/metadata';
import { EntityEventsToDbListener } from 'src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener';
-import { type BillingSubscriptionService } from 'src/engine/core-modules/billing/services/billing-subscription.service';
+import { type WorkspaceEventSinkService } from 'src/engine/core-modules/event-logs/ingest/workspace-event-sink.service';
import { type MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
import { CallAgentDatabaseEventTriggersJob } from 'src/engine/metadata-modules/ai/ai-agent-trigger/jobs/call-agent-database-event-triggers.job';
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
@@ -56,7 +56,7 @@ const buildListener = (triggerEventName: string) => {
{
getOrRecompute: jest.fn().mockResolvedValue({ flatAgentMaps }),
} as unknown as WorkspaceCacheService,
- {} as BillingSubscriptionService,
+ { isEnabled: () => true } as unknown as WorkspaceEventSinkService,
);
return { listener, triggerQueueService, otherQueueService };
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
index 680f37b5e04..9368b679da1 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
@@ -14,9 +14,8 @@ import { STANDARD_OBJECTS } from 'twenty-shared/metadata';
import { OnDatabaseBatchEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-database-batch-event.decorator';
import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
-import { BillingEntitlementKey } from 'src/engine/core-modules/billing/enums/billing-entitlement-key.enum';
-import { BillingSubscriptionService } from 'src/engine/core-modules/billing/services/billing-subscription.service';
import { CreateEventLogFromInternalEvent } from 'src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event';
+import { WorkspaceEventSinkService } from 'src/engine/core-modules/event-logs/ingest/workspace-event-sink.service';
import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
@@ -47,7 +46,7 @@ export class EntityEventsToDbListener {
private readonly objectRecordEventPublisher: ObjectRecordEventPublisher,
private readonly timelineActivityRoutingPlanService: TimelineActivityRoutingPlanService,
private readonly workspaceCacheService: WorkspaceCacheService,
- private readonly billingSubscriptionService: BillingSubscriptionService,
+ private readonly workspaceEventSinkService: WorkspaceEventSinkService,
) {}
@OnDatabaseBatchEvent('*', DatabaseEventAction.CREATED)
@@ -141,31 +140,17 @@ export class EntityEventsToDbListener {
);
}
- if (isAuditLogBatchEvent) {
- promises.push(this.enqueueEventLogIfEntitled(batchEvent));
- }
-
- await Promise.all(promises);
- }
-
- private async enqueueEventLogIfEntitled<T extends ObjectRecordEvent>(
- batchEvent: WorkspaceEventBatch<T>,
- ) {
- const hasAuditLogsEntitlement =
- await this.billingSubscriptionService.getWorkspaceEntitlementValue(
- batchEvent.workspaceId,
- BillingEntitlementKey.AUDIT_LOGS,
+ if (isAuditLogBatchEvent && this.workspaceEventSinkService.isEnabled()) {
+ promises.push(
+ this.eventLogQueueService.add<WorkspaceEventBatch<T>>(
+ CreateEventLogFromInternalEvent.name,
+ batchEvent,
+ { retryLimit: 1 },
+ ),
);
-
- if (!hasAuditLogsEntitlement) {
- return;
}
- await this.eventLogQueueService.add<WorkspaceEventBatch<T>>(
- CreateEventLogFromInternalEvent.name,
- batchEvent,
- { retryLimit: 1 },
- );
+ await Promise.all(promises);
}
private async enqueueWebhookJobsIfAnyWebhookMatches<
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.module.ts b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.module.ts
index bb6b033f9db..b2ae8cdfe06 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.module.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.module.ts
@@ -1,7 +1,7 @@
import { Module } from '@nestjs/common';
import { TelemetryListener } from 'src/engine/api/graphql/workspace-query-runner/listeners/telemetry.listener';
-import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
+import { EventLogIngestionModule } from 'src/engine/core-modules/event-logs/ingest/event-log-ingestion.module';
import { TelemetryModule } from 'src/engine/core-modules/telemetry/telemetry.module';
import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
import { TimelineActivityModule } from 'src/modules/timeline/timeline-activity.module';
@@ -13,7 +13,7 @@ import { EntityEventsToDbListener } from './listeners/entity-events-to-db.listen
TelemetryModule,
TimelineActivityModule,
WorkspaceCacheModule,
- BillingModule,
+ EventLogIngestionModule,
],
providers: [EntityEventsToDbListener, TelemetryListener],
})
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-cron-pattern.constant.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-cron-pattern.constant.ts
index a17a539fa35..993c15bc5b1 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-cron-pattern.constant.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-cron-pattern.constant.ts
@@ -1,2 +1 @@
-// Run daily at 3 AM UTC
-export const EVENT_LOG_CLEANUP_CRON_PATTERN = '0 3 * * *';
+export const EVENT_LOG_CLEANUP_CRON_PATTERN = '0 * * * *';
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-workspace-batch-size.constant.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-workspace-batch-size.constant.ts
new file mode 100644
index 00000000000..0b373fd8d48
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-workspace-batch-size.constant.ts
@@ -0,0 +1 @@
+export const EVENT_LOG_CLEANUP_WORKSPACE_BATCH_SIZE = 1000;
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/crons/event-log-cleanup.cron.job.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/crons/event-log-cleanup.cron.job.ts
index dec20887d93..de8f3127927 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/crons/event-log-cleanup.cron.job.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/crons/event-log-cleanup.cron.job.ts
@@ -9,15 +9,12 @@ import { Repository } from 'typeorm';
import { SentryCronMonitor } from 'src/engine/core-modules/cron/sentry-cron-monitor.decorator';
import { EVENT_LOG_CLEANUP_CRON_PATTERN } from 'src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-cron-pattern.constant';
import {
- EventLogCleanupJob,
- type EventLogCleanupJobData,
-} from 'src/engine/core-modules/event-logs/cleanup/jobs/event-log-cleanup.job';
-import { ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';
-import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
+ EventLogCleanupService,
+ type EventLogCleanupWorkspace,
+} from 'src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service';
import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator';
import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
-import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
@Injectable()
@@ -28,9 +25,7 @@ export class EventLogCleanupCronJob {
constructor(
@InjectRepository(WorkspaceEntity)
private readonly workspaceRepository: Repository<WorkspaceEntity>,
- @InjectMessageQueue(MessageQueue.workspaceQueue)
- private readonly messageQueueService: MessageQueueService,
- private readonly exceptionHandlerService: ExceptionHandlerService,
+ private readonly eventLogCleanupService: EventLogCleanupService,
) {}
@Process(EventLogCleanupCronJob.name)
@@ -47,36 +42,10 @@ export class EventLogCleanupCronJob {
return;
}
- this.logger.log(
- `Enqueuing event log cleanup jobs for ${workspaces.length} workspace(s)`,
- );
-
- for (const workspace of workspaces) {
- try {
- await this.messageQueueService.add<EventLogCleanupJobData>(
- EventLogCleanupJob.name,
- {
- workspaceId: workspace.id,
- eventLogRetentionDays: workspace.eventLogRetentionDays,
- },
- );
- } catch (error) {
- this.exceptionHandlerService.captureExceptions([error], {
- workspace: {
- id: workspace.id,
- },
- });
- }
- }
-
- this.logger.log(
- `Successfully enqueued ${workspaces.length} event log cleanup job(s)`,
- );
+ await this.eventLogCleanupService.cleanupEventLogs(workspaces);
}
- private async getActiveWorkspaces(): Promise<
- Array<{ id: string; eventLogRetentionDays: number }>
- > {
+ private async getActiveWorkspaces(): Promise<EventLogCleanupWorkspace[]> {
const workspaces = await this.workspaceRepository.find({
where: {
activationStatus: WorkspaceActivationStatus.ACTIVE,
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/event-log-cleanup.module.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/event-log-cleanup.module.ts
index 62773d20dd4..fc22b2882b4 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/event-log-cleanup.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/event-log-cleanup.module.ts
@@ -7,14 +7,17 @@ import { ClickHouseModule } from 'src/database/clickhouse/clickhouse.module';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { EventLogCleanupCronCommand } from 'src/engine/core-modules/event-logs/cleanup/commands/event-log-cleanup.cron.command';
import { EventLogCleanupCronJob } from 'src/engine/core-modules/event-logs/cleanup/crons/event-log-cleanup.cron.job';
-import { EventLogCleanupJob } from 'src/engine/core-modules/event-logs/cleanup/jobs/event-log-cleanup.job';
import { EventLogCleanupService } from 'src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service';
+import { EventLogRetentionModule } from 'src/engine/core-modules/event-logs/retention/event-log-retention.module';
@Module({
- imports: [TypeOrmModule.forFeature([WorkspaceEntity]), ClickHouseModule],
+ imports: [
+ TypeOrmModule.forFeature([WorkspaceEntity]),
+ ClickHouseModule,
+ EventLogRetentionModule,
+ ],
providers: [
EventLogCleanupService,
- EventLogCleanupJob,
EventLogCleanupCronJob,
EventLogCleanupCronCommand,
],
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/jobs/event-log-cleanup.job.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/jobs/event-log-cleanup.job.ts
deleted file mode 100644
index 82e06ab8904..00000000000
--- a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/jobs/event-log-cleanup.job.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-/* @license Enterprise */
-
-import { Injectable, Logger } from '@nestjs/common';
-
-import { EventLogCleanupService } from 'src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service';
-import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator';
-import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
-import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
-
-export type EventLogCleanupJobData = {
- workspaceId: string;
- eventLogRetentionDays: number;
-};
-
-@Injectable()
-@Processor(MessageQueue.workspaceQueue)
-export class EventLogCleanupJob {
- private readonly logger = new Logger(EventLogCleanupJob.name);
-
- constructor(
- private readonly eventLogCleanupService: EventLogCleanupService,
- ) {}
-
- @Process(EventLogCleanupJob.name)
- async handle(data: EventLogCleanupJobData): Promise<void> {
- const { workspaceId, eventLogRetentionDays } = data;
-
- try {
- await this.eventLogCleanupService.cleanupWorkspaceEventLogs({
- workspaceId,
- retentionDays: eventLogRetentionDays,
- });
- } catch (error) {
- this.logger.error(
- `Event log cleanup failed for workspace ${workspaceId}`,
- error instanceof Error ? error.stack : String(error),
- );
- throw error;
- }
- }
-}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service.ts b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service.ts
index 160e0cfcf86..42e77152d14 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/cleanup/services/event-log-cleanup.service.ts
@@ -2,27 +2,32 @@
import { Injectable, Logger } from '@nestjs/common';
+import chunk from 'lodash.chunk';
import { EventLogTable } from 'twenty-shared/types';
import { ClickHouseService } from 'src/database/clickhouse/clickhouse.service';
import { formatDateTimeForClickHouse } from 'src/database/clickhouse/utils/format-date-time-for-clickhouse.util';
+import { EVENT_LOG_CLEANUP_WORKSPACE_BATCH_SIZE } from 'src/engine/core-modules/event-logs/cleanup/constants/event-log-cleanup-workspace-batch-size.constant';
import { getClickHouseTableName } from 'src/engine/core-modules/event-logs/registry/event-log-registry';
+import { EventLogRetentionService } from 'src/engine/core-modules/event-logs/retention/services/event-log-retention.service';
-export type EventLogCleanupParams = {
- workspaceId: string;
- retentionDays: number;
+export type EventLogCleanupWorkspace = {
+ id: string;
+ eventLogRetentionDays: number;
};
@Injectable()
export class EventLogCleanupService {
private readonly logger = new Logger(EventLogCleanupService.name);
- constructor(private readonly clickHouseService: ClickHouseService) {}
+ constructor(
+ private readonly clickHouseService: ClickHouseService,
+ private readonly eventLogRetentionService: EventLogRetentionService,
+ ) {}
- async cleanupWorkspaceEventLogs({
- workspaceId,
- retentionDays,
- }: EventLogCleanupParams): Promise<void> {
+ async cleanupEventLogs(
+ workspaces: EventLogCleanupWorkspace[],
+ ): Promise<void> {
if (!this.clickHouseService.getMainClient()) {
this.logger.debug(
'ClickHouse not configured, skipping event log cleanup',
@@ -31,37 +36,92 @@ export class EventLogCleanupService {
return;
}
- const cutoffDate = new Date();
+ const workspaceIdsByRetentionInHours =
+ await this.groupWorkspaceIdsByRetentionInHours(workspaces);
- cutoffDate.setDate(cutoffDate.getDate() - retentionDays);
+ const tablesToClean = Object.values(EventLogTable).filter(
+ (table) => table !== EventLogTable.USAGE_EVENT,
+ );
- for (const table of Object.values(EventLogTable)) {
- const tableName = getClickHouseTableName(table);
+ const now = Date.now();
- try {
- const success = await this.clickHouseService.executeCommand(
- `ALTER TABLE ${tableName} DELETE WHERE "workspaceId" = {workspaceId:String} AND "timestamp" < {cutoffDate:DateTime64(3)}`,
- {
- workspaceId,
- cutoffDate: formatDateTimeForClickHouse(cutoffDate),
- },
- );
+ for (const [
+ retentionInHours,
+ workspaceIds,
+ ] of workspaceIdsByRetentionInHours) {
+ const cutoffDate = new Date(now - retentionInHours * 60 * 60 * 1000);
- if (success) {
- this.logger.log(
- `Scheduled deletion of old ${tableName} events for workspace ${workspaceId} (retention: ${retentionDays} days)`,
- );
- } else {
- this.logger.warn(
- `Failed to schedule deletion for ${tableName} in workspace ${workspaceId}`,
- );
+ for (const workspaceIdsBatch of chunk(
+ workspaceIds,
+ EVENT_LOG_CLEANUP_WORKSPACE_BATCH_SIZE,
+ )) {
+ for (const table of tablesToClean) {
+ await this.deleteEventLogsBefore({
+ table,
+ workspaceIds: workspaceIdsBatch,
+ cutoffDate,
+ });
}
- } catch (error) {
- this.logger.error(
- `Error cleaning up ${tableName} for workspace ${workspaceId}`,
- error instanceof Error ? error.stack : String(error),
+ }
+ }
+ }
+
+ private async groupWorkspaceIdsByRetentionInHours(
+ workspaces: EventLogCleanupWorkspace[],
+ ): Promise<Map<number, string[]>> {
+ const workspaceIdsByRetentionInHours = new Map<number, string[]>();
+
+ for (const workspace of workspaces) {
+ const retentionInHours =
+ await this.eventLogRetentionService.getRetentionInHours({
+ workspaceId: workspace.id,
+ workspaceRetentionInDays: workspace.eventLogRetentionDays,
+ });
+
+ const workspaceIds =
+ workspaceIdsByRetentionInHours.get(retentionInHours) ?? [];
+
+ workspaceIds.push(workspace.id);
+ workspaceIdsByRetentionInHours.set(retentionInHours, workspaceIds);
+ }
+
+ return workspaceIdsByRetentionInHours;
+ }
+
+ private async deleteEventLogsBefore({
+ table,
+ workspaceIds,
+ cutoffDate,
+ }: {
+ table: EventLogTable;
+ workspaceIds: string[];
+ cutoffDate: Date;
+ }): Promise<void> {
+ const tableName = getClickHouseTableName(table);
+
+ try {
+ const success = await this.clickHouseService.executeCommand(
+ `ALTER TABLE ${tableName} DELETE WHERE "workspaceId" IN ({workspaceIds:Array(String)}) AND "timestamp" < {cutoffDate:DateTime64(3)}`,
+ {
+ workspaceIds,
+ cutoffDate: formatDateTimeForClickHouse(cutoffDate),
+ },
+ );
+
+ if (success) {
+ this.logger.log(
+ `Scheduled deletion of ${tableName} events before ${cutoffDate.toISOString()} for ${workspaceIds.length} workspace(s)`,
+ );
+ } else {
+ this.logger.warn(
+ `Failed to schedule deletion for ${tableName} in ${workspaceIds.length} workspace(s)`,
);
}
+ } catch (error) {
+ this.logger.error(
+ `Error cleaning up ${tableName} for ${workspaceIds.length} workspace(s)`,
+ error instanceof Error ? error.stack : String(error),
+ );
}
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs-viewer.module.ts b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs-viewer.module.ts
index d4f3fed7255..78ee7dce65b 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs-viewer.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs-viewer.module.ts
@@ -8,6 +8,7 @@ import { EnterpriseModule } from 'src/engine/core-modules/enterprise/enterprise.
import { EventLogEmitterModule } from 'src/engine/core-modules/event-logs/emit/event-log-emitter.module';
import { EventLogEmitterResolver } from 'src/engine/core-modules/event-logs/emit/event-log-emitter.resolver';
import { EventLogLiveModule } from 'src/engine/core-modules/event-logs/live/event-log-live.module';
+import { EventLogRetentionModule } from 'src/engine/core-modules/event-logs/retention/event-log-retention.module';
import { ClickHouseModule } from 'src/database/clickhouse/clickhouse.module';
import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
@@ -24,6 +25,7 @@ import { EventLogsService } from './event-logs.service';
EnterpriseModule,
EventLogLiveModule,
EventLogEmitterModule,
+ EventLogRetentionModule,
TypeOrmModule.forFeature([UserWorkspaceEntity]),
],
providers: [
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.exception.ts b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.exception.ts
index 0e8b303270a..62a7b2411e8 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.exception.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.exception.ts
@@ -20,7 +20,7 @@ const getEventLogsExceptionUserFriendlyMessage = (
case EventLogsExceptionCode.CLICKHOUSE_NOT_CONFIGURED:
return msg`Audit logs require ClickHouse to be configured.`;
case EventLogsExceptionCode.NO_ENTITLEMENT:
- return msg`Audit logs require an Enterprise subscription.`;
+ return msg`Audit logs require an Organization subscription.`;
case EventLogsExceptionCode.INVALID_FIELD_FILTER:
return msg`This log filter is not valid.`;
case EventLogsExceptionCode.INVALID_TABLE:
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.resolver.ts b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.resolver.ts
index 76a50814518..a5ff5384894 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.resolver.ts
@@ -58,7 +58,7 @@ export class EventLogsResolver {
@AuthApplication({ allowUndefined: true })
callingApplication: FlatApplication | undefined,
): Promise<EventLogQueryResult> {
- return this.eventLogsService.queryEventLogs(workspace.id, input, {
+ return this.eventLogsService.queryEventLogs(workspace, input, {
callingApplicationId: getScopedCallingApplication(callingApplication)?.id,
});
}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.service.ts b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.service.ts
index 2462747a255..44a69e9d1ff 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/event-logs.service.ts
@@ -11,7 +11,9 @@ import { ClickHouseService } from 'src/database/clickhouse/clickhouse.service';
import { formatDateTimeForClickHouse } from 'src/database/clickhouse/utils/format-date-time-for-clickhouse.util';
import { BillingService } from 'src/engine/core-modules/billing/services/billing.service';
import { EnterprisePlanService } from 'src/engine/core-modules/enterprise/services/enterprise-plan.service';
+import { EventLogRetentionService } from 'src/engine/core-modules/event-logs/retention/services/event-log-retention.service';
import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
+import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import {
EventLogsException,
@@ -37,23 +39,38 @@ export class EventLogsService {
private readonly clickHouseService: ClickHouseService,
private readonly billingService: BillingService,
private readonly enterprisePlanService: EnterprisePlanService,
+ private readonly eventLogRetentionService: EventLogRetentionService,
@InjectRepository(UserWorkspaceEntity)
private readonly userWorkspaceRepository: Repository<UserWorkspaceEntity>,
) {}
async queryEventLogs(
- workspaceId: string,
+ workspace: Pick<WorkspaceEntity, 'id' | 'eventLogRetentionDays'>,
input: EventLogQueryInput,
{ callingApplicationId }: { callingApplicationId?: string } = {},
): Promise<EventLogQueryResult> {
+ const workspaceId = workspace.id;
+
await this.validateAccess(workspaceId, input.table);
const limit = Math.min(input.first ?? 100, MAX_LIMIT);
const tableName = getClickHouseTableName(input.table);
const eventFieldName = EVENT_LOG_TYPES[input.table].eventFieldName;
- const whereClauses: string[] = ['"workspaceId" = {workspaceId:String}'];
- const params: Record<string, unknown> = { workspaceId };
+ const retentionStartDate =
+ await this.eventLogRetentionService.getRetentionStartDate({
+ workspaceId,
+ workspaceRetentionInDays: workspace.eventLogRetentionDays,
+ });
+
+ const whereClauses: string[] = [
+ '"workspaceId" = {workspaceId:String}',
+ '"timestamp" >= {retentionStartDate:DateTime64(3)}',
+ ];
+ const params: Record<string, unknown> = {
+ workspaceId,
+ retentionStartDate: formatDateTimeForClickHouse(retentionStartDate),
+ };
if (
input.table === EventLogTable.APPLICATION_LOG &&
@@ -195,7 +212,7 @@ export class EventLogsService {
if (!hasAccess) {
throw new EventLogsException(
- 'Audit logs require an Enterprise subscription.',
+ 'Audit logs require an Organization subscription.',
EventLogsExceptionCode.NO_ENTITLEMENT,
);
}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/retention/event-log-retention.module.ts b/packages/twenty-server/src/engine/core-modules/event-logs/retention/event-log-retention.module.ts
new file mode 100644
index 00000000000..77ce78eed9d
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/retention/event-log-retention.module.ts
@@ -0,0 +1,13 @@
+/* @license Enterprise */
+
+import { Module } from '@nestjs/common';
+
+import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
+import { EventLogRetentionService } from 'src/engine/core-modules/event-logs/retention/services/event-log-retention.service';
+
+@Module({
+ imports: [BillingModule],
+ providers: [EventLogRetentionService],
+ exports: [EventLogRetentionService],
+})
+export class EventLogRetentionModule {}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/retention/services/event-log-retention.service.ts b/packages/twenty-server/src/engine/core-modules/event-logs/retention/services/event-log-retention.service.ts
new file mode 100644
index 00000000000..c1654907d92
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/retention/services/event-log-retention.service.ts
@@ -0,0 +1,63 @@
+/* @license Enterprise */
+
+import { Injectable } from '@nestjs/common';
+
+import { getEventLogRetentionInHours } from 'twenty-shared/utils';
+
+import { BillingEntitlementKey } from 'src/engine/core-modules/billing/enums/billing-entitlement-key.enum';
+import { BillingSubscriptionService } from 'src/engine/core-modules/billing/services/billing-subscription.service';
+import {
+ WorkspaceException,
+ WorkspaceExceptionCode,
+} from 'src/engine/core-modules/workspace/workspace.exception';
+
+@Injectable()
+export class EventLogRetentionService {
+ constructor(
+ private readonly billingSubscriptionService: BillingSubscriptionService,
+ ) {}
+
+ async getRetentionInHours({
+ workspaceId,
+ workspaceRetentionInDays,
+ }: {
+ workspaceId: string;
+ workspaceRetentionInDays: number;
+ }): Promise<number> {
+ return getEventLogRetentionInHours({
+ workspaceRetentionInDays,
+ hasAuditLogsEntitlement: await this.hasAuditLogsEntitlement(workspaceId),
+ });
+ }
+
+ async getRetentionStartDate({
+ workspaceId,
+ workspaceRetentionInDays,
+ }: {
+ workspaceId: string;
+ workspaceRetentionInDays: number;
+ }): Promise<Date> {
+ const retentionInHours = await this.getRetentionInHours({
+ workspaceId,
+ workspaceRetentionInDays,
+ });
+
+ return new Date(Date.now() - retentionInHours * 60 * 60 * 1000);
+ }
+
+ async validateRetentionUpdateOrThrow(workspaceId: string): Promise<void> {
+ if (!(await this.hasAuditLogsEntitlement(workspaceId))) {
+ throw new WorkspaceException(
+ 'Changing the event log retention requires the audit logs entitlement',
+ WorkspaceExceptionCode.EVENT_LOG_RETENTION_DISABLED,
+ );
+ }
+ }
+
+ private async hasAuditLogsEntitlement(workspaceId: string) {
+ return this.billingSubscriptionService.getWorkspaceEntitlementValue(
+ workspaceId,
+ BillingEntitlementKey.AUDIT_LOGS,
+ );
+ }
+}
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/dtos/update-workspace-input.ts b/packages/twenty-server/src/engine/core-modules/workspace/dtos/update-workspace-input.ts
index ec36902ea34..3e599d45e8e 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/dtos/update-workspace-input.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/dtos/update-workspace-input.ts
@@ -2,6 +2,7 @@ import { Field, InputType } from '@nestjs/graphql';
import GraphQLJSON from 'graphql-type-json';
import { type AiModelTier } from 'twenty-shared/ai';
+import { EVENT_LOG_RETENTION } from 'twenty-shared/constants';
import {
IsArray,
@@ -119,8 +120,8 @@ export class UpdateWorkspaceInput {
@Field({ nullable: true })
@IsInt()
- @Min(30) // Minimum 30 days retention for audit compliance
- @Max(1095) // Maximum 3 years (matches ClickHouse table-level TTL)
+ @Min(EVENT_LOG_RETENTION.minInDays)
+ @Max(EVENT_LOG_RETENTION.maxInDays)
@IsOptional()
eventLogRetentionDays?: number;
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts b/packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts
index d20e12b5e9c..74becbc6340 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts
@@ -44,6 +44,7 @@ import { DnsManagerService } from 'src/engine/core-modules/dns-manager/services/
import { CustomDomainManagerService } from 'src/engine/core-modules/domain/custom-domain-manager/services/custom-domain-manager.service';
import { SubdomainManagerService } from 'src/engine/core-modules/domain/subdomain-manager/services/subdomain-manager.service';
import { EmailingDomainEntity } from 'src/engine/core-modules/emailing-domain/emailing-domain.entity';
+import { EventLogRetentionService } from 'src/engine/core-modules/event-logs/retention/services/event-log-retention.service';
import {
EmailingDomainWorkspaceCleanupJob,
type EmailingDomainWorkspaceCleanupJobData,
@@ -192,6 +193,7 @@ export class WorkspaceService {
private readonly sdkClientGenerationService: SdkClientGenerationService,
private readonly postgresAdvisoryLockService: PostgresAdvisoryLockService,
private readonly applicationUninstallService: ApplicationUninstallService,
+ private readonly eventLogRetentionService: EventLogRetentionService,
) {}
// reject unknown new pins now rather than silently falling back at run time; stored pins stay so the form remains editable
@@ -355,6 +357,15 @@ export class WorkspaceService {
);
}
+ if (
+ isDefined(payload.eventLogRetentionDays) &&
+ workspace.eventLogRetentionDays !== payload.eventLogRetentionDays
+ ) {
+ await this.eventLogRetentionService.validateRetentionUpdateOrThrow(
+ workspace.id,
+ );
+ }
+
let customDomainRegistered = false;
if (payload.customDomain === null && isDefined(workspace.customDomain)) {
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/utils/workspace-graphql-api-exception-handler.util.ts b/packages/twenty-server/src/engine/core-modules/workspace/utils/workspace-graphql-api-exception-handler.util.ts
index a992b659793..82e239843a8 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/utils/workspace-graphql-api-exception-handler.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/utils/workspace-graphql-api-exception-handler.util.ts
@@ -25,6 +25,7 @@ export const workspaceGraphqlApiExceptionHandler = (error: Error) => {
throw new ConflictError(error);
case WorkspaceExceptionCode.ENVIRONMENT_VAR_NOT_ENABLED:
case WorkspaceExceptionCode.WORKSPACE_CUSTOM_DOMAIN_DISABLED:
+ case WorkspaceExceptionCode.EVENT_LOG_RETENTION_DISABLED:
throw new ForbiddenError(error);
case WorkspaceExceptionCode.IFRAME_ORIGIN_LIMIT_EXCEEDED:
case WorkspaceExceptionCode.AI_MODEL_PIN_NOT_VALID:
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts b/packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts
index c553fadd64b..4db1506d134 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts
@@ -7,6 +7,7 @@ import {
DEFAULT_AI_CHAT_MODEL_TIER,
type AiModelTier,
} from 'twenty-shared/ai';
+import { EVENT_LOG_RETENTION } from 'twenty-shared/constants';
import { WorkspaceActivationStatus } from 'twenty-shared/workspace';
import {
Check,
@@ -156,7 +157,7 @@ export class WorkspaceEntity {
trashRetentionDays: number;
@Field()
- @Column({ type: 'integer', default: 90 })
+ @Column({ type: 'integer', default: EVENT_LOG_RETENTION.defaultInDays })
eventLogRetentionDays: number;
@OneToMany(() => AppTokenEntity, (appToken) => appToken.workspace, {
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/workspace.exception.ts b/packages/twenty-server/src/engine/core-modules/workspace/workspace.exception.ts
index 508b194c95e..49f202f514b 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/workspace.exception.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/workspace.exception.ts
@@ -17,6 +17,7 @@ export enum WorkspaceExceptionCode {
CUSTOM_DOMAIN_NOT_FOUND = 'CUSTOM_DOMAIN_NOT_FOUND',
APPLICATION_UNINSTALL_IN_PROGRESS = 'APPLICATION_UNINSTALL_IN_PROGRESS',
AI_MODEL_PIN_NOT_VALID = 'AI_MODEL_PIN_NOT_VALID',
+ EVENT_LOG_RETENTION_DISABLED = 'EVENT_LOG_RETENTION_DISABLED',
}
const getWorkspaceExceptionUserFriendlyMessage = (
@@ -45,6 +46,8 @@ const getWorkspaceExceptionUserFriendlyMessage = (
return msg`Application cleanup is still in progress. Please try again.`;
case WorkspaceExceptionCode.AI_MODEL_PIN_NOT_VALID:
return msg`This model cannot be used for this tier.`;
+ case WorkspaceExceptionCode.EVENT_LOG_RETENTION_DISABLED:
+ return msg`Changing log retention requires an Organization subscription.`;
default:
assertUnreachable(code);
}
diff --git a/packages/twenty-server/src/engine/core-modules/workspace/workspace.module.ts b/packages/twenty-server/src/engine/core-modules/workspace/workspace.module.ts
index 45320006b4b..dd88b2475ad 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace/workspace.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace/workspace.module.ts
@@ -6,6 +6,7 @@ import { ApplicationModule } from 'src/engine/core-modules/application/applicati
import { ApplicationManifestModule } from 'src/engine/core-modules/application/application-manifest/application-manifest.module';
import { PreInstalledAppsModule } from 'src/engine/core-modules/application/pre-installed-apps/pre-installed-apps.module';
import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
+import { EventLogRetentionModule } from 'src/engine/core-modules/event-logs/retention/event-log-retention.module';
import { CompanyEnrichmentModule } from 'src/engine/core-modules/company-enrichment/company-enrichment.module';
import { DnsManagerModule } from 'src/engine/core-modules/dns-manager/dns-manager.module';
import { CustomDomainManagerModule } from 'src/engine/core-modules/domain/custom-domain-manager/custom-domain-manager.module';
@@ -51,6 +52,7 @@ import { StandardObjectsPrefillModule } from 'src/engine/workspace-manager/stand
MetricsModule,
StandardObjectsPrefillModule,
BillingModule,
+ EventLogRetentionModule,
FileModule,
UserWorkspaceModule,
WorkspaceManagerModule,
diff --git a/packages/twenty-shared/src/constants/EventLogRetention.ts b/packages/twenty-shared/src/constants/EventLogRetention.ts
new file mode 100644
index 00000000000..bae77e77eae
--- /dev/null
+++ b/packages/twenty-shared/src/constants/EventLogRetention.ts
@@ -0,0 +1,6 @@
+export const EVENT_LOG_RETENTION = {
+ proPlanInHours: 2,
+ defaultInDays: 3,
+ minInDays: 1,
+ maxInDays: 1095,
+} as const;
diff --git a/packages/twenty-shared/src/constants/index.ts b/packages/twenty-shared/src/constants/index.ts
index ef38f874f1f..5073eabac02 100644
--- a/packages/twenty-shared/src/constants/index.ts
+++ b/packages/twenty-shared/src/constants/index.ts
@@ -41,6 +41,7 @@ export { EMAIL_IMAGE_MIME_TYPES } from './EmailImageMimeTypes';
export { EMAIL_SENDING_PROVIDERS } from './EmailSendingProviders';
export type { EnterpriseInstanceType } from './EnterpriseInstanceType';
export { ENTERPRISE_INSTANCE_TYPE } from './EnterpriseInstanceType';
+export { EVENT_LOG_RETENTION } from './EventLogRetention';
export { EVERYONE_PRINCIPAL_ID } from './EveryonePrincipalId';
export { EXCLUDED_FIELD_NAMES_FROM_AGENT_TOOL_SCHEMA } from './ExcludedFieldNamesFromAgentToolSchema';
export { FIELD_FOR_TOTAL_COUNT_AGGREGATE_OPERATION } from './FieldForTotalCountAggregateOperation';
diff --git a/packages/twenty-shared/src/utils/event-logs/__tests__/getEventLogRetentionInHours.test.ts b/packages/twenty-shared/src/utils/event-logs/__tests__/getEventLogRetentionInHours.test.ts
new file mode 100644
index 00000000000..90380ba8bdf
--- /dev/null
+++ b/packages/twenty-shared/src/utils/event-logs/__tests__/getEventLogRetentionInHours.test.ts
@@ -0,0 +1,31 @@
+import { EVENT_LOG_RETENTION } from '@/constants/EventLogRetention';
+import { getEventLogRetentionInHours } from '@/utils/event-logs/getEventLogRetentionInHours';
+
+describe('getEventLogRetentionInHours', () => {
+ it('should keep logs for the Pro plan duration without the audit logs entitlement', () => {
+ expect(
+ getEventLogRetentionInHours({
+ workspaceRetentionInDays: 365,
+ hasAuditLogsEntitlement: false,
+ }),
+ ).toBe(EVENT_LOG_RETENTION.proPlanInHours);
+ });
+
+ it('should use the workspace retention with the audit logs entitlement', () => {
+ expect(
+ getEventLogRetentionInHours({
+ workspaceRetentionInDays: 365,
+ hasAuditLogsEntitlement: true,
+ }),
+ ).toBe(365 * 24);
+ });
+
+ it('should cap the workspace retention at the maximum retention', () => {
+ expect(
+ getEventLogRetentionInHours({
+ workspaceRetentionInDays: 5000,
+ hasAuditLogsEntitlement: true,
+ }),
+ ).toBe(EVENT_LOG_RETENTION.maxInDays * 24);
+ });
+});
diff --git a/packages/twenty-shared/src/utils/event-logs/getEventLogRetentionInHours.ts b/packages/twenty-shared/src/utils/event-logs/getEventLogRetentionInHours.ts
new file mode 100644
index 00000000000..c33d940eae9
--- /dev/null
+++ b/packages/twenty-shared/src/utils/event-logs/getEventLogRetentionInHours.ts
@@ -0,0 +1,15 @@
+import { EVENT_LOG_RETENTION } from '@/constants/EventLogRetention';
+
+export const getEventLogRetentionInHours = ({
+ workspaceRetentionInDays,
+ hasAuditLogsEntitlement,
+}: {
+ workspaceRetentionInDays: number;
+ hasAuditLogsEntitlement: boolean;
+}): number => {
+ if (!hasAuditLogsEntitlement) {
+ return EVENT_LOG_RETENTION.proPlanInHours;
+ }
+
+ return Math.min(workspaceRetentionInDays, EVENT_LOG_RETENTION.maxInDays) * 24;
+};
diff --git a/packages/twenty-shared/src/utils/index.ts b/packages/twenty-shared/src/utils/index.ts
index 402066e9270..e0e57d3f3db 100644
--- a/packages/twenty-shared/src/utils/index.ts
+++ b/packages/twenty-shared/src/utils/index.ts
@@ -62,6 +62,7 @@ export type { ParsedEmailAddress } from './email/parseEmailAddressList';
export { parseEmailAddressList } from './email/parseEmailAddressList';
export { CustomError } from './errors/CustomError';
export { evalFromContext } from './evalFromContext';
+export { getEventLogRetentionInHours } from './event-logs/getEventLogRetentionInHours';
export { extractAndSanitizeObjectStringFields } from './extractAndSanitizeObjectStringFields';
export { computeMorphRelationGqlFieldName } from './fieldMetadata/compute-morph-relation-gql-field-name';
export {
diff --git a/packages/twenty-website/src/sections/pricing-plan-table/plan-table-data.ts b/packages/twenty-website/src/sections/pricing-plan-table/plan-table-data.ts
index a046edc160d..0dd14b896c8 100644
--- a/packages/twenty-website/src/sections/pricing-plan-table/plan-table-data.ts
+++ b/packages/twenty-website/src/sections/pricing-plan-table/plan-table-data.ts
@@ -210,6 +210,14 @@ export const PLAN_TABLE_DATA: PlanTableDataType = {
},
type: 'row',
},
+ {
+ featureLabel: msg`Record change logs`,
+ tiers: {
+ organization: { kind: 'yes', label: msg`Yes` },
+ pro: { kind: 'yes', label: msg`Yes` },
+ },
+ type: 'row',
+ },
{
featureLabel: msg`Audit logs`,
tiers: {
@@ -218,6 +226,14 @@ export const PLAN_TABLE_DATA: PlanTableDataType = {
},
type: 'row',
},
+ {
+ featureLabel: msg`Log retention`,
+ tiers: {
+ organization: { kind: 'text', text: msg`Custom, up to 3 years` },
+ pro: { kind: 'text', text: msg`2 hours` },
+ },
+ type: 'row',
+ },
{
featureLabel: msg`Environments`,
tiers: {
@@ -352,6 +368,14 @@ export const PLAN_TABLE_DATA: PlanTableDataType = {
},
type: 'row',
},
+ {
+ featureLabel: msg`App logs`,
+ tiers: {
+ organization: { kind: 'yes', label: msg`Yes` },
+ pro: { kind: 'yes', label: msg`Yes` },
+ },
+ type: 'row',
+ },
{
featureLabel: msg`Install shared tarball app`,
tiers: {