chore(mm): change merchant monitoring to use v1

[alonp99]

Summary by CodeRabbit

• New Features
  • Introduced a workflowVersion property to enhance reporting functionality, enabling future version tracking and differentiation of report formats.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f30378e

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 recent changes introduce a new workflowVersion property in both the BusinessReportControllerInternal class and the CreateBusinessReportDto class. This enhancement facilitates version tracking for business reports, improving the flexibility and clarity of report generation. The modifications are non-intrusive, preserving existing logic while allowing for future expansions in reporting capabilities.

Changes

Files	Change Summary
services/workflows-service/src/business-report/business-report.controller.internal.ts services/workflows-service/src/business-report/dto/create-business-report.dto.ts	Added workflowVersion property for version tracking in reports. Default value set in controller; optional in DTO with validation.

Poem

In a meadow where reports align,
A version whispers, "I am fine!"
With hops and skips, we cheer and play,
For tracking changes, come what may.
A little hop, a little bound,
New features bloom upon the ground! 🐰✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8f0b4da and 47876af.

Files selected for processing (1)

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

Additional comments not posted (1)

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

126-126: Verify compatibility with the external API.

The addition of workflowVersion: '1' is a good step towards versioning. Ensure the external API can handle this new property without issues. Also, consider if this versioning should be configurable or dynamic in the future.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 47876af and f30378e.

Files selected for processing (2)

• services/workflows-service/src/business-report/business-report.controller.internal.ts (2 hunks)
• services/workflows-service/src/business-report/dto/create-business-report.dto.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• services/workflows-service/src/business-report/business-report.controller.internal.ts

[coderabbitai]

Clarify the optionality of workflowVersion.

The workflowVersion property is described as optional in the PR summary but is marked as required (!:) in the code. Consider aligning the code with the intended design by making it optional if that's the requirement.

-  workflowVersion!: string;
+  workflowVersion?: string;

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	@ApiProperty({
	required: false,
	type: String,
	})
	@MinLength(1)
	@IsString()
	workflowVersion!: string;
	@ApiProperty({
	required: false,
	type: String,
	})
	@MinLength(1)
	@IsString()
	workflowVersion?: string;