fix: better violation names on statistics page (BAL-3294) (#2932)

* feat: better violation names on statistics page * fix: CodeRabbit comments --------- Co-authored-by: Alon Peretz <[email protected]>
ballerine-io · Jan 5, 2025 · 6f0a6af · 6f0a6af
1 parent 995102f
commit 6f0a6af
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 15 deletions.
diff --git a/...ness-reports/hooks/queries/useBusinessReportMetricsQuery/useBusinessReportMetricsQuery.ts b/...ness-reports/hooks/queries/useBusinessReportMetricsQuery/useBusinessReportMetricsQuery.ts
@@ -12,7 +12,13 @@ export const MetricsResponseSchema = z.object({
     high: z.number(),
     critical: z.number(),
   }),
-  violationCounts: z.record(z.string(), z.number()),
+  violationCounts: z.array(
+    z.object({
+      name: z.string(),
+      id: z.string(),
+      count: z.number(),
+    }),
+  ),
 });
 
 export const fetchBusinessReportMetrics = async () => {

diff --git a/...ce-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx b/...ce-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx
@@ -172,11 +172,11 @@ export const PortfolioRiskStatistics: FunctionComponent<z.infer<typeof MetricsRe
                   </TableRow>
                 </TableHeader>
                 <TableBody ref={parent}>
-                  {filteredRiskIndicators.map(({ name, count }, index) => (
+                  {filteredRiskIndicators.map(({ name, count, id }, index) => (
                     <TableRow key={name} className={'border-b-0 hover:bg-[unset]'}>
                       <TableCell className={ctw('pb-0 ps-0', index !== 0 && 'pt-2')}>
                         <Link
-                          to={`/${locale}/merchant-monitoring?findings[0]=${name}`}
+                          to={`/${locale}/merchant-monitoring?findings[0]=${id}`}
                           className={`block h-full cursor-pointer rounded bg-blue-200 p-1 transition-all`}
                           style={{ width: `${widths[index]}%` }}
                         >

diff --git a/...oRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx b/...oRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx
@@ -20,11 +20,10 @@ export const usePortfolioRiskStatisticsLogic = ({
     },
     [],
   );
-  const totalRiskIndicators = Object.values(violationCounts).reduce((acc, curr) => acc + curr, 0);
+  const totalRiskIndicators = violationCounts.reduce((acc, { count }) => acc + count, 0);
   const filteredRiskIndicators = useMemo(
     () =>
-      Object.entries(violationCounts)
-        .map(([name, count]) => ({ name, count }))
+      violationCounts
         .sort((a, b) => (riskIndicatorsSorting === 'asc' ? a.count - b.count : b.count - a.count))
         .slice(0, 5),
     [violationCounts, riskIndicatorsSorting],

diff --git a/services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts b/services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts
@@ -1,5 +1,5 @@
-import { IsNumber, IsObject, ValidateNested } from 'class-validator';
 import { Type } from 'class-transformer';
+import { IsArray, IsNumber, IsString, ValidateNested } from 'class-validator';
 
 import { ApiProperty } from '@nestjs/swagger';
 
@@ -47,12 +47,26 @@ export class BusinessReportMetricsDto {
   riskLevelCounts!: RiskLevelCountsDto;
 
   @ApiProperty({
-    description: 'Counts of violations by type',
-    example: { PROHIBITED_CONTENT: 2, MISSING_INFORMATION: 1 },
-    type: 'object',
-    additionalProperties: { type: 'number' },
+    description: 'Detected violations counts',
+    example: [{ id: 'PROHIBITED_CONTENT', name: 'Prohibited content', count: 2 }],
+    type: 'array',
   })
-  @IsObject()
-  @Type(() => Object)
-  violationCounts!: Record<string, number>;
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => ViolationCountDto)
+  violationCounts!: ViolationCountDto[];
+}
+
+export class ViolationCountDto {
+  @ApiProperty()
+  @IsString()
+  id!: string;
+
+  @ApiProperty()
+  @IsString()
+  name!: string;
+
+  @ApiProperty()
+  @IsNumber()
+  count!: number;
 }
diff --git a/services/workflows-service/src/business-report/merchant-monitoring-client.ts b/services/workflows-service/src/business-report/merchant-monitoring-client.ts
@@ -64,7 +64,13 @@ const MetricsResponseSchema = z.object({
     high: z.number(),
     critical: z.number(),
   }),
-  violationCounts: z.record(z.string(), z.number()),
+  violationCounts: z.array(
+    z.object({
+      name: z.string(),
+      id: z.string(),
+      count: z.number(),
+    }),
+  ),
 });
 
 @Injectable()