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

Resolved : Rendering big numbers in a better way #931

Closed
wants to merge 1 commit into from

Conversation

GradleD
Copy link
Contributor

@GradleD GradleD commented Nov 7, 2024

  • Bugfix

Resolves: Rendering big numbers in a better way

Summary by CodeRabbit

  • New Features

    • Introduced a utility function for consistent currency formatting across the Portfolio Summary component.
    • Enhanced tooltip display in charts to show formatted currency values.
  • Bug Fixes

    • Improved display of item values by ensuring proper formatting with commas and dollar signs.

Copy link

vercel bot commented Nov 7, 2024

@GradleD 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 7, 2024

Walkthrough

The changes introduce a new utility function, formatCurrency, in the PortfolioSummary component to standardize the formatting of currency values. This function is applied to format item values in the ChartEntry component and update the tooltip callback for displaying item values. The modifications ensure consistent currency formatting with commas and dollar signs, while the overall structure of the PortfolioSummary component remains unchanged.

Changes

File Path Change Summary
components/dashboard/PortfolioSummary.tsx Added formatCurrency utility function for formatting currency values; updated chart tooltip callback to use this function instead of direct concatenation.

Possibly related PRs

Suggested labels

❌ Change request


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

🧹 Outside diff range and nitpick comments (1)
components/dashboard/PortfolioSummary.tsx (1)

22-25: Consider centralizing formatting logic

The current implementation spreads formatting logic across multiple locations. Consider:

  1. Moving formatting utilities to a dedicated module (e.g., utils/formatting.ts)
  2. Creating separate utilities for percentage and currency formatting
  3. Adding proper TypeScript interfaces for the formatting functions

Example structure:

// utils/formatting.ts
export interface FormattingOptions {
  minimumFractionDigits?: number;
  maximumFractionDigits?: number;
}

export const formatCurrency = (amount: number, options?: FormattingOptions): string => {
  // Implementation
}

export const formatPercentage = (value: number, options?: FormattingOptions): string => {
  // Implementation
}

Also applies to: 34-37, 81-81

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3d38044 and c572a18.

📒 Files selected for processing (1)
  • components/dashboard/PortfolioSummary.tsx (4 hunks)
🔇 Additional comments (1)
components/dashboard/PortfolioSummary.tsx (1)

81-81: ⚠️ Potential issue

Fix tooltip callback implementation

The current implementation has potential issues:

  1. The item variable is undefined (should be using tooltipItem.raw)
  2. Redundant concatenation of currency symbol
-            return ` ${item.itemValueSymbol}${formatCurrency(item.itemValue)}`;
+            const value = Number(tooltipItem.raw);
+            return tooltipItem.dataset.label === '%' 
+              ? ` ${value}%`
+              : ` ${formatCurrency(value)}`;

Likely invalid or redundant comment.

Comment on lines +34 to +37
const formattedValue = itemValueSymbol === '%'
? `${itemValue}${itemValueSymbol}`
: `${itemValueSymbol}${formatCurrency(itemValue)}`;

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix undefined variable reference and standardize string interpolation

There's a critical error in the ChartEntry component where an undefined 'value' variable is being rendered.

 const formattedValue = itemValueSymbol === '%' 
-    ? `${itemValue}${itemValueSymbol}` 
-    : `${itemValueSymbol}${formatCurrency(itemValue)}`;
+    ? `${itemValue}${itemValueSymbol}` 
+    : formatCurrency(itemValue);

-      <Typography type={TEXT_TYPE.BODY_MIDDLE}>{value}</Typography>
+      <Typography type={TEXT_TYPE.BODY_MIDDLE}>{formattedValue}</Typography>

Also applies to: 47-47

Comment on lines +22 to +25
// Utility function to format currency
const formatCurrency = (amount) => {
return `$${amount.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",")}`;
};
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

Enhance the formatCurrency utility function for better robustness

While the function handles basic currency formatting, it needs improvements for production use:

-const formatCurrency = (amount) => {
+const formatCurrency = (amount: number): string => {
+  if (!Number.isFinite(amount)) {
+    return '$0';
+  }
+  // Handle numbers > 1e16 with scientific notation
+  if (Math.abs(amount) >= 1e16) {
+    return `$${amount.toExponential(2)}`;
+  }
+  // Format with 2 decimal places and thousand separators
+  return `$${amount.toLocaleString('en-US', {
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2
+  })}`;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Utility function to format currency
const formatCurrency = (amount) => {
return `$${amount.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",")}`;
};
// Utility function to format currency
const formatCurrency = (amount: number): string => {
if (!Number.isFinite(amount)) {
return '$0';
}
// Handle numbers > 1e16 with scientific notation
if (Math.abs(amount) >= 1e16) {
return `$${amount.toExponential(2)}`;
}
// Format with 2 decimal places and thousand separators
return `$${amount.toLocaleString('en-US', {
minimumFractionDigits: 2,
maximumFractionDigits: 2
})}`;
};

@fricoben fricoben closed this Nov 7, 2024
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