feat: add a report note when monitoring status is toggled (BAL-3398)

[r4zendev]

Stop storing reason & userReason inside metadata, instead create a note on a report.

Summary by CodeRabbit

• New Features

  • Added option to disable toast notifications when creating notes
  • Simplified ongoing monitoring state management
  • Enhanced note creation for monitoring state changes

• Bug Fixes

  • Streamlined merchant monitoring business report logic
  • Removed unnecessary optional parameters in monitoring state updates

• Refactor

  • Simplified function calls and data structures
  • Removed redundant properties from data transfer objects

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9854689

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

The pull request introduces changes across multiple files in the backoffice and workflows service, focusing on simplifying the ongoing monitoring state management. The modifications primarily involve removing optional reason and userReason properties from various components, streamlining the mutation and data transfer processes. Additionally, a new disableToast parameter is added to the note creation mutation to provide more control over toast notifications.

Changes

File	Change Summary
apps/backoffice-v2/src/domains/notes/hooks/mutations/useCreateNoteMutation/useCreateNoteMutation.tsx	Added disableToast parameter to control toast notification display
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/*	Simplified option mapping, function calls, and removed optional reason properties
services/workflows-service/src/business/business.controller.external.ts	Removed reason and userReason from metadata update
services/workflows-service/src/business/dtos/business-monitoring.patch.dto.ts	Eliminated optional reason and userReason properties

Sequence Diagram

sequenceDiagram
    participant User
    participant UI
    participant Mutation
    participant NotesService
    participant WorkflowService

    User->>UI: Toggle Monitoring
    UI->>Mutation: Turn On/Off Monitoring
    Mutation->>WorkflowService: Update Monitoring State
    WorkflowService-->>Mutation: State Updated
    Mutation->>NotesService: Create Monitoring Note
    NotesService-->>Mutation: Note Created
    Mutation->>UI: Mutation Complete

Loading

Suggested Reviewers

• Omri-Levy
• tomer-shvadron

Poem

🐰 A Rabbit's Code Review Delight

Monitoring state, now sleek and bright,
Reasons trimmed, toast control in sight,
Mutations dance with elegant might,
Simplicity brings such pure delight!

Code hops forward, clean and light! 🚀

✨ 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.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

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

126-141: Consider handling empty strings in content array.

The content array filtering could be improved to handle empty strings more explicitly.

Apply this diff to improve content array handling:

   const content = [
     'Monitoring turned off',
-    reason ? `with reason: ${capitalize(reason)}` : null,
-    userReason ? `(${userReason})` : '',
+    reason && `with reason: ${capitalize(reason)}`,
+    userReason && `(${userReason})`
   ]
-    .filter(Boolean)
+    .filter((part): part is string => Boolean(part))
     .join(' ');

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ce73dc and 9854689.

📒 Files selected for processing (7)

• apps/backoffice-v2/src/domains/notes/hooks/mutations/useCreateNoteMutation/useCreateNoteMutation.tsx (2 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (2 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/fetchers.ts (0 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx (5 hunks)
• apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation.tsx (2 hunks)
• services/workflows-service/src/business/business.controller.external.ts (0 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/fetchers.ts
• services/workflows-service/src/business/business.controller.external.ts

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

• GitHub Check: Analyze (javascript)
• GitHub Check: test_windows
• GitHub Check: test_linux
• GitHub Check: lint
• GitHub Check: build (windows-latest)
• GitHub Check: build (ubuntu-latest)

🔇 Additional comments (6)

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

19-20: LGTM! Clean mutation function signature.

The simplified parameter interface improves usability while maintaining type safety.

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

61-65: LGTM! Clear and comprehensive deboarding reasons.

The simplified string array maintains readability while covering essential deboarding scenarios.

---

104-111: LGTM! Clear monitoring status note creation.

The note content is concise and informative when monitoring is turned on.

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

226-231: LGTM! Clean success callback implementation.

The success callback properly handles modal state management.

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

1-9: LGTM! Changes align with PR objectives.

The removal of reason and userReason properties aligns with the PR objective of storing monitoring status changes as report notes instead of metadata. The remaining state property maintains proper validation, type safety, and API documentation.

---

1-9: Verify the removal of reason properties across the codebase.

Let's ensure all related components have been updated to handle the removal of these properties.