Skip to content

The open alternative to Salesforce, designed for AI.

feat(usage-limit): quota limits over the credit allowance period (#25526)

Etienne26c89a80858f
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/constants/period-units.constant.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/constants/period-units.constant.ts
index 0eed2f39ee2..483962c3099 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/constants/period-units.constant.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/constants/period-units.constant.ts
@@ -1 +1,7 @@
-export const PERIOD_UNITS = ['second', 'day', 'week', 'month'] as const;
+export const PERIOD_UNITS = [
+ 'second',
+ 'day',
+ 'week',
+ 'month',
+ 'allowancePeriod',
+] as const;
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 8df3cd09e7e..97382ad95a0 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
@@ -17,6 +17,8 @@ import { UsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-lim
import { UsageLimitEntitlementService } from 'src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service';
import { UsageLimitQuotaService } from 'src/engine/core-modules/usage-limit/services/usage-limit-quota.service';
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 { 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';
@@ -107,9 +109,12 @@ describe('UsageLimitQuotaService', () => {
};
const usagePeriodService = {
- getCurrentPeriod: jest.fn(),
+ findCurrentPeriod: jest.fn(),
+ findCurrentPeriodsByUnit: jest.fn(),
};
+ let periodByUnit: Partial<Record<PeriodUnit, UsagePeriod>>;
+
const setLimits = (limits: FlatUsageLimit[]) => {
workspaceCacheService.getOrRecompute.mockResolvedValue({
usageLimits: {
@@ -119,6 +124,7 @@ describe('UsageLimitQuotaService', () => {
};
const setAllowance = (allowanceMicro: number | null) => {
+ periodByUnit.allowancePeriod = ALLOWANCE_PERIOD;
creditAllowanceProvider.getCreditAllowancePeriod.mockResolvedValue(
ALLOWANCE_PERIOD,
);
@@ -154,9 +160,13 @@ describe('UsageLimitQuotaService', () => {
cacheStorage.mget.mockResolvedValue([]);
cacheStorage.runScript.mockResolvedValue([]);
clickHouseService.selectOrThrow.mockResolvedValue([]);
- usagePeriodService.getCurrentPeriod.mockImplementation(
- (periodUnit: string) =>
- periodUnit === 'week' ? WEEK_PERIOD : MONTH_PERIOD,
+ periodByUnit = { month: MONTH_PERIOD, week: WEEK_PERIOD };
+ usagePeriodService.findCurrentPeriod.mockImplementation(
+ async ({ periodUnit }: { periodUnit: PeriodUnit }) =>
+ periodByUnit[periodUnit] ?? null,
+ );
+ usagePeriodService.findCurrentPeriodsByUnit.mockImplementation(
+ async () => periodByUnit,
);
workspaceCacheService.getOrRecompute.mockResolvedValue({
usageLimits: { byResourceType: {} },
@@ -295,9 +305,7 @@ describe('UsageLimitQuotaService', () => {
});
it('skips warming an allowance whose period rolled over since the read', async () => {
- creditAllowanceProvider.getCreditAllowancePeriod.mockResolvedValue(
- ALLOWANCE_PERIOD,
- );
+ periodByUnit.allowancePeriod = ALLOWANCE_PERIOD;
creditAllowanceProvider.getCreditAllowance.mockResolvedValue({
allowanceMicro: 100,
periodStart: new Date('2026-09-15T09:00:00.000Z'),
@@ -309,6 +317,54 @@ describe('UsageLimitQuotaService', () => {
expect(cacheStorage.mset).toHaveBeenCalledWith([]);
});
+ describe('allowance-period limits', () => {
+ const allowancePeriodLimit = buildLimit({
+ id: 'allowance-period',
+ periodUnit: 'allowancePeriod',
+ limitValue: 800,
+ });
+
+ it('warms the counter from the consumption of the allowance period', async () => {
+ setLimits([allowancePeriodLimit]);
+ setAllowance(2_000);
+ creditAllowanceProvider.isCreditAllowanceEnabled.mockResolvedValue(false);
+ cacheStorage.mget.mockResolvedValue([undefined]);
+ clickHouseService.selectOrThrow.mockResolvedValue([
+ {
+ operationType: UsageOperationType.AI_CHAT_TOKEN,
+ userWorkspaceId: 'user-1',
+ apiKeyId: '',
+ applicationId: '',
+ agentId: '',
+ workflowId: '',
+ logicFunctionId: '',
+ creditsUsedMicro: '150',
+ quantity: '0',
+ },
+ ]);
+
+ await expect(assertQuotaNotExhausted()).resolves.toBeUndefined();
+
+ expect(clickHouseService.selectOrThrow).toHaveBeenCalledWith(
+ expect.stringContaining(
+ 'AND periodStart = {periodStart:DateTime64(3)}',
+ ),
+ expect.objectContaining({
+ periodStart: expect.stringContaining('2026-08-15'),
+ }),
+ );
+ expect(clickHouseService.selectOrThrow).toHaveBeenCalledWith(
+ expect.stringContaining(
+ 'AND timestamp >= {periodStart:DateTime64(3)} - INTERVAL 1 DAY',
+ ),
+ expect.anything(),
+ );
+ expect(cacheStorage.mset).toHaveBeenCalledWith([
+ expect.objectContaining({ value: 650 }),
+ ]);
+ });
+ });
+
it('admits when the counters cannot be read', async () => {
setLimits([buildLimit({})]);
cacheStorage.mget.mockRejectedValue(new Error('Socket closed'));
@@ -542,6 +598,14 @@ describe('UsageLimitQuotaService', () => {
]);
});
+ it('skips the drop when the period cannot be resolved', async () => {
+ await service.dropLimitCounter(
+ buildLimitCounterScope({ periodUnit: 'allowancePeriod' }),
+ );
+
+ expect(cacheStorage.mdel).not.toHaveBeenCalled();
+ });
+
it('ignores a speed limit', async () => {
await service.dropLimitCounter(
buildLimitCounterScope({ limitKind: 'speed', periodUnit: 'second' }),
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-credit-allowance-provider.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-credit-allowance-provider.service.ts
new file mode 100644
index 00000000000..08d458e31b5
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-credit-allowance-provider.service.ts
@@ -0,0 +1,17 @@
+import { CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/interfaces/credit-allowance-provider.service';
+import { type CreditAllowance } from 'src/engine/core-modules/usage-limit/types/credit-allowance.type';
+import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
+
+export class NoCreditAllowanceProvider extends CreditAllowanceProvider {
+ async isCreditAllowanceEnabled(): Promise<boolean> {
+ return false;
+ }
+
+ async getCreditAllowancePeriod(): Promise<UsagePeriod | null> {
+ return null;
+ }
+
+ async getCreditAllowance(): Promise<CreditAllowance | null> {
+ return null;
+ }
+}
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-usage-limit-entitlement-provider.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-usage-limit-entitlement-provider.service.ts
new file mode 100644
index 00000000000..0cf1d5e4e37
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/no-usage-limit-entitlement-provider.service.ts
@@ -0,0 +1,7 @@
+import { UsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-limit/interfaces/usage-limit-entitlement-provider.service';
+
+export class NoUsageLimitEntitlementProvider extends UsageLimitEntitlementProvider {
+ async hasIntraWorkspaceLimitEntitlement(): Promise<boolean> {
+ return true;
+ }
+}
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service.ts
index acc5860bbfb..ae667782603 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service.ts
@@ -1,8 +1,6 @@
import { Injectable, Logger, type OnModuleInit } from '@nestjs/common';
import { DiscoveryService } from '@nestjs/core';
-import { isDefined } from 'twenty-shared/utils';
-
import { type UsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-limit/interfaces/usage-limit-entitlement-provider.service';
import { type FlatUsageLimit } from 'src/engine/core-modules/usage-limit/types/flat-usage-limit.type';
import { findEnforceableLimits } from 'src/engine/core-modules/usage-limit/utils/find-enforceable-limits.util';
@@ -13,7 +11,7 @@ import { isIntraWorkspaceScoped } from 'src/engine/core-modules/usage-limit/util
export class UsageLimitEntitlementService implements OnModuleInit {
private readonly logger = new Logger(UsageLimitEntitlementService.name);
- private entitlementProvider: UsageLimitEntitlementProvider | null = null;
+ private entitlementProvider: UsageLimitEntitlementProvider;
constructor(private readonly discoveryService: DiscoveryService) {}
@@ -24,9 +22,9 @@ export class UsageLimitEntitlementService implements OnModuleInit {
}
async isIntraWorkspaceLimitEntitled(workspaceId: string): Promise<boolean> {
- return isDefined(this.entitlementProvider)
- ? this.entitlementProvider.hasIntraWorkspaceLimitEntitlement(workspaceId)
- : true;
+ return this.entitlementProvider.hasIntraWorkspaceLimitEntitlement(
+ workspaceId,
+ );
}
async findEnforceableLimits({
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 cbdc04416f2..00a5c2f35a8 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
@@ -23,9 +23,7 @@ import { CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/int
import { UsageLimitEntitlementService } from 'src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service';
import { type ExhaustedScope } from 'src/engine/core-modules/usage-limit/types/exhausted-scope.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 AllowanceQuotaCounter } from 'src/engine/core-modules/usage-limit/types/allowance-quota-counter.type';
-import { type AnchoredPeriodUnit } from 'src/engine/core-modules/usage-limit/types/anchored-period-unit.type';
import { type LimitQuotaCounter } from 'src/engine/core-modules/usage-limit/types/limit-quota-counter.type';
import { type QuotaConsumptionRow } from 'src/engine/core-modules/usage-limit/types/quota-consumption-row.type';
import { type QuotaCost } from 'src/engine/core-modules/usage-limit/types/quota-cost.type';
@@ -47,12 +45,12 @@ import { fromConsumeResultsToRemainings } from 'src/engine/core-modules/usage-li
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 { UsagePeriodService } from 'src/engine/core-modules/usage-limit/services/usage-period.service';
-import { type UsagePeriod } from 'src/engine/core-modules/usage-limit/types/usage-period.type';
import { type UsageSpenders } from 'src/engine/core-modules/usage/types/usage-spenders.type';
import { WorkspaceCacheException } from 'src/engine/workspace-cache/exceptions/workspace-cache.exception';
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
const QUOTA_WARM_LOCK_OPTIONS = { ms: 50, maxRetries: 20, ttl: 10_000 };
+const ALLOWANCE_PERIOD_STAMP_SLACK = 'INTERVAL 1 DAY';
type AllowanceSumRow = {
total: string | number | null;
@@ -69,7 +67,7 @@ type QuotaConsumeArgs = {
export class UsageLimitQuotaService implements OnModuleInit {
private readonly logger = new Logger(UsageLimitQuotaService.name);
- private creditAllowanceProvider: CreditAllowanceProvider | null = null;
+ private creditAllowanceProvider: CreditAllowanceProvider;
constructor(
@InjectCacheStorage(CacheStorageNamespace.EngineUsageLimit)
@@ -128,7 +126,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
async dropAllowanceCounter(workspaceId: string): Promise<void> {
const period =
- await this.creditAllowanceProvider?.getCreditAllowancePeriod(workspaceId);
+ await this.creditAllowanceProvider.getCreditAllowancePeriod(workspaceId);
if (!isDefined(period)) {
return;
@@ -153,7 +151,10 @@ export class UsageLimitQuotaService implements OnModuleInit {
const keys = buildIntraWorkspaceLimitCounterKeys({
workspaceId,
limits,
- periodByUnit: this.getCurrentPeriodsByUnit(limits),
+ periodByUnit: await this.usagePeriodService.findCurrentPeriodsByUnit({
+ workspaceId,
+ limits,
+ }),
});
if (keys.length === 0) {
@@ -171,9 +172,14 @@ export class UsageLimitQuotaService implements OnModuleInit {
return;
}
- const period = this.usagePeriodService.getCurrentPeriod(
- usageLimit.periodUnit,
- );
+ const period = await this.usagePeriodService.findCurrentPeriod({
+ workspaceId: usageLimit.workspaceId,
+ periodUnit: usageLimit.periodUnit,
+ });
+
+ if (!isDefined(period)) {
+ return;
+ }
await this.delUnderWarmLock({
workspaceId: usageLimit.workspaceId,
@@ -338,9 +344,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
const allowance = exhaustedCounters.some(
(counter) => counter.kind === 'allowance',
)
- ? ((await this.creditAllowanceProvider?.getCreditAllowance(
- args.workspaceId,
- )) ?? null)
+ ? await this.creditAllowanceProvider.getCreditAllowance(args.workspaceId)
: null;
return exhaustedCounters.map((counter) =>
@@ -435,24 +439,28 @@ export class UsageLimitQuotaService implements OnModuleInit {
workspaceId,
resourceType,
operationType,
- periodByUnit: this.getCurrentPeriodsByUnit(quotaLimits),
+ periodByUnit: await this.usagePeriodService.findCurrentPeriodsByUnit({
+ workspaceId,
+ limits: quotaLimits,
+ }),
});
}
private async buildAllowanceCounter(
workspaceId: string,
): Promise<AllowanceQuotaCounter | null> {
- const creditAllowanceProvider = this.creditAllowanceProvider;
-
if (
- !isDefined(creditAllowanceProvider) ||
- !(await creditAllowanceProvider.isCreditAllowanceEnabled(workspaceId))
+ !(await this.creditAllowanceProvider.isCreditAllowanceEnabled(
+ workspaceId,
+ ))
) {
return null;
}
- const period =
- await creditAllowanceProvider.getCreditAllowancePeriod(workspaceId);
+ const period = await this.usagePeriodService.findCurrentPeriod({
+ workspaceId,
+ periodUnit: 'allowancePeriod',
+ });
if (!isDefined(period)) {
return null;
@@ -470,28 +478,6 @@ export class UsageLimitQuotaService implements OnModuleInit {
};
}
- private getCurrentPeriodsByUnit(
- quotaLimits: FlatUsageLimit[],
- ): Partial<Record<PeriodUnit, UsagePeriod>> {
- const periodUnits = [
- ...new Set(
- quotaLimits
- .map((limit) => limit.periodUnit)
- .filter(
- (periodUnit): periodUnit is AnchoredPeriodUnit =>
- periodUnit !== 'second',
- ),
- ),
- ];
-
- return Object.fromEntries(
- periodUnits.map((periodUnit) => [
- periodUnit,
- this.usagePeriodService.getCurrentPeriod(periodUnit),
- ]),
- );
- }
-
private async findQuotaLimits({
workspaceId,
resourceType,
@@ -633,7 +619,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
}
const allowance =
- await this.creditAllowanceProvider?.getCreditAllowance(workspaceId);
+ await this.creditAllowanceProvider.getCreditAllowance(workspaceId);
if (
!isDefined(allowance) ||
@@ -711,6 +697,15 @@ export class UsageLimitQuotaService implements OnModuleInit {
workspaceId: string;
counter: LimitQuotaCounter;
}): Promise<QuotaConsumptionRow[]> {
+ // Events carry a period only once the cache holds it, so the bound only helps the primary key prune
+ const periodClause =
+ counter.periodUnit === 'allowancePeriod'
+ ? `AND periodStart = {periodStart:DateTime64(3)}
+ AND timestamp >= {periodStart:DateTime64(3)} - ${ALLOWANCE_PERIOD_STAMP_SLACK}
+ AND timestamp < {periodEnd:DateTime64(3)} + ${ALLOWANCE_PERIOD_STAMP_SLACK}`
+ : `AND toStartOfDay(timestamp, 'UTC') >= {periodStart:DateTime64(3)}
+ AND toStartOfDay(timestamp, 'UTC') < {periodEnd:DateTime64(3)}`;
+
return this.clickHouseService.selectOrThrow<QuotaConsumptionRow>(
`SELECT operationType, userWorkspaceId, apiKeyId, applicationId, agentId,
workflowId, logicFunctionId,
@@ -719,8 +714,7 @@ export class UsageLimitQuotaService implements OnModuleInit {
FROM usageEvent
WHERE workspaceId = {workspaceId:String}
AND resourceType = {resourceType:String}
- AND toStartOfDay(timestamp, 'UTC') >= {periodStart:DateTime64(3)}
- AND toStartOfDay(timestamp, 'UTC') < {periodEnd:DateTime64(3)}
+ ${periodClause}
GROUP BY operationType, userWorkspaceId, apiKeyId, applicationId, agentId,
workflowId, logicFunctionId`,
{
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit.service.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit.service.ts
index 9f874380984..af3ca11dc94 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/services/usage-limit.service.ts
@@ -12,6 +12,7 @@ import {
} from 'src/engine/core-modules/usage-limit/exceptions/usage-limit.exception';
import { UsageLimitEntitlementService } from 'src/engine/core-modules/usage-limit/services/usage-limit-entitlement.service';
import { UsageLimitQuotaService } from 'src/engine/core-modules/usage-limit/services/usage-limit-quota.service';
+import { UsagePeriodService } from 'src/engine/core-modules/usage-limit/services/usage-period.service';
import { type SpenderType } from 'src/engine/core-modules/usage-limit/types/spender-type.type';
import { UsageLimitEntity } from 'src/engine/core-modules/usage-limit/usage-limit.entity';
import { isIntraWorkspaceScoped } from 'src/engine/core-modules/usage-limit/utils/is-intra-workspace-scoped.util';
@@ -41,6 +42,7 @@ export class UsageLimitService {
private readonly workspaceCacheService: WorkspaceCacheService,
private readonly usageLimitQuotaService: UsageLimitQuotaService,
private readonly usageLimitEntitlementService: UsageLimitEntitlementService,
+ private readonly usagePeriodService: UsagePeriodService,
) {}
async findAll(workspaceId: string): Promise<UsageLimitEntity[]> {
@@ -68,6 +70,16 @@ export class UsageLimitService {
);
}
+ if (
+ input.periodUnit === 'allowancePeriod' &&
+ !(await this.usagePeriodService.hasAllowancePeriod(workspaceId))
+ ) {
+ throw new UsageLimitException(
+ 'A limit over the allowance period needs a current billing period',
+ UsageLimitExceptionCode.LIMIT_INVALID,
+ );
+ }
+
if (isNonEmptyString(input.spenderId)) {
await this.validateSpenderBelongsToWorkspace({
workspaceId,
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 80a44883494..f205a372464 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
@@ -1,18 +1,86 @@
/* @license Enterprise */
-import { Injectable } from '@nestjs/common';
+import { Injectable, type OnModuleInit } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
-import { assertUnreachable } from 'twenty-shared/utils';
+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';
import { getCalendarDayPeriod } from 'src/engine/core-modules/usage-limit/utils/get-calendar-day-period.util';
import { getCalendarMonthPeriod } from 'src/engine/core-modules/usage-limit/utils/get-calendar-month-period.util';
import { getCalendarWeekPeriod } from 'src/engine/core-modules/usage-limit/utils/get-calendar-week-period.util';
@Injectable()
-export class UsagePeriodService {
- getCurrentPeriod(periodUnit: AnchoredPeriodUnit): UsagePeriod {
+export class UsagePeriodService implements OnModuleInit {
+ private creditAllowanceProvider: CreditAllowanceProvider;
+
+ constructor(private readonly discoveryService: DiscoveryService) {}
+
+ onModuleInit() {
+ this.creditAllowanceProvider = findCreditAllowanceProvider(
+ this.discoveryService,
+ );
+ }
+
+ async hasAllowancePeriod(workspaceId: string): Promise<boolean> {
+ return isDefined(
+ await this.creditAllowanceProvider.getCreditAllowancePeriod(workspaceId),
+ );
+ }
+
+ async findCurrentPeriod({
+ workspaceId,
+ periodUnit,
+ }: {
+ workspaceId: string;
+ periodUnit: AnchoredPeriodUnit;
+ }): Promise<UsagePeriod | null> {
+ if (periodUnit !== 'allowancePeriod') {
+ return this.getCalendarPeriod(periodUnit);
+ }
+
+ return this.creditAllowanceProvider.getCreditAllowancePeriod(workspaceId);
+ }
+
+ async findCurrentPeriodsByUnit({
+ workspaceId,
+ limits,
+ }: {
+ workspaceId: string;
+ limits: FlatUsageLimit[];
+ }): Promise<Partial<Record<PeriodUnit, UsagePeriod>>> {
+ const periodUnits = [
+ ...new Set(
+ limits
+ .map((limit) => limit.periodUnit)
+ .filter(
+ (periodUnit): periodUnit is AnchoredPeriodUnit =>
+ periodUnit !== 'second',
+ ),
+ ),
+ ];
+
+ const periods = await Promise.all(
+ periodUnits.map(async (periodUnit) => ({
+ periodUnit,
+ period: await this.findCurrentPeriod({ workspaceId, periodUnit }),
+ })),
+ );
+
+ return Object.fromEntries(
+ periods
+ .filter(({ period }) => isDefined(period))
+ .map(({ periodUnit, period }) => [periodUnit, period]),
+ );
+ }
+
+ private getCalendarPeriod(periodUnit: CalendarPeriodUnit): UsagePeriod {
const now = new Date();
switch (periodUnit) {
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/types/calendar-period-unit.type.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/types/calendar-period-unit.type.ts
new file mode 100644
index 00000000000..2974b9758c4
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/types/calendar-period-unit.type.ts
@@ -0,0 +1,3 @@
+import { type AnchoredPeriodUnit } from 'src/engine/core-modules/usage-limit/types/anchored-period-unit.type';
+
+export type CalendarPeriodUnit = Exclude<AnchoredPeriodUnit, 'allowancePeriod'>;
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-credit-allowance-provider.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-credit-allowance-provider.util.ts
index 1c75ec210fa..8b3b1836b05 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-credit-allowance-provider.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-credit-allowance-provider.util.ts
@@ -1,12 +1,13 @@
import { type DiscoveryService } from '@nestjs/core';
import { CreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/interfaces/credit-allowance-provider.service';
+import { NoCreditAllowanceProvider } from 'src/engine/core-modules/usage-limit/services/no-credit-allowance-provider.service';
import { findProviderInstance } from 'src/engine/core-modules/usage-limit/utils/find-provider-instance.util';
export const findCreditAllowanceProvider = (
discoveryService: DiscoveryService,
-): CreditAllowanceProvider | null =>
+): CreditAllowanceProvider =>
findProviderInstance({
discoveryService,
providerClass: CreditAllowanceProvider,
- });
+ }) ?? new NoCreditAllowanceProvider();
diff --git a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-entitlement-provider.util.ts b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-entitlement-provider.util.ts
index 62e59bdedbb..3abcc72d61e 100644
--- a/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-entitlement-provider.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage-limit/utils/find-usage-limit-entitlement-provider.util.ts
@@ -1,12 +1,13 @@
import { type DiscoveryService } from '@nestjs/core';
import { UsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-limit/interfaces/usage-limit-entitlement-provider.service';
+import { NoUsageLimitEntitlementProvider } from 'src/engine/core-modules/usage-limit/services/no-usage-limit-entitlement-provider.service';
import { findProviderInstance } from 'src/engine/core-modules/usage-limit/utils/find-provider-instance.util';
export const findUsageLimitEntitlementProvider = (
discoveryService: DiscoveryService,
-): UsageLimitEntitlementProvider | null =>
+): UsageLimitEntitlementProvider =>
findProviderInstance({
discoveryService,
providerClass: UsageLimitEntitlementProvider,
- });
+ }) ?? new NoUsageLimitEntitlementProvider();
diff --git a/packages/twenty-server/src/engine/core-modules/usage/services/__tests__/usage-recorder.service.spec.ts b/packages/twenty-server/src/engine/core-modules/usage/services/__tests__/usage-recorder.service.spec.ts
index b7ceb76edc7..ba3530219fe 100644
--- a/packages/twenty-server/src/engine/core-modules/usage/services/__tests__/usage-recorder.service.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage/services/__tests__/usage-recorder.service.spec.ts
@@ -50,7 +50,11 @@ describe('UsageRecorderService', () => {
},
{
provide: TwentyConfigService,
- useValue: { get: jest.fn().mockReturnValue(false) },
+ useValue: {
+ get: jest.fn((key: string) =>
+ key === 'USAGE_ROLLUP_FLUSH_INTERVAL_MS' ? 60_000 : false,
+ ),
+ },
},
{
provide: DiscoveryService,
@@ -60,9 +64,11 @@ describe('UsageRecorderService', () => {
}).compile();
recorder = module.get<UsageRecorderService>(UsageRecorderService);
+ recorder.onModuleInit();
});
- afterEach(() => {
+ afterEach(async () => {
+ await recorder.flushAndStop();
jest.restoreAllMocks();
});
diff --git a/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts b/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
index a9cbcfae8c3..5e567723594 100644
--- a/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
@@ -30,7 +30,7 @@ export class UsageRecorderService implements OnModuleInit, OnModuleDestroy {
private readonly buffer = new UsageRollupBuffer(MAX_BUFFERED_ROLLUPS);
private flushTimer: NodeJS.Timeout | null = null;
private pendingFlush: Promise<void> = Promise.resolve();
- private creditAllowanceProvider: CreditAllowanceProvider | null = null;
+ private creditAllowanceProvider: CreditAllowanceProvider;
constructor(
private readonly workspaceEventEmitter: WorkspaceEventEmitter,
@@ -175,7 +175,7 @@ export class UsageRecorderService implements OnModuleInit, OnModuleDestroy {
workspaceId: string,
): Promise<Date | undefined> {
const period =
- await this.creditAllowanceProvider?.getCreditAllowancePeriod(workspaceId);
+ await this.creditAllowanceProvider.getCreditAllowancePeriod(workspaceId);
return period?.periodStart;
}