feat: add signup source tag (#1715)

Adds source tag to workspace created event to identify where the users
where signed up from.

Author: geclos

apps/web/src/actions/user/setupAction.ts

@@ -16,6 +16,7 @@ export const setupAction = errorHandlingProcedure
     async () => {
       return z.object({
         returnTo: z.string().optional(),
+        source: z.string().optional(),
         name: z.string().min(1, { message: 'Name is a required field' }),
         email: z
           .string()

apps/web/src/app/(public)/setup/SetupForm/index.tsx

@@ -18,12 +18,14 @@ export default function SetupForm({
   name,
   companyName,
   footer,
+  source,
   returnTo,
 }: {
   footer: ReactNode
   email?: string
   name?: string
   companyName?: string
+  source?: string
   returnTo?: string
 }) {
   const { toast } = useToast()
@@ -43,6 +45,7 @@ export default function SetupForm({
   return (
     <form action={action}>
       <input type='hidden' name='returnTo' value={returnTo} />
+      <input type='hidden' name='source' value={source} />
       <FormWrapper>
         <Input
           autoFocus

apps/web/src/app/(public)/setup/page.tsx

@@ -23,9 +23,10 @@ export default async function SetupPage({
     name?: string
     companyName?: string
     returnTo?: string
+    source?: string
   }>
 }) {
-  const { email, name, companyName, returnTo } = await searchParams
+  const { email, name, companyName, source, returnTo } = await searchParams
 
   return (
     <FocusLayout
@@ -44,6 +45,7 @@ export default async function SetupPage({
             name={name}
             companyName={companyName}
             footer={<AuthFooter />}
+            source={source}
             returnTo={returnTo}
           />
         </CardContent>

apps/web/src/services/user/setupService.ts

@@ -6,17 +6,20 @@ export default function setupService({
   email,
   name,
   companyName,
+  source,
   importDefaultProject = env.IMPORT_DEFAULT_PROJECT,
 }: {
   email: string
   name: string
   companyName: string
+  source?: string
   importDefaultProject?: boolean
 }) {
   return setupServiceFn({
     email,
     name,
     companyName,
+    source,
     defaultProviderName: env.NEXT_PUBLIC_DEFAULT_PROVIDER_NAME,
     defaultProviderApiKey: env.DEFAULT_PROVIDER_API_KEY,
     captureException,

packages/core/src/events/events.d.ts

@@ -158,6 +158,7 @@ export type WorkspaceCreatedEvent = LatitudeEventGeneric<
     user: User
     userEmail: string
     workspaceId: number
+    source: string
   }
 >
 

packages/core/src/lib/analytics/AnalyticsClient.test.ts

@@ -122,6 +122,7 @@ describe('AnalyticsClient', () => {
         event: {
           type: 'workspaceCreated',
           data: {
+            source: 'default',
             workspace: {} as Workspace, // Not really
             user,
             workspaceId: 123,
@@ -163,6 +164,7 @@ describe('AnalyticsClient', () => {
         event: {
           type: 'workspaceCreated',
           data: {
+            source: 'default',
             workspace,
             user,
             workspaceId: workspace.id,
@@ -204,6 +206,7 @@ describe('AnalyticsClient', () => {
         event: {
           type: 'workspaceCreated',
           data: {
+            source: 'default',
             workspace,
             user,
             workspaceId: workspace.id,
@@ -229,6 +232,7 @@ describe('AnalyticsClient', () => {
         event: {
           type: 'workspaceCreated',
           data: {
+            source: 'default',
             workspace,
             user,
             workspaceId: workspace.id,
@@ -256,6 +260,7 @@ describe('AnalyticsClient', () => {
           event: {
             type: 'workspaceCreated',
             data: {
+              source: 'default',
               workspace,
               user,
               workspaceId: workspace.id,

packages/core/src/services/users/setupService.ts

@@ -26,13 +26,15 @@ export default async function setupService(
     defaultProviderName,
     defaultProviderApiKey,
     captureException,
+    source,
     importDefaultProject = env.IMPORT_DEFAULT_PROJECT,
   }: {
     email: string
     name: string
     companyName: string
     defaultProviderName: string
     defaultProviderApiKey: string
+    source?: string
     captureException?: (error: Error) => void
     importDefaultProject?: boolean
   },
@@ -46,6 +48,7 @@ export default async function setupService(
     {
       name: companyName,
       user,
+      source,
     },
     transaction,
   ).then((r) => r.unwrap())

packages/core/src/services/workspaces/create.ts

@@ -13,10 +13,12 @@ export async function createWorkspace(
     name,
     user,
     createdAt,
+    source = 'default',
     subscriptionPlan = SubscriptionPlan.HobbyV2,
   }: {
     name: string
     user: User
+    source?: string
     createdAt?: Date
     subscriptionPlan?: SubscriptionPlan
   },
@@ -59,6 +61,7 @@ export async function createWorkspace(
         data: {
           workspace: w,
           user,
+          source,
           workspaceId: w.id,
           userEmail: user.email,
         },

packages/core/src/tests/factories/workspaces.ts

@@ -13,6 +13,7 @@ export type ICreateWorkspace = {
   creator?: User | ICreateUser
   createdAt?: Date
   subscriptionPlan?: SubscriptionPlan
+  source?: string
   onboarding?: boolean
   features?: string[]
 }