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): adds loading state for a single merchant record (BAL-3359) #2960

Merged
merged 3 commits into from
Jan 15, 2025

Conversation

r4zendev
Copy link
Collaborator

@r4zendev r4zendev commented Jan 14, 2025

Screenshot 2025-01-14 at 21 06 13

Summary by CodeRabbit

  • New Features

    • Added loading skeletons to the Merchant Monitoring Business Report page
    • Improved user experience by providing visual feedback during data fetching
  • Chores

    • Updated subproject commit in workflows service data migrations

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

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Latest commit: 98da629

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

Walkthrough

The pull request introduces a loading state for the MerchantMonitoringBusinessReport component by adding Skeleton components and a new isFetchingBusinessReport variable. This enhancement provides visual feedback during data fetching, improving the user interface's responsiveness. The changes modify the useMerchantMonitoringBusinessReportLogic hook to expose the fetching state and update the component's rendering logic to conditionally display loading skeletons when data is being retrieved.

Changes

File Change Summary
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx Added isFetchingBusinessReport to control skeleton loading state
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx Updated hook to return isFetchingBusinessReport from query
services/workflows-service/prisma/data-migrations Subproject commit hash updated

Sequence Diagram

sequenceDiagram
    participant Component as MerchantMonitoringBusinessReport
    participant Hook as useMerchantMonitoringBusinessReportLogic
    participant Query as useBusinessReportByIdQuery

    Component->>Hook: Request data
    Hook->>Query: Fetch business report
    Query-->>Hook: Return data and fetching state
    Hook-->>Component: Provide isFetchingBusinessReport
    alt Is Fetching
        Component->>Component: Render Skeleton
    else Data Loaded
        Component->>Component: Render Actual Content
    end
Loading

Possibly related PRs

Suggested reviewers

  • Omri-Levy
  • MatanYadaev

Poem

🐰 Loading bunnies hop and sway,
Skeletons dance their merry way
Data streams in, smooth and bright
Merchant reports now shine with light!
A loading state, so sleek and neat 🚀


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.

@alonp99
Copy link
Collaborator

alonp99 commented Jan 14, 2025

@r4zendev can you do something with the black tag near the status? 🙏

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 (3)
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (3)

90-96: Consider adjusting the skeleton dimensions.

The fixed width of the skeleton (w-32) might be too narrow for longer website names, causing a jarring transition when the actual content loads.

Consider using a wider skeleton or matching the parent width:

-            <Skeleton className="h-6 w-32" />
+            <Skeleton className="h-6 w-64" />

97-139: Enhance loading state granularity.

Currently, a single skeleton represents multiple status elements. Consider showing individual skeletons for each element to provide a more accurate loading representation.

Here's a suggested improvement:

-            <Skeleton className="my-6 h-6 w-2/3" />
+            <div className="flex items-center space-x-8 pb-4">
+              <Skeleton className="h-6 w-24" /> {/* Status */}
+              <Skeleton className="h-6 w-48" /> {/* Created at */}
+              <Skeleton className="h-6 w-32" /> {/* Monitoring Status */}
+              <Skeleton className="h-6 w-16" /> {/* Notes */}
+            </div>

155-172: LGTM! Well-structured content loading state.

The implementation provides a good visual representation of the tab content structure. However, consider making the skeleton heights dynamic based on viewport height for better responsiveness.

Consider using viewport-relative units:

-                  <div className="mt-6 flex h-[24rem] w-full flex-nowrap gap-8">
+                  <div className="mt-6 flex h-[40vh] w-full flex-nowrap gap-8">
📜 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 10bca58.

📒 Files selected for processing (3)
  • apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (4 hunks)
  • apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.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 (6)
  • GitHub Check: test_windows
  • GitHub Check: test_linux
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: lint
🔇 Additional comments (3)
apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx (1)

27-29: LGTM! Clean implementation of loading state.

The changes correctly expose the loading state from React Query, with consistent naming conventions.

Also applies to: 111-111

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx (2)

12-12: LGTM! Clean setup for loading states.

The Skeleton component is properly imported and the loading state is correctly destructured from the hook.

Also applies to: 41-41


103-119: Addressing PR comment about the black tag near status.

The implementation now includes proper styling for the status badge with appropriate background colors and text colors. The loading state ensures a smooth transition when the status loads.

@r4zendev r4zendev enabled auto-merge (squash) January 15, 2025 13:03
@r4zendev r4zendev merged commit dbba2a0 into dev Jan 15, 2025
18 checks passed
@r4zendev r4zendev deleted the bal3359 branch January 15, 2025 13:11
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.

3 participants