fix: correctly format native transfer amounts

schmanu commented 3 days ago

What it solves

On some locales native values are displayed as NaN.

How this PR fixes it

Always uses safeFormatUnits instead of formatVisualAmount before passing the value to SendAmountBlock

Checklist

[x] I've tested the branch on mobile 📱
[x] I've documented how it affects the analytics (if at all) 📊
[x] I've written a unit/e2e test for it (if applicable) 🧑‍💻

github-actions[bot] commented 3 days ago

Branch preview

✅ Deploy successful!

Website: https://fix_amounts--walletweb.review.5afe.dev/home?safe=eth:0xA77DE01e157f9f57C7c4A326eeE9C4874D0598b6

Storybook: https://fix_amounts--walletweb.review.5afe.dev/storybook/

github-actions[bot] commented 3 days ago

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	0	0
Ignored	0	N/A

Result: :white_check_mark: success
- Annotations: 0 total

^{Report generated by eslint-plus-action}

github-actions[bot] commented 3 days ago

📦 Next.js Bundle Analysis for safe-wallet-web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page	Size (compressed)
`global`	`999.98 KB` (🟢 -209 B)

Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page	Size (compressed)	First Load
`/swap`	`30.45 KB` (🟡 +365 B)	1.01 MB

Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

github-actions[bot] commented 3 days ago

Coverage report

St.^{:grey_question:}	Category	Percentage	Covered / Total
🟡	Statements	78.71% (-0.04% 🔻)	11386/14465
🔴	Branches	57.95% (-0.09% 🔻)	2753/4751
🟡	Functions	65.66% (-0.07% 🔻)	1828/2784
🟢	Lines	80.09% (-0.05% 🔻)	10261/12812

Show files with reduced coverage 🔻

|

St.^{:grey_question:}

| File | Statements | Branches | Functions | Lines | | :-: | :- | :- | :- | :- | :- | | 🟢 |

`...` / utils.ts

|

80.52% (-0.49% 🔻)

| 66.67% | 80% |

82.35% (-0.26% 🔻)

| | 🟢 |

`...` / index.tsx

|

96.55% (-0.22% 🔻)

|

92% (-0.59% 🔻)

| 100% | 100% | | 🟡 |

`...` / index.tsx

|

55% (-2.14% 🔻)

| 0% | 0% |

61.11% (-2.05% 🔻)

| | 🔴 |

`...` / ReviewTokenTransfer.tsx

|

44% (-1.45% 🔻)

| 0% | 0% |

50% (-2.63% 🔻)

| | 🔴 |

`...` / ReviewSpendingLimitTx.tsx

|

41.67% (-0.36% 🔻)

| 0% | 0% |

43.48% (-0.46% 🔻)

| | 🔴 |

`...` / ReviewSpendingLimit.tsx

|

40.91% (-1.95% 🔻)

| 0% | 0% |

42.86% (-2.14% 🔻)

|

Test suite run success

1416 tests passing in 195 suites.

Report generated by 🧪jest coverage report action from ccb4117eb47026c258f722b9cc8ed05facf03bad

usame-algan commented 3 days ago

A more general observation: It is not clear what amount format components like SendAmountBlock expect. For example if I want to send 1 ETH, the component expects the value to be 1 and not 1 with 18 zeroes but this is not clear from looking at its props. Imo we should find a way to define this either via types or naming so that regressions are less likely to happen.

safe-global / safe-wallet-web