refactor(web): use new gateway RTK API #4752
Conversation
Instead of using an async call from the old safe-gateway-typescript-sdk, we are now using the RTK hooks from the @safe-global/store package.
Branch preview✅ Deploy successful! Website: Storybook: |
Coverage report for
|
St.❔ |
Category | Percentage | Covered / Total |
|---|---|---|---|
| 🟡 | Statements | 77.39% (+3.12% 🔼) |
13746/17761 |
| 🔴 | Branches | 56.83% (+4.77% 🔼) |
3475/6115 |
| 🟡 | Functions | 62.67% (+5.3% 🔼) |
2062/3290 |
| 🟡 | Lines | 78.83% (+3.01% 🔼) |
12399/15729 |
Show new covered files 🐣
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🟢 | ... / gateway.ts |
87.5% | 75% | 100% | 100% |
Show files with reduced coverage 🔻
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🟢 | src/utils/chains.ts | 93.1% | 90% (-2.31% 🔻) |
100% | 100% |
| 🟢 | ... / safePass.ts |
88.89% (-2.02% 🔻) |
100% (+25% 🔼) |
50% | 85.71% (-3.17% 🔻) |
| 🟢 | ... / pk-popup-store.ts |
80% (-10% 🔻) |
50% | 0% | 88.89% |
| 🟢 | ... / utils.ts |
90.91% (-0.34% 🔻) |
71.88% (-8.77% 🔻) |
90% (-0.48% 🔻) |
95.08% (-0.23% 🔻) |
| 🟢 | ... / firebase.ts |
86.96% (+7.79% 🔼) |
72.73% (-4.2% 🔻) |
100% | 89.47% (+9.47% 🔼) |
| 🟢 | ... / useNotificationPreferences.ts |
86.36% (-2.65% 🔻) |
40% (-26.67% 🔻) |
80.65% (-1.17% 🔻) |
85.54% (-2.69% 🔻) |
| 🟢 | ... / stake.ts |
75% (-25% 🔻) |
100% | 100% | 100% |
| 🟡 | ... / index.tsx |
67.65% (-0.92% 🔻) |
42.11% | 20% | 69.84% (-0.93% 🔻) |
Test suite run failed
Failed tests: 0/1760. Failed suites: 1/239.
● Test suite failed to run
Cannot find module '../../../../../../packages/store/src/src/gateway/AUTO_GENERATED/balances' from 'src/components/balances/CurrencySelect/useCurrencies.ts'
Require stack:
src/components/balances/CurrencySelect/useCurrencies.ts
src/components/balances/CurrencySelect/__tests__/useCurrencies.test.ts
at Resolver._throwModNotFoundError (../../node_modules/jest-resolve/build/resolver.js:427:11)
at Object.<anonymous> (src/components/balances/CurrencySelect/useCurrencies.ts:200:26)
at Object.<anonymous> (src/components/balances/CurrencySelect/__tests__/useCurrencies.test.ts:17:63)
Report generated by 🧪jest coverage report action from 0f78f3a
📦 Next.js Bundle Analysis for @safe-global/webThis analysis was generated by the Next.js Bundle Analysis action. 🤖
|
| Page | Size (compressed) |
|---|---|
global |
1.06 MB (🟡 +69.76 KB) |
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!
Thirty-two Pages Changed Size
The following pages changed size from the code in this PR compared to its base branch:
| Page | Size (compressed) | First Load |
|---|---|---|
/ |
509 B (🟢 -1 B) |
1.06 MB |
/address-book |
23.21 KB (🟡 +143 B) |
1.08 MB |
/apps |
35.81 KB (🟡 +2.08 KB) |
1.09 MB |
/apps/custom |
33.87 KB (🟡 +2.08 KB) |
1.09 MB |
/apps/open |
55.57 KB (🟡 +1.96 KB) |
1.11 MB |
/balances |
30.01 KB (🟡 +314 B) |
1.09 MB |
/balances/nfts |
9.52 KB (🟢 -23 B) |
1.07 MB |
/bridge |
2.55 KB (🟢 -5 B) |
1.06 MB |
/cookie |
8.77 KB (🟡 +1 B) |
1.07 MB |
/home |
61.38 KB (🟡 +2.12 KB) |
1.12 MB |
/licenses |
2.46 KB (🟢 -1 B) |
1.06 MB |
/new-safe/advanced-create |
26.38 KB (🟢 -72 B) |
1.08 MB |
/new-safe/create |
25.53 KB (🟢 -64 B) |
1.08 MB |
/privacy |
14.57 KB (🟡 +2 B) |
1.07 MB |
/settings/appearance |
2.25 KB (🟡 +1 B) |
1.06 MB |
/settings/cookies |
1.87 KB (🟡 +1 B) |
1.06 MB |
/settings/modules |
4.06 KB (🟡 +3 B) |
1.06 MB |
/settings/notifications |
6.34 KB (🟢 -14.98 KB) |
1.06 MB |
/settings/safe-apps |
20.35 KB (🟡 +2.08 KB) |
1.08 MB |
/settings/security |
2.34 KB (🟡 +2 B) |
1.06 MB |
/settings/setup |
30.83 KB (🟡 +102 B) |
1.09 MB |
/share/safe-app |
7.55 KB (🟢 -8 B) |
1.06 MB |
/stake |
617 B (🟢 -2 B) |
1.06 MB |
/swap |
763 B (🟡 +3 B) |
1.06 MB |
/terms |
12.93 KB (🟡 +1 B) |
1.07 MB |
/transactions |
99.46 KB (🟡 +2.89 KB) |
1.15 MB |
/transactions/history |
99.42 KB (🟡 +2.89 KB) |
1.15 MB |
/transactions/messages |
60.26 KB (🟡 +1.96 KB) |
1.12 MB |
/transactions/msg |
56.51 KB (🟡 +1.96 KB) |
1.11 MB |
/transactions/queue |
49.37 KB (🟡 +1.97 KB) |
1.11 MB |
/transactions/tx |
48.73 KB (🟡 +1.96 KB) |
1.1 MB |
/welcome/accounts |
408 B (🟡 +1 B) |
1.06 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.
What it solves
The PR ads the @safe-global/store package to the web application. The store package exposes auto-generated endpoints for interaction with the gateway API. We can use the hooks in it to replace a lot of code from the old gateway sdk.
The benefit of using the store package is that RTK takes care of fetching and caching of the data. If we have multiple components on the page relying on the same piece of data only one fetch request will be sent.
How this PR fixes it
How to test it
This PR changes the useCurrencies call from useAsync(getFiatCurrencies) to the new rtk hook: useBalancesGetSupportedFiatCodesV1Query
Going on the assets page one should see all supported currencies in the currencies dropdown.
Screenshots
Checklist