Skip to content

[TASK-7285] fix(cashout): format bank account number#552

Merged
Hugo0 merged 1 commit intomainfrom
fix/cashout-format-bank-account
Dec 3, 2024
Merged

[TASK-7285] fix(cashout): format bank account number#552
Hugo0 merged 1 commit intomainfrom
fix/cashout-format-bank-account

Conversation

@jjramirezn
Copy link
Copy Markdown
Contributor

@jjramirezn jjramirezn commented Dec 3, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced display of bank account numbers for improved readability.
  • Bug Fixes

    • Refined error messages for clearer user feedback during bank account selection.
  • Improvements

    • Enhanced state management for bank account validation, ensuring accurate UI representation.

@vercel
Copy link
Copy Markdown

vercel bot commented Dec 3, 2024

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

Name Status Preview Comments Updated (UTC)
peanut-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 9:01am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The pull request introduces modifications to the InitialCashoutView component, primarily enhancing the display of bank account numbers. A new utility function, formatBankAccountDisplay, is imported to format these numbers for better readability. The error handling in the handleOnNext function has been improved, particularly for cases with no selected bank account. Additionally, state management for bank account validation has been updated to ensure accurate feedback, while the overall control flow remains consistent.

Changes

File Path Change Summary
src/components/Cashout/Components/Initial.view.tsx Utilized formatBankAccountDisplay for formatting bank account numbers; improved error handling in handleOnNext; updated state management for bank account validation.
src/utils/format.utils Added formatBankAccountDisplay(value: string) function for bank account number formatting.
src/components/Global/ValidatedInput Updated formatDisplayValue function signature from value: string to value: string, type: string.

Possibly related PRs

Suggested reviewers

  • nezz0746
  • panosfilianos

🐰 "In the meadow where numbers play,
A format was born to brighten the day.
With clearer paths for accounts to show,
Errors refined, and validations flow.
Hopping along, we cheer with delight,
For a smoother cashout, everything feels right!" 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3adb383 and b6aec7b.

📒 Files selected for processing (1)
  • src/components/Cashout/Components/Initial.view.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Cashout/Components/Initial.view.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.

@jjramirezn jjramirezn requested a review from Hugo0 December 3, 2024 08:43
@notion-workspace
Copy link
Copy Markdown

Copy link
Copy Markdown
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 (3)
src/components/Cashout/Components/Initial.view.tsx (3)

Line range hint 214-220: Consider adding validation for sanitized bank account

While the sanitization is good, consider validating the sanitized identifier before setting it as valid.

 const handleBankAccountSelect = (accountIdentifier: string) => {
     if (!xchainAllowed) return
     const sanitizedIdentifier = sanitizeBankAccount(accountIdentifier)
+    const isValid = validateBankAccount(sanitizedIdentifier)
     setBankAccountNumber(sanitizedIdentifier)
-    setIsValidBankAccountNumber(true)
+    setIsValidBankAccountNumber(isValid)
     setIsValidatingBankAccountNumber(false)
 }

Line range hint 222-234: Extract magic number for US routing number length

Consider extracting the magic number 9 into a named constant for better maintainability.

+const US_ROUTING_NUMBER_LENGTH = 9;
+
 const matchAccount = (storedAccount: any, inputAccount: string) => {
     const sanitizedInput = sanitizeBankAccount(inputAccount)
     const sanitizedStored = sanitizeBankAccount(storedAccount.account_identifier)
 
     if (storedAccount.account_type === 'iban') {
         return sanitizedInput === sanitizedStored
     } else if (storedAccount.account_type === 'us') {
         // For US accounts, only match against the account number part (after routing number)
-        const storedAccountNumber = sanitizedStored.slice(9)
+        const storedAccountNumber = sanitizedStored.slice(US_ROUTING_NUMBER_LENGTH)
         return sanitizedInput === storedAccountNumber
     }
     return false
 }

Line range hint 367-389: Remove manual error state management

Based on previous feedback, the ValidatedInput component will handle error messages for invalid bank accounts. Manual error state management is unnecessary and should be removed.

 <ValidatedInput
     placeholder="IBAN / US account number"
     label="To"
     value={bankAccountNumber}
     className="uppercase"
     debounceTime={750}
     validate={validateBankAccount}
     onUpdate={({ value, isValid, isChanging }) => {
         setBankAccountNumber(value.toLowerCase())
         setIsValidBankAccountNumber(isValid)
         setIsValidatingBankAccountNumber(isChanging)
-        if (!isChanging && value && !isValid) {
-            setErrorState({
-                showError: true,
-                errorMessage:
-                    'Invalid bank account. For US bank accounts, enter your routing number and account number separately.',
-            })
-        } else {
-            setErrorState({
-                showError: false,
-                errorMessage: '',
-            })
-        }
     }}
     autoComplete="on"
     name="bank-account"
     formatDisplayValue={formatBankAccountDisplay}
 />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a07c5b7 and 3adb383.

📒 Files selected for processing (1)
  • src/components/Cashout/Components/Initial.view.tsx (1 hunks)
🧰 Additional context used
📓 Learnings (1)
src/components/Cashout/Components/Initial.view.tsx (1)
Learnt from: jjramirezn
PR: peanutprotocol/peanut-ui#484
File: src/components/Cashout/Components/Initial.view.tsx:273-274
Timestamp: 2024-11-12T09:39:20.720Z
Learning: In the `InitialCashoutView` component (`src/components/Cashout/Components/Initial.view.tsx`), linked bank accounts should not generate error states, and the `ValidatedInput` component will clear any error messages if needed. Therefore, it's unnecessary to manually clear the error state when selecting or clearing linked bank accounts.
🔇 Additional comments (1)
src/components/Cashout/Components/Initial.view.tsx (1)

23-23: LGTM: Import changes align with PR objective

The new utility imports for bank account formatting are appropriate and well-named.

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