feat(posthog): send events for workflow runtime data changes to posth… (#3258)

Author: jonathan-shemer

apps/kyb-app/src/pages/CollectionFlow/versions/v2/components/organisms/CollectionFlowUI/CollectionFlowUI.tsx

@@ -218,8 +218,8 @@ export const CollectionFlowUI: FunctionComponent<ICollectionFlowUIProps> = ({
 
   if (isLoadingRevisionFields) {
     return (
-      <div className="flex items-center justify-center min-h-[200px]">
-        <div className="animate-spin rounded-full h-12 w-12 border-4 border-primary border-t-transparent" />
+      <div className="flex min-h-[200px] items-center justify-center">
+        <div className="border-primary h-12 w-12 animate-spin rounded-full border-4 border-t-transparent" />
       </div>
     );
   }

renovate.json

@@ -1,6 +1,4 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:recommended"
-  ]
+  "extends": ["config:recommended"]
 }

services/workflows-service/src/auth/workflow-token/workflow-token.service.ts

@@ -42,16 +42,16 @@ export class WorkflowTokenService {
       );
 
       let collectionFlow;
-      try {
-        const [uiDefinition, customer] = await Promise.all([
-          this.uiDefinitionService.getByWorkflowDefinitionId(
-            workflowDefinitionId,
-            UiDefinitionContext.collection_flow,
-            [projectId],
-          ),
-          this.customerService.getByProjectId(projectId),
-        ]);
+      const [uiDefinition, customer] = await Promise.all([
+        this.uiDefinitionService.getByWorkflowDefinitionId(
+          workflowDefinitionId,
+          UiDefinitionContext.collection_flow,
+          [projectId],
+        ),
+        this.customerService.getByProjectId(projectId),
+      ]);
 
+      try {
         collectionFlow = buildCollectionFlowState({
           apiUrl: env.APP_API_URL,
           steps: uiDefinition?.definition
@@ -80,6 +80,7 @@ export class WorkflowTokenService {
       }
 
       await this.workflowRuntimeDataRepository.updateStateById(
+        customer,
         workflowRuntimeDataId,
         {
           data: {

services/workflows-service/src/collection-flow/controllers/collection-flow.no-user.controller.intg.test.ts

@@ -1,7 +1,7 @@
 import { INestApplication } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { Test, TestingModule } from '@nestjs/testing';
-import { Project, WorkflowRuntimeDataToken } from '@prisma/client';
+import { Customer, Project, WorkflowRuntimeDataToken } from '@prisma/client';
 import { noop } from 'lodash';
 import request from 'supertest';
 import { ClsModule } from 'nestjs-cls';
@@ -50,8 +50,6 @@ import { CollectionFlowStateService } from '../services/collection-flow-state.se
 import { AssessmentsService } from '@/assessments/assessments.service';
 import { UnifiedApiClient } from '@/common/utils/unified-api-client/unified-api-client';
 import { KycService } from '@/kyc/kyc.service';
-import { HttpService } from '@nestjs/axios';
-import { ConfigService } from '@nestjs/config';
 
 describe('CollectionFlowSignupController', () => {
   let app: INestApplication;
@@ -65,6 +63,7 @@ describe('CollectionFlowSignupController', () => {
 
   let project: Project;
   let workflowRuntimeDataToken: WorkflowRuntimeDataToken;
+  let customer: Customer;
 
   beforeAll(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -83,7 +82,7 @@ describe('CollectionFlowSignupController', () => {
         { provide: UserService, useValue: noop },
         { provide: EventEmitter2, useValue: noop },
         { provide: AppLoggerService, useValue: { log: noop } },
-        { provide: AnalyticsService, useValue: { log: noop } },
+        { provide: AnalyticsService, useValue: { trackSafe: noop } },
         { provide: WorkflowEventEmitterService, useValue: { emit: noop } },
         WorkflowService,
         EndUserService,
@@ -134,7 +133,7 @@ describe('CollectionFlowSignupController', () => {
   beforeEach(async () => {
     await cleanupDatabase();
 
-    const customer = await customerRepository.create({
+    customer = await customerRepository.create({
       data: {
         name: 'signup-test-customer',
         displayName: 'Signup Test Customer',
@@ -163,7 +162,7 @@ describe('CollectionFlowSignupController', () => {
       },
     });
 
-    const { id: workflowRuntimeDataId } = await workflowRuntimeDataRepository.create({
+    const { id: workflowRuntimeDataId } = await workflowRuntimeDataRepository.create(customer, {
       data: {
         workflowDefinitionId: workflowDefinition.id,
         projectId: project.id,

services/workflows-service/src/collection-flow/services/collection-flow.service.intg.test.ts

@@ -56,7 +56,7 @@ const deps: Provider[] = [
   },
   {
     provide: AnalyticsService,
-    useValue: noop,
+    useValue: { trackSafe: noop },
   },
   {
     provide: EndUserService,
@@ -246,7 +246,7 @@ describe('CollectionFlowService', () => {
         },
       });
 
-      const workflowRuntimeData = await workflowRuntimeDataRepository.create({
+      const workflowRuntimeData = await workflowRuntimeDataRepository.create(customer, {
         data: {
           workflowDefinitionId: workflowDefinition.id,
           workflowDefinitionVersion: workflowDefinition.version,

services/workflows-service/src/collection-flow/services/collection-flow.service.ts

@@ -229,12 +229,12 @@ export class CollectionFlowService {
   }
 
   async createEntitiesIfNeeded(
-    entities: {
+    entities: Array<{
       firstName: string;
       lastName: string;
       email: string;
       ballerineEntityId?: string;
-    }[],
+    }>,
     projectId: string,
     transaction: Prisma.TransactionClient,
   ) {

services/workflows-service/src/common/analytics-logger/analytics.service.ts

@@ -12,6 +12,7 @@ export const EventNamesMap = {
   CUSTOMER_CREATED: 'customer.created',
   USER_CREATED: 'user.created',
   BUSINESS_REPORT_REQUESTED: 'business_report.requested',
+  CASE_CHANGED: 'case.changed',
 } as const;
 
 type AnalyticsEvents = {
@@ -26,6 +27,14 @@ type AnalyticsEvents = {
     businessId: string;
     customerId: string;
   };
+  [EventNamesMap.CASE_CHANGED]: {
+    workflowRuntimeDataId: string;
+    endUserId: string | null;
+    businessId: string | null;
+    projectId: string;
+    actorUserId: string | null;
+    actorEndUserId: string | null;
+  };
 };
 
 type TrackParams<Event extends keyof AnalyticsEvents> = {

services/workflows-service/src/common/utils/idv/index.ts

@@ -130,14 +130,14 @@ export const handleIndividualVerificationDocuments = async ({
   kycDocumentImages: Array<{ context?: string; content: string }>;
   person: Pick<TIndividualVerificationData['person'], 'idNumber'>;
 }) => {
-  const documentPages: {
+  const documentPages: Array<{
     uri: string;
     provider: string;
     type: string | undefined;
     metadata: {
       side: string | undefined;
     };
-  }[] = [];
+  }> = [];
 
   for (const kycDocumentImage of kycDocumentImages) {
     const tmpFile = tmp.fileSync({ keep: false }).name;

services/workflows-service/src/common/utils/parse-csv/parse-csv.ts

@@ -23,11 +23,12 @@ export const parseCsv = async <TSchema extends ZodSchema>(
     fileContent = fs.readFileSync(processEntity.filePath);
     filenameWithExtension = processEntity.filePath;
   }
+
   const isCsv = filenameWithExtension.toLowerCase().endsWith('.csv');
 
   return new Promise((resolve, reject) => {
     const results: z.output<TSchema> = [];
-    const errors: { message: string }[] = [];
+    const errors: Array<{ message: string }> = [];
 
     if (!isCsv) {
       errors.push({
@@ -67,9 +68,11 @@ export const parseCsv = async <TSchema extends ZodSchema>(
             results.push(validatedRecord);
           } catch (error) {
             const lineNumber = index + 2;
+
             if (!(error instanceof ZodError)) {
               throw error;
             }
+
             logger.error('Validation error:', { error, record });
             const rowErrors = error.errors.map(zodIssue => ({
               message: `Line ${lineNumber} - ${zodIssue.message}`,

services/workflows-service/src/user/user.controller.internal.ts

@@ -116,6 +116,7 @@ export class UserControllerInternal {
     try {
       // Check if user exists
       const existingUser = await this.userService.getByIdUnscoped(id, {});
+
       if (!existingUser) {
         throw new NotFoundException(`User with ID ${id} not found`);
       }
@@ -141,6 +142,7 @@ export class UserControllerInternal {
       if (error instanceof NotFoundException) {
         throw error;
       }
+
       throw new BadRequestException('Failed to update user');
     }
   }
@@ -155,6 +157,7 @@ export class UserControllerInternal {
     try {
       // Check if user exists
       const existingUser = await this.userService.getByIdUnscoped(id, {});
+
       if (!existingUser) {
         throw new NotFoundException(`User with ID ${id} not found`);
       }
@@ -169,6 +172,7 @@ export class UserControllerInternal {
       if (error instanceof NotFoundException) {
         throw error;
       }
+
       throw new BadRequestException('Failed to delete user');
     }
   }
@@ -183,6 +187,7 @@ export class UserControllerInternal {
     try {
       // Check if user exists
       const existingUser = await this.userService.getByIdUnscoped(id, {});
+
       if (!existingUser) {
         throw new NotFoundException(`User with ID ${id} not found`);
       }
@@ -208,6 +213,7 @@ export class UserControllerInternal {
       if (error instanceof NotFoundException) {
         throw error;
       }
+
       throw new BadRequestException('Failed to block user');
     }
   }
@@ -222,6 +228,7 @@ export class UserControllerInternal {
     try {
       // Check if user exists
       const existingUser = await this.userService.getByIdUnscoped(id, {});
+
       if (!existingUser) {
         throw new NotFoundException(`User with ID ${id} not found`);
       }
@@ -247,6 +254,7 @@ export class UserControllerInternal {
       if (error instanceof NotFoundException) {
         throw error;
       }
+
       throw new BadRequestException('Failed to unblock user');
     }
   }