Not showing unfinished ongoing reports

[tomer-shvadron]

Summary by CodeRabbit

• New Features

  • Enhanced filtering logic for business reports, allowing for more precise retrieval based on report type and status.

• Bug Fixes

  • Excluded ongoing merchant reports from the list unless their status is marked as completed, improving report relevance.

[changeset-bot]

⚠️ No Changeset found

Latest commit: fcce7ef

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 in this pull request focus on the BusinessReportControllerInternal class within the business-report.controller.internal.ts file. A new import for BusinessReportType from the @prisma/client package has been added. The listBusinessReports method has been updated to include enhanced filtering logic, specifically introducing an OR condition to manage business report types and their statuses. Overall, the modifications refine the existing logic without altering method signatures or adding new methods.

Changes

File	Change Summary
services/workflows-service/src/business-report/business-report.controller.internal.ts	- Added import for BusinessReportType from @prisma/client. - Enhanced filtering logic in listBusinessReports method to include an OR condition for report types and statuses.

Possibly related PRs

• blokh/feat/business report alerts #2311: Modifies the BusinessReport model and introduces new methods in the BusinessReportRepository and BusinessReportService, relevant to report handling and filtering logic.
• Limit reports generation per customer #2582: Introduces a restriction on the number of reports that can be generated for each customer, aligning with the enhanced filtering logic in the main PR.
• Feature/create multi merchant csv import #2652: Includes significant modifications to the BusinessReportControllerInternal, particularly in handling batch reports and enhancing the listBusinessReports method, directly relating to the main PR's changes.

Suggested labels

enhancement, Review effort [1-5]: 3

Suggested reviewers

• Omri-Levy
• liorzam

🐰 In the meadow, reports do play,
Filtering types in a clever way.
With statuses checked, we hop and cheer,
Business insights now bright and clear!
A rabbit's joy in code we find,
Enhancements made, oh so refined! 🌼

---

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

🧹 Outside diff range and nitpick comments (1)

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

242-254: LGTM: Filtering logic for ongoing reports implemented correctly.

The new OR condition in the where clause effectively filters out unfinished ongoing reports of type ONGOING_MERCHANT_REPORT_T1, addressing the PR objective. This implementation ensures that only completed ongoing reports or reports of other types are returned.

Consider adjusting the indentation of the new code block to match the rest of the file for consistency. The current indentation appears to be 2 spaces, while the rest of the file uses 4 spaces.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 224283c and fcce7ef.

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (2)

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

23-23: LGTM: Import of BusinessReportType added.

The addition of BusinessReportType to the imports is appropriate, as it's used in the updated filtering logic of the listBusinessReports method.

---

Line range hint 1-391: Overall assessment: Changes successfully implement the PR objective.

The modifications to the listBusinessReports method effectively filter out unfinished ongoing reports of type ONGOING_MERCHANT_REPORT_T1. The implementation is correct and aligns with the PR objective. The changes are well-contained and don't introduce any breaking changes to the API.