chore(workflows-service): rewrite quality control prop

[shanegrouber]

• Refactor withQualityControl property to always include it in the post request

Summary by CodeRabbit

• New Features

  • Updated the create method in the Merchant Monitoring Client to include the withQualityControl parameter in the request payload.

• Bug Fixes

  • Retained error handling in the findById method to ensure proper handling of 404 errors.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4156232

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 involves two primary changes: an update to the commit reference in the services/workflows-service/prisma/data-migrations directory and modifications to the MerchantMonitoringClient class in the merchant-monitoring-client.ts file. The main change in the client is the handling of the withQualityControl parameter in the create method, where it is now directly included in the request payload regardless of its value.

Changes

File	Change Summary
services/workflows-service/prisma/data-migrations	Commit reference updated from 1b7508555c1f354619b11197d94fab8a2252ce29 to bfc772b0ade3ae49465629d6c85ac26aac3796ab
services/workflows-service/src/business-report/merchant-monitoring-client.ts	Modified create method to include withQualityControl in request payload unconditionally

Possibly related PRs

• feat: business Report in Backoffice updates #2450: Updates to services/workflows-service/prisma/data-migrations directory
• add parent company name #2503: Commit reference update in the same directory
• Sending withQualityControl to Unified API #2618: Changes to BusinessReportControllerInternal class
• bug/fix_quality_controll_issue #2692: Introduction of withQualityControl parameter in BusinessReportService
• Additional swagger documentations #2767: Updates to OngoingMonitoringCron class

Suggested Reviewers

• Omri-Levy
• alonp99

Poem

🐰 A rabbit's tale of code so bright,
Commits dancing left and right,
withQualityControl takes its stand,
In payload's ever-changing land,
A small tweak with algorithmic might! 🔧

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.

---

📜 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 4def82c and 4156232.

📒 Files selected for processing (2)

• services/workflows-service/prisma/data-migrations (1 hunks)
• services/workflows-service/src/business-report/merchant-monitoring-client.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• services/workflows-service/prisma/data-migrations

🔇 Additional comments (2)

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

111-111: LGTM! Consistent handling of withQualityControl parameter.

This change standardizes the inclusion of withQualityControl in the request payload, making it consistent with the createBatch method's behavior. This improves code maintainability and predictability.

---

111-111: Verify API handling of undefined withQualityControl.

Since withQualityControl is now always included in the payload (even when undefined), let's verify the API's behavior.

✅ Verification successful

Based on the search results, I can now generate a final response:

The API properly handles undefined withQualityControl parameter

The codebase shows that:

• In the controller (business-report.controller.external.ts), there's explicit handling: withQualityControl: typeof withQualityControl === 'boolean' ? withQualityControl : false
• The parameter is properly typed as optional (withQualityControl?: boolean) in the client interface
• The API endpoint accepts the parameter as part of the payload without any validation errors

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any error handling or validation related to withQualityControl
# in API documentation or tests

# Look for test files related to merchant monitoring
fd -e test.ts -e spec.ts merchant-monitoring

# Search for withQualityControl validation or error handling
rg -A 5 "withQualityControl.*validation|withQualityControl.*error" 

# Look for API schema definitions
rg -A 10 "merchants/analysis.*schema|merchants/analysis.*validation"

Length of output: 186

---

Script:

#!/bin/bash
# Let's try a broader search for withQualityControl usage and validation
rg -A 5 "withQualityControl"

# Look for API endpoint definitions and schemas
fd -e ts api-schema
fd -e ts schema

# Search for merchant analysis or monitoring related files
fd -e ts merchant

Length of output: 20118

---

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.