Merge pull request #994 from internxt/feature/cello-referral

[PB-5982]: add referral integration for token generation and purchase tracking

Author: terrerox

src/app.module.ts

@@ -31,6 +31,7 @@ import { nanoid } from 'nanoid';
 import { getClientIdFromHeaders } from './common/decorators/client.decorator';
 import { AuthGuard } from './modules/auth/auth.guard';
 import { CacheManagerModule } from './modules/cache-manager/cache-manager.module';
+import { ReferralModule } from './modules/referral/referral.module';
 
 @Module({
   imports: [
@@ -145,6 +146,7 @@ import { CacheManagerModule } from './modules/cache-manager/cache-manager.module
     WorkspacesModule,
     GatewayModule,
     CacheManagerModule,
+    ReferralModule,
   ],
   controllers: [],
   providers: [

src/config/configuration.ts

@@ -175,5 +175,9 @@ export default () => ({
     endpointForSignedUrls: process.env.AVATAR_ENDPOINT_REWRITE_FOR_SIGNED_URLS,
     forcePathStyle: process.env.AVATAR_FORCE_PATH_STYLE || 'true',
   },
+  cello: {
+    productId: process.env.CELLO_PRODUCT_ID,
+    productSecret: process.env.CELLO_PRODUCT_SECRET,
+  },
   executeCronjobs: process.env.EXECUTE_JOBS === 'true',
 });

src/modules/referral/cello-referral.service.spec.ts

@@ -0,0 +1,53 @@
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { Test, type TestingModule } from '@nestjs/testing';
+import { type Logger } from '@nestjs/common';
+import { createMock } from '@golevelup/ts-jest';
+import { verify } from 'jsonwebtoken';
+import { CelloReferralService } from './cello-referral.service';
+
+describe('CelloReferralService', () => {
+  let service: CelloReferralService;
+
+  const celloConfig = {
+    'cello.productId': 'test-product-id',
+    'cello.productSecret': 'test-product-secret',
+  };
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      imports: [ConfigModule],
+      providers: [CelloReferralService],
+    })
+      .setLogger(createMock<Logger>())
+      .compile();
+
+    service = module.get<CelloReferralService>(CelloReferralService);
+
+    const configService = module.get<ConfigService>(ConfigService);
+    jest
+      .spyOn(configService, 'get')
+      .mockImplementation((key: string) => celloConfig[key]);
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  describe('generateToken', () => {
+    it('When called, then it returns a valid JWT signed with HS512', () => {
+      const signupDate = new Date('2024-01-15T10:00:00.000Z');
+      const token = service.generateToken('user-uuid', signupDate);
+
+      const decoded = verify(token, celloConfig['cello.productSecret'], {
+        algorithms: ['HS512'],
+      }) as Record<string, unknown>;
+
+      expect(decoded.productId).toBe(celloConfig['cello.productId']);
+      expect(decoded.productUserId).toBe('user-uuid');
+      expect(decoded.signupDate).toBe('2024-01-15T10:00:00.000Z');
+      expect(decoded.iat).toBeDefined();
+      expect(decoded.exp).toBe((decoded.iat as number) + 3600);
+    });
+  });
+});

src/modules/referral/cello-referral.service.ts

@@ -0,0 +1,29 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { sign } from 'jsonwebtoken';
+import { ReferralService } from './referral.service';
+
+@Injectable()
+export class CelloReferralService extends ReferralService {
+  constructor(private readonly configService: ConfigService) {
+    super();
+  }
+
+  generateToken(productUserId: string, signupDate: Date): string {
+    const productId = this.configService.get<string>('cello.productId');
+    const productSecret = this.configService.get<string>('cello.productSecret');
+    const now = Math.floor(Date.now() / 1000);
+
+    return sign(
+      {
+        productId,
+        productUserId,
+        signupDate: signupDate.toISOString(),
+        iat: now,
+        exp: now + 3600,
+      },
+      productSecret,
+      { algorithm: 'HS512' },
+    );
+  }
+}

src/modules/referral/referral.controller.spec.ts

@@ -0,0 +1,43 @@
+import { type Logger } from '@nestjs/common';
+import { Test } from '@nestjs/testing';
+import { type DeepMocked, createMock } from '@golevelup/ts-jest';
+import { newUser } from '../../../test/fixtures';
+import { ReferralController } from './referral.controller';
+import { ReferralService } from './referral.service';
+
+describe('ReferralController', () => {
+  let controller: ReferralController;
+  let referralService: DeepMocked<ReferralService>;
+
+  const user = newUser();
+
+  beforeEach(async () => {
+    const moduleRef = await Test.createTestingModule({
+      controllers: [ReferralController],
+    })
+      .setLogger(createMock<Logger>())
+      .useMocker(() => createMock())
+      .compile();
+
+    controller = moduleRef.get(ReferralController);
+    referralService = moduleRef.get(ReferralService);
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('POST /token', () => {
+    it('When called, then it returns the generated token', async () => {
+      referralService.generateToken.mockReturnValue('jwt-token');
+
+      const result = await controller.generateToken(user);
+
+      expect(result).toEqual({ token: 'jwt-token' });
+      expect(referralService.generateToken).toHaveBeenCalledWith(
+        user.uuid,
+        user.createdAt,
+      );
+    });
+  });
+});

src/modules/referral/referral.controller.ts

@@ -0,0 +1,20 @@
+import { Controller, HttpCode, HttpStatus, Post } from '@nestjs/common';
+import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
+import { User as UserDecorator } from '../auth/decorators/user.decorator';
+import { type User } from '../user/user.domain';
+import { ReferralService } from './referral.service';
+
+@ApiTags('Referral')
+@Controller('referral')
+export class ReferralController {
+  constructor(private readonly referralService: ReferralService) {}
+
+  @Post('/token')
+  @HttpCode(HttpStatus.OK)
+  @ApiOperation({ summary: 'Generate referral token' })
+  @ApiOkResponse({ description: 'Referral token generated successfully' })
+  async generateToken(@UserDecorator() user: User) {
+    const token = this.referralService.generateToken(user.uuid, user.createdAt);
+    return { token };
+  }
+}

src/modules/referral/referral.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { ReferralController } from './referral.controller';
+import { ReferralService } from './referral.service';
+import { CelloReferralService } from './cello-referral.service';
+
+@Module({
+  controllers: [ReferralController],
+  providers: [
+    {
+      provide: ReferralService,
+      useClass: CelloReferralService,
+    },
+  ],
+})
+export class ReferralModule {}

src/modules/referral/referral.service.ts

@@ -0,0 +1,3 @@
+export abstract class ReferralService {
+  abstract generateToken(productUserId: string, signupDate: Date): string;
+}