Repository navigation
[No QA] Type web-only styles for the React Native Strict TypeScript API - #106526
roryabraham merged 8 commits into
Conversation
|
|
…t-api-web-style-types # Conflicts: # src/libs/Navigation/helpers/singleRHPWidth/index.ts # src/styles/index.ts
Codecov Report✅ Changes either increased or maintained existing code coverage, great job!
|
…er the augmentation with knip
…b, correct the Accordion comment
|
Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers! |
| import parseAttribute from './parseAttribute'; | ||
|
|
||
| /** Chart nodes also carry the SVG paint properties that the chart's style attribute sets */ | ||
| type ChartNodeStyle = ViewStyle & { |
There was a problem hiding this comment.
Doesn't victory chart export simiar style? Why would we have to defin ours?
There was a problem hiding this comment.
victory-native has no {fill, stroke} type because it never uses that shape, those keys come from our chart HTML and we turn them into its color and strokeWidth props ourselves.
iewStyle used to accept them because react-native-web types added every CSS property to it and 0.19.3 stopped doing that
There was a problem hiding this comment.
[NAB] I get that extracting those functions to a separate file makes the codebase cleaner, but also everyone now have to check what each function does (which is just an assertion).
Not saying that this is entirely wrong, but it may be worth considering
There was a problem hiding this comment.
I believe keeping them in one file is the cleanest option, inlining them would mean 39 as casts, each with its own eslint-disable across 17 files. The helpers are also stricter than a bare as, toViewStyle only accepts a WebOnlyViewStyle, so it can't cast an unrelated object.
I've added a one-line JSDoc to each of them so hovering shows they just return their argument
…t-api-web-style-types # Conflicts: # src/styles/utils/index.ts
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
roryabraham
left a comment
There was a problem hiding this comment.
Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
- I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
toggleReportand notonIconClick). - I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
- If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- I verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar, I verified the components usingAvatarhave been tested & I retested again) - If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a
/** comment above it */ - The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
- If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
- If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
- If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
- If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like
Avataris modified, I verified thatAvataris working as expected in all cases) - If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
- If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
- If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
|
🚧 roryabraham has triggered a test Expensify/App build. You can view the workflow run here. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Deployed to staging by https://github.com/roryabraham in version: 9.5.40-0 🚀
|
|
No help site update needed — this PR updates TypeScript style types and compatibility helpers without changing user-facing features, workflows, or labels, so existing articles remain accurate. |
Explanation of Change
RN 0.87+ makes the Strict TypeScript API the default. @types/react-native-web 0.19.2 widened RN's style types globally, which the Strict API rejects. This bumps it to 0.19.3, which drops that, removes its obsolete patch, and types the web-only CSS values the app uses through
WebOnlyStyleUtilsand a narrow augmentation. Behavior is unchanged.What 0.19.2 did. Its
declare module "react-native"block merged every CSS property into RN'sViewStyle,TextStyleandImageStyle, and redeclared keys RN already has (display,position,width, ...) with CSS types. Any CSS value typechecked, including any string as a size. Those redeclarations conflict with RN's own, whichskipLibCheckhid because they live in a.d.ts.How web-only values are typed now. Module augmentation can add keys, but it can't widen a key RN already declares, so there are two paths:
whiteSpace,gridTemplateColumns,scrollSnapAlign,visibility, ...) are added back insrc/types/modules/react-native-web-augmentation.tswith react-native-web's own value types. It's a.tsfile, so a conflict with RN's declarations is reported instead of hidden byskipLibCheck.display: 'grid',position: 'fixed',calc()sizes, ...) are wrapped intoViewStyle,toTextStyleortoDimensionValue. These return their argument and hold the only type assertion. They still check every key they don't widen against RN's types, which an inlineas ViewStyledoesn't.Why the patch can go. It edited the removed block: it extended
Text'saccessibilityRoleand addeduserSelectwith'contain'toViewStyle. Without the block,TexttakesaccessibilityRolefrom RN'sAccessibilityProps, whose list is the same 30 roles the patch wrote. RN declaresuserSelect,'contain'included, onTextStyleonly. The augmentation adds it toViewStylewithTextStyle's type, next to the other text keys the app sets on views (styles.userSelectNoneis used onViews).Why some type assertions are gone. 0.19.2 gave
ViewStyleCSS types forcolor,fontSizeandfontWeightwhileTextStylekept RN's. SoTextStylestopped being aViewStyle, and the style types of react-native-render-html and expo-image, which are derived from RN's, stopped matching. Theas TextStyle,as ViewStyleandas ExpoImageProps['style']casts covered that up. Removing them on main, with 0.19.2 and the patch, gives 14 type errors. On this branch it gives none. The casts inMentionUserRendererandFeatureTrainingCarouselweren't needed even before.No longer typed: 0.19.2 also let
Texttakerolevalues that RN'sRoledoesn't have (paragraph,label,text). Nothing in the app uses them.Fixed Issues
$ #101439
PROPOSAL: N/A
Tests
This PR changes types, plus identity helpers around web-only style values. Tests 1 and 2 check the type graph, tests 3 and 4 check that the web-only styles still reach the DOM on web.
Test 1: The app still typechecks on the current React Native types
npm installnpm run typecheckType checking passed.Test 2: @types/react-native-web no longer widens React Native's types
grep -c 'declare module "react-native"' node_modules/@types/react-native-web/index.d.ts0npm installagain and verify that patch-package reports no error for@types/react-native-webOffline tests
N/A
QA Steps
No QA
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari