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

[r4zendev]

Changes

• Changes expected shape of data that comes from the Unified API when calling for metrics
• Adjusts front-end logic to work with new data shape

Note

This PR must be reviewed in conjunction with another PR opened against our private repository with Unified API.

Summary by CodeRabbit

• New Features

  • Updated violation counts data structure to include more detailed information (name, id, count).
  • Improved routing for portfolio risk statistics using new identifier.

• Bug Fixes

  • Adjusted data processing logic to work with new violation counts array format.

• Refactor

  • Streamlined data handling in business report metrics and portfolio risk statistics components.

[changeset-bot]

⚠️ No Changeset found

Latest commit: bf85463

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request introduces a significant change to the structure of violationCounts across multiple services and components. The modification transforms violationCounts from a simple key-value record to an array of objects with name, id, and count properties. This change impacts the business reports metrics schema, affecting how violation data is represented and processed in the backoffice application and workflows service.

Changes

File	Change Summary
apps/backoffice-v2/src/domains/business-reports/hooks/queries/useBusinessReportMetricsQuery/useBusinessReportMetricsQuery.ts	Updated MetricsResponseSchema to use array of objects for violationCounts
apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx	Added id property to filteredRiskIndicators mapping
apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx	Modified logic to process violationCounts as an array of objects
services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts	Changed violationCounts type and description
services/workflows-service/src/business-report/merchant-monitoring-client.ts	Updated MetricsResponseSchema to use array of objects for violationCounts

Possibly related PRs

• blokh/feat/business report alerts #2311: The changes in the BusinessReportMetricsDto class regarding the violationCounts property are related to the modifications in the MetricsResponseSchema in the main PR, as both involve changing the structure of violationCounts from a record to an array of objects.
• Fixed reports #2454: The BusinessReportSummary component's updates in this PR include changes to how data is processed, which may relate to the overall handling of business report metrics, particularly in how the violationCounts data might be displayed or summarized.
• Additional swagger documentations #2767: The modifications to the OngoingMonitoringCron class and its logging enhancements may indirectly relate to the changes in how business report metrics are processed and reported, especially if they involve monitoring violations.
• fix: browser back button functionality in merchant report page (BAL-3296) #2927: The enhancement of the browser back button functionality in the merchant report page could relate to the user experience when navigating reports that include the updated violationCounts structure, ensuring that users can easily return to previous states after viewing metrics.

Suggested labels

enhancement, Review effort [1-5]: 3

Suggested reviewers

• Omri-Levy
• MatanYadaev

Poem

🐰 Violation counts, once a simple map,
Now dance in arrays with newfound zap!
From records to objects, data takes flight,
Bringing structure that shines so bright.
A rabbit's code leap, precise and clean! 🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx (1)

26-26: Consider avoiding in-place sorting to prevent mutating the array.

Using .sort() directly mutates violationCounts. For immutability (and fewer potential surprises in React), consider copying first:

- violationCounts
-   .sort((a, b) => ...)
+ [...violationCounts]
+   .sort((a, b) => ...)

apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx (1)

175-179: Use the unique ID as the component key.

While the new id parameter is used in the URL, the key is still tied to name. For better React rendering stability and uniqueness guarantees, consider switching to key={id}.

- <TableRow key={name} className={'border-b-0 hover:bg-[unset]'}>
+ <TableRow key={id} className={'border-b-0 hover:bg-[unset]'}>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24dae62 and b9977f8.

📒 Files selected for processing (5)

• apps/backoffice-v2/src/domains/business-reports/hooks/queries/useBusinessReportMetricsQuery/useBusinessReportMetricsQuery.ts (1 hunks)
• apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx (1 hunks)
• apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx (1 hunks)
• services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts (1 hunks)
• services/workflows-service/src/business-report/merchant-monitoring-client.ts (1 hunks)

🔇 Additional comments (3)

apps/backoffice-v2/src/domains/business-reports/hooks/queries/useBusinessReportMetricsQuery/useBusinessReportMetricsQuery.ts (1)

15-21: Looks good and consistent with the new format.

Your Zod schema accurately reflects the array structure of violations.

apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx (1)

23-23: Accurate summation logic.

Summing all count properties correctly computes the total risk indicators.

services/workflows-service/src/business-report/merchant-monitoring-client.ts (1)

67-73: Schema alignment looks great.

Switching from a record to an array aligns well with the rest of the code changes and maintains consistency across the application.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts (1)

60-71: Enhance API documentation for ViolationCountDto properties.

While the implementation is correct, consider adding more descriptive API documentation for better OpenAPI/Swagger documentation.

Apply this diff to improve the documentation:

 export class ViolationCountDto {
   @ApiProperty({
+    description: 'Unique identifier of the violation type',
+    example: 'PROHIBITED_CONTENT'
   })
   @IsString()
   id!: string;

   @ApiProperty({
+    description: 'Human-readable name of the violation',
+    example: 'Prohibited content'
   })
   @IsString()
   name!: string;

   @ApiProperty({
+    description: 'Number of occurrences of this violation',
+    example: 2
   })
   @IsNumber()
   count!: number;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9977f8 and 42cd2b0.

📒 Files selected for processing (1)

• services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts (2 hunks)

🔇 Additional comments (2)

services/workflows-service/src/business-report/dtos/business-report-metrics-dto.ts (2)

2-2: LGTM! Appropriate validation decorators imported.

The added imports from class-validator are correctly chosen for validating the new array structure and its nested objects.

---

50-57: Well-structured implementation with proper validation!

The changes to violationCounts property are well-implemented:

• Clear description and example
• Proper validation using @IsArray() and @ValidateNested()
• Type safety with @Type(() => ViolationCountDto)