Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(monitoring): adjusts merchant risk summary text (BAL-3373) #2961

Merged
merged 5 commits into from
Jan 15, 2025
Merged

Conversation

r4zendev
Copy link
Collaborator

@r4zendev r4zendev commented Jan 14, 2025

Summary by CodeRabbit

  • New Features

    • Added isOngoing property to Business Report Summary component
    • Enhanced report type handling in Website Monitoring Business Report Tab
  • Refactor

    • Updated useReportTabs hook with new type definition
    • Improved prop handling for report-related components
  • Chores

    • Updated subproject commit in workflows service

@r4zendev r4zendev self-assigned this Jan 14, 2025
Copy link

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Latest commit: 7d1c485

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

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Warning

Rate limit exceeded

@r4zendev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7d1013a and 7d1c485.

📒 Files selected for processing (5)
  • apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/WebsiteMonitoringBusinessReportTab.tsx (2 hunks)
  • apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/hooks/useWebsiteMonitoringBusinessReportTab/useWebsiteMonitoringBusinessReportTab.tsx (2 hunks)
  • apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx (2 hunks)
  • packages/ui/src/components/templates/report/components/BusinessReportSummary/BusinessReportSummary.tsx (3 hunks)
  • packages/ui/src/components/templates/report/hooks/useReportTabs/useReportTabs.tsx (3 hunks)

Walkthrough

This pull request introduces enhancements to the reporting system, specifically focusing on handling ongoing merchant reports. The changes span multiple components and files, adding a new isOngoing prop to control the display and behavior of business report summaries. The modifications include updating type definitions, introducing new constants for report types, and adjusting the rendering logic in the BusinessReportSummary component to conditionally display "Onboarding" for ongoing reports.

Changes

File Change Summary
apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/WebsiteMonitoringBusinessReportTab.tsx Added MERCHANT_REPORT_TYPES and MERCHANT_REPORT_TYPES_MAP constants
packages/ui/src/components/templates/report/components/BusinessReportSummary/BusinessReportSummary.tsx Added isOngoing prop to conditionally modify header text
packages/ui/src/components/templates/report/hooks/useReportTabs/useReportTabs.tsx Introduced UseReportTabsProps type and updated function signature
services/workflows-service/prisma/data-migrations Updated subproject commit identifier

Sequence Diagram

sequenceDiagram
    participant WebsiteMonitoringTab as Website Monitoring Tab
    participant ReportTabs as Report Tabs Hook
    participant BusinessReportSummary as Business Report Summary

    WebsiteMonitoringTab->>ReportTabs: Pass report type and isOngoing
    ReportTabs->>BusinessReportSummary: Forward isOngoing prop
    BusinessReportSummary->>BusinessReportSummary: Conditionally render header
Loading

Possibly related PRs

Suggested labels

enhancement, Review effort [1-5]: 3

Suggested reviewers

  • tomer-shvadron
  • MatanYadaev

Poem

🐰 Hop, hop, through the code we go,
Ongoing reports now start to glow
Constants dance, props take flight
Merchant summaries shine so bright!
A rabbit's tale of UI delight 🚀


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)
apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/WebsiteMonitoringBusinessReportTab.tsx (1)

12-15: Consider using a type-safe enum for report types.

While importing constants is a valid approach, using TypeScript enums or as-const objects would provide better type safety and autocompletion.

-import {
-  MERCHANT_REPORT_TYPES,
-  MERCHANT_REPORT_TYPES_MAP,
-} from '@/domains/business-reports/constants';
+import {
+  MerchantReportTypes,
+  MerchantReportTypesMap,
+} from '@/domains/business-reports/constants';
packages/ui/src/components/templates/report/hooks/useReportTabs/useReportTabs.tsx (1)

17-23: Consider strengthening the report type.

While the type definition is good, the report property could be more specific than Record<PropertyKey, any>.

Consider creating a proper type for the report object:

type Report = {
  // Add specific report properties here
  // This will provide better type safety and autocompletion
};

type UseReportTabsProps = {
  reportVersion: string;
  isOngoing: boolean;
  report: Report;
  companyName: string;
  Link: ComponentProps<typeof BusinessReportSummary>['Link'];
};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 01c2c7b and 7d1013a.

📒 Files selected for processing (4)
  • apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/WebsiteMonitoringBusinessReportTab.tsx (2 hunks)
  • packages/ui/src/components/templates/report/components/BusinessReportSummary/BusinessReportSummary.tsx (3 hunks)
  • packages/ui/src/components/templates/report/hooks/useReportTabs/useReportTabs.tsx (2 hunks)
  • services/workflows-service/prisma/data-migrations (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • services/workflows-service/prisma/data-migrations
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (6)
apps/backoffice-v2/src/lib/blocks/variants/WebsiteMonitoringBlocks/hooks/useWebsiteMonitoringReportBlock/WebsiteMonitoringBusinessReportTab.tsx (1)

41-43: LGTM! Clear and concise condition for ongoing reports.

The implementation correctly determines if a report is ongoing based on its type.

packages/ui/src/components/templates/report/components/BusinessReportSummary/BusinessReportSummary.tsx (3)

10-10: LGTM! Well-typed prop addition.

The isOngoing prop is correctly typed as a required boolean.


74-76: LGTM! Clean conditional text rendering.

The implementation elegantly handles the conditional "Onboarding" prefix.


84-84: LGTM! Improved layout structure.

The flex layout provides better control over the screenshot container dimensions.

packages/ui/src/components/templates/report/hooks/useReportTabs/useReportTabs.tsx (2)

27-27: LGTM! Clean hook parameter update.

The hook signature is correctly updated to use the new type.

Also applies to: 31-31


129-129: LGTM! Proper prop forwarding.

The isOngoing prop is correctly passed to the BusinessReportSummary component.

@r4zendev r4zendev merged commit 7c79cfe into dev Jan 15, 2025
18 checks passed
@r4zendev r4zendev deleted the bal3373 branch January 15, 2025 13:33
Omri-Levy added a commit that referenced this pull request Jan 21, 2025
* feat: updated styles for link elements (#2959)

* feat: added csv document rendering (#2958)

* fix(monitoring): changes the block ordering in website credibility view (#2963)

* feat(monitoring): adds loading state for a single merchant record (BAL-3359) (#2960)

* feat(monitoring): adjusts merchant risk summary text (BAL-3373) (#2961)

* refactor(websiteCredibility): fix CardContent height for no data (#2966)

* refactor(websiteCredibility): fix CardContent height for no data

- Remove unused Tooltip import from recharts
- Update CardContent class to ensure full height

(your code is like a tidy room: looks clean but still has hidden messes)

* empty

* fix: UI fixes for statistics and merchant monitoring report pages (#2965)

* feat(monitoring): adds exhaustive check for action before deboarding a merchant (BAL-3343) (#2964)

* feat(monitoring): preserves scroll position on a data table (BAL-3248) (#2962)

* fix: chart graph cut off (BAL-3395) (#2969)

* fix: corrected home page merchants metrics source of truth (BAL-3396, BAL-3397) (#2968)

* chore(*): updated packages (#2971)

* fix(backoffice-v2): reverted default logic for from and to (#2973)

* refactor(entities): streamline form data context creation (#2974)

- Remove unnecessary context object creation
- Simplify the return statement by directly returning the new context

(your code is like a magic trick that turns objects into empty space)

* fix: remove monitoring params logic from navbar (#2975)

Co-authored-by: Omri Levy <[email protected]>

* fix: fixed popup flickering in date picker & bump (#2977)

* feat: add a report note when monitoring status is toggled (BAL-3398) (#2979)

* feat: add a report note when monitoring status is toggled

* chore: remove storing reason in metadata

* fix: dmt and dsta rules (#2970)

Co-authored-by: Lior Zamir <[email protected]>
Co-authored-by: Alon Peretz <[email protected]>

---------

Co-authored-by: Illia Rudniev <[email protected]>
Co-authored-by: Sasha <[email protected]>
Co-authored-by: Shane <[email protected]>
Co-authored-by: Tomer Shvadron <[email protected]>
Co-authored-by: liorzam <[email protected]>
Co-authored-by: Lior Zamir <[email protected]>
Co-authored-by: Alon Peretz <[email protected]>
@Omri-Levy Omri-Levy mentioned this pull request Jan 21, 2025
Omri-Levy added a commit that referenced this pull request Jan 21, 2025
* feat: updated styles for link elements (#2959)

* feat: added csv document rendering (#2958)

* fix(monitoring): changes the block ordering in website credibility view (#2963)

* feat(monitoring): adds loading state for a single merchant record (BAL-3359) (#2960)

* feat(monitoring): adjusts merchant risk summary text (BAL-3373) (#2961)

* refactor(websiteCredibility): fix CardContent height for no data (#2966)

* refactor(websiteCredibility): fix CardContent height for no data

- Remove unused Tooltip import from recharts
- Update CardContent class to ensure full height

(your code is like a tidy room: looks clean but still has hidden messes)

* empty

* fix: UI fixes for statistics and merchant monitoring report pages (#2965)

* feat(monitoring): adds exhaustive check for action before deboarding a merchant (BAL-3343) (#2964)

* feat(monitoring): preserves scroll position on a data table (BAL-3248) (#2962)

* fix: chart graph cut off (BAL-3395) (#2969)

* fix: corrected home page merchants metrics source of truth (BAL-3396, BAL-3397) (#2968)

* chore(*): updated packages (#2971)

* fix(backoffice-v2): reverted default logic for from and to (#2973)

* refactor(entities): streamline form data context creation (#2974)

- Remove unnecessary context object creation
- Simplify the return statement by directly returning the new context

(your code is like a magic trick that turns objects into empty space)

* fix: remove monitoring params logic from navbar (#2975)



* fix: fixed popup flickering in date picker & bump (#2977)

* feat: add a report note when monitoring status is toggled (BAL-3398) (#2979)

* feat: add a report note when monitoring status is toggled

* chore: remove storing reason in metadata

* fix: dmt and dsta rules (#2970)




---------

Co-authored-by: Illia Rudniev <[email protected]>
Co-authored-by: Sasha <[email protected]>
Co-authored-by: Shane <[email protected]>
Co-authored-by: Tomer Shvadron <[email protected]>
Co-authored-by: liorzam <[email protected]>
Co-authored-by: Lior Zamir <[email protected]>
Co-authored-by: Alon Peretz <[email protected]>
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.

2 participants