[TS migration] Migrate 'SettingsProfileDetails' page to TypeScript #37426
Conversation
|
Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers! |
kubabutkiewicz
changed the title
|
@situchan @tylerkaraszewski Reopening this PR #35307 |
|
@kubabutkiewicz please run prettier |
|
@kubabutkiewicz can you share diff from previous PR? |
| zipPostCode?: string; | ||
| addressLine1?: string; | ||
| addressLine2?: string; |
There was a problem hiding this comment.
@situchan Also making this props as optional and GetPhysicalCardUtils removal those are the only changes
There was a problem hiding this comment.
Thanks. Please merge main
…s-migration/SettingsProfileDetails
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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
- 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g.
myBool && <MyComponent />. - 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 shown in the product is localized by adding it to
src/languages/*files and using the translation method - I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- 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 approved by marketing by adding the
Waiting for Copylabel for a copy review on the original GH to get the correct copy. - I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in
STYLE.md) were followed
- 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) - I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - 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: Native
android.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov
|
🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.46-0 🚀
|
| /** User's private personal details */ | ||
| privatePersonalDetails: OnyxEntry<PrivatePersonalDetails>; | ||
| }; | ||
|
|
There was a problem hiding this comment.
@kubabutkiewicz it looks like you copied the LegalNamePage into both LegalNamePage and DateOfBirthPage
There was a problem hiding this comment.
ah yes, just naming issue. @kubabutkiewicz maybe you can fix this in any of your next PRs.
|
🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.46-2 🚀
|
| @@ -108,7 +108,7 @@ function FormWrapper({ | |||
| buttonText={submitButtonText} | |||
| isAlertVisible={((!isEmptyObject(errors) || !isEmptyObject(formState?.errorFields)) && !shouldHideFixErrorsAlert) || !!errorMessage} | |||
| isLoading={!!formState?.isLoading} | |||
| message={isEmptyObject(formState?.errorFields) ? errorMessage : undefined} | |||
| message={typeof errorMessage === 'string' && isEmptyObject(formState?.errorFields) ? errorMessage : undefined} | |||
There was a problem hiding this comment.
@kubabutkiewicz This change has caused a regression : #37623
The typeof errorMessage is not always string. It is object in case of CloseAccountpage and ValidateAccountPage.
If you remember, can you please share why was the change made and can we safely remove the type check?
There was a problem hiding this comment.
It was added because message prop in FormWrapper is typed as string and it was added to fix a typecheck
There was a problem hiding this comment.
So to fix that we need to adjust the type of message prop to be MaybePhraseKey from @lib/Localize and get rid of this condition
There was a problem hiding this comment.
@kubabutkiewicz FormWrapper doesn't have message prop. Do you mean message prop in FormAlertWithSubmitButton?
There was a problem hiding this comment.
They mean we need to update the type of Error message over here:
App/src/components/Form/FormWrapper.tsx
Line 65 in 4f86857
Is that right @kubabutkiewicz
There was a problem hiding this comment.
@kubabutkiewicz FormWrapper doesn't have message prop. Do you mean message prop in FormAlertWithSubmitButton?
Yes I meant FormAlertWithSubmitButton
@GandalfGwaihir no, errorMessage has correct type
There was a problem hiding this comment.
Actually I just checked and now message prop in FormAlertWithSubmitButton has correct type which is MaybePhraseKey so its safe to just remove this typeof errorMessage === 'string' && condition.
There was a problem hiding this comment.
FormAlertWithSubmitButton already has MaybePhraseKey as type of message prop. So, I guess, we are good to remove the type check.
type FormAlertWithSubmitButtonProps = {
/** Error message to display above button */
message?: MaybePhraseKey;
Details
Fixed Issues
$ #25214
Tests
Offline tests
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel so the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.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.mp4
Android: mWeb Chrome
mchrome.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
msafari.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4