feat: add support for conversion payments

[rodrigopavezi]

Fixes:

• Wrong Balance values
• Missing Network value
• Missing Settlement Currency in PDF

Changes:

• add support for conversion payments
• fix PDF download render issue

Summary by CodeRabbit

Summary by CodeRabbit

• New Features
  • Introduced PDF export functionality with a loading spinner for improved user experience.
  • Enhanced payment data handling, including clearer display of currency and blockchain network information.
  • Added a new interface for payment data representation.
• Bug Fixes
  • Resolved issues related to payment data extraction and rendering in the PDF.
• Chores
  • Added a delay before PDF export to ensure content is fully rendered.
  • Introduced new utility functions for better payment data management.

[coderabbitai]

Walkthrough

The changes introduce enhancements for exporting PDF documents and improved handling of payment data within the application. Key updates include the addition of a loading state during the PDF export process, modifications to the useExportPDF hook for better extraction of payment details, and the introduction of a new utility function for retrieving payment data from transaction parameters.

Changes

File	Change Summary
src/app/request/[id]/page.tsx	Added loading state for PDF export, modified handleExportPDF to be asynchronous, and improved payment data handling.
src/lib/hooks/use-export-pdf.tsx	Introduced sleep function, added paymentData parameter, updated PDF rendering logic with settlement currency details.
src/lib/types.ts	Added new PaymentData interface to represent payment-related data.
src/lib/utils.ts	Added getPaymentDataFromCreateTransaction function to extract payment data from transaction parameters and introduced capitalize utility function.

Possibly related PRs

• fix: pdf address formatting issue and copy address button position #32: Modifies src/app/request/[id]/page.tsx to address PDF address formatting issues, related to the enhancements made in the main PR for PDF export functionality.
• fix: small V1 issues #30: Includes fixes to PDF formatting, aligning with the main PR's focus on improving the PDF export process and handling payment data.
• fix: unhandled exception for getting payment reference #56: Updates the calculateShortPaymentReference function in src/lib/utils.ts, relevant as the main PR introduces a new utility function for extracting payment data.
• fix: types #57: Modifies the calculateShortPaymentReference function, focusing on error handling and return types, which could impact how payment references are managed in conjunction with the changes in the main PR.

Suggested reviewers

• MantisClone
• sstefdev
• aimensahnoun

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 7

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between e736ca0 and 85e992c.

📒 Files selected for processing (3)

• src/app/request/[id]/page.tsx (7 hunks)
• src/lib/hooks/use-export-pdf.tsx (4 hunks)
• src/lib/utils.ts (1 hunks)

🧰 Additional context used

🪛 Biome

src/lib/utils.ts

[error] 167-167: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)

🔇 Additional comments (6)

src/lib/hooks/use-export-pdf.tsx (1)

15-16: LGTM: Utility function for introducing delays

The sleep function is a well-implemented utility for introducing delays in asynchronous operations. It will be useful for ensuring content is fully rendered before PDF export.

src/app/request/[id]/page.tsx (5)

24-24: LGTM: New imports align with feature additions.

The new imports for getPaymentDataFromCreateTransaction, Loader2, and useState are consistent with the changes described in the PR objectives and AI-generated summary. They support the new functionality for payment data handling and the loading state for PDF export.

Also applies to: 30-30, 36-36

---

112-112: LGTM: Loading state added for PDF export.

The addition of the isDownloading state variable using the useState hook is a good practice. It will allow for better user feedback during the PDF export process, improving the overall user experience.

---

158-159: LGTM: Enhanced payment data extraction.

The addition of the paymentData variable using the getPaymentDataFromCreateTransaction function is a good improvement. It extracts payment-related information from the transaction parameters, which supports the new functionality for conversion payments as mentioned in the PR objectives.

---

214-214: LGTM: Improved UI feedback and formatting.

1. The addition of a loading spinner to the export button when isDownloading is true provides excellent visual feedback to the user during the PDF export process.
2. Capitalizing the first letter of the blockchain network name improves readability and presentation.

Both changes enhance the overall user experience of the application.

Also applies to: 307-307

---

Line range hint 1-353: Overall assessment: Well-implemented features with minor suggestions for improvement.

The changes in this file successfully implement the new functionality for conversion payments and address the rendering issue for PDF downloads. The code is well-structured and improves both the functionality and user experience of the application. Here's a summary of the key improvements:

1. Enhanced payment data handling and extraction.
2. Improved PDF export process with proper loading state management.
3. Better UI feedback during the PDF export process.
4. More accurate balance currency display.
5. Improved formatting for blockchain network display.

The minor suggestions provided in the review comments, if implemented, would further enhance the robustness and user experience of the application.

[MantisClone]

Looks good. Approving on contingency that following comment is resolved:

If there's no Issue, please add the problem to the PR description

[coderabbitai]

Actionable comments posted: 7

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 85e992c and 2624a1d.

📒 Files selected for processing (4)

• src/app/request/[id]/page.tsx (7 hunks)
• src/lib/hooks/use-export-pdf.tsx (4 hunks)
• src/lib/types.ts (1 hunks)
• src/lib/utils.ts (2 hunks)

🧰 Additional context used

🪛 Biome

src/lib/utils.ts

[error] 167-167: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)

🔇 Additional comments (5)

src/lib/utils.ts (1)

192-192: LGTM: Capitalize function implementation

The capitalize function is well-implemented. It correctly handles the capitalization of the first character and gracefully manages empty strings. The use of the logical OR operator for default value is a concise and effective approach.

src/lib/hooks/use-export-pdf.tsx (4)

7-8: LGTM: Imported necessary modules

The import statements for capitalize, renderAddress, and PaymentData are appropriate and correctly set up the dependencies needed for the enhancements.

---

15-17: LGTM: Added delay constant and sleep function

Defining RENDER_DELAY_MS and the sleep function is a good approach to introduce a delay before exporting the PDF. This aligns with the need to ensure that all content is fully rendered.

---

67-67: LGTM: Added 'paymentData' parameter to 'exportPDF' function

The addition of the paymentData parameter enhances the exportPDF function by allowing it to include payment-related details in the PDF export, aligning with the PR objectives.

---

73-77: LGTM: Safely retrieved payment currency details

The logic for obtaining paymentCurrencyDetails is sound. The null checks ensure that the code handles cases where acceptedTokens may be undefined or empty.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 2624a1d and 4cdca41.

📒 Files selected for processing (2)

• src/app/request/[id]/page.tsx (7 hunks)
• src/lib/hooks/use-export-pdf.tsx (4 hunks)

🔇 Additional comments (12)

src/lib/hooks/use-export-pdf.tsx (6)

7-8: Imports added are appropriate

The addition of capitalize, renderAddress, and PaymentData imports correctly introduces the required utilities and types used in the code.

---

15-17: Consider using a more reliable method to ensure content is rendered before exporting

---

67-67: Improved type safety by specifying 'PaymentData' type

Specifying PaymentData as the type for paymentData enhances type safety and aligns with best practices.

---

73-77: Safety check added for 'acceptedTokens' array

The conditional check ensures that acceptedTokens has elements before accessing them, preventing potential runtime errors.

---

115-115: Prevented potential error when capitalizing 'network'

By checking if invoice?.paymentData?.network is defined before calling capitalize, you prevent potential runtime errors if network is undefined.

---

216-218: Consider using a more reliable method to ensure content is rendered before exporting

src/app/request/[id]/page.tsx (6)

113-113: Initialize isDownloading state for loading indicator

The isDownloading state variable is properly initialized to manage the loading state during the PDF export process.

---

158-159: Retrieve payment data from transaction parameters

The paymentData is correctly extracted using getPaymentDataFromCreateTransaction(createParameters).

---

160-164: Assign balanceCurrency based on accepted tokens

The logic for assigning balanceCurrency checks if acceptedTokens has entries and assigns the first token appropriately.

---

180-196: Implement error handling in handleExportPDF function

The handleExportPDF function is correctly updated to be asynchronous with proper error handling using try...catch...finally. Placing setIsDownloading(false) in the finally block ensures the loading state is reset regardless of success or failure.

---

223-227: Disable Export PDF button during download

The Export PDF button is correctly disabled when isDownloading is true, and a loading spinner is displayed to indicate progress. This prevents multiple clicks and duplicate export attempts.

---

320-322: Safely capitalize the network name

Properly checks if paymentData.network exists before calling capitalize, preventing potential runtime errors if paymentData.network is undefined.