Skip to content

Conversation

@MatanYadaev
Copy link
Contributor

@MatanYadaev MatanYadaev commented Jan 28, 2025

Summary by CodeRabbit

  • New Features
    • Added a displayDate property to enhance business report data structures.
  • Bug Fixes
    • Improved error messaging for business report generation.
    • Updated support guidance for report quota limits.
  • Improvements
    • Updated the display logic for creation dates in business reports to use displayDate instead of createdAt.

@changeset-bot
Copy link

changeset-bot bot commented Jan 28, 2025

⚠️ No Changeset found

Latest commit: 1623fef

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
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

The pull request introduces changes across several files, focusing on enhancing error messages in the BusinessReportService class and adding a new property, displayDate, to various report schemas. The error messages in the checkBusinessReportsLimit and processBatchFile methods have been modified to provide clearer guidance to users. Additionally, the displayDate property has been integrated into the BusinessReportSchema and ReportSchema, affecting how dates are displayed in the relevant components.

Changes

File Change Summary
services/workflows-service/src/business-report/business-report.service.ts Updated error messages in checkBusinessReportsLimit and processBatchFile methods for improved clarity.
apps/backoffice-v2/src/domains/business-reports/fetchers.ts Added displayDate: z.string().datetime() to BusinessReportSchema.
apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx Renamed createdAt to displayDate in column definition and updated retrieval logic accordingly.
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx Changed date source from businessReport?.createdAt to businessReport?.displayDate for display purposes.
services/workflows-service/src/business-report/merchant-monitoring-client.ts Added displayDate: z.string().datetime().transform(value => new Date(value)) to ReportSchema.

Possibly related PRs

  • feat: business Report in Backoffice updates #2450: This PR involves changes to the BusinessReportService, which is directly related to the modifications made in the main PR regarding error messages in the BusinessReportService class.
  • Not showing unfinished ongoing reports #2773: This PR modifies the listBusinessReports method in the BusinessReportControllerInternal class, which is relevant as it deals with business report retrieval, similar to the changes made in the main PR.
  • Small fix for the Ongoing OR condition #2777: This PR also focuses on the listBusinessReports method in the BusinessReportControllerInternal, enhancing the filtering logic, which relates to the overall handling of business reports in the main PR.

Suggested reviewers

  • Omri-Levy

Poem

🐰 In the land of reports, where data does play,
Error messages brightened, guiding the way!
A new date to display, clear as the sun,
With every small change, we hop and we run!
Support is now near, in each gentle line,
A hoppy delight, all users will find! 🌟

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
services/workflows-service/src/business-report/business-report.service.ts (2)

34-34: Consider including the actual limit in the error message.

While the new message effectively encourages users to contact support for additional features, it removes transparency about the actual quota limit. This could frustrate users who need this information for immediate decision-making.

Consider this balanced approach:

-        `You've hit your reports limit. Talk to us to unlock additional features and continue effective risk management with Ballerine.`,
+        `You've reached your limit of ${maxBusinessReports} reports. Contact us to unlock additional features and continue effective risk management with Ballerine.`,

Line range hint 123-127: Fix typo in error message.

There's a spelling error in the error message: "qouta" should be "quota".

-        } left from a qouta of ${maxBusinessReports})`,
+        } left from a quota of ${maxBusinessReports})`,
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0e018fe and 26cffab.

📒 Files selected for processing (1)
  • services/workflows-service/src/business-report/business-report.service.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: test_windows
  • GitHub Check: build (windows-latest)
  • GitHub Check: test_linux
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: lint

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
apps/backoffice-v2/src/domains/business-reports/fetchers.ts (1)

26-26: Consider consistent date transformation across schema.

The displayDate field doesn't transform the string to a Date object, unlike createdAt and updatedAt. This inconsistency might lead to different date handling across the application.

-    displayDate: z.string().datetime(),
+    displayDate: z.string().datetime().transform(value => new Date(value)),
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26cffab and 0fbf2ee.

📒 Files selected for processing (4)
  • apps/backoffice-v2/src/domains/business-reports/fetchers.ts (1 hunks)
  • apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx (1 hunks)
  • apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (1 hunks)
  • services/workflows-service/src/business-report/merchant-monitoring-client.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test_windows
  • GitHub Check: test_linux
  • GitHub Check: build (windows-latest)
  • GitHub Check: lint
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx (1)

Line range hint 156-173: LGTM! Clean migration to displayDate.

The change from createdAt to displayDate is implemented correctly, maintaining the existing UTC to local time conversion and formatting logic.

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

53-56: LGTM! Consistent date handling implementation.

The displayDate field is properly implemented with datetime validation and Date object transformation, maintaining consistency with other date fields in the schema.


Line range hint 1-1: Verify PR title and implementation alignment.

The PR is titled "Notify Clients on Credit Limit Reached", but the changes only introduce a new date display field. Either the PR title needs updating, or the notification implementation is missing.

Comment on lines +275 to +276
{businessReport?.displayDate &&
dayjs(new Date(businessReport?.displayDate)).format('HH:mm MMM Do, YYYY')}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Date formatting and timezone handling needs standardization

The current implementation has several issues:

  • The date format 'HH:mm MMM Do, YYYY' is inconsistent with other date formats in the codebase
  • Redundant new Date() wrapper is unnecessary as dayjs can parse the date string directly
  • Timezone handling should be explicitly defined (UTC vs local) for consistency

Suggested changes:

dayjs(businessReport?.displayDate).format('DD/MM/YYYY HH:mm')
🔗 Analysis chain

LGTM! Verify date handling across time zones.

The change from createdAt to displayDate is consistent with the schema updates. The date formatting remains correct.

Please ensure that:

  1. The date is correctly displayed across different time zones
  2. The format 'HH:mm MMM Do, YYYY' is consistently used across the application
  3. Dayjs plugins (utc, timezone) are properly configured
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for consistent date formatting across the codebase
echo "Checking for date format consistency:"
rg -l "dayjs\(.*\)\.format\(" | xargs rg "format\(['\"].*['\"]\)"

Length of output: 8189

@MatanYadaev MatanYadaev merged commit 4121a89 into dev Jan 28, 2025
18 checks passed
@MatanYadaev MatanYadaev deleted the bal-3427 branch January 28, 2025 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants