Feature/implement risk rule ( WIP ) BAL-2445

packages/common/src/rule-engine/types.ts

@@ -32,7 +32,14 @@ export type RuleResult = PassedRuleResult | FailedRuleResult;
 
 export type RuleResultSet = RuleResult[];
 
-export interface TFindAllRulesOptions {
+export type TNotionRulesOptions = {
   databaseId: string;
   source: 'notion';
-}
+};
+
+export type TDatabaseRulesOptions = {
+  policyId: string;
+  source: 'database';
+};
+
+export type TFindAllRulesOptions = TNotionRulesOptions | TDatabaseRulesOptions;

packages/workflow-core/src/lib/plugins/common-plugin/types.ts

@@ -49,10 +49,7 @@ export interface IterativePluginParams {
 type RuleSetOptions = { databaseId: string };
 export interface RiskRulesPluginParams {
   name: string;
-  rulesSource: {
-    source: 'notion';
-    databaseId: string;
-  };
+  rulesSource: TFindAllRulesOptions;
   stateNames: string[];
   successAction?: string;
   errorAction?: string;

services/workflows-service/plugins/verify-repository-project-scoped/verify-repository-project-scoped.rule.js

@@ -10,7 +10,7 @@ module.exports = {
   },
   create: context => {
     const isRepository =
-      /^(?!.*\/(customer|data-migration)\.repository\.(ts|js)$).*\.repository\.(ts|js)$/.test(
+      /^(?!.*\/(customer|data-migration|risk-rule-set)\.repository\.(ts|js)$).*\.repository\.(ts|js)$/.test(
         // Using deprecated .getFilename here because relevant context.filename returns undefined
         context.getFilename(),
       );

services/workflows-service/prisma/migrations/20240716155934_create_rule_policy/migration.sql

@@ -0,0 +1,94 @@
+-- CreateEnum
+CREATE TYPE "IndicatorRiskLevel" AS ENUM ('positive', 'moderate', 'critical');
+
+-- CreateEnum
+CREATE TYPE "RuleEngine" AS ENUM ('Ballerine', 'JsonLogic');
+
+-- CreateTable
+CREATE TABLE "WorkflowDefinitionRiskRulePolicy" (
+    "id" TEXT NOT NULL,
+    "workflowDefinitionId" TEXT NOT NULL,
+    "riskRulesPolicyId" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "WorkflowDefinitionRiskRulePolicy_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RiskRulesPolicy" (
+    "id" TEXT NOT NULL,
+    "projectId" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "RiskRulesPolicy_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RiskRuleSet" (
+    "id" TEXT NOT NULL,
+    "riskRulePolicyId" TEXT NOT NULL,
+    "domain" TEXT NOT NULL,
+    "indicator" TEXT NOT NULL,
+    "riskLevel" "IndicatorRiskLevel" NOT NULL,
+    "baseRiskScore" INTEGER NOT NULL,
+    "additionalRiskScore" INTEGER NOT NULL,
+    "minRiskScore" INTEGER,
+    "maxRiskScore" INTEGER,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "RiskRuleSet_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Rule" (
+    "id" TEXT NOT NULL,
+    "riskRuleSetId" TEXT NOT NULL,
+    "key" TEXT NOT NULL,
+    "operator" TEXT NOT NULL,
+    "comparisonValue" JSONB NOT NULL,
+    "engine" "RuleEngine" NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "riskRuleSetRiskRulePolicyId" TEXT,
+
+    CONSTRAINT "Rule_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "WorkflowDefinitionRiskRulePolicy_workflowDefinitionId_key" ON "WorkflowDefinitionRiskRulePolicy"("workflowDefinitionId");
+
+-- CreateIndex
+CREATE INDEX "WorkflowDefinitionRiskRulePolicy_workflowDefinitionId_idx" ON "WorkflowDefinitionRiskRulePolicy"("workflowDefinitionId");
+
+-- CreateIndex
+CREATE INDEX "WorkflowDefinitionRiskRulePolicy_riskRulesPolicyId_idx" ON "WorkflowDefinitionRiskRulePolicy"("riskRulesPolicyId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "WorkflowDefinitionRiskRulePolicy_workflowDefinitionId_riskR_key" ON "WorkflowDefinitionRiskRulePolicy"("workflowDefinitionId", "riskRulesPolicyId");
+
+-- CreateIndex
+CREATE INDEX "RiskRulesPolicy_projectId_idx" ON "RiskRulesPolicy"("projectId");
+
+-- CreateIndex
+CREATE INDEX "RiskRuleSet_riskRulePolicyId_idx" ON "RiskRuleSet"("riskRulePolicyId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "RiskRuleSet_id_riskRulePolicyId_key" ON "RiskRuleSet"("id", "riskRulePolicyId");
+
+-- AddForeignKey
+ALTER TABLE "WorkflowDefinitionRiskRulePolicy" ADD CONSTRAINT "WorkflowDefinitionRiskRulePolicy_riskRulesPolicyId_fkey" FOREIGN KEY ("riskRulesPolicyId") REFERENCES "RiskRulesPolicy"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "WorkflowDefinitionRiskRulePolicy" ADD CONSTRAINT "WorkflowDefinitionRiskRulePolicy_workflowDefinitionId_fkey" FOREIGN KEY ("workflowDefinitionId") REFERENCES "WorkflowDefinition"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RiskRulesPolicy" ADD CONSTRAINT "RiskRulesPolicy_projectId_fkey" FOREIGN KEY ("projectId") REFERENCES "Project"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RiskRuleSet" ADD CONSTRAINT "RiskRuleSet_riskRulePolicyId_fkey" FOREIGN KEY ("riskRulePolicyId") REFERENCES "RiskRulesPolicy"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Rule" ADD CONSTRAINT "Rule_riskRuleSetId_fkey" FOREIGN KEY ("riskRuleSetId") REFERENCES "RiskRuleSet"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

services/workflows-service/prisma/schema.prisma

@@ -188,12 +188,13 @@ model WorkflowDefinition {
   persistStates Json?
   submitStates  Json?
 
-  createdAt           DateTime              @default(now())
-  updatedAt           DateTime              @updatedAt
-  createdBy           String                @default("SYSTEM")
-  project             Project?              @relation(fields: [projectId], references: [id])
-  workflowRuntimeData WorkflowRuntimeData[]
-  uiDefinitions       UiDefinition[]
+  createdAt                        DateTime                          @default(now())
+  updatedAt                        DateTime                          @updatedAt
+  createdBy                        String                            @default("SYSTEM")
+  project                          Project?                          @relation(fields: [projectId], references: [id])
+  workflowRuntimeData              WorkflowRuntimeData[]
+  uiDefinitions                    UiDefinition[]
+  workflowDefinitionRiskRulePolicy WorkflowDefinitionRiskRulePolicy?
 
   @@unique([name, version, projectId, definitionType])
   @@index([projectId, name, definitionType])
@@ -370,6 +371,7 @@ model Project {
   SalesforceIntegration    SalesforceIntegration?
   workflowDefinitions      WorkflowDefinition[]
   uiDefinitions            UiDefinition[]
+  riskRulesPolicies        RiskRulesPolicy[]
   WorkflowRuntimeDataToken WorkflowRuntimeDataToken[]
   TransactionRecord        TransactionRecord[]
   AlertDefinition          AlertDefinition[]
@@ -806,6 +808,12 @@ enum RiskCategory {
   high
 }
 
+enum IndicatorRiskLevel {
+  positive
+  moderate
+  critical
+}
+
 enum ComplianceStatus {
   compliant
   non_compliant
@@ -855,6 +863,11 @@ enum BusinessReportStatus {
   completed
 }
 
+enum RuleEngine {
+  Ballerine
+  JsonLogic
+}
+
 model BusinessReport {
   id       String             @id @default(cuid())
   type     BusinessReportType
@@ -878,3 +891,72 @@ model BusinessReport {
   @@index([riskScore])
   @@index([type])
 }
+
+model WorkflowDefinitionRiskRulePolicy {
+  id                   String             @id @default(cuid())
+  workflowDefinitionId String             @unique
+  riskRulesPolicyId    String
+  riskRulesPolicy      RiskRulesPolicy    @relation(fields: [riskRulesPolicyId], references: [id])
+  workflowDefinition   WorkflowDefinition @relation(fields: [workflowDefinitionId], references: [id])
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@unique([workflowDefinitionId, riskRulesPolicyId])
+  @@index([workflowDefinitionId])
+  @@index([riskRulesPolicyId])
+}
+
+model RiskRulesPolicy {
+  id        String @id @default(cuid())
+  projectId String
+
+  riskRuleSets                       RiskRuleSet[]
+  workflowDefinitionRiskRulePolicies WorkflowDefinitionRiskRulePolicy[]
+  project                            Project                            @relation(fields: [projectId], references: [id])
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@index([projectId])
+}
+
+model RiskRuleSet {
+  id               String @id @default(cuid())
+  riskRulePolicyId String
+
+  domain    String
+  indicator String
+  riskLevel IndicatorRiskLevel
+
+  baseRiskScore       Int
+  additionalRiskScore Int
+  minRiskScore        Int?
+  maxRiskScore        Int?
+
+  riskRulePolicy RiskRulesPolicy @relation(fields: [riskRulePolicyId], references: [id])
+  rules          Rule[]
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@unique([id, riskRulePolicyId])
+  @@index([riskRulePolicyId])
+}
+
+model Rule {
+  id            String @id @default(cuid())
+  riskRuleSetId String
+
+  key             String
+  operator        String
+  comparisonValue Json
+  engine          RuleEngine
+
+  riskRuleSet RiskRuleSet @relation(fields: [riskRuleSetId], references: [id])
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  riskRuleSetRiskRulePolicyId String?
+}

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

@@ -47,6 +47,9 @@ import z from 'zod';
 import { hashKey } from './customer/api-key/utils';
 import { RuleEngineModule } from './rule-engine/rule-engine.module';
 import { NotionModule } from '@/notion/notion.module';
+import { RiskRulePolicyModule } from '@/risk-rules/risk-rule-policy/risk-rule-policy.module';
+import { RiskRuleSetModule } from '@/risk-rules/risk-rule-set/risk-rule-set.module';
+import { RuleModule } from '@/risk-rules/rule/rule.module';
 
 export const validate = async (config: Record<string, unknown>) => {
   const zodEnvSchema = z
@@ -124,6 +127,10 @@ export const validate = async (config: Record<string, unknown>) => {
     initHttpMoudle(),
     RuleEngineModule,
     NotionModule,
+    // Risk rules Modules
+    RiskRulePolicyModule,
+    RiskRuleSetModule,
+    RuleModule,
   ],
   providers: [
     {

services/workflows-service/src/helpers/type-box/type-string-enum.ts

@@ -0,0 +1,8 @@
+import { Type } from '@sinclair/typebox';
+
+export const TypeStringEnum = <T extends string[]>(values: [...T], description?: string) =>
+  Type.Unsafe<T[number]>({
+    type: 'string',
+    enum: values,
+    description,
+  });

services/workflows-service/src/risk-rules/risk-rule-policy/risk-rule-policy.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { AppLoggerModule } from '@/common/app-logger/app-logger.module';
+import { RiskRulePolicyService } from '@/risk-rules/risk-rule-policy/risk-rule-policy.service';
+import { RiskRulePolicyRepository } from '@/risk-rules/risk-rule-policy/risk-rule-policy.repository';
+import { PrismaModule } from '@/prisma/prisma.module';
+import { RiskRuleSetModule } from '@/risk-rules/risk-rule-set/risk-rule-set.module';
+
+@Module({
+  imports: [AppLoggerModule, PrismaModule, RiskRuleSetModule],
+  providers: [RiskRulePolicyService, RiskRulePolicyRepository],
+  exports: [RiskRulePolicyService],
+})
+export class RiskRulePolicyModule {}

services/workflows-service/src/risk-rules/risk-rule-policy/risk-rule-policy.repository.ts

@@ -0,0 +1,52 @@
+import { Injectable } from '@nestjs/common';
+import { PrismaService } from '@/prisma/prisma.service';
+import { Prisma } from '@prisma/client';
+import { ProjectScopeService } from '@/project/project-scope.service';
+import { TProjectIds } from '@/types';
+
+@Injectable()
+export class RiskRulePolicyRepository {
+  constructor(
+    private readonly prisma: PrismaService,
+    private readonly scopeService: ProjectScopeService,
+  ) {}
+
+  async createRiskRulePolicy(
+    projectId: string,
+    createArgs: Prisma.RiskRulesPolicyCreateArgs['data'],
+  ) {
+    return this.prisma.riskRulesPolicy.create({
+      data: createArgs,
+    });
+  }
+
+  async findRiskRulePolicyById(id: string, projectIds: TProjectIds) {
+    return this.prisma.riskRulesPolicy.findUnique({
+      where: { id },
+    });
+  }
+
+  async findRiskRulePolicyByWorkflowDefinitionId(
+    workflowDefinitionId: string,
+    projectIds: TProjectIds,
+  ) {
+    return this.prisma.riskRulesPolicy.findFirstOrThrow({
+      where: {
+        workflowDefinitionRiskRulePolicies: {
+          some: {
+            workflowDefinitionId,
+          },
+        },
+      },
+      select: {
+        riskRuleSets: true,
+      },
+    });
+  }
+
+  async findRiskRulePolicyByProjectId(projectId: string) {
+    return this.prisma.riskRulesPolicy.findFirst({
+      where: { projectId },
+    });
+  }
+}

services/workflows-service/src/risk-rules/risk-rule-policy/risk-rule-policy.service.ts

@@ -0,0 +1,7 @@
+import { Injectable } from '@nestjs/common';
+import { RiskRulePolicyRepository } from './risk-rule-policy.repository';
+
+@Injectable()
+export class RiskRulePolicyService {
+  constructor(private readonly riskRuleSetRepository: RiskRulePolicyRepository) {}
+}

services/workflows-service/src/risk-rules/risk-rule-set/risk-rule-set.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { AppLoggerModule } from '@/common/app-logger/app-logger.module';
+import { PrismaModule } from '@/prisma/prisma.module';
+import { RiskRuleSetService } from '@/risk-rules/risk-rule-set/risk-rule-set.service';
+import { RiskRuleSetRepository } from '@/risk-rules/risk-rule-set/risk-rule-set.repository';
+
+@Module({
+  imports: [AppLoggerModule, PrismaModule],
+  providers: [RiskRuleSetService, RiskRuleSetRepository],
+  exports: [RiskRuleSetService],
+})
+export class RiskRuleSetModule {}