fix: fixed exceptions that were throws for cf on unsupported flows & cleaned code

Author: chesterkmr

services/workflows-service/prisma/data-migrations

@@ -49,6 +49,7 @@ import { CollectionFlowStateService } from './services/collection-flow-state.ser
 import { CollectionFlowDocumentsController } from './controllers/collection-flow.documents.controller';
 import { CollectionFlowDocumentsService } from './services/collection-flow-documents.service';
 import { DocumentFileModule } from '@/document-file/document-file.module';
+import { CollectionFlowUtilityModule } from './services/сollection-flow-utility/collection-flow-utility.module';
 
 @Module({
   imports: [
@@ -67,6 +68,7 @@ import { DocumentFileModule } from '@/document-file/document-file.module';
     forwardRef(() => WorkflowModule),
     DocumentModule,
     DocumentFileModule,
+    CollectionFlowUtilityModule,
   ],
   controllers: [
     CollectionFlowController,

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

@@ -20,7 +20,6 @@ import {
   DocumentStatus,
   EndUserVariant,
   UiDefinition,
-  WorkflowRuntimeData,
 } from '@prisma/client';
 import { findEntityFieldsDefinition } from '../helpers/find-entity-fields-definition';
 import { findDocumentDefinitionByTypeAndCategory } from '../helpers/find-document-definition-by-type-and-category';
@@ -38,6 +37,7 @@ import {
 } from '@/prisma/prisma.util';
 import { PrismaService } from '@/prisma/prisma.service';
 import { assertIsValidProjectIds } from '@/project/project-scope.service';
+import { CollectionFlowUtilityService } from './сollection-flow-utility/collection-flow-utility.service';
 
 @Injectable()
 export class CollectionFlowStateService {
@@ -49,6 +49,7 @@ export class CollectionFlowStateService {
     protected readonly workflowService: WorkflowService,
     protected readonly appLogger: AppLoggerService,
     protected readonly prismaService: PrismaService,
+    protected readonly collectionFlowUtilityService: CollectionFlowUtilityService,
   ) {}
 
   async getCollectionFlowState(workflowId: string, projectIds: TProjectIds) {
@@ -60,6 +61,15 @@ export class CollectionFlowStateService {
     );
 
     const collectionFlowState = getCollectionFlowState(workflowWithRelations.context);
+    const isCollectionFlowStateSupported =
+      await this.collectionFlowUtilityService.isCollectionFlowStateSupported(
+        workflowId,
+        projectIds,
+      );
+
+    if (!isCollectionFlowStateSupported) {
+      return null;
+    }
 
     if (!collectionFlowState) {
       throw new CollectionFlowMissingException();
@@ -281,41 +291,6 @@ export class CollectionFlowStateService {
     return collectionFlowState.status;
   }
 
-  private getEntityIdsFromWorkflow(
-    workflow: WorkflowRuntimeData & {
-      childWorkflowsRuntimeData: WorkflowRuntimeData[];
-    },
-  ): Array<{ entityId: string; entityType: TEntityType }> {
-    const entityIds: Array<{ entityId: string; entityType: TEntityType }> = [
-      {
-        entityId: workflow.context.entity.ballerineEntityId,
-        entityType: EntityType.business,
-      },
-    ];
-
-    workflow.childWorkflowsRuntimeData?.forEach(childWorkflow => {
-      if (!childWorkflow.endUserId) {
-        throw new Error('End user ID not found on child workflow.');
-      }
-
-      entityIds.push({
-        entityId: childWorkflow.endUserId,
-        entityType: EntityType.ubo,
-      });
-    });
-
-    workflow.context?.entity?.data?.additionalInfo?.directors?.forEach(
-      (director: { ballerineEntityId: string }) => {
-        entityIds.push({
-          entityId: director.ballerineEntityId,
-          entityType: EntityType.director,
-        });
-      },
-    );
-
-    return entityIds;
-  }
-
   async updateCollectionFlowState(
     workflowId: string,
     newState: UpdateCollectionFlowStateDto,

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

@@ -0,0 +1,16 @@
+// eslint-disable-next-line import/no-cycle
+import { WorkflowModule } from '@/workflow/workflow.module';
+import { forwardRef, Module } from '@nestjs/common';
+import { CollectionFlowUtilityService } from './collection-flow-utility.service';
+import { UiDefinitionModule } from '@/ui-definition/ui-definition.module';
+
+@Module({
+  imports: [
+    // eslint-disable-next-line import/no-cycle
+    forwardRef(() => WorkflowModule),
+    UiDefinitionModule,
+  ],
+  providers: [CollectionFlowUtilityService],
+  exports: [CollectionFlowUtilityService],
+})
+export class CollectionFlowUtilityModule {}

services/workflows-service/src/collection-flow/services/сollection-flow-utility/collection-flow-utility.module.ts

@@ -0,0 +1,37 @@
+import { isPrismaException } from '@/common/is-prisma-exception/is-prisma-exception';
+import { TProjectIds } from '@/types';
+import { UiDefinitionService } from '@/ui-definition/ui-definition.service';
+import { WorkflowService } from '@/workflow/workflow.service';
+import { forwardRef, Inject, Injectable } from '@nestjs/common';
+
+@Injectable()
+export class CollectionFlowUtilityService {
+  constructor(
+    @Inject(forwardRef(() => WorkflowService))
+    protected readonly workflowService: WorkflowService,
+    protected readonly uiDefinitionService: UiDefinitionService,
+  ) {}
+
+  async isCollectionFlowStateSupported(workflowId: string, projectIds: TProjectIds) {
+    const workflowDefinition = await this.workflowService.getWorkflowByIdWithRelations(
+      workflowId,
+      projectIds,
+    );
+
+    try {
+      await this.uiDefinitionService.getByWorkflowDefinitionId(
+        workflowDefinition.workflowDefinitionId,
+        'collection_flow',
+        projectIds,
+      );
+
+      return true;
+    } catch (error) {
+      if (isPrismaException(error) && error.code === 'P2025') {
+        return false;
+      }
+
+      throw error;
+    }
+  }
+}

services/workflows-service/src/collection-flow/services/сollection-flow-utility/collection-flow-utility.service.ts

@@ -0,0 +1,6 @@
+import { isType } from '@ballerine/common';
+import { PrismaClientKnownRequestError } from '@prisma/client/runtime';
+import { z } from 'zod';
+
+export const isPrismaException = (value: unknown): value is PrismaClientKnownRequestError =>
+  isType(z.object({ code: z.string() }))(value);

services/workflows-service/src/common/is-prisma-exception/is-prisma-exception.ts

@@ -10,6 +10,7 @@ import { WorkflowModule } from '@/workflow/workflow.module';
 import { UiDefinitionModule } from '@/ui-definition/ui-definition.module';
 import { WorkflowDefinitionModule } from '@/workflow-defintion/workflow-definition.module';
 import { ProjectScopeService } from '@/project/project-scope.service';
+import { CollectionFlowUtilityModule } from '@/collection-flow/services/сollection-flow-utility/collection-flow-utility.module';
 
 @Module({
   imports: [
@@ -19,6 +20,7 @@ import { ProjectScopeService } from '@/project/project-scope.service';
     forwardRef(() => WorkflowModule),
     UiDefinitionModule,
     WorkflowDefinitionModule,
+    CollectionFlowUtilityModule,
   ],
   controllers: [DocumentControllerExternal],
   providers: [DocumentService, DocumentRepository, ProjectScopeService],

services/workflows-service/src/document/document.module.ts

@@ -42,10 +42,13 @@ import {
   EntitySchema,
   TParsedDocuments,
 } from './types';
-import { defaultPrismaTransactionOptions } from '@/prisma/prisma.util';
-import { beginTransactionIfNotExistCurry } from '@/prisma/prisma.util';
+import {
+  defaultPrismaTransactionOptions,
+  beginTransactionIfNotExistCurry,
+} from '@/prisma/prisma.util';
 import { PrismaService } from '@/prisma/prisma.service';
 import { assertIsValidProjectIds } from '@/project/project-scope.service';
+import { CollectionFlowUtilityService } from '@/collection-flow/services/сollection-flow-utility/collection-flow-utility.service';
 
 @Injectable()
 export class DocumentService {
@@ -58,6 +61,7 @@ export class DocumentService {
     protected readonly uiDefinitionService: UiDefinitionService,
     protected readonly workflowDefinitionService: WorkflowDefinitionService,
     protected readonly prismaService: PrismaService,
+    protected readonly collectionFlowUtilityService: CollectionFlowUtilityService,
   ) {}
 
   async create(
@@ -806,6 +810,23 @@ export class DocumentService {
   }
 
   async getDocumentTrackerByWorkflowId(projectId: TProjectId, workflowId: string) {
+    const defaultTrackerItems = {
+      business: [],
+      individuals: {
+        ubos: [],
+        directors: [],
+      },
+    };
+
+    const isCollectionFlowStateSupported =
+      await this.collectionFlowUtilityService.isCollectionFlowStateSupported(workflowId, [
+        projectId,
+      ]);
+
+    if (!isCollectionFlowStateSupported) {
+      return defaultTrackerItems;
+    }
+
     const uiDefinition = await this.uiDefinitionService.getByRuntimeId(
       workflowId,
       'collection_flow',
@@ -817,13 +838,7 @@ export class DocumentService {
       .safeParse(uiDefinition.uiSchema);
 
     if (!uiSchemaValidation.success) {
-      return {
-        business: [],
-        individuals: {
-          ubos: [],
-          directors: [],
-        },
-      };
+      return defaultTrackerItems;
     }
 
     const workflowDataWithEndUsers = await this.workflowService.getWorkflowByIdWithRelations(