Skip to content

The open alternative to Salesforce, designed for AI.

feat(usage-limit): ship a default daily email quota per workspace (#26535)

Etienne637150616f12
diff --git a/packages/twenty-server/src/engine/core-modules/billing/services/billing-usage.service.ts b/packages/twenty-server/src/engine/core-modules/billing/services/billing-usage.service.ts
index af52351cb44..c463b23dccd 100644
--- a/packages/twenty-server/src/engine/core-modules/billing/services/billing-usage.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/billing/services/billing-usage.service.ts
@@ -28,6 +28,7 @@ import { buildUsageRefusalException } from 'src/engine/core-modules/billing/util
import { getBillingSubscriptionPeriod } from 'src/engine/core-modules/billing/utils/get-billing-subscription-period.util';
import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { UsageLimitQuotaService } from 'src/engine/core-modules/usage-limit/services/usage-limit-quota.service';
+import { type QuotaCost } from 'src/engine/core-modules/usage-limit/types/quota-cost.type';
import { type UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
import { type UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
import { type UsageSpenders } from 'src/engine/core-modules/usage/types/usage-spenders.type';
@@ -43,6 +44,7 @@ type UsageQuotaScope = {
resourceType: UsageResourceType;
operationType: UsageOperationType;
spenders: UsageSpenders;
+ cost?: QuotaCost;
};
@Injectable()
@@ -75,6 +77,7 @@ export class BillingUsageService {
resourceType,
operationType,
spenders,
+ cost,
}: UsageQuotaScope): Promise<UsageRefusal | null> {
const subscriptionInactiveReason =
await this.getSubscriptionInactiveReason(workspaceId);
@@ -87,7 +90,7 @@ export class BillingUsageService {
}
const exhaustedScope = await this.usageLimitQuotaService.findExhaustedScope(
- { workspaceId, resourceType, operationType, spenders },
+ { workspaceId, resourceType, operationType, spenders, cost },
);
return isDefined(exhaustedScope)
diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/count-delivered-recipients.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/count-delivered-recipients.util.ts
index 0becc1a472f..969960bc417 100644
--- a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/count-delivered-recipients.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/count-delivered-recipients.util.ts
@@ -1,8 +1,9 @@
-import { type EmailingDomainSendEmailResult } from 'src/engine/core-modules/emailing-domain/drivers/types/emailing-domain-send-email-result.type';
-
export const countDeliveredRecipients = ({
to,
cc,
bcc,
-}: EmailingDomainSendEmailResult['deliveredRecipients']): number =>
- to.length + cc.length + bcc.length;
+}: {
+ to: string[];
+ cc?: string[];
+ bcc?: string[];
+}): number => to.length + (cc?.length ?? 0) + (bcc?.length ?? 0);
diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
index 798021c8f4c..bf2875bae87 100644
--- a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
@@ -1745,6 +1745,15 @@ export class ConfigVariables {
@CastToPositiveNumber()
EMAIL_SEND_RATE_LIMITING_LIMIT = 100;
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.RATE_LIMITING,
+ description:
+ 'Maximum number of emails a single workspace may send per UTC day, campaign and one-off sends counted together. A workspace limit configured in the app replaces it',
+ type: ConfigVariableType.NUMBER,
+ })
+ @CastToPositiveNumber()
+ EMAIL_SEND_WORKSPACE_DAILY_LIMIT = 1_000;
+
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.RATE_LIMITING,
description:
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/constants/usage-limit-definitions.constant.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/constants/usage-limit-definitions.constant.ts
index bef60da3cf3..b094f923b2d 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/constants/usage-limit-definitions.constant.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/constants/usage-limit-definitions.constant.ts
@@ -64,6 +64,7 @@ export const USAGE_LIMIT_DEFINITIONS = {
'application',
],
allowedMeters: ['creditsUsedMicro', 'quantity'],
+ defaults: [],
},
},
[UsageResourceType.WORKFLOW]: {
@@ -71,6 +72,7 @@ export const USAGE_LIMIT_DEFINITIONS = {
allowedOperationTypes: [UsageOperationType.WORKFLOW_EXECUTION],
allowedSpenderTypes: ['workspace', 'application'],
allowedMeters: ['creditsUsedMicro', 'quantity'],
+ defaults: [],
},
},
[UsageResourceType.APP]: {},
@@ -100,6 +102,7 @@ export const USAGE_LIMIT_DEFINITIONS = {
allowedOperationTypes: [UsageOperationType.CODE_EXECUTION],
allowedSpenderTypes: ['workspace', 'application', 'logicFunction'],
allowedMeters: ['creditsUsedMicro', 'quantity'],
+ defaults: [],
},
},
[UsageResourceType.EMAIL]: {
@@ -175,6 +178,20 @@ export const USAGE_LIMIT_DEFINITIONS = {
allowedOperationTypes: [UsageOperationType.EMAIL_SEND],
allowedSpenderTypes: ['workspace', 'userWorkspace'],
allowedMeters: ['creditsUsedMicro', 'quantity'],
+ defaults: [
+ {
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ limitKind: 'quota',
+ spenderType: 'workspace',
+ spenderId: '',
+ meter: 'quantity',
+ periodUnit: 'day',
+ periodCount: 1,
+ limitValueConfigVariable: 'EMAIL_SEND_WORKSPACE_DAILY_LIMIT',
+ isOverridable: true,
+ },
+ ],
},
},
[UsageResourceType.WEBHOOK]: {
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/__tests__/usage-limit-quota.service.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/__tests__/usage-limit-quota.service.spec.ts
index f890ec0ff15..7da54ece51e 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/services/__tests__/usage-limit-quota.service.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/__tests__/usage-limit-quota.service.spec.ts
@@ -9,6 +9,7 @@ import {
import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';
import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';
+import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/interfaces/credit-allowance-provider.service';
import { UsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-limit/interfaces/usage-limit-entitlement-provider.service';
import { UsageLimitEntitlementService } from 'src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service';
@@ -20,6 +21,7 @@ import { type UsageConsumptionRow } from 'src/engine/core-modules/usage/types/us
import { type UsageLimitCounterScope } from 'src/engine/core-modules/usage-limit/types/usage-limit-counter-scope.type';
import { buildAllowanceCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-allowance-counter-key.util';
import { buildQuotaCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-counter-key.util';
+import { buildQuotaDefaultCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util';
import { buildQuotaWarmLockKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-warm-lock-key.util';
import { UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
import { UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
@@ -37,6 +39,11 @@ const WEEK_PERIOD = {
periodEnd: new Date('2100-08-31T00:00:00.000Z'),
};
+const DAY_PERIOD = {
+ periodStart: new Date('2026-08-20T00:00:00.000Z'),
+ periodEnd: new Date('2100-08-21T00:00:00.000Z'),
+};
+
const ALLOWANCE_PERIOD = {
periodStart: new Date('2026-08-15T09:00:00.000Z'),
periodEnd: new Date('2100-09-15T09:00:00.000Z'),
@@ -118,12 +125,19 @@ describe('UsageLimitQuotaService', () => {
incrementCounterBy: jest.fn(),
};
+ const twentyConfigService = {
+ get: jest.fn(),
+ };
+
let periodByUnit: Partial<Record<PeriodUnit, UsagePeriod>>;
- const setLimits = (limits: FlatUsageLimit[]) => {
+ const setLimits = (
+ limits: FlatUsageLimit[],
+ resourceType: UsageResourceType = UsageResourceType.AI,
+ ) => {
workspaceCacheService.getOrRecompute.mockResolvedValue({
usageLimits: {
- byResourceType: { [UsageResourceType.AI]: limits },
+ byResourceType: { [resourceType]: limits },
},
});
};
@@ -170,6 +184,7 @@ describe('UsageLimitQuotaService', () => {
);
cacheStorage.mget.mockResolvedValue([]);
cacheStorage.runScript.mockResolvedValue([]);
+ twentyConfigService.get.mockReturnValue(1_000);
usageAnalyticsService.getConsumptionRowsForAllScopes.mockResolvedValue([]);
usageAnalyticsService.getCreditsUsedMicroForBillingPeriod.mockResolvedValue(
0,
@@ -199,6 +214,7 @@ describe('UsageLimitQuotaService', () => {
{ provide: UsageAnalyticsService, useValue: usageAnalyticsService },
{ provide: UsagePeriodService, useValue: usagePeriodService },
{ provide: MetricsService, useValue: metricsService },
+ { provide: TwentyConfigService, useValue: twentyConfigService },
{
provide: DiscoveryService,
useValue: {
@@ -662,6 +678,42 @@ describe('UsageLimitQuotaService', () => {
]);
});
+ it('also drops the default counter the limit overrides', async () => {
+ periodByUnit.day = DAY_PERIOD;
+
+ await service.dropLimitCounter(
+ buildLimitCounterScope({
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ periodUnit: 'day',
+ meter: 'quantity',
+ }),
+ );
+
+ expect(cacheStorage.mdel).toHaveBeenCalledWith([
+ buildQuotaCounterKey({
+ workspaceId: 'workspace-1',
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ spenderType: 'workspace',
+ spenderId: '',
+ meter: 'quantity',
+ periodUnit: 'day',
+ periodStart: DAY_PERIOD.periodStart,
+ }),
+ buildQuotaDefaultCounterKey({
+ workspaceId: 'workspace-1',
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ spenderType: 'workspace',
+ meter: 'quantity',
+ periodUnit: 'day',
+ periodStart: DAY_PERIOD.periodStart,
+ limitValue: 1_000,
+ }),
+ ]);
+ });
+
it('skips the drop when the period cannot be resolved', async () => {
await service.dropLimitCounter(
buildLimitCounterScope({ periodUnit: 'allowancePeriod' }),
@@ -917,4 +969,85 @@ describe('UsageLimitQuotaService', () => {
);
});
});
+
+ describe('default limits', () => {
+ const findEmailExhaustedScope = () =>
+ service.findExhaustedScope({
+ workspaceId: 'workspace-1',
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ spenders: {},
+ });
+
+ const mockRemaining = (remaining: number | undefined) =>
+ cacheStorage.mget.mockResolvedValue([remaining]);
+
+ const buildEmailLimit = (overrides: Partial<FlatUsageLimit>) =>
+ buildLimit({
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ periodUnit: 'day',
+ meter: 'quantity',
+ ...overrides,
+ });
+
+ beforeEach(() => {
+ periodByUnit.day = DAY_PERIOD;
+ });
+
+ it('caps a workspace that stores no limit of its own', async () => {
+ mockRemaining(0);
+
+ await expect(findEmailExhaustedScope()).resolves.toMatchObject({
+ exhaustedKind: 'limit',
+ isDefault: true,
+ limitValue: 1_000,
+ periodUnit: 'day',
+ spenderType: 'workspace',
+ });
+ });
+
+ it('warms the default counter against the configured limit value', async () => {
+ mockRemaining(undefined);
+ usageAnalyticsService.getConsumptionRowsForAllScopes.mockResolvedValue([
+ {
+ operationType: UsageOperationType.EMAIL_SEND,
+ userWorkspaceId: '',
+ apiKeyId: '',
+ applicationId: '',
+ agentId: '',
+ logicFunctionId: '',
+ creditsUsedMicro: 0,
+ quantity: 400,
+ },
+ ]);
+
+ await expect(findEmailExhaustedScope()).resolves.toBeNull();
+ expect(cacheStorage.mset).toHaveBeenCalledWith([
+ expect.objectContaining({ value: 600 }),
+ ]);
+ });
+
+ it('declares no default where ClickHouse is not configured', async () => {
+ twentyConfigService.get.mockImplementation((key: string) =>
+ key === 'CLICKHOUSE_URL' ? undefined : 1_000,
+ );
+ mockRemaining(undefined);
+
+ await expect(findEmailExhaustedScope()).resolves.toBeNull();
+ expect(
+ usageAnalyticsService.getConsumptionRowsForAllScopes,
+ ).not.toHaveBeenCalled();
+ });
+
+ it('gives way to a workspace limit that overrides it', async () => {
+ setLimits([buildEmailLimit({ limitValue: 50 })], UsageResourceType.EMAIL);
+ cacheStorage.mget.mockResolvedValue([0]);
+
+ await expect(findEmailExhaustedScope()).resolves.toMatchObject({
+ isDefault: false,
+ limitValue: 50,
+ });
+ });
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-quota.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-quota.service.ts
index edce34b72b7..197ccccc1ba 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-quota.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-quota.service.ts
@@ -13,6 +13,7 @@ import { CacheStorageService } from 'src/engine/core-modules/cache-storage/servi
import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';
import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';
+import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { CONSUME_QUOTA_COUNTERS_SCRIPT } from 'src/engine/core-modules/usage-limit/constants/consume-quota-counters-script.constant';
import { UsageLimitException } from 'src/engine/core-modules/usage-limit/exceptions/usage-limit.exception';
import { CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/interfaces/credit-allowance-provider.service';
@@ -26,11 +27,13 @@ import { type LimitConsumption } from 'src/engine/core-modules/usage-limit/types
import { type LimitQuotaCounter } from 'src/engine/core-modules/usage-limit/types/limit-quota-counter.type';
import { type QuotaCost } from 'src/engine/core-modules/usage-limit/types/quota-cost.type';
import { type QuotaCounter } from 'src/engine/core-modules/usage-limit/types/quota-counter.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
import { type UsageLimitCounterScope } from 'src/engine/core-modules/usage-limit/types/usage-limit-counter-scope.type';
import { buildAllowanceCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-allowance-counter-key.util';
import { buildIntraWorkspaceLimitCounterKeys } from 'src/engine/core-modules/usage-limit/utils/build-intra-workspace-limit-counter-keys.util';
import { buildLimitQuotaCounter } from 'src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util';
import { buildLimitWarmedEntries } from 'src/engine/core-modules/usage-limit/utils/build-limit-warmed-entries.util';
+import { buildOverriddenQuotaDefaultCounterKeys } from 'src/engine/core-modules/usage-limit/utils/build-overridden-quota-default-counter-keys.util';
import { buildPeriodGroupKey } from 'src/engine/core-modules/usage-limit/utils/build-period-group-key.util';
import { buildQuotaCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-counter-key.util';
import { buildQuotaCounters } from 'src/engine/core-modules/usage-limit/utils/build-quota-counters.util';
@@ -84,6 +87,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
private readonly discoveryService: DiscoveryService,
private readonly usageLimitEntitlementService: UsageLimitEntitlementService,
private readonly metricsService: MetricsService,
+ private readonly twentyConfigService: TwentyConfigService,
) {}
onModuleInit() {
@@ -93,7 +97,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
}
async findExhaustedScope(
- args: QuotaConsumeArgs,
+ args: QuotaConsumeArgs & { cost?: QuotaCost },
): Promise<ExhaustedScope | null> {
const exhaustedScopes =
await this.findExhaustedScopesAdmittingOnFailure(args);
@@ -159,7 +163,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
limits,
periodByUnit: await this.usagePeriodService.findCurrentPeriodsByUnit({
workspaceId,
- limits,
+ periodUnits: limits.map((limit) => limit.periodUnit),
}),
});
@@ -178,29 +182,53 @@ export class UsageLimitQuotaService implements OnModuleInit {
return;
}
- const period = await this.usagePeriodService.findCurrentPeriod({
- workspaceId: usageLimit.workspaceId,
- periodUnit: usageLimit.periodUnit,
- });
+ const quotaLimitDefaults = this.buildQuotaLimitDefaults(
+ usageLimit.resourceType,
+ );
- if (!isDefined(period)) {
+ const periodByUnit = await this.usagePeriodService.findCurrentPeriodsByUnit(
+ {
+ workspaceId: usageLimit.workspaceId,
+ periodUnits: [
+ usageLimit.periodUnit,
+ ...quotaLimitDefaults.map(
+ (quotaLimitDefault) => quotaLimitDefault.periodUnit,
+ ),
+ ],
+ },
+ );
+
+ const period = periodByUnit[usageLimit.periodUnit];
+
+ const keys = [
+ ...(isDefined(period)
+ ? [
+ buildQuotaCounterKey({
+ workspaceId: usageLimit.workspaceId,
+ resourceType: usageLimit.resourceType,
+ operationType: usageLimit.operationType,
+ spenderType: usageLimit.spenderType,
+ spenderId: usageLimit.spenderId,
+ meter: usageLimit.meter,
+ periodUnit: usageLimit.periodUnit,
+ periodStart: period.periodStart,
+ }),
+ ]
+ : []),
+ ...buildOverriddenQuotaDefaultCounterKeys({
+ usageLimit,
+ quotaLimitDefaults,
+ periodByUnit,
+ }),
+ ];
+
+ if (keys.length === 0) {
return;
}
await this.delUnderWarmLock({
workspaceId: usageLimit.workspaceId,
- keys: [
- buildQuotaCounterKey({
- workspaceId: usageLimit.workspaceId,
- resourceType: usageLimit.resourceType,
- operationType: usageLimit.operationType,
- spenderType: usageLimit.spenderType,
- spenderId: usageLimit.spenderId,
- meter: usageLimit.meter,
- periodUnit: usageLimit.periodUnit,
- periodStart: period.periodStart,
- }),
- ],
+ keys,
});
}
@@ -285,7 +313,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
}
const periodByUnit = await this.usagePeriodService.findCurrentPeriodsByUnit(
- { workspaceId, limits },
+ { workspaceId, periodUnits: limits.map((limit) => limit.periodUnit) },
);
const entries = limits.filter(isQuotaLimit).flatMap((limit) => {
@@ -369,9 +397,10 @@ export class UsageLimitQuotaService implements OnModuleInit {
);
}
- private async findExhaustedScopesAdmittingOnFailure(
- args: QuotaConsumeArgs,
- ): Promise<ExhaustedScope[]> {
+ private async findExhaustedScopesAdmittingOnFailure({
+ cost,
+ ...args
+ }: QuotaConsumeArgs & { cost?: QuotaCost }): Promise<ExhaustedScope[]> {
try {
const counters = await this.buildCounters(args);
@@ -388,6 +417,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
args,
counters,
remainings,
+ cost,
});
} catch (error) {
return this.admitOnFailure({
@@ -446,12 +476,18 @@ export class UsageLimitQuotaService implements OnModuleInit {
args,
counters,
remainings,
+ cost,
}: {
args: QuotaConsumeArgs;
counters: QuotaCounter[];
remainings: (number | null)[];
+ cost?: QuotaCost;
}): Promise<ExhaustedScope[]> {
- const exhaustedCounters = findExhaustedCounters({ counters, remainings });
+ const exhaustedCounters = findExhaustedCounters({
+ counters,
+ remainings,
+ cost,
+ });
if (exhaustedCounters.length === 0) {
return [];
@@ -549,27 +585,55 @@ export class UsageLimitQuotaService implements OnModuleInit {
return [];
}
+ const quotaLimitDefaults = this.buildQuotaLimitDefaults(resourceType);
+
const quotaLimits = await this.findQuotaLimits({
workspaceId,
resourceType,
});
- if (quotaLimits.length === 0) {
+ if (quotaLimits.length === 0 && quotaLimitDefaults.length === 0) {
return [];
}
return buildQuotaCounters({
limits: quotaLimits,
+ quotaLimitDefaults,
usageSpenders: spenders,
workspaceId,
operationType,
periodByUnit: await this.usagePeriodService.findCurrentPeriodsByUnit({
workspaceId,
- limits: quotaLimits,
+ periodUnits: [
+ ...quotaLimits.map((limit) => limit.periodUnit),
+ ...quotaLimitDefaults.map(
+ (quotaLimitDefault) => quotaLimitDefault.periodUnit,
+ ),
+ ],
}),
});
}
+ private buildQuotaLimitDefaults(
+ resourceType: UsageResourceType,
+ ): QuotaLimitDefault[] {
+ if (!this.twentyConfigService.get('CLICKHOUSE_URL')) {
+ return [];
+ }
+
+ const definition = findUsageLimitDefinition({
+ resourceType,
+ limitKind: 'quota',
+ });
+
+ return (definition?.defaults ?? []).map(
+ ({ limitValueConfigVariable, ...quotaLimitDefaultDefinition }) => ({
+ ...quotaLimitDefaultDefinition,
+ limitValue: this.twentyConfigService.get(limitValueConfigVariable),
+ }),
+ );
+ }
+
private async buildAllowanceCounter(
workspaceId: string,
): Promise<AllowanceQuotaCounter | null> {
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-period.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-period.service.ts
index 10fc04e779f..033cfec5159 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-period.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-period.service.ts
@@ -8,7 +8,6 @@ import { assertUnreachable, isDefined } from 'twenty-shared/utils';
import { type CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/interfaces/credit-allowance-provider.service';
import { type AnchoredPeriodUnit } from 'src/engine/core-modules/usage-limit/types/anchored-period-unit.type';
import { type CalendarPeriodUnit } from 'src/engine/core-modules/usage-limit/types/calendar-period-unit.type';
-import { type FlatUsageLimit } from 'src/engine/core-modules/usage-limit/types/flat-usage-limit.type';
import { type PeriodUnit } from 'src/engine/core-modules/usage-limit/types/period-unit.type';
import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
import { findCreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/utils/find-credit-allowance-provider.util';
@@ -51,19 +50,17 @@ export class UsagePeriodService implements OnModuleInit {
async findCurrentPeriodsByUnit({
workspaceId,
- limits,
+ periodUnits,
}: {
workspaceId: string;
- limits: FlatUsageLimit[];
+ periodUnits: PeriodUnit[];
}): Promise<Partial<Record<PeriodUnit, UsagePeriod>>> {
- const periodUnits = [
- ...new Set(
- limits.map((limit) => limit.periodUnit).filter(isAnchoredPeriodUnit),
- ),
+ const anchoredPeriodUnits = [
+ ...new Set(periodUnits.filter(isAnchoredPeriodUnit)),
];
const periods = await Promise.all(
- periodUnits.map(async (periodUnit) => ({
+ anchoredPeriodUnits.map(async (periodUnit) => ({
periodUnit,
period: await this.findCurrentPeriod({ workspaceId, periodUnit }),
})),
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/limit-quota-counter.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/limit-quota-counter.type.ts
index a7f7d07d8a7..6da7fa42efa 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/types/limit-quota-counter.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/limit-quota-counter.type.ts
@@ -6,6 +6,7 @@ import { type UsageResourceType } from 'src/engine/core-modules/usage/enums/usag
export type LimitQuotaCounter = {
kind: 'limit';
+ isDefault: boolean;
key: string;
limitValue: number;
meter: QuotaMeter;
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-default-key-scope.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-default-key-scope.type.ts
new file mode 100644
index 00000000000..63f4358a2e4
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-default-key-scope.type.ts
@@ -0,0 +1,16 @@
+import { type PeriodUnit } from 'src/engine/core-modules/usage-limit/types/period-unit.type';
+import { type QuotaMeter } from 'src/engine/core-modules/usage-limit/types/quota-meter.type';
+import { type SpenderType } from 'src/engine/core-modules/usage-limit/types/spender-type.type';
+import { type UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
+import { type UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
+
+export type QuotaDefaultKeyScope = {
+ workspaceId: string;
+ resourceType: UsageResourceType;
+ operationType: UsageOperationType;
+ spenderType: SpenderType;
+ spenderId?: string | null;
+ meter: QuotaMeter;
+ periodUnit: PeriodUnit;
+ periodStart: Date;
+};
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type.ts
new file mode 100644
index 00000000000..27eeaeb6675
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type.ts
@@ -0,0 +1,21 @@
+import { type NumericConfigVariableKey } from 'src/engine/core-modules/twenty-config/types/numeric-config-variable-key.type';
+import { type AnchoredPeriodUnit } from 'src/engine/core-modules/usage-limit/types/anchored-period-unit.type';
+import { type QuotaMeter } from 'src/engine/core-modules/usage-limit/types/quota-meter.type';
+import { type SpenderType } from 'src/engine/core-modules/usage-limit/types/spender-type.type';
+import { type UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
+import { type UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
+
+export type QuotaLimitDefaultDefinition<
+ TResourceType extends UsageResourceType = UsageResourceType,
+> = {
+ resourceType: TResourceType;
+ operationType: UsageOperationType;
+ limitKind: 'quota';
+ spenderType: SpenderType;
+ spenderId: '';
+ meter: QuotaMeter;
+ periodUnit: AnchoredPeriodUnit;
+ periodCount: 1;
+ limitValueConfigVariable: NumericConfigVariableKey;
+ isOverridable: boolean;
+};
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default.type.ts
new file mode 100644
index 00000000000..7ef8e92979c
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/quota-limit-default.type.ts
@@ -0,0 +1,8 @@
+import { type QuotaLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type';
+
+export type QuotaLimitDefault = Omit<
+ QuotaLimitDefaultDefinition,
+ 'limitValueConfigVariable'
+> & {
+ limitValue: number;
+};
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-default-definition.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-default-definition.type.ts
index a4c2fb92927..a7f4d6c8fe5 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-default-definition.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-default-definition.type.ts
@@ -1,6 +1,8 @@
+import { type QuotaLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type';
import { type SpeedLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/speed-limit-default-definition.type';
import { type StockLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/stock-limit-default-definition.type';
export type UsageLimitDefaultDefinition =
| SpeedLimitDefaultDefinition
+ | QuotaLimitDefaultDefinition
| StockLimitDefaultDefinition;
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-definition.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-definition.type.ts
index 3888e5b7594..397a703bf81 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-definition.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/usage-limit-definition.type.ts
@@ -1,3 +1,4 @@
+import { type QuotaLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/quota-limit-default-definition.type';
import { type QuotaMeter } from 'src/engine/core-modules/usage-limit/types/quota-meter.type';
import { type SpeedLimitDefaultDefinition } from 'src/engine/core-modules/usage-limit/types/speed-limit-default-definition.type';
import { type SpenderType } from 'src/engine/core-modules/usage-limit/types/spender-type.type';
@@ -12,10 +13,11 @@ type SpeedLimitDefinition<TResourceType extends UsageResourceType> = {
defaults: SpeedLimitDefaultDefinition<TResourceType>[];
};
-type QuotaLimitDefinition = {
+type QuotaLimitDefinition<TResourceType extends UsageResourceType> = {
allowedOperationTypes: UsageOperationType[];
allowedSpenderTypes: SpenderType[];
allowedMeters: QuotaMeter[];
+ defaults: QuotaLimitDefaultDefinition<TResourceType>[];
};
type StockLimitDefinition<TResourceType extends UsageResourceType> = {
@@ -29,7 +31,7 @@ export type UsageLimitDefinitions<
TResourceType extends UsageResourceType = UsageResourceType,
> = {
speed?: SpeedLimitDefinition<TResourceType>;
- quota?: QuotaLimitDefinition;
+ quota?: QuotaLimitDefinition<TResourceType>;
stock?: StockLimitDefinition<TResourceType>;
};
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-limit-warmed-entries.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-limit-warmed-entries.util.spec.ts
index b0aca173fb7..43a43146e49 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-limit-warmed-entries.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-limit-warmed-entries.util.spec.ts
@@ -11,6 +11,7 @@ const buildCounter = (
overrides: Partial<LimitQuotaCounter> = {},
): LimitQuotaCounter => ({
kind: 'limit',
+ isDefault: false,
key: 'counter-key',
limitValue: 1_000,
meter: 'creditsUsedMicro',
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-overridden-quota-default-counter-keys.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-overridden-quota-default-counter-keys.util.spec.ts
new file mode 100644
index 00000000000..19824a59085
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-overridden-quota-default-counter-keys.util.spec.ts
@@ -0,0 +1,91 @@
+import { type PeriodUnit } from 'src/engine/core-modules/usage-limit/types/period-unit.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
+import { type UsageLimitCounterScope } from 'src/engine/core-modules/usage-limit/types/usage-limit-counter-scope.type';
+import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
+import { buildOverriddenQuotaDefaultCounterKeys } from 'src/engine/core-modules/usage-limit/utils/build-overridden-quota-default-counter-keys.util';
+import { UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
+import { UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
+
+const DAY_PERIOD = {
+ periodStart: new Date('2026-08-20T00:00:00.000Z'),
+ periodEnd: new Date('2026-08-21T00:00:00.000Z'),
+};
+
+const DEFAULT_COUNTER_KEY = `{workspace-1}:quota:EMAIL:EMAIL_SEND:workspace:-:quantity:day:${DAY_PERIOD.periodStart.getTime()}:default:1000`;
+
+const buildUsageLimit = (
+ overrides: Partial<UsageLimitCounterScope> = {},
+): UsageLimitCounterScope => ({
+ workspaceId: 'workspace-1',
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ spenderType: 'workspace',
+ spenderId: '',
+ limitKind: 'quota',
+ periodUnit: 'day',
+ meter: 'quantity',
+ ...overrides,
+});
+
+const buildDefault = (
+ overrides: Partial<QuotaLimitDefault> = {},
+): QuotaLimitDefault => ({
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ limitKind: 'quota',
+ spenderType: 'workspace',
+ spenderId: '',
+ meter: 'quantity',
+ periodUnit: 'day',
+ periodCount: 1,
+ isOverridable: true,
+ limitValue: 1_000,
+ ...overrides,
+});
+
+const buildKeys = ({
+ usageLimit = buildUsageLimit(),
+ quotaLimitDefaults = [buildDefault()],
+ periodByUnit = { day: DAY_PERIOD },
+}: {
+ usageLimit?: UsageLimitCounterScope;
+ quotaLimitDefaults?: QuotaLimitDefault[];
+ periodByUnit?: Partial<Record<PeriodUnit, UsagePeriod>>;
+} = {}) =>
+ buildOverriddenQuotaDefaultCounterKeys({
+ usageLimit,
+ quotaLimitDefaults,
+ periodByUnit,
+ });
+
+describe('buildOverriddenQuotaDefaultCounterKeys', () => {
+ it('keys the default counter the row suppresses', () => {
+ expect(buildKeys()).toEqual([DEFAULT_COUNTER_KEY]);
+ });
+
+ it('keys it whatever period the row itself spans', () => {
+ expect(
+ buildKeys({ usageLimit: buildUsageLimit({ periodUnit: 'month' }) }),
+ ).toEqual([DEFAULT_COUNTER_KEY]);
+ });
+
+ it.each([
+ { spenderType: 'userWorkspace' as const },
+ { meter: 'creditsUsedMicro' as const },
+ { operationType: UsageOperationType.ALL },
+ ])('leaves a default on another scope alone: %j', (overrides) => {
+ expect(buildKeys({ usageLimit: buildUsageLimit(overrides) })).toEqual([]);
+ });
+
+ it('leaves a default no row can suppress alone', () => {
+ expect(
+ buildKeys({
+ quotaLimitDefaults: [buildDefault({ isOverridable: false })],
+ }),
+ ).toEqual([]);
+ });
+
+ it('skips a default whose period was not resolved', () => {
+ expect(buildKeys({ periodByUnit: {} })).toEqual([]);
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-counters.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-counters.util.spec.ts
index c293df28367..4d6f5cf09d6 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-counters.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-counters.util.spec.ts
@@ -1,4 +1,5 @@
import { type FlatQuotaLimit } from 'src/engine/core-modules/usage-limit/types/flat-quota-limit.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
import { buildQuotaCounters } from 'src/engine/core-modules/usage-limit/utils/build-quota-counters.util';
import { UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
import { UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
@@ -29,9 +30,32 @@ const buildLimit = (overrides: Partial<FlatQuotaLimit>): FlatQuotaLimit => ({
...overrides,
});
-const buildCounters = ({ limits }: { limits: FlatQuotaLimit[] }) =>
+const buildDefault = (
+ overrides: Partial<QuotaLimitDefault> = {},
+): QuotaLimitDefault => ({
+ resourceType: UsageResourceType.AI,
+ operationType: UsageOperationType.AI_CHAT_TOKEN,
+ limitKind: 'quota',
+ spenderType: 'workspace',
+ spenderId: '',
+ meter: 'creditsUsedMicro',
+ periodUnit: 'month',
+ periodCount: 1,
+ isOverridable: true,
+ limitValue: 5_000,
+ ...overrides,
+});
+
+const buildCounters = ({
+ limits = [],
+ quotaLimitDefaults = [],
+}: {
+ limits?: FlatQuotaLimit[];
+ quotaLimitDefaults?: QuotaLimitDefault[];
+}) =>
buildQuotaCounters({
limits,
+ quotaLimitDefaults,
usageSpenders: { userWorkspaceId: 'user-1' },
workspaceId: 'workspace-1',
operationType: UsageOperationType.AI_CHAT_TOKEN,
@@ -47,6 +71,7 @@ describe('buildQuotaCounters', () => {
expect(counters).toEqual([
{
kind: 'limit',
+ isDefault: false,
key: `{workspace-1}:quota:AI:AI_CHAT_TOKEN:workspace:-:creditsUsedMicro:month:${MONTH_PERIOD.periodStart.getTime()}`,
limitValue: 1_000_000,
meter: 'creditsUsedMicro',
@@ -132,4 +157,109 @@ describe('buildQuotaCounters', () => {
expect(counters).toEqual([]);
});
+
+ it('caps the workspace with the default when no limit is stored', () => {
+ const counters = buildCounters({
+ quotaLimitDefaults: [buildDefault()],
+ });
+
+ expect(counters).toEqual([
+ {
+ kind: 'limit',
+ isDefault: true,
+ key: `{workspace-1}:quota:AI:AI_CHAT_TOKEN:workspace:-:creditsUsedMicro:month:${MONTH_PERIOD.periodStart.getTime()}:default:5000`,
+ limitValue: 5_000,
+ meter: 'creditsUsedMicro',
+ resourceType: UsageResourceType.AI,
+ periodUnit: 'month',
+ periodStart: MONTH_PERIOD.periodStart,
+ periodEnd: MONTH_PERIOD.periodEnd,
+ spenderType: 'workspace',
+ spenderId: null,
+ operationType: UsageOperationType.AI_CHAT_TOKEN,
+ },
+ ]);
+ });
+
+ it.each([500, 50_000])(
+ 'overrides the default with a workspace limit of %i',
+ (limitValue) => {
+ const counters = buildCounters({
+ limits: [buildLimit({ limitValue })],
+ quotaLimitDefaults: [buildDefault()],
+ });
+
+ expect(counters).toEqual([
+ expect.objectContaining({ isDefault: false, limitValue }),
+ ]);
+ },
+ );
+
+ it('keeps a non-overridable default alongside a stored limit', () => {
+ const counters = buildCounters({
+ limits: [buildLimit({})],
+ quotaLimitDefaults: [buildDefault({ isOverridable: false })],
+ });
+
+ expect(counters.map((counter) => counter.isDefault)).toEqual([false, true]);
+ expect(new Set(counters.map((counter) => counter.key)).size).toBe(2);
+ });
+
+ it.each([
+ { spenderType: 'userWorkspace' as const, spenderId: 'user-1' },
+ { meter: 'quantity' as const },
+ ])('preserves the default for a different scope: %j', (overrides) => {
+ const counters = buildCounters({
+ limits: [buildLimit(overrides)],
+ quotaLimitDefaults: [buildDefault()],
+ });
+
+ expect(counters.map((counter) => counter.isDefault)).toEqual([false, true]);
+ });
+
+ it('skips a default whose period was not resolved', () => {
+ const counters = buildCounters({
+ quotaLimitDefaults: [buildDefault({ periodUnit: 'day' })],
+ });
+
+ expect(counters).toEqual([]);
+ });
+
+ it('ignores a default for a spender type absent from the call', () => {
+ const counters = buildCounters({
+ quotaLimitDefaults: [buildDefault({ spenderType: 'apiKey' })],
+ });
+
+ expect(counters).toEqual([]);
+ });
+
+ it('preserves the default against a row scoped to every operation', () => {
+ const counters = buildCounters({
+ limits: [buildLimit({ operationType: UsageOperationType.ALL })],
+ quotaLimitDefaults: [buildDefault()],
+ });
+
+ expect(counters.map((counter) => counter.isDefault)).toEqual([true, false]);
+ });
+
+ it('ignores a default declared on another operation', () => {
+ const counters = buildCounters({
+ quotaLimitDefaults: [
+ buildDefault({ operationType: UsageOperationType.WEB_SEARCH }),
+ ],
+ });
+
+ expect(counters).toEqual([]);
+ });
+
+ it('overrides the default whatever period the stored limit spans', () => {
+ const counters = buildCounters({
+ limits: [buildLimit({ periodUnit: 'week' })],
+ quotaLimitDefaults: [buildDefault()],
+ });
+
+ expect(counters).toEqual([
+ expect.objectContaining({ isDefault: false, periodUnit: 'week' }),
+ ]);
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-exhausted-scope.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-exhausted-scope.util.spec.ts
index 477ad11a318..2b9577c5529 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-exhausted-scope.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/build-quota-exhausted-scope.util.spec.ts
@@ -12,6 +12,7 @@ const buildLimitCounter = (
overrides: Partial<LimitQuotaCounter> = {},
): LimitQuotaCounter => ({
kind: 'limit',
+ isDefault: false,
key: 'counter-key',
limitValue: 1_000,
meter: 'creditsUsedMicro',
@@ -61,9 +62,20 @@ describe('buildQuotaExhaustedScope', () => {
periodCount: 1,
periodUnit: 'month',
retryAfterMs: PERIOD_END.getTime() - NOW.getTime(),
+ isDefault: false,
});
});
+ it('marks a scope built from a default counter', () => {
+ expect(
+ buildQuotaExhaustedScope({
+ resourceType: UsageResourceType.AI,
+ counter: buildLimitCounter({ isDefault: true }),
+ allowance: null,
+ }),
+ ).toMatchObject({ exhaustedKind: 'limit', isDefault: true });
+ });
+
it('scopes an exhausted allowance counter to the whole workspace', () => {
expect(
buildQuotaExhaustedScope({
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/compute-quota-consumed.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/compute-quota-consumed.util.spec.ts
index c68aad76103..5c3f8398162 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/compute-quota-consumed.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/compute-quota-consumed.util.spec.ts
@@ -23,6 +23,7 @@ const buildCounter = (
overrides: Partial<LimitQuotaCounter>,
): LimitQuotaCounter => ({
kind: 'limit',
+ isDefault: false,
key: 'counter-key',
limitValue: 1_000,
meter: 'creditsUsedMicro',
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-exhausted-counters.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-exhausted-counters.util.spec.ts
index b45c1fff588..691083c96bb 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-exhausted-counters.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-exhausted-counters.util.spec.ts
@@ -1,19 +1,43 @@
import { type AllowanceQuotaCounter } from 'src/engine/core-modules/usage-limit/types/allowance-quota-counter.type';
+import { type LimitQuotaCounter } from 'src/engine/core-modules/usage-limit/types/limit-quota-counter.type';
import { findExhaustedCounters } from 'src/engine/core-modules/usage-limit/utils/find-exhausted-counters.util';
+import { UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
+import { UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-resource-type.enum';
-const buildCounter = (key: string): AllowanceQuotaCounter => ({
+const PERIOD_START = new Date('2026-08-01T00:00:00.000Z');
+const PERIOD_END = new Date('2026-09-01T00:00:00.000Z');
+
+const buildAllowanceCounter = (key: string): AllowanceQuotaCounter => ({
kind: 'allowance',
key,
meter: 'creditsUsedMicro',
- periodStart: new Date('2026-08-01T00:00:00.000Z'),
- periodEnd: new Date('2026-09-01T00:00:00.000Z'),
+ periodStart: PERIOD_START,
+ periodEnd: PERIOD_END,
+});
+
+const buildLimitCounter = (key: string): LimitQuotaCounter => ({
+ kind: 'limit',
+ isDefault: false,
+ key,
+ limitValue: 1_000,
+ meter: 'creditsUsedMicro',
+ resourceType: UsageResourceType.AI,
+ operationType: UsageOperationType.AI_CHAT_TOKEN,
+ periodUnit: 'month',
+ periodStart: PERIOD_START,
+ periodEnd: PERIOD_END,
+ spenderType: 'workspace',
+ spenderId: null,
});
describe('findExhaustedCounters', () => {
it('answers empty when every counter has budget left', () => {
expect(
findExhaustedCounters({
- counters: [buildCounter('first'), buildCounter('second')],
+ counters: [
+ buildAllowanceCounter('first'),
+ buildAllowanceCounter('second'),
+ ],
remainings: [250, 1],
}),
).toEqual([]);
@@ -23,9 +47,9 @@ describe('findExhaustedCounters', () => {
expect(
findExhaustedCounters({
counters: [
- buildCounter('first'),
- buildCounter('second'),
- buildCounter('third'),
+ buildAllowanceCounter('first'),
+ buildAllowanceCounter('second'),
+ buildAllowanceCounter('third'),
],
remainings: [0, 100, 0],
}),
@@ -35,7 +59,7 @@ describe('findExhaustedCounters', () => {
it('counts an overdrawn counter as exhausted', () => {
expect(
findExhaustedCounters({
- counters: [buildCounter('first')],
+ counters: [buildAllowanceCounter('first')],
remainings: [-10],
}),
).toMatchObject([{ key: 'first' }]);
@@ -44,7 +68,10 @@ describe('findExhaustedCounters', () => {
it('skips cold counters', () => {
expect(
findExhaustedCounters({
- counters: [buildCounter('first'), buildCounter('second')],
+ counters: [
+ buildAllowanceCounter('first'),
+ buildAllowanceCounter('second'),
+ ],
remainings: [null, 0],
}),
).toMatchObject([{ key: 'second' }]);
@@ -53,9 +80,79 @@ describe('findExhaustedCounters', () => {
it('answers empty when every counter is cold', () => {
expect(
findExhaustedCounters({
- counters: [buildCounter('first')],
+ counters: [buildAllowanceCounter('first')],
remainings: [null],
}),
).toEqual([]);
});
+
+ it('refuses a limit that cannot cover the named cost', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildLimitCounter('first')],
+ remainings: [100],
+ cost: { creditsUsedMicro: 101, quantity: 0 },
+ }),
+ ).toMatchObject([{ key: 'first' }]);
+ });
+
+ it('admits a cost that fits the remaining exactly', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildLimitCounter('first')],
+ remainings: [100],
+ cost: { creditsUsedMicro: 100, quantity: 0 },
+ }),
+ ).toEqual([]);
+ });
+
+ it('charges a limit only for the meter it counts', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildLimitCounter('first')],
+ remainings: [10],
+ cost: { creditsUsedMicro: 0, quantity: 500 },
+ }),
+ ).toEqual([]);
+ });
+
+ it('still refuses an emptied limit whatever the cost', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildLimitCounter('first')],
+ remainings: [0],
+ cost: { creditsUsedMicro: 0, quantity: 0 },
+ }),
+ ).toMatchObject([{ key: 'first' }]);
+ });
+
+ it('refuses a credit allowance that cannot cover the whole cost', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildAllowanceCounter('allowance')],
+ remainings: [10],
+ cost: { creditsUsedMicro: 5_000, quantity: 100 },
+ }),
+ ).toMatchObject([{ key: 'allowance' }]);
+ });
+
+ it('admits a credit allowance holding exactly the whole cost', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildAllowanceCounter('allowance')],
+ remainings: [5_000],
+ cost: { creditsUsedMicro: 5_000, quantity: 100 },
+ }),
+ ).toEqual([]);
+ });
+
+ it('still refuses an emptied credit allowance under a named cost', () => {
+ expect(
+ findExhaustedCounters({
+ counters: [buildAllowanceCounter('allowance')],
+ remainings: [0],
+ cost: { creditsUsedMicro: 5_000, quantity: 100 },
+ }),
+ ).toMatchObject([{ key: 'allowance' }]);
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-suppressed-usage-limit-defaults.util.spec.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-suppressed-usage-limit-defaults.util.spec.ts
index 38c12efe8af..e3ca2fd32b6 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-suppressed-usage-limit-defaults.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/__tests__/find-suppressed-usage-limit-defaults.util.spec.ts
@@ -37,6 +37,21 @@ const buildStockScope = (
...overrides,
});
+const buildQuotaScope = (
+ overrides: Partial<UsageLimitScope> = {},
+): UsageLimitScope =>
+ buildUsageLimitScope({
+ resourceType: UsageResourceType.EMAIL,
+ operationType: UsageOperationType.EMAIL_SEND,
+ spenderType: 'workspace',
+ spenderId: '',
+ limitKind: 'quota',
+ periodCount: 1,
+ periodUnit: 'day',
+ meter: 'quantity',
+ ...overrides,
+ });
+
describe('findSuppressedUsageLimitDefaults', () => {
it('returns only the overridable default when a resource declares one of each', () => {
const suppressed = findSuppressedUsageLimitDefaults(buildSpeedScope());
@@ -119,6 +134,32 @@ describe('findSuppressedUsageLimitDefaults', () => {
expect(suppressionKeysWithTwoDefaults).toEqual([]);
});
+ it('replaces the email quota default whatever period the row names', () => {
+ const suppressed = findSuppressedUsageLimitDefaults(
+ buildQuotaScope({ periodUnit: 'month', periodCount: 3 }),
+ );
+
+ expect(suppressed.map((entry) => entry.limitValueConfigVariable)).toEqual([
+ 'EMAIL_SEND_WORKSPACE_DAILY_LIMIT',
+ ]);
+ });
+
+ it('leaves the email quota default alone for a row on every operation', () => {
+ expect(
+ findSuppressedUsageLimitDefaults(
+ buildQuotaScope({ operationType: UsageOperationType.ALL }),
+ ),
+ ).toEqual([]);
+ });
+
+ it('leaves the email quota default alone for the speed kind', () => {
+ expect(
+ findSuppressedUsageLimitDefaults(
+ buildQuotaScope({ limitKind: 'speed', periodUnit: 'second' }),
+ ).map((entry) => entry.limitKind),
+ ).toEqual(['speed']);
+ });
+
it('returns nothing for a resource that declares no default', () => {
expect(
findSuppressedUsageLimitDefaults(
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util.ts
index 5eb968409d2..1e9ac091fef 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util.ts
@@ -17,6 +17,7 @@ export const buildLimitQuotaCounter = ({
period: UsagePeriod;
}): LimitQuotaCounter => ({
kind: 'limit',
+ isDefault: false,
key: buildQuotaCounterKey({
workspaceId,
resourceType: limit.resourceType,
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-overridden-quota-default-counter-keys.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-overridden-quota-default-counter-keys.util.ts
new file mode 100644
index 00000000000..bf8c9b365b6
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-overridden-quota-default-counter-keys.util.ts
@@ -0,0 +1,46 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type PeriodUnit } from 'src/engine/core-modules/usage-limit/types/period-unit.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
+import { type UsageLimitCounterScope } from 'src/engine/core-modules/usage-limit/types/usage-limit-counter-scope.type';
+import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
+import { buildQuotaDefaultCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util';
+import { doesUsageLimitRowSuppressDefault } from 'src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util';
+
+export const buildOverriddenQuotaDefaultCounterKeys = ({
+ usageLimit,
+ quotaLimitDefaults,
+ periodByUnit,
+}: {
+ usageLimit: UsageLimitCounterScope;
+ quotaLimitDefaults: QuotaLimitDefault[];
+ periodByUnit: Partial<Record<PeriodUnit, UsagePeriod>>;
+}): string[] =>
+ quotaLimitDefaults
+ .filter((quotaLimitDefault) =>
+ doesUsageLimitRowSuppressDefault({
+ scope: usageLimit,
+ usageLimitDefault: quotaLimitDefault,
+ }),
+ )
+ .flatMap((quotaLimitDefault) => {
+ const period = periodByUnit[quotaLimitDefault.periodUnit];
+
+ if (!isDefined(period)) {
+ return [];
+ }
+
+ return [
+ buildQuotaDefaultCounterKey({
+ workspaceId: usageLimit.workspaceId,
+ resourceType: quotaLimitDefault.resourceType,
+ operationType: quotaLimitDefault.operationType,
+ spenderType: quotaLimitDefault.spenderType,
+ spenderId: quotaLimitDefault.spenderId,
+ meter: quotaLimitDefault.meter,
+ periodUnit: quotaLimitDefault.periodUnit,
+ periodStart: period.periodStart,
+ limitValue: quotaLimitDefault.limitValue,
+ }),
+ ];
+ });
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-counters.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-counters.util.ts
index 38a9c9c6330..acd782ef955 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-counters.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-counters.util.ts
@@ -4,8 +4,11 @@ import { SPENDER_TYPE_SPECIFICITY } from 'src/engine/core-modules/usage-limit/co
import { type FlatQuotaLimit } from 'src/engine/core-modules/usage-limit/types/flat-quota-limit.type';
import { type PeriodUnit } from 'src/engine/core-modules/usage-limit/types/period-unit.type';
import { type LimitQuotaCounter } from 'src/engine/core-modules/usage-limit/types/limit-quota-counter.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
import { buildLimitQuotaCounter } from 'src/engine/core-modules/usage-limit/utils/build-limit-quota-counter.util';
+import { buildQuotaDefaultCounter } from 'src/engine/core-modules/usage-limit/utils/build-quota-default-counter.util';
import { buildSpendersFromUsageSpenders } from 'src/engine/core-modules/usage-limit/utils/build-spenders-from-usage-spenders.util';
+import { doesUsageLimitRowSuppressDefault } from 'src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util';
import { findLimitsForSpender } from 'src/engine/core-modules/usage-limit/utils/find-limits-for-spender.util';
import { UsageOperationType } from 'src/engine/core-modules/usage/enums/usage-operation-type.enum';
import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
@@ -18,12 +21,14 @@ const counterSpecificity = (counter: LimitQuotaCounter): number =>
export const buildQuotaCounters = ({
limits,
+ quotaLimitDefaults,
usageSpenders,
workspaceId,
operationType,
periodByUnit,
}: {
limits: FlatQuotaLimit[];
+ quotaLimitDefaults: QuotaLimitDefault[];
usageSpenders: UsageSpenders;
workspaceId: string;
operationType: UsageOperationType;
@@ -31,7 +36,7 @@ export const buildQuotaCounters = ({
}): LimitQuotaCounter[] => {
const spenders = buildSpendersFromUsageSpenders(usageSpenders);
- const counters = spenders.flatMap((spender) =>
+ const limitCounters = spenders.flatMap((spender) =>
findLimitsForSpender({ limits, spender, operationType }).flatMap(
(limit) => {
const period = periodByUnit[limit.periodUnit];
@@ -45,5 +50,29 @@ export const buildQuotaCounters = ({
),
);
- return counters.sort((a, b) => counterSpecificity(a) - counterSpecificity(b));
+ const spenderTypes = new Set(spenders.map((spender) => spender.spenderType));
+
+ const defaultCounters = quotaLimitDefaults
+ .filter(
+ (quotaLimitDefault) =>
+ quotaLimitDefault.operationType === operationType &&
+ spenderTypes.has(quotaLimitDefault.spenderType) &&
+ !limits.some((limit) =>
+ doesUsageLimitRowSuppressDefault({
+ scope: limit,
+ usageLimitDefault: quotaLimitDefault,
+ }),
+ ),
+ )
+ .flatMap((quotaLimitDefault) => {
+ const period = periodByUnit[quotaLimitDefault.periodUnit];
+
+ return isDefined(period)
+ ? [buildQuotaDefaultCounter({ workspaceId, quotaLimitDefault, period })]
+ : [];
+ });
+
+ return [...limitCounters, ...defaultCounters].sort(
+ (a, b) => counterSpecificity(a) - counterSpecificity(b),
+ );
};
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util.ts
new file mode 100644
index 00000000000..a3b943d3218
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util.ts
@@ -0,0 +1,8 @@
+import { type QuotaDefaultKeyScope } from 'src/engine/core-modules/usage-limit/types/quota-default-key-scope.type';
+import { buildQuotaCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-counter-key.util';
+
+export const buildQuotaDefaultCounterKey = ({
+ limitValue,
+ ...scope
+}: QuotaDefaultKeyScope & { limitValue: number }): string =>
+ `${buildQuotaCounterKey(scope)}:default:${limitValue}`;
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter.util.ts
new file mode 100644
index 00000000000..ee79cbdc872
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-default-counter.util.ts
@@ -0,0 +1,37 @@
+import { type LimitQuotaCounter } from 'src/engine/core-modules/usage-limit/types/limit-quota-counter.type';
+import { type QuotaLimitDefault } from 'src/engine/core-modules/usage-limit/types/quota-limit-default.type';
+import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
+import { buildQuotaDefaultCounterKey } from 'src/engine/core-modules/usage-limit/utils/build-quota-default-counter-key.util';
+
+export const buildQuotaDefaultCounter = ({
+ workspaceId,
+ quotaLimitDefault,
+ period,
+}: {
+ workspaceId: string;
+ quotaLimitDefault: QuotaLimitDefault;
+ period: UsagePeriod;
+}): LimitQuotaCounter => ({
+ kind: 'limit',
+ isDefault: true,
+ key: buildQuotaDefaultCounterKey({
+ workspaceId,
+ resourceType: quotaLimitDefault.resourceType,
+ operationType: quotaLimitDefault.operationType,
+ spenderType: quotaLimitDefault.spenderType,
+ spenderId: quotaLimitDefault.spenderId,
+ meter: quotaLimitDefault.meter,
+ periodUnit: quotaLimitDefault.periodUnit,
+ periodStart: period.periodStart,
+ limitValue: quotaLimitDefault.limitValue,
+ }),
+ limitValue: quotaLimitDefault.limitValue,
+ meter: quotaLimitDefault.meter,
+ resourceType: quotaLimitDefault.resourceType,
+ periodUnit: quotaLimitDefault.periodUnit,
+ periodStart: period.periodStart,
+ periodEnd: period.periodEnd,
+ spenderType: quotaLimitDefault.spenderType,
+ spenderId: null,
+ operationType: quotaLimitDefault.operationType,
+});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-exhausted-scope.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-exhausted-scope.util.ts
index 1b6c475fe5f..10bcf5c847c 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-exhausted-scope.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/build-quota-exhausted-scope.util.ts
@@ -28,6 +28,7 @@ export const buildQuotaExhaustedScope = ({
periodCount: 1,
periodUnit: counter.periodUnit,
retryAfterMs,
+ isDefault: counter.isDefault,
};
}
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util.ts
index 105c9d1f693..1ba70447742 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/does-usage-limit-row-suppress-default.util.ts
@@ -6,7 +6,7 @@ export const doesUsageLimitRowSuppressDefault = ({
scope,
usageLimitDefault,
}: {
- scope: UsageLimitScope;
+ scope: SuppressibleScope;
usageLimitDefault: SuppressibleScope & { isOverridable: boolean };
}): boolean =>
usageLimitDefault.isOverridable &&
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-exhausted-counters.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-exhausted-counters.util.ts
index 07622c5ae0b..35178578eae 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-exhausted-counters.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-exhausted-counters.util.ts
@@ -1,16 +1,27 @@
import { isDefined } from 'twenty-shared/utils';
+import { type QuotaCost } from 'src/engine/core-modules/usage-limit/types/quota-cost.type';
import { type QuotaCounter } from 'src/engine/core-modules/usage-limit/types/quota-counter.type';
export const findExhaustedCounters = ({
counters,
remainings,
+ cost,
}: {
counters: QuotaCounter[];
remainings: (number | null)[];
+ cost?: QuotaCost;
}): QuotaCounter[] =>
- counters.filter((_, index) => {
+ counters.filter((counter, index) => {
const remaining = remainings[index];
- return isDefined(remaining) && remaining <= 0;
+ if (!isDefined(remaining)) {
+ return false;
+ }
+
+ if (remaining <= 0) {
+ return true;
+ }
+
+ return remaining < (cost?.[counter.meter] ?? 0);
});
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-defaults.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-defaults.util.ts
index 68ae9bf8d7e..2d9bf7a53dd 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-defaults.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-defaults.util.ts
@@ -8,8 +8,12 @@ export const findUsageLimitDefaults = ({
}: {
resourceType: UsageResourceType;
}): UsageLimitDefaultDefinition[] => {
- const { speed, stock }: UsageLimitDefinitions =
+ const { speed, quota, stock }: UsageLimitDefinitions =
USAGE_LIMIT_DEFINITIONS[resourceType];
- return [...(speed?.defaults ?? []), ...(stock?.defaults ?? [])];
+ return [
+ ...(speed?.defaults ?? []),
+ ...(quota?.defaults ?? []),
+ ...(stock?.defaults ?? []),
+ ];
};
diff --git a/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts b/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
index 77b6624fa99..7edbe79a371 100644
--- a/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
+++ b/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
@@ -87,6 +87,7 @@ export class EmailingSendResolver {
await this.emailBillingService.validateEmailSendOrThrow({
workspaceId: currentWorkspace.id,
spenders,
+ emailCount: countDeliveredRecipients(input),
});
const { emailingDomainId, ...content } = input;
diff --git a/packages/twenty-server/src/modules/emailing/services/email-billing.service.ts b/packages/twenty-server/src/modules/emailing/services/email-billing.service.ts
index 50c7d7f3937..b1f22fa1038 100644
--- a/packages/twenty-server/src/modules/emailing/services/email-billing.service.ts
+++ b/packages/twenty-server/src/modules/emailing/services/email-billing.service.ts
@@ -8,6 +8,7 @@ import { UsageResourceType } from 'src/engine/core-modules/usage/enums/usage-res
import { UsageUnit } from 'src/engine/core-modules/usage/enums/usage-unit.enum';
import { UsageRecorderService } from 'src/engine/core-modules/usage/services/usage-recorder.service';
import { type UsageSpenders } from 'src/engine/core-modules/usage/types/usage-spenders.type';
+import { buildEmailQuotaCost } from 'src/modules/emailing/utils/build-email-quota-cost.util';
import { computeEmailCreditsUsedMicro } from 'src/modules/emailing/utils/compute-email-credits-used-micro.util';
type EmailUsageScope = {
@@ -15,6 +16,8 @@ type EmailUsageScope = {
spenders: UsageSpenders;
};
+type EmailSendScope = EmailUsageScope & { emailCount?: number };
+
@Injectable()
export class EmailBillingService {
constructor(
@@ -26,24 +29,28 @@ export class EmailBillingService {
async validateEmailSendOrThrow({
workspaceId,
spenders,
- }: EmailUsageScope): Promise<void> {
+ emailCount,
+ }: EmailSendScope): Promise<void> {
await this.billingUsageService.assertUsageAllowed({
workspaceId,
resourceType: UsageResourceType.EMAIL,
operationType: UsageOperationType.EMAIL_SEND,
spenders,
+ cost: buildEmailQuotaCost(emailCount),
});
}
async findEmailSendRefusal({
workspaceId,
spenders,
- }: EmailUsageScope): Promise<UsageRefusal | null> {
+ emailCount,
+ }: EmailSendScope): Promise<UsageRefusal | null> {
return this.billingUsageService.findUsageRefusal({
workspaceId,
resourceType: UsageResourceType.EMAIL,
operationType: UsageOperationType.EMAIL_SEND,
spenders,
+ cost: buildEmailQuotaCost(emailCount),
});
}
diff --git a/packages/twenty-server/src/modules/emailing/services/message-campaign-batch-delivery.service.ts b/packages/twenty-server/src/modules/emailing/services/message-campaign-batch-delivery.service.ts
index c6fff21c537..8f88665f479 100644
--- a/packages/twenty-server/src/modules/emailing/services/message-campaign-batch-delivery.service.ts
+++ b/packages/twenty-server/src/modules/emailing/services/message-campaign-batch-delivery.service.ts
@@ -31,7 +31,6 @@ import { MessageCampaignStatisticsService } from 'src/modules/emailing/services/
import { MessageCampaignWorkspaceEntity } from 'src/modules/emailing/standard-objects/message-campaign.workspace-entity';
import { type EmailingDomainEmailTemplate } from 'src/engine/core-modules/emailing-domain/drivers/types/emailing-domain-email-template.type';
import { type CampaignDeliverySettlement } from 'src/modules/emailing/types/campaign-delivery-settlement.type';
-import { type UsageRefusal } from 'src/engine/core-modules/billing/types/usage-refusal.type';
import { buildCampaignBatchReplacements } from 'src/modules/emailing/utils/build-campaign-batch-replacements.util';
import { buildCampaignThreadExternalId } from 'src/modules/emailing/utils/build-campaign-thread-external-id.util';
import { getCampaignDeliveryTableName } from 'src/modules/emailing/utils/get-campaign-delivery-table-name.util';
@@ -76,11 +75,6 @@ export class MessageCampaignBatchDeliveryService {
await this.messageCampaignLifecycleService.findRunningCampaign(
campaignId,
);
- const sendRefusal = await this.emailBillingService.findEmailSendRefusal({
- workspaceId,
- spenders: { userWorkspaceId: data.userWorkspaceId },
- });
-
const claimToken = v4();
const claimedDeliveryIds = await this.claimBatch({
deliveryIds: data.recipients.map((recipient) => recipient.messageId),
@@ -100,7 +94,6 @@ export class MessageCampaignBatchDeliveryService {
await this.processClaimedBatch({
data,
campaign,
- sendRefusal,
claimToken,
claimedRecipients,
});
@@ -130,13 +123,11 @@ export class MessageCampaignBatchDeliveryService {
private async processClaimedBatch({
data,
campaign,
- sendRefusal,
claimToken,
claimedRecipients,
}: {
data: SendCampaignEmailBatchJobData;
campaign: MessageCampaignWorkspaceEntity | null;
- sendRefusal: UsageRefusal | null;
claimToken: string;
claimedRecipients: BatchRecipient[];
}): Promise<void> {
@@ -153,17 +144,6 @@ export class MessageCampaignBatchDeliveryService {
return;
}
- if (isDefined(sendRefusal)) {
- await this.settleWholeBatchAs({
- claimToken,
- recipients: claimedRecipients,
- state: CAMPAIGN_DELIVERY_STATE.SKIPPED,
- skipReason: CAMPAIGN_SKIP_REASON.OUT_OF_CREDITS,
- });
-
- return;
- }
-
// Suppressed recipients are resolved before the slots are asked for, so a
// batch full of unsubscribed addresses does not spend send capacity that
// the recipients it actually has could have used. This only sizes the
@@ -184,6 +164,26 @@ export class MessageCampaignBatchDeliveryService {
!blockedAddresses.has(recipient.email.trim().toLowerCase()),
).length;
+ const sendRefusal =
+ deliverableRecipientCount === 0
+ ? null
+ : await this.emailBillingService.findEmailSendRefusal({
+ workspaceId,
+ spenders: { userWorkspaceId: data.userWorkspaceId },
+ emailCount: deliverableRecipientCount,
+ });
+
+ if (isDefined(sendRefusal)) {
+ await this.settleWholeBatchAs({
+ claimToken,
+ recipients: claimedRecipients,
+ state: CAMPAIGN_DELIVERY_STATE.SKIPPED,
+ skipReason: CAMPAIGN_SKIP_REASON.OUT_OF_CREDITS,
+ });
+
+ return;
+ }
+
const sendSlotRefusal =
deliverableRecipientCount === 0
? null
diff --git a/packages/twenty-server/src/modules/emailing/utils/__tests__/build-email-quota-cost.util.spec.ts b/packages/twenty-server/src/modules/emailing/utils/__tests__/build-email-quota-cost.util.spec.ts
new file mode 100644
index 00000000000..be9ce82ebcd
--- /dev/null
+++ b/packages/twenty-server/src/modules/emailing/utils/__tests__/build-email-quota-cost.util.spec.ts
@@ -0,0 +1,22 @@
+import { buildEmailQuotaCost } from 'src/modules/emailing/utils/build-email-quota-cost.util';
+import { computeEmailCreditsUsedMicro } from 'src/modules/emailing/utils/compute-email-credits-used-micro.util';
+
+describe('buildEmailQuotaCost', () => {
+ it('names both meters a send will spend', () => {
+ expect(buildEmailQuotaCost(30)).toEqual({
+ quantity: 30,
+ creditsUsedMicro: computeEmailCreditsUsedMicro(30),
+ });
+ });
+
+ it('names no cost when the caller does not know the count', () => {
+ expect(buildEmailQuotaCost(undefined)).toBeUndefined();
+ });
+
+ it('names a zero cost rather than none for an empty send', () => {
+ expect(buildEmailQuotaCost(0)).toEqual({
+ quantity: 0,
+ creditsUsedMicro: 0,
+ });
+ });
+});
diff --git a/packages/twenty-server/src/modules/emailing/utils/build-email-quota-cost.util.ts b/packages/twenty-server/src/modules/emailing/utils/build-email-quota-cost.util.ts
new file mode 100644
index 00000000000..b0e23c2c18b
--- /dev/null
+++ b/packages/twenty-server/src/modules/emailing/utils/build-email-quota-cost.util.ts
@@ -0,0 +1,14 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type QuotaCost } from 'src/engine/core-modules/usage-limit/types/quota-cost.type';
+import { computeEmailCreditsUsedMicro } from 'src/modules/emailing/utils/compute-email-credits-used-micro.util';
+
+export const buildEmailQuotaCost = (
+ emailCount: number | undefined,
+): QuotaCost | undefined =>
+ isDefined(emailCount)
+ ? {
+ quantity: emailCount,
+ creditsUsedMicro: computeEmailCreditsUsedMicro(emailCount),
+ }
+ : undefined;