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

refactor: use Array.reduce instead of Object.groupBy #1652

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

AMIRKHANEF
Copy link
Member

@AMIRKHANEF AMIRKHANEF commented Nov 14, 2024

Close: #1651

Summary by CodeRabbit

  • New Features

    • Enhanced clarity and type safety in the Total Balance Pie Chart component.
    • Improved asset data aggregation and grouping for better performance.
  • Bug Fixes

    • Simplified balance price calculations for more accurate results.

Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

Walkthrough

The pull request modifies the TotalBalancePieChart.tsx file, focusing on type handling and asset data aggregation. It removes the import of FetchedBalance and employs explicit TypeScript type assertions for better type safety. The method for grouping assets has shifted from Object.groupBy to a manual reduction approach, enhancing clarity. The aggregation logic for asset prices has been simplified, removing unnecessary type assertions and streamlining calculations. Overall, these changes improve the clarity and safety of data handling without altering the component's structure.

Changes

File Path Change Summary
packages/extension-polkagate/src/fullscreen/homeFullScreen/partials/TotalBalancePieChart.tsx Removed import of FetchedBalance, updated asset grouping method to manual reduction, refined type assertions for asset price calculations, and improved clarity in data handling.

Possibly related PRs

🐇 In the world of balance, we hop and play,
With types and assets, we clear the way.
No more imports, just clarity bright,
Grouping and pricing, all feels just right.
So here’s to our charts, so lively and neat,
In the garden of code, our work is a treat! 🌼✨


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

🧹 Outside diff range and nitpick comments (1)
packages/extension-polkagate/src/fullscreen/homeFullScreen/partials/TotalBalancePieChart.tsx (1)

164-167: Add safety check for empty asset groups

The code assumes that groupedAssets[index] is non-empty. While this might be guaranteed by the logic above, it's better to be explicit.

Consider adding a safety check:

-      const assetSample = groupedAssets[index][0];
+      const assets = groupedAssets[index];
+      if (!assets.length) {
+        return null;
+      }
+      const assetSample = assets[0];

Also, consider renaming accumulatedPricePerAsset to accumulatedBalance as it represents the sum of balances, not prices.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f860a8a and 882cc3e.

📒 Files selected for processing (1)
  • packages/extension-polkagate/src/fullscreen/homeFullScreen/partials/TotalBalancePieChart.tsx (1 hunks)
🔇 Additional comments (1)
packages/extension-polkagate/src/fullscreen/homeFullScreen/partials/TotalBalancePieChart.tsx (1)

152-162: LGTM! Clean implementation of grouping logic

The refactoring from Object.groupBy to Array.reduce is well-implemented. The composite key creation is clean, and the accumulator type is properly defined.

@@ -146,19 +144,27 @@ function TotalBalancePieChart ({ hideNumbers, setGroupedAssets }: Props): React.
Object.keys(balances).forEach((address) => {
Object.keys(balances?.[address]).forEach((genesisHash) => {
if (!TEST_NETS.includes(genesisHash)) {
// @ts-ignore
allAccountsAssets = allAccountsAssets.concat(balances[address][genesisHash]);
allAccountsAssets = allAccountsAssets.concat(balances[address][genesisHash] as unknown as AssetsWithUiAndPrice[]);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider removing the double type assertion

The double type assertion as unknown as AssetsWithUiAndPrice[] bypasses TypeScript's type checking completely. This could hide potential type mismatches and make the code less type-safe.

Consider properly typing the balances structure or using a type guard instead:

interface AccountBalances {
  [address: string]: {
    [genesisHash: string]: AssetsWithUiAndPrice[];
  };
}

@Nick-1979 Nick-1979 merged commit 44dcb3b into PolkaGate:main Dec 2, 2024
8 checks passed
@AMIRKHANEF AMIRKHANEF deleted the reduce branch December 3, 2024 08:07
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.

some type issues in the TotalBalancePieChart.tsx
2 participants