add referral link command and tests

libs/model/src/models/user.ts

@@ -74,6 +74,7 @@ export default (sequelize: Sequelize.Sequelize): UserModelStatic =>
       selected_community_id: { type: Sequelize.STRING, allowNull: true },
       profile: { type: Sequelize.JSONB, allowNull: false },
       xp_points: { type: Sequelize.INTEGER, defaultValue: 0, allowNull: true },
+      referral_link: { type: Sequelize.STRING, allowNull: true },
     },
     {
       timestamps: true,

libs/model/src/user/CreateReferralLink.command.ts

@@ -0,0 +1,34 @@
+import { InvalidInput, type Command } from '@hicommonwealth/core';
+import * as schemas from '@hicommonwealth/schemas';
+import { randomBytes } from 'crypto';
+import { models } from '../database';
+import { mustExist } from '../middleware/guards';
+
+export function CreateReferralLink(): Command<
+  typeof schemas.CreateReferralLink
+> {
+  return {
+    ...schemas.CreateReferralLink,
+    auth: [],
+    secure: true,
+    body: async ({ actor }) => {
+      const user = await models.User.findOne({
+        where: { id: actor.user.id },
+        attributes: ['id', 'referral_link'],
+      });
+      mustExist('User', user);
+
+      if (user.referral_link)
+        throw new InvalidInput('Referral link already exists');
+
+      const randomSegment = randomBytes(8).toString('base64url');
+      const referral_link = `ref_${user.id}_${randomSegment}`;
+
+      await user.update({ referral_link });
+
+      return {
+        referral_link,
+      };
+    },
+  };
+}

libs/model/test/user/user-lifecycle.spec.ts

@@ -0,0 +1,36 @@
+import { Actor, command, dispose } from '@hicommonwealth/core';
+import { CreateReferralLink } from 'model/src/user/CreateReferralLink.command';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { seedCommunity } from '../utils/community-seeder';
+
+describe('User lifecycle', () => {
+  let member: Actor;
+
+  beforeAll(async () => {
+    const { actors } = await seedCommunity({
+      roles: ['member'],
+    });
+    member = actors.member;
+  });
+
+  afterAll(async () => {
+    await dispose()();
+  });
+
+  it('should create referral link when user is created', async () => {
+    const response = await command(CreateReferralLink(), {
+      actor: member,
+      payload: {},
+    });
+    expect(response!.referral_link).toBeDefined();
+  });
+
+  it('should fail to create referral link when one already exists', async () => {
+    expect(
+      command(CreateReferralLink(), {
+        actor: member,
+        payload: {},
+      }),
+    ).rejects.toThrowError('Referral link already exists');
+  });
+});

libs/schemas/src/commands/user.schemas.ts

@@ -38,3 +38,10 @@ export const DeleteApiKey = {
     deleted: z.boolean(),
   }),
 };
+
+export const CreateReferralLink = {
+  input: z.object({}),
+  output: z.object({
+    referral_link: z.string(),
+  }),
+};

libs/schemas/src/entities/user.schemas.ts

@@ -53,6 +53,7 @@ export const User = z.object({
 
   profile: UserProfile,
   xp_points: PG_INT.default(0).nullish(),
+  referral_link: z.string().nullish(),
 
   ProfileTags: z.array(ProfileTags).optional(),
   ApiKey: ApiKey.optional(),

packages/commonwealth/server/migrations/20241114144100-create-referral-link.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  up: async ({ sequelize }) => {
+    await sequelize.transaction(async (transaction) => {
+      await sequelize.query(
+        `ALTER TABLE "Users" ADD COLUMN "referral_link" character varying(255);`,
+        { transaction },
+      );
+    });
+  },
+
+  down: async ({ sequelize }) => {
+    await sequelize.transaction(async (transaction) => {
+      await sequelize.query(
+        `ALTER TABLE "Users" DROP COLUMN "referral_link";`,
+        { transaction },
+      );
+    });
+  },
+};