feat(monitoring): adds exhaustive check for action before deboarding a merchant (BAL-3343)

[r4zendev]

Repro steps:

• Click on the Turn Monitoring Off option from the options list in the top-right corner of the page
• Notice a confirmation modal popping up letting user to select the "deboarding reason"

See in action:

Screen.Recording.2025-01-14.at.21.11.41.mov

Includes changes to store user-entered data on the backend.

Summary by CodeRabbit

• New Features

  • Added a dialog component for managing merchant monitoring status
  • Introduced more detailed monitoring state changes with reasons
  • Enhanced form validation for monitoring state updates

• Improvements

  • Streamlined monitoring toggle functionality
  • Improved error handling for monitoring state changes
  • Added user feedback through toast notifications

• Bug Fixes

  • Implemented more robust error checking for merchant monitoring actions

[changeset-bot]

⚠️ No Changeset found

Latest commit: 17f711e

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 comprehensive changes to the merchant monitoring business report functionality. The modifications span multiple files across the backoffice and workflows service, focusing on enhancing the user experience for turning monitoring on and off for merchants. The changes include adding a dialog component, improving state management, implementing form validation, and updating the backend controller to handle more detailed monitoring state changes.

Changes

File	Change Summary
...MerchantMonitoringBusinessReport.page.tsx	Added dialog component for deboarding, new state management for dropdown and dialog, enhanced user interaction
...fetchers.ts	Introduced new types and schemas for ongoing monitoring requests with improved validation
...useMerchantMonitoringBusinessReportLogic.tsx	Added form validation schema, new state variables, consolidated monitoring mutation
...useToggleMonitoringMutation.tsx	New custom hook for managing monitoring state with enhanced error handling
...business.controller.external.ts	Updated method to accept more detailed monitoring state information
...business-monitoring.patch.dto.ts	New DTO for handling monitoring state patch requests

Sequence Diagram

sequenceDiagram
    participant User
    participant Page
    participant Dialog
    participant Hook
    participant API
    
    User->>Page: Click Monitoring Toggle
    Page->>Dialog: Open Confirmation Modal
    Dialog->>User: Request Monitoring State Change
    User->>Dialog: Select Reason and Confirm
    Dialog->>Hook: Submit Monitoring Change
    Hook->>API: Send Monitoring State Update
    API-->>Hook: Return Response
    Hook->>Page: Update UI
    Page->>User: Show Confirmation Toast

Loading

Possibly related PRs

• Ongoing monitoring #2743: Focuses on ongoing monitoring features
• Unsubscribe from Ongoing Merchant Monitoring #2799: Introduces unsubscribing from ongoing monitoring
• feat(monitoring): adds loading state for a single merchant record (BAL-3359) #2960: Adds loading state for merchant record

Suggested Labels

enhancement, Review effort [1-5]: 3

Suggested Reviewers

• Omri-Levy
• MatanYadaev

Poem

🐰 A Rabbit's Ode to Monitoring Might

In backoffice's digital light,
Merchants' states now dance just right,
Dialogs pop, reasons unfold,
A monitoring tale, precisely told!

Hop, hop, code springs to life! 🚀

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.

[tomer-shvadron]

LGTM, please make sure Nitzan and Adi and Robbie take a look at the design and texts

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/fetchers.ts (1)

8-12: Consider adding validation constraints to the state field.

The state field should be restricted to specific values ('on'/'off') to prevent invalid states.

-  state: z.string(),
+  state: z.enum(['on', 'off']),

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation.tsx (2)

15-17: Consider adding JSDoc documentation.

Adding documentation would help explain the purpose of each parameter, especially the optional callbacks.

+/**
+ * Custom hook for toggling merchant monitoring state
+ * @param state - The desired monitoring state ('on'/'off')
+ * @param onSuccess - Optional callback called after successful state change
+ * @param onError - Optional callback called after error, if not a 400 error
+ */

---

31-39: Consider adding error type safety.

The error handling could benefit from type narrowing to ensure all error cases are handled properly.

-    onError: (error: unknown) => {
+    onError: (error: unknown) => {
+      if (!(error instanceof Error)) {
+        onError?.(error);
+        return;
+      }
+
       if (error instanceof HttpError && error.code === 400) {
         toast.error(error.message);
         return;
       }
-
-      onError?.(error);
+      
+      toast.error(error.message);
+      onError?.(error);
     },

services/workflows-service/src/business/business.controller.external.ts (2)

139-146: Add OpenAPI documentation for the request body.

The endpoint would benefit from detailed OpenAPI documentation for the new request body structure.

 @common.Patch('/:id/monitoring')
 @swagger.ApiForbiddenResponse()
 @swagger.ApiOkResponse({ type: BusinessDto })
 @swagger.ApiNotFoundResponse({ type: errors.NotFoundException })
+@swagger.ApiBody({
+  description: 'Update monitoring state with reason',
+  type: BusinessMonitoringPatchDto,
+})

---

158-166: Consider adding type safety for metadata structure.

The metadata handling could benefit from stronger typing to prevent potential runtime errors.

-    const metadata = business?.metadata as {
+    interface BusinessMetadata {
+      featureConfig?: {
+        [FEATURE_LIST.ONGOING_MERCHANT_REPORT]?: {
+          enabled: boolean;
+          reason: string | null;
+          userReason: string | null;
+        };
+      };
+    }
+
+    const metadata = business?.metadata as BusinessMetadata;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 09b8c7d and eb31ef6.

📒 Files selected for processing (8)

• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (4 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/fetchers.ts (1 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx (4 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation.tsx (1 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/mutations/useTurnMonitoringOffMutation/useTurnMonitoringOffMutation.tsx (0 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/mutations/useTurnMonitoringOnMutation/useTurnMonitoringOnMutation.tsx (0 hunks)
• services/workflows-service/src/business/business.controller.external.ts (3 hunks)
• services/workflows-service/src/business/dtos/business-monitoring.patch.dto.ts (1 hunks)

💤 Files with no reviewable changes (2)

• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/mutations/useTurnMonitoringOffMutation/useTurnMonitoringOffMutation.tsx
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/mutations/useTurnMonitoringOnMutation/useTurnMonitoringOnMutation.tsx

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: test_linux
• GitHub Check: test_windows
• GitHub Check: build (windows-latest)

🔇 Additional comments (6)

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx (1)

23-46: Well-implemented Zod schema with conditional validation

The ZodDeboardingSchema correctly uses refine to ensure that when the reason is 'other', the userReason must be provided and have at least 5 characters. This keeps validation logic centralized and maintains form integrity.

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (2)

226-234: Move inline success handler to mutation's onSuccess

The onSuccess callback passed directly to turnOngoingMonitoringOn overrides the one defined in the mutation hook. For consistency and better maintainability, consider moving this success logic into the mutation's onSuccess handler.

---

130-139: Verify escape key handling when deboarding modal is open

Ensure that the onEscapeKeyDown handler prevents the dropdown menu from closing when the deboarding modal is open without causing unintended side effects. Test to confirm that pressing the escape key behaves correctly in all modal states.

services/workflows-service/src/business/dtos/business-monitoring.patch.dto.ts (1)

10-13: ⚠️ Potential issue

Add allowed values validation to the reason field

The reason field should accept only specific predefined values to prevent invalid input. Consider adding @IsIn([...]) to enforce this constraint.

Apply this diff to enhance validation:

 @ApiProperty({ type: String, required: false })
 @IsOptional()
 @IsString()
+@IsIn(['fraud', 'regulations', 'disputes', 'expired', 'other'])
 reason?: string;

Likely invalid or redundant comment.

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/fetchers.ts (1)

27-30: LGTM! Clean API integration.

The endpoint and method are correctly configured, and the schema validation is properly implemented.

services/workflows-service/src/business/business.controller.external.ts (1)

Line range hint 169-183: LGTM! Proper transaction handling.

The transaction is correctly implemented to ensure atomic updates to the business metadata.