[No QA] [TS migration] Migrate 'PersonalDetails.js' lib to TypeScript #28269

fabioh8010 · 2023-09-26T15:32:56Z

Details

Fixed Issues

$ #24909
PROPOSAL: N/A

Tests

General testing in profile page:

Change display name
Check contact method
Change pronouns
Change legal name
Check report list if display name is changed

Offline tests

Same as above.

QA Steps

Same as above.

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 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).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
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)
I followed proper code patterns (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. toggleReport and not onIconClick)
- 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
  - 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:
- 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 Copy label 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
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
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)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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)
- 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)
- 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(themeColors.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 Avatar is modified, I verified that Avatar is 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 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.
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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-10-04.at.12.34.55.mov

Screen.Recording.2023-10-04.at.12.35.45.mov

Desktop

Screen.Recording.2023-10-04.at.12.36.29.mov

Mobile Web - Chrome

Screen.Recording.2023-10-04.at.12.38.02.mov

Android

Screen.Recording.2023-10-04.at.12.38.58.mov

Mobile Web - Safari

Screen.Recording.2023-10-04.at.12.39.55.mov

iOS

Screen.Recording.2023-10-04.at.12.40.50.mov

adhorodyski · 2023-09-26T15:40:03Z

src/libs/actions/PersonalDetails.ts

-        const detailsByLogin = _.findWhere(allPersonalDetails, {login: userAccountIDOrLogin}) || {};
-        return detailsByLogin.displayName || userAccountIDOrLogin;
+    if (Number.isNaN(accountID)) {
+        const detailsByLogin = Object.entries(allPersonalDetails ?? {}).find(([, value]) => value?.login === userAccountIDOrLogin)?.[1];


feels like a good candidate for introducing a global EMPTY_OBJECT to limit the memory footprint. Do you think that's possible?

I don't know how much memory we could save by doing this, but looks like an interesting proposal to explore. We also must ensure that object is read only and cannot be mutated.

src/libs/actions/PersonalDetails.ts

src/ONYXKEYS.ts

fabioh8010 · 2023-09-26T17:38:17Z

I will put this on HOLD until is Expensify/react-native-onyx#353 merged.

blazejkustra · 2023-10-05T13:38:35Z

src/libs/actions/PersonalDetails.ts

+    type DeleteUserAvatarParams = Record<string, never>;
+
+    const parameters: DeleteUserAvatarParams = {};
+
+    API.write('DeleteUserAvatar', parameters, {optimisticData, failureData});


Isn't this enough?

API.write('DeleteUserAvatar', {}, {optimisticData, failureData});

It's part of what we discussed here.

blazejkustra · 2023-10-05T13:42:57Z

src/libs/actions/PersonalDetails.ts

    ];

-    API.write('UpdateUserAvatar', {file}, {optimisticData, successData, failureData});
+    type UpdateUserAvatarParams = {


It's first time I see types defined inside of a function, I would rather move it outside of the function scope. Wdyt?

It's part of what we discussed here.

blazejkustra · 2023-10-05T13:43:13Z

src/libs/actions/PersonalDetails.ts

    ];
-    API.read('OpenPublicProfilePage', {accountID}, {optimisticData, successData, failureData});
+
+    type OpenPublicProfilePageParams = {


It's part of what we discussed here.

src/libs/actions/PersonalDetails.ts

blazejkustra · 2023-10-05T13:53:15Z

src/libs/actions/PersonalDetails.ts

 });

-let allPersonalDetails;
+let allPersonalDetails: OnyxCollection<OnyxTypes.PersonalDetails> = null;


PersonalDetails is not a collection, I think this type is more accurate:

OnyxEntry<Record<string, PersonalDetails>>

blazejkustra · 2023-10-05T13:54:05Z

src/libs/actions/PersonalDetails.ts

 import CONST from '../../CONST';
+import ONYXKEYS from '../../ONYXKEYS';
+import ROUTES from '../../ROUTES';
+import * as OnyxTypes from '../../types/onyx';


NAB: I would import types a bit different:

import PersonalDetails from '../../types/onyx/PersonalDetails';

fabioh8010 · 2023-10-05T14:17:01Z

FYI I will be on vacations starting tomorrow for the next two weeks and will return on Oct 23, so @kubabutkiewicz will replace me on this PR!

kubabutkiewicz · 2023-10-11T07:34:59Z

@blazejkustra comments are resolved , can you recheck 😄 ?

melvin-bot · 2023-10-11T11:03:34Z

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

situchan

Please careful check ?? operators when left one is empty string.

situchan · 2023-10-25T16:11:08Z

src/libs/actions/PersonalDetails.ts


 let currentUserEmail = '';
-let currentUserAccountID;
+let currentUserAccountID = -1;


Any reason for setting default value here?

It will be set to -1 as default value in connect(), so it's safe to assume that the default value for this variable is also -1.

let currentUserEmail = ''; let currentUserAccountID = -1; Onyx.connect({ key: ONYXKEYS.SESSION, callback: (val) => { currentUserEmail = val?.email ?? ''; currentUserAccountID = val?.accountID ?? -1; }, });

src/libs/actions/PersonalDetails.ts

fabioh8010 · 2023-10-26T13:01:24Z

Hi @situchan , thanks for the feedback. I've checked other ?? usages and they look correct besides the ones you mentioned, I'm just wondering if we have to change it back to || for this one. Do you think we need to use ||?

situchan · 2023-10-26T14:15:47Z

Hi @situchan , thanks for the feedback. I've checked other ?? usages and they look correct besides the ones you mentioned, I'm just wondering if we have to change it back to || for this one. Do you think we need to use ||?

If ?? is used, need to make sure that affected page is thoroughly tested in the case of empty string.

fabioh8010 · 2023-10-27T12:34:42Z

Hi @situchan , I've updated the branch against main, check the usage of || / ?? and they are correct now, and improved some comments.

situchan · 2023-10-28T23:16:34Z

@fabioh8010 please fix conflict when you get a chance

fabioh8010 · 2023-10-30T12:46:13Z

@situchan Done, please check it again!

BartoszGrajdek · 2023-11-06T09:58:44Z

@situchan bump!
cc @kubabutkiewicz

situchan · 2023-11-06T10:19:49Z

on it now

situchan · 2023-11-06T11:37:16Z

I am getting this lint error locally after pulling main

EDIT: fixed after reopening VS Code

…b/PersonalDetails

…ify-app into ts/lib/PersonalDetails

situchan · 2023-11-06T15:46:06Z

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 Issues section 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 Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- 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 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. toggleReport and not onIconClick).
- 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 Copy label 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
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 using Avatar have 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 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)
- 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)
- 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(themeColors.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 Avatar is modified, I verified that Avatar is 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 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.
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.
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-msafari.mov

Android: mWeb Chrome

desktop-mchrome.mov

iOS: Native

web-ios.mov

iOS: mWeb Safari

android-msafari.mov

MacOS: Chrome / Safari

web-ios.mov

MacOS: Desktop

desktop-mchrome.mov

situchan

situchan

Hmm, not sure why engineer is not auto assigned
Reapproving

cristipaval

LGTM

OSBotify · 2023-11-06T20:41:02Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-11-06T22:29:43Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.96-0 🚀

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

OSBotify · 2023-11-09T22:47:16Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T15:43:45Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

fabioh8010 added 4 commits September 26, 2023 11:46

Rename file to TS

63c06cf

Organize imports

4ac2485

Migrate PersonalDetails to TS

0a1bae4

Remove underscore usage

0513362

adhorodyski reviewed Sep 26, 2023

View reviewed changes

src/libs/actions/PersonalDetails.ts Show resolved Hide resolved

adhorodyski reviewed Sep 26, 2023

View reviewed changes

src/libs/actions/PersonalDetails.ts Show resolved Hide resolved

adhorodyski reviewed Sep 26, 2023

View reviewed changes

src/libs/actions/PersonalDetails.ts Show resolved Hide resolved

kubabutkiewicz reviewed Sep 26, 2023

View reviewed changes

src/ONYXKEYS.ts Show resolved Hide resolved

Improve PendingFields and ErrorFields

1f5f253

This was referenced Oct 2, 2023

[TS] Allow deep null values on merge operations Expensify/react-native-onyx#381

Merged

[No QA] Upgrade react-native-onyx to 1.0.98 #28725

Merged

fabioh8010 added 5 commits October 3, 2023 16:16

Merge branch 'main' into ts/lib/PersonalDetails

3206385

Improve typings

b76af47

Merge remote-tracking branch 'origin/main' into ts/lib/PersonalDetails

1464338

Merge branch 'main' into ts/lib/PersonalDetails

c2105b4

Minor fixes

3992778

blazejkustra suggested changes Oct 5, 2023

View reviewed changes

kubabutkiewicz added 2 commits October 9, 2023 09:56

Merge branch 'main' into ts/lib/PersonalDetails

318b020

fix: resolve comments

2250991

blazejkustra approved these changes Oct 11, 2023

View reviewed changes

blazejkustra mentioned this pull request Oct 11, 2023

[No QA] [TS Migration] Migrate PaymentMethods.js to TypeScript #29074

Merged

59 tasks

fabioh8010 marked this pull request as ready for review October 11, 2023 11:03

fabioh8010 requested a review from a team as a code owner October 11, 2023 11:03

melvin-bot bot requested review from thesahindia and removed request for a team October 11, 2023 11:03

situchan suggested changes Oct 25, 2023

View reviewed changes

situchan reviewed Oct 25, 2023

View reviewed changes

src/libs/actions/PersonalDetails.ts Outdated Show resolved Hide resolved

Address review comments

067cce1

fabioh8010 added 2 commits October 27, 2023 07:23

Merge remote-tracking branch 'origin/main' into ts/lib/PersonalDetails

f12b828

Improve comments

58eb8f3

Merge remote-tracking branch 'origin/main' into ts/lib/PersonalDetails

fe109f1

kubabutkiewicz added 2 commits November 6, 2023 12:52

Merge branch 'main' of github.com:fabioh8010/expensify-app into ts/li…

c801a02

…b/PersonalDetails

Merge branch 'ts/lib/PersonalDetails' of github.com:fabioh8010/expens…

3d2abe0

…ify-app into ts/lib/PersonalDetails

situchan approved these changes Nov 6, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval November 6, 2023 16:45

cristipaval approved these changes Nov 6, 2023

View reviewed changes

cristipaval merged commit 8eaf6c4 into Expensify:main Nov 6, 2023

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

cristipaval mentioned this pull request Nov 28, 2023

[TS migration] Migrate 'PersonalDetails.js' lib to TypeScript #24909

Closed

[No QA] [TS migration] Migrate 'PersonalDetails.js' lib to TypeScript #28269

[No QA] [TS migration] Migrate 'PersonalDetails.js' lib to TypeScript #28269

Uh oh!

Conversation

fabioh8010 commented Sep 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 commented Sep 26, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabioh8010 commented Oct 5, 2023

Uh oh!

kubabutkiewicz commented Oct 11, 2023

Uh oh!

melvin-bot bot commented Oct 11, 2023

Uh oh!

situchan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 commented Oct 26, 2023

Uh oh!

situchan commented Oct 26, 2023

Uh oh!

fabioh8010 commented Oct 27, 2023

Uh oh!

situchan commented Oct 28, 2023

Uh oh!

fabioh8010 commented Oct 30, 2023

Uh oh!

BartoszGrajdek commented Nov 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

situchan commented Nov 6, 2023

Uh oh!

situchan commented Nov 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

situchan commented Nov 6, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

situchan left a comment

fabioh8010 commented Sep 26, 2023 •

edited

Loading

BartoszGrajdek commented Nov 6, 2023 •

edited

Loading

situchan commented Nov 6, 2023 •

edited

Loading

situchan left a comment •

edited

Loading