blokh/feat/business report alerts

services/workflows-service/prisma/migrations/20240415161621_add_monitoring_type/migration.sql

@@ -0,0 +1,5 @@
+-- CreateEnum
+CREATE TYPE "MonitoringType" AS ENUM ('transaction_monitoring', 'ongoing_merchant_monitoring');
+
+-- AlterTable with default in order to avoid the error for existing data
+ALTER TABLE "AlertDefinition" ADD COLUMN     "monitoringType" "MonitoringType" NOT NULL DEFAULT 'transaction_monitoring';

services/workflows-service/prisma/migrations/20240415161704_remove_alert_definition_monitoring_default_type/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "AlertDefinition" ALTER COLUMN "monitoringType" DROP DEFAULT;

services/workflows-service/prisma/migrations/20240415183939_associate_alert_with_business_for_ongoing_report/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "Alert" ADD COLUMN     "businessId" TEXT;
+
+-- AddForeignKey
+ALTER TABLE "Alert" ADD CONSTRAINT "Alert_businessId_fkey" FOREIGN KEY ("businessId") REFERENCES "Business"("id") ON DELETE SET NULL ON UPDATE CASCADE;

services/workflows-service/prisma/migrations/20240421105728_add_business_report_report_id/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "BusinessReport" ADD COLUMN     "reportId" TEXT NOT NULL;
+
+-- CreateIndex
+CREATE INDEX "BusinessReport_reportId_idx" ON "BusinessReport"("reportId");

services/workflows-service/prisma/migrations/20240502085516_add_risk_score_to_business_report/migration.sql

@@ -0,0 +1,11 @@
+/*
+  Warnings:
+
+  - Added the required column `riskScore` to the `BusinessReport` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "BusinessReport" ADD COLUMN     "riskScore" INTEGER NOT NULL;
+
+-- CreateIndex
+CREATE INDEX "BusinessReport_riskScore_idx" ON "BusinessReport"("riskScore");

services/workflows-service/prisma/migrations/20240502123851_add_alert_additional_info/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Alert" ADD COLUMN     "additionalInfo" JSONB;

services/workflows-service/prisma/migrations/20240516085653_add_unique_report_id/migration.sql

@@ -0,0 +1,11 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[reportId]` on the table `BusinessReport` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- DropIndex
+DROP INDEX "BusinessReport_reportId_idx";
+
+-- CreateIndex
+CREATE UNIQUE INDEX "BusinessReport_reportId_key" ON "BusinessReport"("reportId");

services/workflows-service/prisma/schema.prisma

@@ -145,6 +145,7 @@ model Business {
   project         Project          @relation(fields: [projectId], references: [id])
   Counterparty    Counterparty[]
   businessReports BusinessReport[]
+  alerts     Alert[]
 
   @@unique([projectId, correlationId])
   @@index([companyName])
@@ -707,10 +708,16 @@ enum AlertStatus {
   completed @map("300")
 }
 
+enum MonitoringType {
+  transaction_monitoring
+  ongoing_merchant_monitoring
+}
+
 model AlertDefinition {
   id          String  @id @default(cuid())
   crossEnvKey String? @unique
-  correlationId       String
+  correlationId     String
+  monitoringType    MonitoringType
   name        String
   enabled     Boolean @default(true)
   description String?
@@ -758,6 +765,7 @@ model Alert {
   severity      AlertSeverity?
 
   executionDetails Json
+  additionalInfo   Json?
 
   assignee   User?     @relation(fields: [assigneeId], references: [id], onUpdate: Cascade, onDelete: NoAction)
   assigneeId String?
@@ -772,6 +780,9 @@ model Alert {
   counterpartyId String?
   counterparty   Counterparty? @relation(fields: [counterpartyId], references: [id])
 
+  businessId String?
+  business   Business? @relation(fields: [businessId], references: [id])
+
   @@index([assigneeId])
   @@index([projectId])
   @@index([alertDefinitionId])
@@ -830,19 +841,22 @@ model Counterparty {
 model BusinessReport {
   id     String             @id @default(cuid())
   type   BusinessReportType
+  reportId String           @unique
   report Json
 
+  riskScore  Int
   businessId String
-  projectId  String
+  business   Business @relation(fields: [businessId], references: [id])
 
-  business Business @relation(fields: [businessId], references: [id])
-  project  Project  @relation(fields: [projectId], references: [id])
+  projectId  String
+  project    Project @relation(fields: [projectId], references: [id])
 
-  createdAt DateTime @default(now())
-  updatedAt DateTime @updatedAt
+  createdAt  DateTime @default(now())
+  updatedAt  DateTime @updatedAt
 
   @@index([createdAt])
   @@index([businessId])
   @@index([projectId])
+  @@index([riskScore])
   @@index([type])
 }

services/workflows-service/scripts/alerts/generate-alerts.ts

@@ -1,9 +1,10 @@
 import {
   ALERT_DEDUPE_STRATEGY_DEFAULT,
+  daysToMinutesConverter,
+  MerchantAlertLabel,
   SEVEN_DAYS,
   THREE_DAYS,
   TWENTY_ONE_DAYS,
-  daysToMinutesConverter,
 } from '@/alert/consts';
 import { TDedupeStrategy } from '@/alert/types';
 import { AggregateType, TIME_UNITS } from '@/data-analytics/consts';
@@ -14,6 +15,7 @@ import {
   AlertSeverity,
   AlertState,
   AlertStatus,
+  MonitoringType,
   PaymentMethod,
   Prisma,
   PrismaClient,
@@ -358,6 +360,7 @@ export const ALERT_DEFINITIONS = {
     description:
       'High Percentage of Chargebacks - High percentage of chargebacks over a set period of time',
     dedupeStrategy: {
+      mute: false,
       cooldownTimeframeInMinutes: daysToMinutesConverter(TWENTY_ONE_DAYS),
     },
     inlineRule: {
@@ -369,7 +372,7 @@ export const ALERT_DEFINITIONS = {
         subjectColumn: 'counterpartyOriginatorId',
         minimumCount: 3,
         minimumPercentage: 50,
-        timeAmount: 21,
+        timeAmount: TWENTY_ONE_DAYS,
         timeUnit: TIME_UNITS.days,
       },
     },
@@ -537,16 +540,74 @@ export const ALERT_DEFINITIONS = {
   },
 } as const satisfies Record<string, Parameters<typeof getAlertDefinitionCreateData>[0]>;
 
+export const MERCHANT_MONITORING_ALERT_DEFINITIONS = {
+  MERCHANT_ONGOING_RISK_ALERT_RISK_INCREASE: {
+    enabled: true,
+    defaultSeverity: AlertSeverity.low,
+    monitoringType: MonitoringType.ongoing_merchant_monitoring,
+    description: 'Monitor ongoing risk changes',
+    inlineRule: {
+      id: 'MERCHANT_ONGOING_RISK_ALERT_RISK_INCREASE',
+      fnName: 'checkMerchantOngoingAlert',
+      subjects: ['businessId', 'projectId'],
+      options: {
+        increaseRiskScore: 20,
+      },
+    },
+  },
+  MERCHANT_ONGOING_RISK_ALERT_THRESHOLD: {
+    enabled: true,
+    defaultSeverity: AlertSeverity.high,
+    monitoringType: MonitoringType.ongoing_merchant_monitoring,
+    description: 'Monitor ongoing risk changes',
+    inlineRule: {
+      id: 'MERCHANT_ONGOING_RISK_ALERT_THRESHOLD',
+      fnName: 'checkMerchantOngoingAlert',
+      subjects: ['businessId', 'projectId'],
+      options: {
+        maxRiskScoreThreshold: 60,
+      },
+    },
+  },
+  MERCHANT_ONGOING_RISK_ALERT_PERCENTAGE: {
+    enabled: true,
+    defaultSeverity: AlertSeverity.medium,
+    monitoringType: MonitoringType.ongoing_merchant_monitoring,
+    description: 'Monitor ongoing risk changes',
+    inlineRule: {
+      id: 'MERCHANT_ONGOING_RISK_ALERT_PERCENTAGE',
+      fnName: 'checkMerchantOngoingAlert',
+      subjects: ['businessId', 'projectId'],
+      options: {
+        increaseRiskScorePercentage: 30,
+      },
+    },
+  },
+} as const satisfies Partial<
+  Record<
+    keyof typeof MerchantAlertLabel | string,
+    {
+      inlineRule: InlineRule & InputJsonValue;
+      monitoringType: MonitoringType;
+      defaultSeverity: AlertSeverity;
+      enabled?: boolean;
+      description?: string;
+    }
+  >
+>;
+
 export const getAlertDefinitionCreateData = (
   {
     inlineRule,
     defaultSeverity,
     description,
+    monitoringType = MonitoringType.transaction_monitoring,
     enabled = false,
     dedupeStrategy = ALERT_DEDUPE_STRATEGY_DEFAULT,
   }: {
     inlineRule: InlineRule;
     defaultSeverity: AlertSeverity;
+    monitoringType?: MonitoringType;
     enabled: boolean;
     dedupeStrategy?: Partial<TDedupeStrategy>;
     description?: string;
@@ -564,6 +625,7 @@ export const getAlertDefinitionCreateData = (
       ...ALERT_DEDUPE_STRATEGY_DEFAULT,
       ...(dedupeStrategy ?? {}),
     },
+    monitoringType: monitoringType ?? MonitoringType.transaction_monitoring,
     inlineRule,
     correlationId: id,
     name: id,
@@ -587,6 +649,9 @@ export const generateAlertDefinitions = async (
     createdBy = 'SYSTEM',
     alertsDef = ALERT_DEFINITIONS,
   }: {
+    alertsDefConfiguration?:
+      | typeof ALERT_DEFINITIONS
+      | typeof MERCHANT_MONITORING_ALERT_DEFINITIONS;
     createdBy?: string;
     project: Project;
     alertsDef?: Partial<typeof ALERT_DEFINITIONS>;
@@ -627,18 +692,34 @@ export const generateAlertDefinitions = async (
       }),
   );
 
-const generateFakeAlert = ({
-  severity,
-  counterparyIds,
-  agentUserIds,
-}: {
-  severity: AlertSeverity;
-  counterparyIds: string[];
-  agentUserIds: string[];
-}): Omit<Prisma.AlertCreateManyAlertDefinitionInput, 'projectId'> => {
-  const counterypartyId = faker.helpers.arrayElement(
-    counterparyIds.map(id => ({ counterpartyId: id })),
-  );
+const generateFakeAlert = (
+  options: {
+    severity: AlertSeverity;
+    agentUserIds: string[];
+  } & (
+    | {
+        counterpartyIds: string[];
+      }
+    | {
+        businessIds: string[];
+      }
+  ),
+): Omit<Prisma.AlertCreateManyAlertDefinitionInput, 'projectId'> => {
+  const { severity, agentUserIds } = options;
+
+  let businessId: { businessId: string } | {} = {};
+  let counterpartyId: { counterpartyId: string } | {} = {};
+
+  if ('businessIds' in options) {
+    // For merchant monitoring alerts
+    businessId = faker.helpers.arrayElement(options.businessIds.map(id => ({ businessId: id })));
+  } else if ('counterpartyIds' in options) {
+    // For transaction alerts
+    counterpartyId = faker.helpers.arrayElement(
+      options.counterpartyIds.map(id => ({ counterpartyId: id })),
+    );
+  }
+
   // In chance of 1 to 5, assign an agent to the alert
   const assigneeId =
     faker.datatype.number({ min: 1, max: 5 }) === 1
@@ -658,29 +739,39 @@ const generateFakeAlert = ({
     } as InputJsonValue,
     severity,
     assigneeId,
-    ...counterypartyId,
+    ...counterpartyId,
+    ...businessId,
   };
 };
 
-export const generateFakeAlertsAndDefinitions = async (
+export const seedTransactionsAlerts = async (
   prisma: PrismaClient,
   {
     project,
-    counterparyIds,
+    businessIds,
+    counterpartyIds,
     agentUserIds,
   }: {
     project: Project;
-    counterparyIds: string[];
+    businessIds: string[];
+    counterpartyIds: string[];
     agentUserIds: string[];
   },
 ) => {
-  const alertDefinitions = await generateAlertDefinitions(prisma, {
+  const transactionsAlertDef = await generateAlertDefinitions(prisma, {
+    alertsDefConfiguration: ALERT_DEFINITIONS,
     project,
     createdBy: faker.internet.userName(),
   });
 
-  await Promise.all(
-    alertDefinitions.map(alertDefinition =>
+  const merchantMonitoringAlertDef = await generateAlertDefinitions(prisma, {
+    alertsDefConfiguration: MERCHANT_MONITORING_ALERT_DEFINITIONS,
+    project,
+    createdBy: faker.internet.userName(),
+  });
+
+  await Promise.all([
+    ...transactionsAlertDef.map(alertDefinition =>
       prisma.alert.createMany({
         data: Array.from(
           {
@@ -690,7 +781,7 @@ export const generateFakeAlertsAndDefinitions = async (
             alertDefinitionId: alertDefinition.id,
             projectId: project.id,
             ...generateFakeAlert({
-              counterparyIds,
+              counterpartyIds,
               agentUserIds,
               severity: faker.helpers.arrayElement(Object.values(AlertSeverity)),
             }),
@@ -699,5 +790,5 @@ export const generateFakeAlertsAndDefinitions = async (
         skipDuplicates: true,
       }),
     ),
-  );
+  ]);
 };