Refactor(web): use TypedData type from the @safe-global/utils package #5536
Conversation
This file contains hidden or 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
Branch preview✅ Deploy successful! Storybook: |
Coverage (27%)
|
📦 Next.js Bundle Analysis for @safe-global/webThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
Coverage report for
|
St.❔ |
Category | Percentage | Covered / Total |
|---|---|---|---|
| 🟡 | Statements | 76.86% (-0% 🔻) |
14670/19087 |
| 🔴 | Branches | 55.56% (-0.02% 🔻) |
3764/6775 |
| 🟡 | Functions | 61.2% | 2158/3526 |
| 🟡 | Lines | 78.3% (-0.01% 🔻) |
13304/16991 |
Show files with reduced coverage 🔻
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🟡 | ... / safe-message-guards.ts |
66.67% (-4.76% 🔻) |
100% | 50% | 75% (-5% 🔻) |
| 🟢 | ... / SignMessage.tsx |
91.67% (-0.08% 🔻) |
82.35% | 69.23% | 92.38% (-0.07% 🔻) |
| 🟢 | ... / index.tsx |
88.89% (-0.4% 🔻) |
92.86% | 75% | 95.83% (-0.17% 🔻) |
| 🟢 | ... / useSafeMessageNotifications.ts |
86.89% (-0.21% 🔻) |
78.26% | 100% | 87.5% (-0.22% 🔻) |
| 🟢 | ... / index.tsx |
96.88% (-0.09% 🔻) |
73.33% (+9.7% 🔼) |
100% | 96.77% (-0.1% 🔻) |
| 🟢 | ... / index.tsx |
94.12% | 47.06% (-6.27% 🔻) |
50% | 93.75% |
| 🟡 | ... / index.tsx |
76% (-0.92% 🔻) |
45.45% | 33.33% | 75% (-1% 🔻) |
Test suite run success
1803 tests passing in 253 suites.
Report generated by 🧪jest coverage report action from d0026a3
usame-algan
reviewed
Mar 31, 2025
| @@ -46,7 +46,7 @@ const MsgDetails = ({ msg }: { msg: SafeMessage }): ReactElement => { | |||
| <EthHashInfo | |||
| address={msg.proposedBy.value || ''} | |||
| name={msg.proposedBy.name} | |||
| customAvatar={msg.proposedBy.logoUri} | |||
| customAvatar={msg.proposedBy.logoUri || undefined} | |||
There was a problem hiding this comment.
Afaiu logoUri now has the type of string | null | undefined. Is there a benefit of having a fallback here instead of adjusting the EthHashInfo type to also accept null as a value for customAvatar?
There was a problem hiding this comment.
Although thinking about it it makes sense to change it here instead of everywhere downstream so we don't have to deal with a null value in potentially many components.
There was a problem hiding this comment.
Good question. The EthHashInfo component has specific requirements. if you pass a prop to it, it should be a string, otherwise you should not pass a customAvatar. The component defines concrete function arguments.
I'm not sure changing the function arguments should be done, because an API we use might return an incompatible type.
On the other hand I agree that it is a bit weird, but not sure that deserves changing the EthHashInfo component.
usame-algan
reviewed
Mar 31, 2025
apps/web/src/components/safe-messages/MsgSigners/MsgSigners.test.tsx
Outdated
Show resolved
Hide resolved
katspaugh
reviewed
Apr 1, 2025
katspaugh
approved these changes
Apr 1, 2025
iamacook
approved these changes
Apr 1, 2025
The types for balances were reverted as they cause lint errors
The codemod migrates old safe-gateway-typescript-sdk to the new @safe-global/store types
compojoom
force-pushed
the
refactor-data-type
branch
from
ffa3db4 to
a27645b
Compare
compojoom
force-pushed
the
refactor-data-type
branch
from
a27645b to
d0026a3
Compare
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
Refactors the usage of the old types to the new ones. Why? Because the new ones are "more correct & auto-generated" and the mobile app already uses them. If we want to reuse code, types need to match, otherwise all hell breaks lose and developers loose their sanity & joy of life.
Resolves #
How this PR fixes it
There is a codemod that maps old types to new types and also exchanges the use of the old enum types. After running the script I went through the files and did manual modifications that were necessary for the types to be correctly used
How to test it
Everything should continue to work as before. Unit tests and e2e tests should catch any errors.
Screenshots
Checklist