Skip to content

The open alternative to Salesforce, designed for AI.

[Onboarding 1/10] Track credit rewards (#26778)

Thomas des Francs7e2a5325e2af
diff --git a/packages/twenty-front/src/modules/client-config/types/OnboardingConfig.ts b/packages/twenty-front/src/modules/client-config/types/OnboardingConfig.ts
index 55fc035b549..6a247075df6 100644
--- a/packages/twenty-front/src/modules/client-config/types/OnboardingConfig.ts
+++ b/packages/twenty-front/src/modules/client-config/types/OnboardingConfig.ts
@@ -1,7 +1,8 @@
export type OnboardingConfig = {
importContactsCreditsReward: number;
- inviteTeamMaxCreditsReward: number;
inviteTeamCreditsRewardPerUser: number;
+ installAppsCreditsReward: number;
+ createProfileCreditsReward: number;
upgradeCreditsReward: number;
- installAppsCreditsRewardPerApp: number;
+ inviteTeamMaxInvites: number;
};
diff --git a/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx b/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
index 9e31ed06812..18e15deda5a 100644
--- a/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
@@ -33,10 +33,11 @@ i18n.activate(SOURCE_LOCALE);
const onboardingConfig: OnboardingConfig = {
importContactsCreditsReward: 2,
- inviteTeamMaxCreditsReward: 9,
inviteTeamCreditsRewardPerUser: 3,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
upgradeCreditsReward: 5,
- installAppsCreditsRewardPerApp: 1,
+ inviteTeamMaxInvites: 3,
};
const Wrapper = ({ children }: { children: ReactNode }) => (
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
index a965e684185..7e8f1f0cd40 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
@@ -22,10 +22,11 @@ jest.mock('@/onboarding/hooks/useTriggerInstallAppsOnboardingStep', () => ({
const onboardingConfig: OnboardingConfig = {
importContactsCreditsReward: 2,
- inviteTeamMaxCreditsReward: 9,
inviteTeamCreditsRewardPerUser: 3,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
upgradeCreditsReward: 5,
- installAppsCreditsRewardPerApp: 1,
+ inviteTeamMaxInvites: 3,
};
const Wrapper = ({ children }: { children: React.ReactNode }) =>
@@ -83,7 +84,7 @@ describe('useInstallOnboardingApps', () => {
universalIdentifiers: ['app-1', 'app-2'],
isAutoSkipped: false,
});
- expect(result.current.onboardingFreeCredits.installApps).toBe(2);
+ expect(result.current.onboardingFreeCredits.installApps).toBe(1);
});
it('should reset the completing state and not credit when the step fails', async () => {
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
index cd6aa4ba6d4..507bfd4e36d 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
@@ -4,6 +4,7 @@ import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCr
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import { useState } from 'react';
+import { isNonEmptyArray } from 'twenty-shared/utils';
export const useInstallOnboardingApps = () => {
const onboardingConfig = useAtomStateValue(onboardingConfigState);
@@ -35,12 +36,11 @@ export const useInstallOnboardingApps = () => {
isAutoSkipped: false,
});
- const creditsRewardPerApp =
- onboardingConfig?.installAppsCreditsRewardPerApp ?? 0;
+ const creditsReward = onboardingConfig?.installAppsCreditsReward ?? 0;
setOnboardingFreeCredits((current) => ({
...current,
- installApps: creditsRewardPerApp * universalIdentifiers.length,
+ installApps: isNonEmptyArray(universalIdentifiers) ? creditsReward : 0,
}));
} catch {
setIsCompleting(false);
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts b/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
index 5c065997a44..11984918c09 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
@@ -162,10 +162,14 @@ export const useInviteTeam = () => {
const creditsRewardPerUser =
onboardingConfig?.inviteTeamCreditsRewardPerUser ?? 0;
+ const maxRewardedInvitationsCount =
+ onboardingConfig?.inviteTeamMaxInvites ?? 0;
setOnboardingFreeCredits((current) => ({
...current,
- inviteTeam: sentInvitationsCount * creditsRewardPerUser,
+ inviteTeam:
+ Math.min(sentInvitationsCount, maxRewardedInvitationsCount) *
+ creditsRewardPerUser,
}));
if (emails.length > 0) {
@@ -195,6 +199,7 @@ export const useInviteTeam = () => {
isBookCallOnboardingStepEnabled,
isCompanyEnrichmentEnabled,
onboardingConfig?.inviteTeamCreditsRewardPerUser,
+ onboardingConfig?.inviteTeamMaxInvites,
sendInvitation,
setNextOnboardingStatus,
setOnboardingFreeCredits,
diff --git a/packages/twenty-front/src/pages/onboarding/InstallApps.tsx b/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
index ce80e6c2f3d..4fb93c6a97a 100644
--- a/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
+++ b/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
@@ -63,7 +63,7 @@ export const InstallApps = () => {
<InstallAppsContent
apps={availableApps}
selectedUniversalIdentifiers={selectedUniversalIdentifiers}
- creditsRewardPerApp={onboardingConfig?.installAppsCreditsRewardPerApp}
+ creditsReward={onboardingConfig?.installAppsCreditsReward}
isCompleting={isCompleting}
onToggleApp={toggleApp}
onInstall={installSelectedAppsAndContinue}
diff --git a/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx b/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
index 48c1fb4bf82..23ad4aff9f4 100644
--- a/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
+++ b/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
@@ -102,7 +102,7 @@ const StyledInstallButton = styled.div`
type InstallAppsContentProps = {
apps: (OnboardingInstallableApp & { logoUrl: string | null })[];
selectedUniversalIdentifiers: string[];
- creditsRewardPerApp?: number;
+ creditsReward?: number;
isCompleting: boolean;
onToggleApp: (universalIdentifier: string) => void;
onInstall: () => void;
@@ -112,7 +112,7 @@ type InstallAppsContentProps = {
export const InstallAppsContent = ({
apps,
selectedUniversalIdentifiers,
- creditsRewardPerApp,
+ creditsReward,
isCompleting,
onToggleApp,
onInstall,
@@ -139,13 +139,10 @@ export const InstallAppsContent = ({
: t`No apps are available to install right now`}
</StyledOnboardingStepSubtitle>
</OnboardingStepAnimatedItem>
- {isDefined(creditsRewardPerApp) && hasApps && (
+ {isDefined(creditsReward) && hasApps && (
<OnboardingStepAnimatedItem index={2}>
<StyledOnboardingStepTagsRow>
- <OnboardingCreditsRewardTag
- amount={creditsRewardPerApp * apps.length}
- suffix={t`free credits (${creditsRewardPerApp} per tool)`}
- />
+ <OnboardingCreditsRewardTag amount={creditsReward} />
</StyledOnboardingStepTagsRow>
</OnboardingStepAnimatedItem>
)}
diff --git a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
index 36c7750ea41..2cf997b186c 100644
--- a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
+++ b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
@@ -1,4 +1,4 @@
-import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { currentUserState } from '@/auth/states/currentUserState';
import { clientConfigApiStatusState } from '@/client-config/states/clientConfigApiStatusState';
import { isGoogleCalendarEnabledState } from '@/client-config/states/isGoogleCalendarEnabledState';
import { isGoogleMessagingEnabledState } from '@/client-config/states/isGoogleMessagingEnabledState';
@@ -48,10 +48,9 @@ export const SyncEmails = () => {
clientConfigApiStatusState,
).isLoadedOnce;
const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const currentWorkspace = useAtomStateValue(currentWorkspaceState);
+ const currentUser = useAtomStateValue(currentUserState);
- const isFirstWorkspaceUser = currentWorkspace?.workspaceMembersCount === 1;
- const creditsReward = isFirstWorkspaceUser
+ const creditsReward = currentUser?.isWorkspaceCreator
? onboardingConfig?.importContactsCreditsReward
: undefined;
diff --git a/packages/twenty-front/src/pages/onboarding/__stories__/SyncEmails.stories.tsx b/packages/twenty-front/src/pages/onboarding/__stories__/SyncEmails.stories.tsx
index f236ece16bf..f0c1248af88 100644
--- a/packages/twenty-front/src/pages/onboarding/__stories__/SyncEmails.stories.tsx
+++ b/packages/twenty-front/src/pages/onboarding/__stories__/SyncEmails.stories.tsx
@@ -4,7 +4,7 @@ import { HttpResponse, graphql } from 'msw';
import { expect, within } from 'storybook/test';
import { AppPath } from 'twenty-shared/types';
-import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { currentUserState } from '@/auth/states/currentUserState';
import { jotaiStore } from '@/ui/utilities/state/jotai/jotaiStore';
import { OnboardingStatus } from '~/generated-metadata/graphql';
import { GET_CURRENT_USER } from '~/modules/users/graphql/queries/getCurrentUser';
@@ -15,14 +15,14 @@ import {
} from '~/testing/decorators/PageDecorator';
import { graphqlMocks } from '~/testing/graphqlMocks';
import {
- mockCurrentWorkspace,
mockedOnboardingUserData,
+ mockedUserData,
} from '~/testing/mock-data/users';
-const setWorkspaceMembersCount = (workspaceMembersCount: number) => {
- jotaiStore.set(currentWorkspaceState.atom, {
- ...mockCurrentWorkspace,
- workspaceMembersCount,
+const setIsWorkspaceCreator = (isWorkspaceCreator: boolean) => {
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator,
});
};
@@ -55,7 +55,7 @@ export type Story = StoryObj<typeof SyncEmails>;
export const Default: Story = {
beforeEach: () => {
- setWorkspaceMembersCount(1);
+ setIsWorkspaceCreator(true);
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
@@ -66,7 +66,7 @@ export const Default: Story = {
export const InvitedUser: Story = {
beforeEach: () => {
- setWorkspaceMembersCount(2);
+ setIsWorkspaceCreator(false);
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
diff --git a/packages/twenty-front/src/testing/mock-data/config.ts b/packages/twenty-front/src/testing/mock-data/config.ts
index e4a58564d07..f7f0379a0e2 100644
--- a/packages/twenty-front/src/testing/mock-data/config.ts
+++ b/packages/twenty-front/src/testing/mock-data/config.ts
@@ -48,10 +48,11 @@ export const mockedClientConfig: ClientConfig = {
api: { mutationMaximumAffectedRecords: 100 },
onboarding: {
importContactsCreditsReward: 2,
- inviteTeamMaxCreditsReward: 9,
inviteTeamCreditsRewardPerUser: 3,
- upgradeCreditsReward: 5,
- installAppsCreditsRewardPerApp: 1,
+ installAppsCreditsReward: 0.5,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 2,
+ inviteTeamMaxInvites: 10,
},
canManageFeatureFlags: true,
publicFeatureFlags: [],
diff --git a/packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts b/packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts
index de89fa5975a..aead54d7117 100644
--- a/packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts
@@ -26,8 +26,6 @@ import {
} from 'src/engine/core-modules/app-token/app-token.entity';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
-import { BillingCreditGrantType } from 'src/engine/core-modules/billing/enums/billing-credit-grant-type.enum';
-import { BillingCreditService } from 'src/engine/core-modules/billing/services/billing-credit.service';
import { BillingService } from 'src/engine/core-modules/billing/services/billing.service';
import {
AuthException,
@@ -101,7 +99,6 @@ export class SignInUpService {
private readonly exceptionHandlerService: ExceptionHandlerService,
private readonly enterprisePlanService: EnterprisePlanService,
private readonly eventLogEmitterService: EventLogEmitterService,
- private readonly billingCreditService: BillingCreditService,
private readonly billingService: BillingService,
@InjectDataSource()
private readonly dataSource: DataSource,
@@ -252,22 +249,10 @@ export class SignInUpService {
params.invitation.type === AppTokenType.OnboardingInvitationToken &&
params.userData.type === 'newUserWithPicture'
) {
- try {
- await this.billingCreditService.grantCredits({
- workspaceId: invitationValidation.workspace.id,
- amountMicro: this.twentyConfigService.get(
- 'ONBOARDING_INVITE_TEAM_CREDITS_REWARD_PER_USER',
- ),
- type: BillingCreditGrantType.ONBOARDING_REWARD,
- reason: 'Onboarding reward: invited teammate signed up',
- idempotencyKey: `onboarding-invite-team:${invitationValidation.workspace.id}:${updatedUser.id}`,
- });
- } catch (error) {
- this.logger.error(
- `Failed to credit onboarding invite reward for workspace ${invitationValidation.workspace.id}`,
- error,
- );
- }
+ await this.onboardingService.creditInviteTeamReward({
+ workspaceId: invitationValidation.workspace.id,
+ userId: updatedUser.id,
+ });
}
await this.workspaceInvitationService.invalidateWorkspaceInvitation(
diff --git a/packages/twenty-server/src/engine/core-modules/billing/services/billing-credit-grant.service.ts b/packages/twenty-server/src/engine/core-modules/billing/services/billing-credit-grant.service.ts
index 7b4656cf817..ac8aefff865 100644
--- a/packages/twenty-server/src/engine/core-modules/billing/services/billing-credit-grant.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/billing/services/billing-credit-grant.service.ts
@@ -3,7 +3,7 @@
import { Injectable } from '@nestjs/common';
import { isDefined } from 'twenty-shared/utils';
-import { type EntityManager, IsNull, LessThan, MoreThan } from 'typeorm';
+import { type EntityManager, IsNull, LessThan, Like, MoreThan } from 'typeorm';
import {
BillingException,
@@ -257,6 +257,25 @@ export class BillingCreditGrantService {
});
}
+ async countGrantsByIdempotencyKeyPrefix({
+ workspaceId,
+ type,
+ idempotencyKeyPrefix,
+ }: {
+ workspaceId: string;
+ type: BillingCreditGrantType;
+ idempotencyKeyPrefix: string;
+ }): Promise<number> {
+ return this.billingCreditGrantRepository.count(workspaceId, {
+ where: {
+ type,
+ revokedAt: IsNull(),
+ sourceGrantId: IsNull(),
+ idempotencyKey: Like(`${idempotencyKeyPrefix}%`),
+ },
+ });
+ }
+
async revokeGrant({
workspaceId,
grantId,
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts b/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
index 08a5bccac18..6bd26c593b5 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
@@ -92,8 +92,10 @@ describe('ClientConfigController', () => {
onboarding: {
importContactsCreditsReward: 2,
inviteTeamCreditsRewardPerUser: 3,
- upgradeCreditsReward: 5,
- installAppsCreditsRewardPerApp: 1,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 0.5,
+ inviteTeamMaxInvites: 10,
},
isAttachmentPreviewEnabled: true,
analyticsEnabled: false,
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts b/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
index 7f5ace97b2b..d6e1d0d79d3 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
@@ -299,9 +299,13 @@ export class OnboardingConfig {
inviteTeamCreditsRewardPerUser: number;
+ installAppsCreditsReward: number;
+
+ createProfileCreditsReward: number;
+
upgradeCreditsReward: number;
- installAppsCreditsRewardPerApp: number;
+ inviteTeamMaxInvites: number;
}
@ObjectType()
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts b/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
index 5e8ded6b07b..4546985940d 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
@@ -246,16 +246,30 @@ export class ClientConfigService {
'ONBOARDING_INVITE_TEAM_CREDITS_REWARD_PER_USER',
),
),
- upgradeCreditsReward: toDisplayCredits(
+ installAppsCreditsReward: toDisplayCredits(
this.twentyConfigService.get(
- 'BILLING_FREE_WORKFLOW_CREDITS_FOR_TRIAL_PERIOD_WITH_CREDIT_CARD',
+ 'ONBOARDING_INSTALL_APPS_CREDITS_REWARD',
),
),
- installAppsCreditsRewardPerApp: toDisplayCredits(
+ createProfileCreditsReward: toDisplayCredits(
this.twentyConfigService.get(
- 'ONBOARDING_INSTALL_APPS_CREDITS_REWARD_PER_APP',
+ 'BILLING_FREE_WORKFLOW_CREDITS_FOR_TRIAL_PERIOD_WITHOUT_CREDIT_CARD',
),
),
+ upgradeCreditsReward: toDisplayCredits(
+ Math.max(
+ 0,
+ this.twentyConfigService.get(
+ 'BILLING_FREE_WORKFLOW_CREDITS_FOR_TRIAL_PERIOD_WITH_CREDIT_CARD',
+ ) -
+ this.twentyConfigService.get(
+ 'BILLING_FREE_WORKFLOW_CREDITS_FOR_TRIAL_PERIOD_WITHOUT_CREDIT_CARD',
+ ),
+ ),
+ ),
+ inviteTeamMaxInvites: this.twentyConfigService.get(
+ 'ONBOARDING_INVITE_TEAM_MAX_INVITES',
+ ),
}
: null,
isAttachmentPreviewEnabled: this.twentyConfigService.get(
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/__tests__/onboarding.service.spec.ts b/packages/twenty-server/src/engine/core-modules/onboarding/__tests__/onboarding.service.spec.ts
index d8297d1ee00..dcff585aef7 100644
--- a/packages/twenty-server/src/engine/core-modules/onboarding/__tests__/onboarding.service.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/__tests__/onboarding.service.spec.ts
@@ -4,8 +4,10 @@ import { getDataSourceToken, getRepositoryToken } from '@nestjs/typeorm';
import { type DataSource } from 'typeorm';
import { BillingCreditGrantType } from 'src/engine/core-modules/billing/enums/billing-credit-grant-type.enum';
+import { BillingCreditGrantService } from 'src/engine/core-modules/billing/services/billing-credit-grant.service';
import { BillingCreditService } from 'src/engine/core-modules/billing/services/billing-credit.service';
import { BillingService } from 'src/engine/core-modules/billing/services/billing.service';
+import { CacheLockService } from 'src/engine/core-modules/cache-lock/cache-lock.service';
import { ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { getQueueToken } from 'src/engine/core-modules/message-queue/utils/get-queue-token.util';
@@ -55,6 +57,8 @@ describe('OnboardingService', () => {
OnboardingService,
{ provide: BillingService, useValue: { isBillingEnabled: jest.fn() } },
{ provide: BillingCreditService, useValue: { grantCredits } },
+ { provide: BillingCreditGrantService, useValue: {} },
+ { provide: CacheLockService, useValue: {} },
{
provide: ExceptionHandlerService,
useValue: { captureExceptions },
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-invite-team-reward-lock-options.ts b/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-invite-team-reward-lock-options.ts
new file mode 100644
index 00000000000..aa7ae0e2e3e
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-invite-team-reward-lock-options.ts
@@ -0,0 +1,7 @@
+import { type CacheLockOptions } from 'src/engine/core-modules/cache-lock/cache-lock.service';
+
+export const ONBOARDING_INVITE_TEAM_REWARD_LOCK_OPTIONS = {
+ ttl: 30_000,
+ ms: 200,
+ maxRetries: 200,
+} satisfies CacheLockOptions;
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-reward-idempotency-key-prefixes.ts b/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-reward-idempotency-key-prefixes.ts
new file mode 100644
index 00000000000..7629c67f5f1
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/constants/onboarding-reward-idempotency-key-prefixes.ts
@@ -0,0 +1,6 @@
+export const ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES = {
+ importContacts: 'onboarding-import-contacts',
+ installApps: 'onboarding-install-apps',
+ inviteTeam: 'onboarding-invite-team',
+ enrichmentQualification: 'onboarding-enrichment-qualified',
+} as const;
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.spec.ts b/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.spec.ts
index 1ac774e47ca..813c7c5f485 100644
--- a/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.spec.ts
@@ -80,7 +80,6 @@ describe('InstallOnboardingAppsJob', () => {
expect(onboardingService.creditInstallAppsReward).toHaveBeenCalledWith({
workspaceId,
- rewardAppsCount: 2,
});
expect(applicationInstallService.installApplication).toHaveBeenCalledTimes(
2,
@@ -182,7 +181,6 @@ describe('InstallOnboardingAppsJob', () => {
expect(onboardingService.creditInstallAppsReward).toHaveBeenCalledWith({
workspaceId,
- rewardAppsCount: 1,
});
expect(applicationInstallService.installApplication).toHaveBeenCalledTimes(
1,
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.ts b/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.ts
index c6ff45e965d..71e9028a7d4 100644
--- a/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.ts
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/jobs/install-onboarding-apps.job.ts
@@ -29,7 +29,7 @@ export class InstallOnboardingAppsJob {
universalIdentifiers,
userId,
}: InstallOnboardingAppsJobData): Promise<void> {
- let installedAppsCount = 0;
+ let hasInstalledAnyApp = false;
for (const universalIdentifier of universalIdentifiers) {
const hasInstalledApp = await this.installApp({
@@ -38,18 +38,15 @@ export class InstallOnboardingAppsJob {
});
if (hasInstalledApp) {
- installedAppsCount += 1;
+ hasInstalledAnyApp = true;
}
}
- if (installedAppsCount === 0) {
+ if (!hasInstalledAnyApp) {
return;
}
- await this.onboardingService.creditInstallAppsReward({
- workspaceId,
- rewardAppsCount: installedAppsCount,
- });
+ await this.onboardingService.creditInstallAppsReward({ workspaceId });
if (isDefined(userId)) {
await this.onboardingService.clearReversibleOnboardingStepHistoryAfterAppsInstalled(
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.module.ts b/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.module.ts
index 56a94e9ced1..ea30d43a9cd 100644
--- a/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.module.ts
@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
+import { CacheLockModule } from 'src/engine/core-modules/cache-lock/cache-lock.module';
import { OnboardingResolver } from 'src/engine/core-modules/onboarding/onboarding.resolver';
import { OnboardingService } from 'src/engine/core-modules/onboarding/onboarding.service';
import { UserVarsModule } from 'src/engine/core-modules/user/user-vars/user-vars.module';
@@ -12,6 +13,7 @@ import { OnboardingInviteSuggestionsModule } from 'src/modules/onboarding-invite
@Module({
imports: [
BillingModule,
+ CacheLockModule,
UserVarsModule,
OnboardingInviteSuggestionsModule,
TypeOrmModule.forFeature([WorkspaceEntity, UserWorkspaceEntity]),
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.service.ts b/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.service.ts
index ab1ef40829a..5ce31595fb9 100644
--- a/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/onboarding.service.ts
@@ -7,14 +7,19 @@ import { WorkspaceActivationStatus } from 'twenty-shared/workspace';
import { type DataSource, type QueryRunner, Repository } from 'typeorm';
import { BillingCreditGrantType } from 'src/engine/core-modules/billing/enums/billing-credit-grant-type.enum';
+import { BillingCreditGrantService } from 'src/engine/core-modules/billing/services/billing-credit-grant.service';
import { BillingCreditService } from 'src/engine/core-modules/billing/services/billing-credit.service';
import { BillingService } from 'src/engine/core-modules/billing/services/billing.service';
+import { CacheLockService } from 'src/engine/core-modules/cache-lock/cache-lock.service';
import { ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';
import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
import { ONBOARDING_INSTALLABLE_APP_UNIVERSAL_IDENTIFIERS } from 'src/engine/core-modules/onboarding/constants/onboarding-installable-app-universal-identifiers';
+import { ONBOARDING_INVITE_TEAM_REWARD_LOCK_OPTIONS } from 'src/engine/core-modules/onboarding/constants/onboarding-invite-team-reward-lock-options';
+import { ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES } from 'src/engine/core-modules/onboarding/constants/onboarding-reward-idempotency-key-prefixes';
import { ACQUIRE_ONBOARDING_STEP_TRANSITION_LOCK_STATEMENT } from 'src/engine/core-modules/onboarding/constants/acquire-onboarding-step-transition-lock-statement';
+import { buildOnboardingInviteTeamRewardLockKey } from 'src/engine/core-modules/onboarding/utils/build-onboarding-invite-team-reward-lock-key.util';
import { buildOnboardingStepTransitionLockName } from 'src/engine/core-modules/onboarding/utils/build-onboarding-step-transition-lock-name.util';
import { OnboardingStatus } from 'src/engine/core-modules/onboarding/enums/onboarding-status.enum';
import {
@@ -60,6 +65,8 @@ export class OnboardingService {
constructor(
private readonly billingService: BillingService,
private readonly billingCreditService: BillingCreditService,
+ private readonly billingCreditGrantService: BillingCreditGrantService,
+ private readonly cacheLockService: CacheLockService,
private readonly exceptionHandlerService: ExceptionHandlerService,
private readonly userVarsService: UserVarsService<OnboardingKeyValueTypeMap>,
private readonly twentyConfigService: TwentyConfigService,
@@ -507,7 +514,10 @@ export class OnboardingService {
return;
}
- await this.creditImportContactsRewardForFirstWorkspaceUser({ workspaceId });
+ await this.creditImportContactsRewardForWorkspaceCreator({
+ userId,
+ workspaceId,
+ });
}
async skipOnboardingConnectAccountStep({
@@ -544,16 +554,20 @@ export class OnboardingService {
);
}
- private async isFirstWorkspaceUser({
+ private async isWorkspaceCreator({
+ userId,
workspaceId,
}: {
+ userId: string;
workspaceId: string;
}): Promise<boolean> {
- const workspaceUserCount = await this.userWorkspaceRepository.countBy({
- workspaceId,
+ const earliestUserWorkspace = await this.userWorkspaceRepository.findOne({
+ where: { workspaceId },
+ order: { createdAt: 'ASC' },
+ withDeleted: true,
});
- return workspaceUserCount === 1;
+ return earliestUserWorkspace?.userId === userId;
}
private async claimOnboardingConnectAccountStep(
@@ -578,17 +592,20 @@ export class OnboardingService {
return isDefined(affectedRows) && affectedRows > 0;
}
- private async creditImportContactsRewardForFirstWorkspaceUser({
+ private async creditImportContactsRewardForWorkspaceCreator({
+ userId,
workspaceId,
}: {
+ userId: string;
workspaceId: string;
}) {
try {
- const isFirstWorkspaceUser = await this.isFirstWorkspaceUser({
+ const isWorkspaceCreator = await this.isWorkspaceCreator({
+ userId,
workspaceId,
});
- if (!isFirstWorkspaceUser) {
+ if (!isWorkspaceCreator) {
return;
}
@@ -599,7 +616,7 @@ export class OnboardingService {
),
type: BillingCreditGrantType.ONBOARDING_REWARD,
reason: 'Onboarding reward: import contacts',
- idempotencyKey: `onboarding-import-contacts:${workspaceId}`,
+ idempotencyKey: `${ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES.importContacts}:${workspaceId}`,
});
} catch (error) {
this.logger.error(
@@ -796,23 +813,16 @@ export class OnboardingService {
return isDefined(affectedRows) && affectedRows > 0;
}
- async creditInstallAppsReward({
- workspaceId,
- rewardAppsCount,
- }: {
- workspaceId: string;
- rewardAppsCount: number;
- }) {
+ async creditInstallAppsReward({ workspaceId }: { workspaceId: string }) {
try {
await this.billingCreditService.grantCredits({
workspaceId,
- amountMicro:
- this.twentyConfigService.get(
- 'ONBOARDING_INSTALL_APPS_CREDITS_REWARD_PER_APP',
- ) * rewardAppsCount,
+ amountMicro: this.twentyConfigService.get(
+ 'ONBOARDING_INSTALL_APPS_CREDITS_REWARD',
+ ),
type: BillingCreditGrantType.ONBOARDING_REWARD,
- reason: `Onboarding reward: install ${rewardAppsCount} app(s)`,
- idempotencyKey: `onboarding-install-apps:${workspaceId}`,
+ reason: 'Onboarding reward: install apps',
+ idempotencyKey: `${ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES.installApps}:${workspaceId}`,
});
} catch (error) {
this.logger.error(
@@ -822,6 +832,59 @@ export class OnboardingService {
}
}
+ async creditInviteTeamReward({
+ workspaceId,
+ userId,
+ }: {
+ workspaceId: string;
+ userId: string;
+ }) {
+ const idempotencyKeyPrefix = `${ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES.inviteTeam}:${workspaceId}:`;
+
+ try {
+ await this.cacheLockService.withLock(
+ async () => {
+ const rewardedTeammatesCount =
+ await this.billingCreditGrantService.countGrantsByIdempotencyKeyPrefix(
+ {
+ workspaceId,
+ type: BillingCreditGrantType.ONBOARDING_REWARD,
+ idempotencyKeyPrefix,
+ },
+ );
+
+ if (
+ rewardedTeammatesCount >=
+ this.twentyConfigService.get('ONBOARDING_INVITE_TEAM_MAX_INVITES')
+ ) {
+ return;
+ }
+
+ await this.billingCreditService.grantCredits({
+ workspaceId,
+ amountMicro: this.twentyConfigService.get(
+ 'ONBOARDING_INVITE_TEAM_CREDITS_REWARD_PER_USER',
+ ),
+ type: BillingCreditGrantType.ONBOARDING_REWARD,
+ reason: 'Onboarding reward: invited teammate signed up',
+ idempotencyKey: `${idempotencyKeyPrefix}${userId}`,
+ });
+ },
+ buildOnboardingInviteTeamRewardLockKey(workspaceId),
+ ONBOARDING_INVITE_TEAM_REWARD_LOCK_OPTIONS,
+ );
+ } catch (error) {
+ this.logger.error(
+ `Failed to credit onboarding invite reward for workspace ${workspaceId}`,
+ error,
+ );
+
+ this.exceptionHandlerService.captureExceptions([error], {
+ workspace: { id: workspaceId },
+ });
+ }
+ }
+
async setOnboardingInviteTeamPending(
{
userId,
@@ -901,7 +964,7 @@ export class OnboardingService {
// workspace rather than the enriching user so that a re-run of the
// enrichment, or a second member qualifying later, replays instead of
// topping up a balance the workspace already received.
- idempotencyKey: `onboarding-enrichment-qualified:${workspaceId}`,
+ idempotencyKey: `${ONBOARDING_REWARD_IDEMPOTENCY_KEY_PREFIXES.enrichmentQualification}:${workspaceId}`,
});
} catch (error) {
this.logger.error(
diff --git a/packages/twenty-server/src/engine/core-modules/onboarding/utils/build-onboarding-invite-team-reward-lock-key.util.ts b/packages/twenty-server/src/engine/core-modules/onboarding/utils/build-onboarding-invite-team-reward-lock-key.util.ts
new file mode 100644
index 00000000000..7b578dd852d
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/onboarding/utils/build-onboarding-invite-team-reward-lock-key.util.ts
@@ -0,0 +1,3 @@
+export const buildOnboardingInviteTeamRewardLockKey = (
+ workspaceId: string,
+): string => `onboarding-invite-team-reward:${workspaceId}`;
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 87317d096ed..c988c54be05 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
@@ -1117,13 +1117,13 @@ export class ConfigVariables {
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.BILLING_CONFIG,
description:
- 'Free credits granted per app installed during the install-apps onboarding step (in microCredits)',
+ 'Free credits granted for installing apps during the install-apps onboarding step, whatever the number of apps (in microCredits)',
type: ConfigVariableType.NUMBER,
})
@CastToPositiveNumber()
@IsInt()
@IsOptional()
- ONBOARDING_INSTALL_APPS_CREDITS_REWARD_PER_APP = 500_000;
+ ONBOARDING_INSTALL_APPS_CREDITS_REWARD = 500_000;
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.BILLING_CONFIG,
diff --git a/packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts b/packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts
index ea391ef5750..bd0ada76e75 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts
@@ -14,7 +14,6 @@ import {
IsNull,
LessThanOrEqual,
MoreThan,
- Not,
Raw,
Repository,
} from 'typeorm';
@@ -320,14 +319,6 @@ export class WorkspaceInvitationService {
workspaceId: workspace.id,
})));
- if (isOnboardingInviteReward) {
- await this.throwIfOnboardingInvitationLimitReached({
- workspaceId: workspace.id,
- requestedCount: emails.length,
- excludedAppTokenId: appTokenIdToInvalidate,
- });
- }
-
await this.throttleInvitationSending(workspace.id, emails);
if (isDefined(appTokenIdToInvalidate)) {
@@ -492,42 +483,6 @@ export class WorkspaceInvitationService {
return this.appTokenRepository.save(invitationToken);
}
- private async throwIfOnboardingInvitationLimitReached({
- workspaceId,
- requestedCount,
- excludedAppTokenId,
- }: {
- workspaceId: string;
- requestedCount: number;
- excludedAppTokenId?: string;
- }) {
- const maxOnboardingInvitations = this.twentyConfigService.get(
- 'ONBOARDING_INVITE_TEAM_MAX_INVITES',
- );
-
- const existingOnboardingInvitations = await this.appTokenRepository.count({
- where: {
- workspaceId,
- type: AppTokenType.OnboardingInvitationToken,
- deletedAt: IsNull(),
- expiresAt: MoreThan(new Date()),
- ...(isDefined(excludedAppTokenId)
- ? { id: Not(excludedAppTokenId) }
- : {}),
- },
- });
-
- if (
- existingOnboardingInvitations + requestedCount >
- maxOnboardingInvitations
- ) {
- throw new WorkspaceInvitationException(
- `Onboarding invitation limit (${maxOnboardingInvitations}) reached for workspace ${workspaceId}`,
- WorkspaceInvitationExceptionCode.TOO_MANY_ONBOARDING_INVITATIONS,
- );
- }
- }
-
private async throttleInvitationSending(
workspaceId: string,
emails: string[],
diff --git a/packages/twenty-server/src/engine/core-modules/workspace-invitation/workspace-invitation.exception.ts b/packages/twenty-server/src/engine/core-modules/workspace-invitation/workspace-invitation.exception.ts
index 4b841fb7e92..1df15537db0 100644
--- a/packages/twenty-server/src/engine/core-modules/workspace-invitation/workspace-invitation.exception.ts
+++ b/packages/twenty-server/src/engine/core-modules/workspace-invitation/workspace-invitation.exception.ts
@@ -11,7 +11,6 @@ export enum WorkspaceInvitationExceptionCode {
USER_ALREADY_EXIST = 'USER_ALREADY_EXIST',
INVALID_INVITATION = 'INVALID_INVITATION',
EMAIL_MISSING = 'EMAIL_MISSING',
- TOO_MANY_ONBOARDING_INVITATIONS = 'TOO_MANY_ONBOARDING_INVITATIONS',
}
const getWorkspaceInvitationExceptionUserFriendlyMessage = (
@@ -28,8 +27,6 @@ const getWorkspaceInvitationExceptionUserFriendlyMessage = (
return msg`This user is already a member of the workspace.`;
case WorkspaceInvitationExceptionCode.EMAIL_MISSING:
return msg`Email is required.`;
- case WorkspaceInvitationExceptionCode.TOO_MANY_ONBOARDING_INVITATIONS:
- return msg`You have reached the maximum number of invitations for this step.`;
default:
assertUnreachable(code);
}