App icon indicating copy to clipboard operation
App copied to clipboard

[TS migration] Migrate 'SettingsProfileDetails' page to TypeScript

Open kubabutkiewicz opened this issue 1 year ago • 1 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/25214

Tests

  1. Login into app
  2. Go to Settings > Profile > Personal Details
  3. Verify that Legal name page is working
  4. Verify that Date of Birth Page is working
  5. Verify that Address Page is working
  • [x] Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Login into app
  2. Go to Settings > Profile > Personal Details
  3. Verify that Legal name page is working
  4. Verify that Date of Birth Page is working
  5. Verify that Address Page is working
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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. toggleReport and not onIconClick)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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 Copy label for a copy review on the original GH to get the correct copy.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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 Avatar is modified, I verified that Avatar is working as expected in all cases)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • [x] If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/25230417/92a963f4-a975-4983-81ec-0a75bd48c6c8

Android: mWeb Chrome

https://github.com/Expensify/App/assets/25230417/fb0cba55-ae27-41b6-98f4-da2dd0dcfe71

iOS: Native

https://github.com/Expensify/App/assets/25230417/016aad85-1c5b-429d-8ac1-2f19e097c861

iOS: mWeb Safari

https://github.com/Expensify/App/assets/25230417/b061c05c-d252-4851-a8bd-223f84019dec

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/25230417/9268e57a-160e-4a45-b922-035b6501e386

MacOS: Desktop

https://github.com/Expensify/App/assets/25230417/66b913c0-5341-44f4-94af-bc4ba881bd27

kubabutkiewicz avatar Jan 29 '24 12:01 kubabutkiewicz

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot[bot] avatar Jan 29 '24 12:01 melvin-bot[bot]

@situchan 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]

melvin-bot[bot] avatar Feb 12 '24 15:02 melvin-bot[bot]

@kubabutkiewicz please fix conflict

situchan avatar Feb 13 '24 13:02 situchan

@situchan Comments are resolved and conflicts are fixed, you can recheck 😄

kubabutkiewicz avatar Feb 15 '24 15:02 kubabutkiewicz

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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. toggleReport and not onIconClick).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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 Copy label for a copy review on the original GH to get the correct copy.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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 using Avatar have been tested & I retested again)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • [x] Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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 Avatar is modified, I verified that Avatar is working as expected in all cases)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • [x] If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/108292595/6ee384fa-08cd-41a3-aaee-1d1c51c0bc7c

Android: mWeb Chrome

https://github.com/Expensify/App/assets/108292595/7640d67f-61b4-4214-b050-b8347b03599b

iOS: Native

https://github.com/Expensify/App/assets/108292595/8009c277-9690-4a07-8939-0a2d1edaeb46

iOS: mWeb Safari

https://github.com/Expensify/App/assets/108292595/62937bcc-759b-48ef-9435-777fb2d4b96c

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/108292595/6dcbfbb4-9167-480f-b525-92fe6253e200

MacOS: Desktop

https://github.com/Expensify/App/assets/108292595/a55d7180-c5a4-487b-9fea-3d21625ccbd9

situchan avatar Feb 15 '24 22:02 situchan

Please also update QA Steps

  1. Go to Settings > Profile > Personal Details

Personal Details page is deprecated. Now all sub-pages are directly in Profile page

situchan avatar Feb 19 '24 07:02 situchan

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25214 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

melvin-bot[bot] avatar Feb 19 '24 07:02 melvin-bot[bot]

@kubabutkiewicz there's conflict

situchan avatar Feb 21 '24 20:02 situchan

@situchan conflicts resolved 😄

kubabutkiewicz avatar Feb 22 '24 11:02 kubabutkiewicz

@tylerkaraszewski all yours

situchan avatar Feb 22 '24 11:02 situchan

There are conflicts again.

tylerkaraszewski avatar Feb 22 '24 17:02 tylerkaraszewski

@tylerkaraszewski conflicts resolved

kubabutkiewicz avatar Feb 23 '24 10:02 kubabutkiewicz

@kubabutkiewicz job2 still failing

situchan avatar Feb 23 '24 12:02 situchan

will take a look at this today

kubabutkiewicz avatar Feb 26 '24 08:02 kubabutkiewicz

I merged this, but it caused the failure here: https://github.com/Expensify/App/issues/37215

I am going to revert this PR and let you re-create it kubabutkiewicz, sorry about the extra work, but you can look at the failure above and resolve that in the next iteration.

tylerkaraszewski avatar Feb 26 '24 17:02 tylerkaraszewski

We probably shouldn't have duplicate zip and zipPostCode fields in an address.

tylerkaraszewski avatar Feb 26 '24 17:02 tylerkaraszewski

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.44-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

OSBotify avatar Feb 26 '24 21:02 OSBotify

will take a look soon on that

kubabutkiewicz avatar Feb 27 '24 13:02 kubabutkiewicz

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

OSBotify avatar Feb 28 '24 23:02 OSBotify