fix: move metrics logic back to unified API (BAL-3429)

[r4zendev]

Summary by CodeRabbit

• Refactor

  • Streamlined business report endpoints to deliver consolidated monitoring metrics for quicker, more direct data insights.
  • Updated access controls, easing restrictions and simplifying permission checks.

• Chore

  • Removed outdated methods and unnecessary dependencies to enhance overall code maintainability.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 051864e

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 changes simplify the metrics retrieval process in the workflows service. In the external business report controller, the AdminAuthGuard import has been removed and the getMetrics method now directly fetches and returns metrics using the merchantMonitoringClient. In the business service, the method that previously calculated merchant monitoring metrics has been removed alongside its dependent imports, reducing complexity and unused code.

Changes

File(s)	Change Summary
services/.../business-report.controller.external.ts	Removed AdminAuthGuard import; updated getMetrics to remove individual metrics calculations and directly return metrics from merchantMonitoringClient.
services/.../business.service.ts	Removed getMerchantMonitoringMetrics method and cleaned up unused imports (removed FEATURE_LIST, TCustomerFeaturesConfig, and adjusted Business/Prisma imports).

Sequence Diagram(s)

sequenceDiagram
    participant User as API Consumer
    participant Controller as BusinessReportControllerExternal
    participant MonitoringClient as MerchantMonitoringClient

    User->>Controller: HTTP GET /metrics
    Controller->>MonitoringClient: fetch metrics
    MonitoringClient-->>Controller: merchantMonitoringMetrics
    Controller-->>User: return merchantMonitoringMetrics

Loading

Possibly related PRs

• fix: corrected home page merchants metrics source of truth (BAL-3396, BAL-3397) #2968: Simplified metrics retrieval in getMetrics relates to additional metrics retrieval logic enhancements.
• feat: add a report note when monitoring status is toggled (BAL-3398) #2979: Removal of properties from BusinessMonitoringPatchDto aligns with the overall streamlining of merchant metrics handling.

Suggested labels

enhancement, Review effort [1-5]: 3

Suggested reviewers

• Omri-Levy
• MatanYadaev

Poem

I'm a little rabbit in a code-filled glen,
Skipping guards and metrics again and again.
Complexity hops away with every line,
Clean code flows like a carrot vine.
With a twitch of my nose, I celebrate the change—
A happy leap forward in our coding range!
🥕🐰

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb3892c and 81c88d6.

📒 Files selected for processing (2)

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

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

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

🔇 Additional comments (3)

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

7-7: LGTM! Clean import statements.

The imports have been simplified by removing unused types while retaining only the necessary TCustomerWithFeatures type for the list method.

Also applies to: 13-13

---

78-87: LGTM! Type safety maintained.

The list method correctly maintains type safety by using TCustomerWithFeatures for the metadata feature configuration.

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

167-175: LGTM! Simplified metrics retrieval.

The code has been simplified to directly use the merchant monitoring client, which aligns with the PR objective of moving metrics logic back to unified API.

Let's verify that the merchant monitoring client is properly configured to handle the metrics:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Check MerchantMonitoringClient implementation
ast-grep --pattern $'class MerchantMonitoringClient {
  $$$
  getMetrics($_, $_) {
    $$$
  }
  $$$
}'

Length of output: 104

---

I'll run some additional shell scripts to locate the MerchantMonitoringClient definition and verify that the getMetrics method is implemented as expected.

---

🏁 Script executed:

#!/bin/bash
# Locate any occurrence of "class MerchantMonitoringClient" in the repository
rg -n "class MerchantMonitoringClient" .

# Verify the implementation of the 'getMetrics' method in files where MerchantMonitoringClient is defined
rg -n "getMetrics\(" .

Length of output: 591

---

🏁 Script executed:

#!/bin/bash
# Display the implementation snippet for getMetrics in MerchantMonitoringClient
sed -n '280,310p' ./services/workflows-service/src/business-report/merchant-monitoring-client.ts

Length of output: 661

---

Final Verification: MerchantMonitoringClient's getMetrics method is implemented as expected.

• The method correctly sends a GET request using axios with the necessary parameters and authorization header.
• The response data is parsed using MetricsResponseSchema, ensuring valid metrics data is returned.

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