refactor(web): use new gateway RTK API #4752
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.42% (+3.17% 🔼) |
13771/17788 |
| 🔴 | Branches | 56.85% (+4.85% 🔼) |
3478/6118 |
| 🟡 | Functions | 62.69% (+5.34% 🔼) |
2067/3297 |
| 🟡 | Lines | 78.84% (+3.05% 🔼) |
12421/15754 |
Show new covered files 🐣
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🟢 | ... / gateway.ts |
87.5% | 75% | 100% | 100% |
| 🟡 | ... / index.tsx |
80% | 100% | 66.67% | 78.95% |
Show files with reduced coverage 🔻
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🟢 | ... / broadcast.ts |
100% | 90% (-10% 🔻) |
100% | 100% |
| 🟢 | 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 success
1761 tests passing in 239 suites.
Report generated by 🧪jest coverage report action from 1c6a94c
📦 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.85 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.97 KB (🟡 +2.25 KB) |
1.09 MB |
/apps/custom |
34.03 KB (🟡 +2.25 KB) |
1.09 MB |
/apps/open |
55.56 KB (🟡 +1.95 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.54 KB (🟡 +2.28 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.45 KB (🟡 +2.88 KB) |
1.15 MB |
/transactions/history |
99.41 KB (🟡 +2.88 KB) |
1.15 MB |
/transactions/messages |
60.25 KB (🟡 +1.95 KB) |
1.12 MB |
/transactions/msg |
56.5 KB (🟡 +1.95 KB) |
1.11 MB |
/transactions/queue |
49.36 KB (🟡 +1.96 KB) |
1.11 MB |
/transactions/tx |
48.71 KB (🟡 +1.95 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.
Moving the msw handlers to the shared test package. This way we can reuse the same handlers in the web app as we are calling the same endpoints.
Mock Service Worker (MSW) is an API mocking library. With MSW we can intercept outgoing requests, observe them, and respond to them using mocked responses. This simplifies our tests a lot. Up until now we were mocking the method that would do a network request. This always required knowledge of the internal workings of our APIs. MSW runs in the background and outputs a warning in the terminal when we are trying to access a network resource for which we haven’t mocked a response. This way we only need to provide dummy data for our endpoints instead of fiddling with internal logic. Updating to MSW outlined problems in JSDOM and I had to update to jest-fixed-jsdom. We were manually fixing some of those problems like missing global fetch, response and request objects. Now our jsdom environment has the global objects that are available both in the browser and in node, so we don’t introduce pollyfills and maintain them.
Coverage (52%)
|
compojoom
commented
Jan 13, 2025
compojoom
commented
Jan 13, 2025
| afterAll(() => { | ||
| // @ts-ignore | ||
| delete global.fetch | ||
| global.fetch = originalGlobalFetch | ||
| }) |
There was a problem hiding this comment.
@iamacook you wrote the original version of those tests. Why were you deleting the global.fetch object? I didn't fully get it. Can you maybe check if those tests make sense with the new fixed jsdom environment. Maybe you did those things because jsdom was broken and we can simplify them now(less mocking?).
There was a problem hiding this comment.
The response is stubbed in each test.
compojoom
commented
Jan 13, 2025
Comment on lines
+141
to
+143
| if (!options?.skipBroadcast) { | ||
| listenToBroadcast(store) | ||
| } |
There was a problem hiding this comment.
in jsdom the BroadcastChannel object was actually missing. Note that it is generally available in the Browser and in Node. With the jest-fixed-jsdom this object was now available and jest was complaining that we have open listeners. That's why I added this line to be able to control when we need the broadcast listeners in the tests.
compojoom
commented
Jan 13, 2025
| @@ -0,0 +1,62 @@ | |||
| import { http, HttpResponse } from 'msw' | |||
There was a problem hiding this comment.
The handlers are now shared between web and mobile. The idea for this handlers would be to have default data for the endpoints we use across the project. We should combine this with the fake builders.
note how every response endpoint specifies the type of the returned JSON. With this whenever a type in the store package change we can be sure that we also need to update a test as the type would become invalid.
iamacook
reviewed
Jan 14, 2025
| @@ -71,7 +71,7 @@ describe('useNotificationTracking', () => { | |||
| }) | |||
|
|
|||
| const _entries = await entries(createNotificationTrackingIndexedDb()) | |||
| expect(Object.fromEntries(_entries)).toStrictEqual({ | |||
| expect(Object.fromEntries(_entries)).toEqual({ | |||
There was a problem hiding this comment.
Why was this change necessary?
apps/web/src/components/tx/security/tenderly/__tests__/useSimulation.test.ts
Show resolved
Hide resolved
Comment on lines
+10
to
+57
| items: [ | ||
| { | ||
| tokenInfo: { | ||
| name: 'Ethereum', | ||
| symbol: 'ETH', | ||
| decimals: 18, | ||
| address: '0x', | ||
| type: 'ERC20', | ||
| logoUri: 'https://safe-transaction-assets.safe.global/chains/1/chain_logo.png', | ||
| }, | ||
| balance: '1000000000000000000', | ||
| fiatBalance: '2000', | ||
| fiatConversion: '2000', | ||
| }, | ||
| ], | ||
| fiatTotal: '2000', | ||
| }) | ||
| }), | ||
| http.get<never, never, CollectiblePage>(`${GATEWAY_URL}/v2/chains/:chainId/safes/:safeAddress/collectibles`, () => { | ||
| return HttpResponse.json({ | ||
| count: 2, | ||
| next: null, | ||
| previous: null, | ||
| results: [ | ||
| { | ||
| id: '1', | ||
| address: '0x123', | ||
| tokenName: 'Cool NFT', | ||
| tokenSymbol: 'CNFT', | ||
| logoUri: 'https://example.com/nft1.png', | ||
| name: 'NFT #1', | ||
| description: 'A cool NFT', | ||
| uri: 'https://example.com/nft1.json', | ||
| imageUri: 'https://example.com/nft1.png', | ||
| }, | ||
| { | ||
| id: '2', | ||
| address: '0x456', | ||
| tokenName: 'Another NFT', | ||
| tokenSymbol: 'ANFT', | ||
| logoUri: 'https://example.com/nft2.png', | ||
| name: 'NFT #2', | ||
| description: 'Another cool NFT', | ||
| uri: 'https://example.com/nft2.json', | ||
| imageUri: 'https://example.com/nft2.png', | ||
| }, | ||
| ], | ||
| }) |
There was a problem hiding this comment.
Nit: not necessary here but if there are builders, we could use them here to have dynamic mock data.
There was a problem hiding this comment.
Yes, I think that we should move some of the builders to the test package. But that would be something for a different PR.
Funny enough since the last test was setting it to false we were going back to the correct value, but this was just chance :)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Next to the new store package I've added the MSW package for testing our code. Instead of mocking the response on our RTK functions, we just mock json responses at endpoints that our code calls. MSW is helping in this by outputing endpoints that don't have a mocked response. Our code no longer needs to mock fetch and our tests behave more like they would do for the user. A network call will start with an undefined data, then will resolve with data or fail (depending on what we specify for the endpoint)
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