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

fix: UI fixes for statistics and merchant monitoring report pages (BAL-3389, BAL-3390, BAL-3391) #2965

Merged
merged 4 commits into from
Jan 16, 2025

Conversation

r4zendev
Copy link
Collaborator

@r4zendev r4zendev commented Jan 15, 2025

Screen.Recording.2025-01-15.at.11.35.17.mov

Chart tooltip:

image

Summary by CodeRabbit

Release Notes

  • New Features

    • Added ContentTooltip component to the UI library
    • Enhanced chart tooltip with custom value rendering
  • Improvements

    • Updated portfolio risk statistics with user-selected date functionality
    • Modified merchant monitoring table with improved tooltip and copy functionality
  • Dependency Updates

    • Upgraded @ballerine/ui from version 0.5.62 to 0.5.63
    • Updated @ballerine/kyb-app and @ballerine/react-pdf-toolkit versions
  • Bug Fixes

    • Adjusted home page rendering logic
    • Refined website credibility component rendering

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

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: 366a924

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 15, 2025

Walkthrough

This pull request encompasses multiple changes across various components and packages in the Ballerine ecosystem. The modifications include updates to rendering logic in the Home page, enhancements to the Statistics and Portfolio Risk Statistics components, version bumps for several packages, and the introduction of a new ContentTooltip component. The changes primarily focus on improving user interface, component flexibility, and package maintenance.

Changes

File Change Summary
apps/backoffice-v2/src/pages/Home/Home.page.tsx Conditional rendering of <Outlet /> based on isDemo and isExample states
apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx Updated imports and modified monitoringStatus column rendering with new ContentTooltip
apps/backoffice-v2/src/pages/Statistics/ Added userSelectedDate prop to PortfolioRiskStatistics component
apps/kyb-app/ Version bump to 0.3.110 and updated @ballerine/ui dependency
packages/react-pdf-toolkit/ Version bump to 1.2.63 and updated @ballerine/ui dependency
packages/ui/ Version bump to 0.5.63, exported ContentTooltip component
packages/ui/src/components/atoms/Chart/Chart.tsx Added valueRender prop to ChartTooltipContent

Possibly related PRs

Suggested Reviewers

  • Omri-Levy
  • MatanYadaev

Poem

🐰 Hop, hop, through code we go,
Tooltips dancing, versions flow
Components shift with gentle grace
A rabbit's dance in digital space
Ballerine's magic, line by line! 🚀


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

🧹 Nitpick comments (4)
apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx (1)

95-124: Improved tooltip implementation for monitoring status.

The new implementation using ContentTooltip provides a more consistent and maintainable approach to displaying the monitoring status. The tooltip content is clearer, and the icon rendering is more semantic.

packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (1)

187-189: Consider keeping the more descriptive label "Monthly Visitors".

The label "Visited" might be too concise and could lose important context about the time period being displayed.

-      label: 'Visited',
+      label: 'Monthly Visitors',
apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx (2)

91-93: Consider extracting URL construction logic

The navigation URL construction with date parameters is repeated in multiple places. Consider extracting this logic into a utility function:

+ const buildMonitoringUrl = (params: {
+   locale: string;
+   from: string;
+   to: string;
+   riskLevels?: string[];
+   findings?: string[];
+   isAlert?: string;
+ }) => {
+   const searchParams = new URLSearchParams();
+   if (params.riskLevels?.length) searchParams.set('riskLevels[0]', params.riskLevels[0]);
+   if (params.findings?.length) searchParams.set('findings[0]', params.findings[0]);
+   if (params.isAlert) searchParams.set('isAlert', params.isAlert);
+   searchParams.set('from', params.from);
+   searchParams.set('to', params.to);
+   return `/${params.locale}/merchant-monitoring?${searchParams.toString()}`;
+ };

- navigate(`/${locale}/merchant-monitoring?riskLevels[0]=${riskLevel}&from=${from}&to=${to}`);
+ navigate(buildMonitoringUrl({ locale, from, to, riskLevels: [riskLevel] }));

- to={`/${locale}/merchant-monitoring?findings[0]=${id}&from=${from}&to=${to}`}
+ to={buildMonitoringUrl({ locale, from, to, findings: [id] })}

Also applies to: 144-144


Line range hint 1-190: Consider component decomposition

The component has grown quite large and handles multiple responsibilities. Consider breaking it down into smaller, focused components:

  • RiskLevelPieChart
  • ContentViolationsTable
  • UnresolvedAlertsCard

This would improve maintainability and make the code more testable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c32783d and f4b19d4.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (16)
  • apps/backoffice-v2/src/pages/Home/Home.page.tsx (0 hunks)
  • apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx (2 hunks)
  • apps/backoffice-v2/src/pages/Statistics/Statistics.page.tsx (1 hunks)
  • apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx (5 hunks)
  • apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx (3 hunks)
  • apps/kyb-app/CHANGELOG.md (1 hunks)
  • apps/kyb-app/package.json (2 hunks)
  • packages/react-pdf-toolkit/CHANGELOG.md (1 hunks)
  • packages/react-pdf-toolkit/package.json (2 hunks)
  • packages/ui/CHANGELOG.md (1 hunks)
  • packages/ui/package.json (1 hunks)
  • packages/ui/src/components/atoms/Chart/Chart.tsx (6 hunks)
  • packages/ui/src/components/molecules/ContentTooltip/index.ts (1 hunks)
  • packages/ui/src/components/molecules/index.ts (1 hunks)
  • packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (3 hunks)
  • services/workflows-service/prisma/data-migrations (1 hunks)
💤 Files with no reviewable changes (1)
  • apps/backoffice-v2/src/pages/Home/Home.page.tsx
✅ Files skipped from review due to trivial changes (5)
  • packages/ui/src/components/molecules/ContentTooltip/index.ts
  • packages/ui/package.json
  • apps/kyb-app/package.json
  • packages/react-pdf-toolkit/CHANGELOG.md
  • services/workflows-service/prisma/data-migrations
🔇 Additional comments (17)
packages/ui/src/components/molecules/index.ts (1)

1-1: LGTM!

The export statement for ContentTooltip is correctly added and maintains consistency with other exports.

apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx (3)

3-3: LGTM!

The utc plugin import is correctly placed after the timezone plugin, maintaining the proper order of dayjs plugin initialization.


13-15: LGTM!

The new imports for UI components (CopyToClipboardButton, IndicatorCircle, useEllipsesWithTitle) are correctly added and will enhance the table's functionality.


128-135: Enhanced header tooltip for better user understanding.

The header tooltip now provides clearer context about the monitoring status column's purpose.

packages/ui/src/components/atoms/Chart/Chart.tsx (4)

4-4: LGTM!

The ValueType import is correctly added from the Recharts types package.


104-104: LGTM!

The new valueRender prop enhances the flexibility of the ChartTooltipContent component by allowing custom value rendering.


223-228: LGTM!

The value rendering logic correctly implements the new valueRender prop with a proper fallback to toLocaleString().


Line range hint 298-321: Consider keeping the function declaration style consistent.

While the change from function declaration to arrow function doesn't affect functionality, it might be worth maintaining consistency with other helper functions in the codebase.

Let's check the prevalent function declaration style in the codebase:

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

3-12: LGTM!

The imports are correctly organized and include all necessary UI components.


226-235: LGTM!

The tooltip content is enhanced with proper number formatting using Intl.NumberFormat, improving readability for large numbers.

packages/react-pdf-toolkit/package.json (1)

4-4: Version and dependency updates look good!

The version bump and dependency update are consistent with the changes across other packages.

Also applies to: 30-30

packages/ui/CHANGELOG.md (1)

3-8: Changelog entry is well-documented!

The new version entry clearly documents the export of the ContentTooltip component as a patch change.

apps/kyb-app/CHANGELOG.md (1)

3-9: Changelog entry is properly maintained!

The new version entry correctly documents the dependency update to @ballerine/[email protected].

apps/backoffice-v2/src/pages/Statistics/Statistics.page.tsx (1)

34-34: LGTM: Clean prop addition

The addition of the userSelectedDate prop to PortfolioRiskStatistics is clean and properly typed.

apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx (2)

19-20: LGTM: Clean parameter addition

The addition of userSelectedDate parameter is properly typed and integrated.


74-75: LGTM: Clean return value addition

The addition of from and to to the return object is properly structured.

apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx (1)

24-27: LGTM: Clean prop type definition

The addition of userSelectedDate to the component's props is properly typed.

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

🔭 Outside diff range comments (1)
packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (1)

Chart accessibility improvements needed

The verification confirms that the chart implementation needs accessibility enhancements. Current implementation only includes accessibilityLayer but lacks:

  • ARIA labels and descriptions for chart elements
  • Keyboard navigation support
  • Screen reader friendly data representation

Consider:

  • Adding aria-label and aria-description to describe chart trends and data points
  • Implementing keyboard navigation for interactive elements
  • Including screen reader text that describes the data visualization
  • Using role="img" with appropriate ARIA attributes for the chart container
🔗 Analysis chain

Line range hint 201-245: Verify chart accessibility features.

While the chart includes accessibilityLayer, consider enhancing accessibility by:

  1. Adding ARIA labels for chart elements
  2. Ensuring keyboard navigation works for interactive elements
  3. Providing alternative text descriptions for the visualization

Run this script to check current accessibility implementations:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for accessibility-related attributes in chart components
rg -i 'aria-|role=|accessib' packages/ui/src/components/

Length of output: 1576


Script:

#!/bin/bash
# Search for chart-specific accessibility implementations and keyboard handlers
echo "=== Checking for chart accessibility components ==="
rg -i 'chart.*accessibility|accessibility.*chart' packages/ui/src/

echo -e "\n=== Checking for keyboard handlers in chart components ==="
rg -i 'onkey|keydown|keypress|keyup' packages/ui/src/components/templates/report/

echo -e "\n=== Checking for screen reader related implementations ==="
rg -i 'screen-reader|screenreader|sr-only' packages/ui/src/components/

Length of output: 829

🧹 Nitpick comments (1)
packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (1)

187-188: Consider using a more descriptive chart label.

The label "Visited" is less clear than the previous "Monthly Visitors". A descriptive label helps users understand the metric at a glance.

     visitors: {
-      label: 'Visited',
+      label: 'Monthly Visitors',
       color: '#007aff',
     },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f4b19d4 and 366a924.

📒 Files selected for processing (1)
  • packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test_linux
  • GitHub Check: test_windows
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: lint
🔇 Additional comments (2)
packages/ui/src/components/templates/report/components/WebsiteCredibility/WebsiteCredibility.tsx (2)

3-12: Good architectural improvement with modular components!

The refactoring to use atomic components from a dedicated atoms directory aligns well with atomic design principles and improves component reusability.


226-235: Excellent tooltip enhancement!

The tooltip improvements are well implemented:

  • Uses proper number formatting with Intl.NumberFormat
  • Consistent styling with the design system
  • Clear value presentation with monospace font and tabular numbers

@r4zendev r4zendev merged commit 72822ae into dev Jan 16, 2025
18 checks passed
@r4zendev r4zendev deleted the bal3391 branch January 16, 2025 09:24
@r4zendev r4zendev changed the title fix: UI fixes for statistics and merchant monitoring report pages fix: UI fixes for statistics and merchant monitoring report pages (BAL-3389, BAL-3390, BAL-3391) Jan 16, 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)

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