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

Add skeleton for portfolio value sum #947

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

Yunusabdul38
Copy link
Contributor

@Yunusabdul38 Yunusabdul38 commented Nov 13, 2024

Pull Request type

Please add the labels corresponding to the type of changes your PR introduces:
A skeleton loader for the portfolio value sum to address the loading delay issue was added

  • Bugfix

Resolves: #936

Other information

i make use of the loading component in the project file, the loading component has two type of loading component
1- A spinner and
2- A skeleton

i try using the spinner but i noticed it makes the ui to look more buggy but it has a better indication for a loading feature but due to the ui issue i end up using the skeleton type (loading) which looks much more better
if you want more modification to this please let me know

Summary by CodeRabbit

  • New Features

    • Introduced a loading indicator for the user's total balance in the ProfileCard component.
    • The balance display now shows a loading state when data is being fetched, enhancing user feedback.
  • Bug Fixes

    • Improved user experience by ensuring the balance is only displayed when available, preventing potential confusion.

Copy link

vercel bot commented Nov 13, 2024

@Yunusabdul38 is attempting to deploy a commit to the LFG Labs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

Walkthrough

The changes in this pull request involve the modification of the ProfileCard component in the profileCard.tsx file. A new Loading component is imported and utilized to enhance the user experience by providing loading feedback for the user's total balance. The Typography component displaying the balance is conditionally wrapped in the Loading component, which shows a loading state when the totalBalance is null. This adjustment maintains the existing balance display logic while improving visual feedback during loading.

Changes

File Change Summary
components/UI/profileCard/profileCard.tsx Added import for Loading component; modified rendering logic to wrap Typography in Loading based on totalBalance being null.

Assessment against linked issues

Objective Addressed Explanation
Add skeleton for portfolio value sum (#936)

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/UI/profileCard/profileCard.tsx

Oops! Something went wrong! :(

ESLint: 9.14.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 321c166 and 8a63b9f.

📒 Files selected for processing (1)
  • components/UI/profileCard/profileCard.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/UI/profileCard/profileCard.tsx

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

🧹 Outside diff range and nitpick comments (2)
components/UI/profileCard/profileCard.tsx (2)

Line range hint 169-194: Consider consolidating loading states.

There appears to be two different loading implementations:

  1. The new Loading component wrapper
  2. The existing MUI Skeleton component inside the Typography

This might lead to redundant loading states. Consider:

  1. Using only the new Loading component for consistency
  2. Removing the MUI Skeleton implementation
-                {totalBalance !== null ? (
-                  hidePortfolio ? (
-                    '******'
-                  ) : (
-                    `$${totalBalance?.toFixed(2)}`
-                  )
-                ) : (
-                  <Skeleton
-                    variant='text'
-                    width={60}
-                    height={30}
-                  />
-                )}
+                {hidePortfolio ? '******' : `$${totalBalance?.toFixed(2)}`}

Line range hint 78-106: Improve error handling and cleanup in balance fetching.

Several improvements could enhance the robustness of the balance fetching logic:

  1. The while(true) loop with MAX_RETRIES could lead to infinite retries
  2. The abort controller is defined but not properly utilized for cleanup
  3. Error states are not surfaced to the UI

Consider implementing these improvements:

 useEffect(() => {
   const fetchTotalBalance = async () => {
-    let attempts = 0;
-    while (true) {
+    for (let attempts = 0; attempts < MAX_RETRIES; attempts++) {
       try {
         const balance = await calculateTotalBalance(formattedAddress, 'USD', {
           signal,
         });
         setTotalBalance(balance);
-        return;
+        break;
       } catch (err) {
-        attempts++;
         console.error(
           `Attempt ${attempts} - Error fetching total balance:`,
           err
         );
-        if (attempts >= MAX_RETRIES) {
-          console.error(
-            'Failed to fetch total balance after multiple attempts.'
-          );
-        } else {
-          await new Promise((resolve) => setTimeout(resolve, RETRY_DELAY));
-        }
+        if (attempts === MAX_RETRIES - 1) {
+          setTotalBalance(0); // or some error state
+          console.error('Failed to fetch total balance after multiple attempts.');
+          return;
+        }
+        await new Promise((resolve) => setTimeout(resolve, RETRY_DELAY));
       }
     }
   };

   if (address) {
     fetchTotalBalance();
   }
+  
+  return () => {
+    controller.abort();
+  };
 }, [formattedAddress, address]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d41593e and 321c166.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • components/UI/profileCard/profileCard.tsx (3 hunks)
🔇 Additional comments (2)
components/UI/profileCard/profileCard.tsx (2)

32-32: LGTM: Import statement aligns with PR objectives.

The import of the Loading component is correctly placed and follows the project's component organization structure.


Line range hint 169-194: Verify loading behavior matches design.

While the skeleton loader implementation meets the basic requirements from issue #936, please ensure that:

  1. The loading behavior matches the before/after images provided in the issue
  2. The loading state properly handles the privacy icon visibility

Consider implementing a comprehensive loading state that includes:

  • Skeleton for the amount
  • Placeholder for the privacy icon
  • Consistent loading indicators across all dynamic content in the card

Copy link

vercel bot commented Nov 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
starknet-quest ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 14, 2024 11:04am

Copy link
Contributor

@fricoben fricoben left a comment

Choose a reason for hiding this comment

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

Nope, we want a skeleton like so https://mui.com/material-ui/react-skeleton/

Check the /skeletons and the rest of the codebase to see, if you change the skeleton type then we're good

Copy link
Contributor

@fricoben fricoben left a comment

Choose a reason for hiding this comment

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

Nope, we want a skeleton not a spinner (like so https://mui.com/material-ui/react-skeleton/)

Check the /skeletons and the rest of the codebase to see, if you change the skeleton type then we're good

@fricoben fricoben added the ❌ Change request Change requested from reviewer label Nov 14, 2024
Copy link
Contributor

@fricoben fricoben left a comment

Choose a reason for hiding this comment

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

lgtm

@fricoben fricoben merged commit 248013e into lfglabs-dev:testnet Nov 15, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
❌ Change request Change requested from reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add skeleton for porfolio value sum
2 participants