Temp fix for merchant reports

[Omri-Levy]

Summary by CodeRabbit

• New Features

  • No new features introduced; existing functionality remains intact.

• Bug Fixes

  • Reintroduced necessary imports for better integration with API documentation.

• Chores

  • Commented out the list method for business reports, indicating its removal from available endpoints.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 29c7e9c

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 involve modifications to the BusinessReportControllerExternal class within the business-report.controller.external.ts file. Specifically, the imports for swagger and related decorators have been reintroduced, while the AdminAuthGuard and its @UseGuards decorator have been commented out, along with the list method that previously allowed the retrieval of business reports. The remaining methods in the class remain unchanged in terms of logic and signatures.

Changes

File Path	Change Summary
services/workflows-service/src/business-report/business-report.controller.external.ts	Reintroduced swagger imports; commented out AdminAuthGuard, @UseGuards, and list method; remaining methods unchanged.

Possibly related PRs

• Not showing unfinished ongoing reports #2773: The changes in the BusinessReportControllerInternal class involve modifications to the logic for retrieving business reports, which is closely related to the functionality of the BusinessReportControllerExternal class where the list method has been commented out.

Suggested reviewers

• MatanYadaev

🐇 In the code where the reports did dwell,
A method once lively, now bids farewell.
With swagger restored, the guards are in shade,
The list is now silent, its presence delayed.
But fear not, dear coder, for others remain,
Business reports thrive, in sunshine or rain! 🌼

---

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.external.ts (1)

Line range hint 1-220: Consider implementing a proper admin access control solution.

Given this is marked as a temporary fix, here are some architectural recommendations for the permanent solution:

1. Consider implementing a proper role-based access control (RBAC) system if not already in place
2. Instead of removing the endpoint, consider:
   • Moving admin endpoints to a separate admin-specific controller
   • Implementing proper audit logging for admin actions
   • Adding rate limiting for admin endpoints
3. Document the admin API endpoints separately from the external API

This will provide a more maintainable and secure solution in the long term.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ae9e32a and 29c7e9c.

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

11-12: LGTM: Swagger imports are correctly restored.

The reintroduction of swagger imports is appropriate as they are actively used throughout the controller for API documentation.

---

205-220: ⚠️ Potential issue

Security concern: Document the temporary removal of admin-protected endpoint.

While commenting out this endpoint might be a temporary fix, it raises several concerns:

1. The removal of an admin-protected endpoint should be clearly documented
2. No explanation is provided for why this is temporary
3. No timeline or ticket for proper resolution is referenced

Please add a TODO comment explaining:

• Why this endpoint needed to be temporarily disabled
• The timeline or ticket number for proper resolution
• Any alternative admin access method in the meantime

Let's verify if this endpoint is referenced elsewhere: