[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript #30169

BartoszGrajdek · 2023-10-23T11:44:30Z

Details

Migrate 'PersonalDetailsUtils.js' lib file to TypeScript

Fixed Issues

$ #24884

Tests

Go to Settings > Profile > Personal Details
Change First & last name
Change birthdate
Change address
Check whether everything is working properly

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to Settings > Profile > Personal Details
Change First & last name
Change birthdate
Change address
Check whether everything is working properly

Verify that no errors appear in the JS console

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
  - 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

android.mov

src/libs/PersonalDetailsUtils.ts

fabioh8010 · 2023-10-25T09:43:13Z

src/libs/PersonalDetailsUtils.ts

+import * as LocalePhoneNumber from './LocalePhoneNumber';
+import * as OnyxTypes from '../types/onyx';
+
+type PersonalDetailsList = Record<string, OnyxEntry<OnyxTypes.PersonalDetails>>;


Suggested change

type PersonalDetailsList = Record<string, OnyxEntry<OnyxTypes.PersonalDetails>>;

type PersonalDetailsList = Record<string, OnyxTypes.PersonalDetails | null>;

In this case would make more sense not using OnyxEntry internally in this way.

BTW, do you think we can move this PersonalDetailsList type to src/types/onyx/PersonalDetails.ts and use it in ONYXKEYS.ts as well?

fabioh8010 · 2023-10-25T09:43:45Z

src/libs/PersonalDetailsUtils.ts

+type PersonalDetailsList = Record<string, OnyxEntry<OnyxTypes.PersonalDetails>>;
+
+let personalDetails: OnyxTypes.PersonalDetails[] = [];
+let allPersonalDetails: OnyxEntry<Record<string, OnyxTypes.PersonalDetails>> = {};


Suggested change

let allPersonalDetails: OnyxEntry<Record<string, OnyxTypes.PersonalDetails>> = {};

let allPersonalDetails: OnyxEntry<PersonalDetailsList> = {};

BartoszGrajdek · 2023-10-26T10:42:26Z

Done! @fabioh8010

fabioh8010 · 2023-10-26T11:18:39Z

@BartoszGrajdek LGTM but we have typecheck errors.

fabioh8010 · 2023-10-30T12:06:30Z

@BartoszGrajdek LGTM, but I think we can remove [No QA] for this one in order to be tested by QA. Also, please provide test steps and screenshots!

melvin-bot · 2023-11-24T13:36:23Z

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

BartoszGrajdek · 2023-11-29T19:16:05Z

@thesahindia bump

thesahindia · 2023-11-30T17:52:49Z

@BartoszGrajdek, please resolve the conflicts.

BartoszGrajdek · 2023-12-03T13:30:59Z

Done! @thesahindia :)

BartoszGrajdek · 2023-12-07T19:34:27Z

@thesahindia fixed! Thank you for noticing that 🙇🏻

thesahindia · 2023-12-10T20:32:33Z

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(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 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

Screen.Recording.2023-12-10.at.10.43.21.PM.mov

Android: mWeb Chrome

Screen.Recording.2023-12-10.at.10.52.01.PM.mov

iOS: Native

Screen.Recording.2023-12-11.at.1.43.28.AM.mov

iOS: mWeb Safari

Screen.Recording.2023-12-10.at.11.37.02.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-10.at.9.29.41.PM.mov

MacOS: Desktop

Screen.Recording.2023-12-11.at.1.58.15.AM.mov

melvin-bot · 2023-12-10T20:32:59Z

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

MonilBhavsar

Looks good overall!

MonilBhavsar · 2023-12-11T07:21:51Z

src/components/ArchivedReportFooter.tsx

    const originalMessage = reportClosedAction?.actionName === CONST.REPORT.ACTIONS.TYPE.CLOSED ? reportClosedAction.originalMessage : null;
    const archiveReason = originalMessage?.reason ?? CONST.REPORT.ARCHIVE_REASON.DEFAULT;
-    let displayName = PersonalDetailsUtils.getDisplayNameOrDefault(personalDetails, [report.ownerAccountID, 'displayName']);
+    let displayName = PersonalDetailsUtils.getDisplayNameOrDefault(personalDetails?.[report?.ownerAccountID ?? '']?.displayName);


ownerAccountID is of type number. Should this condition default to 0?

MonilBhavsar · 2023-12-15T10:12:04Z

@BartoszGrajdek 👋

MonilBhavsar · 2023-12-15T16:46:01Z

Thank you! A type check test is failing

…-details-utils

BartoszGrajdek · 2023-12-18T11:44:54Z

@MonilBhavsar done 😄

MonilBhavsar

Thanks! 🚀

OSBotify · 2023-12-18T17:57:57Z

✋ 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-12-19T02:42:09Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-19T03:45:30Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.14-0 🚀

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

paultsimura · 2023-12-19T12:44:55Z

src/libs/PersonalDetailsUtils.ts

+ * @param [defaultValue] optional default display name value
+ */
+function getDisplayNameOrDefault(displayName?: string, defaultValue = ''): string {
+    return displayName ?? defaultValue ?? Localize.translateLocal('common.hidden');


Did you test this function to ever actually fall back to Localize.translateLocal('common.hidden')?

?? only checks for undefined and null, so '' ?? will always be true.
Therefore, since you pass defaultValue = '', the defaultValue ?? check will always be true, and we'll return the defaultValue even if it's empty, won't we?

OSBotify · 2023-12-21T05:13:05Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

…/ts-migration/personal-details-utils" This reverts commit e17c313, reversing changes made to 9973d8f.

BartoszGrajdek added 6 commits September 21, 2023 09:27

[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript

894f232

Migrate personal details utils to TS

9510a4e

Merge changes

12832ed

Rename personal details

1caa40d

[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript

ed764e4

Tweak getDisplayNameOrDefault usages

209f33c

blazejkustra approved these changes Oct 23, 2023

View reviewed changes

src/libs/PersonalDetailsUtils.ts Outdated Show resolved Hide resolved

src/libs/PersonalDetailsUtils.ts Outdated Show resolved Hide resolved

Resolve merge conflicts & fixes

9e97b7e

fabioh8010 reviewed Oct 25, 2023

View reviewed changes

Fix: review of personalDetailsUtils.ts

7d00e4b

BartoszGrajdek added 2 commits October 30, 2023 11:10

Resolve merge conflicts

729e718

Fix typecheck errors PersonalDetailsUtils

ada39cf

fabioh8010 approved these changes Oct 30, 2023

View reviewed changes

BartoszGrajdek added 4 commits November 15, 2023 12:42

Resolve merge conflicts

d0f7046

fix: typecheck errors

5e717fe

fix: resolve merge conflicts

c0ef729

fix: lint

9ddcc2f

BartoszGrajdek changed the title ~~[No QA][TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript~~ [TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript Nov 24, 2023

BartoszGrajdek marked this pull request as ready for review November 24, 2023 13:36

BartoszGrajdek requested a review from a team as a code owner November 24, 2023 13:36

melvin-bot bot requested review from thesahindia and removed request for a team November 24, 2023 13:36

Resolve merge conflicts

0309f32

BartoszGrajdek added 2 commits December 7, 2023 20:28

fix: merge conflicts

df26c75

fix: handle PersonalDetailsUtils.getDisplayNameOrDefault properly

1e4eaaf

thesahindia approved these changes Dec 10, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar December 10, 2023 20:33

MonilBhavsar reviewed Dec 11, 2023

View reviewed changes

BartoszGrajdek added 3 commits December 15, 2023 12:37

Merge main

e98aece

change default value for owner account

866ef5c

Resolve merge conflict

d63f975

BartoszGrajdek added 4 commits December 18, 2023 11:30

Fix: typecheck

65dda0d

Merge remote-tracking branch 'origin/main' into ts-migration/personal…

24f5eb2

…-details-utils

fix: types in util files

40d8204

fix: unit test

d2dfec6

MonilBhavsar approved these changes Dec 18, 2023

View reviewed changes

MonilBhavsar merged commit e17c313 into Expensify:main Dec 18, 2023

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

paultsimura reviewed Dec 19, 2023

View reviewed changes

paultsimura mentioned this pull request Dec 19, 2023

fix: Handle merged account display name #32792

Merged

55 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2023-12-28] [TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript #24884

Closed

iwiznia mentioned this pull request Dec 21, 2023

[HOLD] Revert "[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript" #33438

Closed

	type PersonalDetailsList = Record<string, OnyxEntry<OnyxTypes.PersonalDetails>>;
	type PersonalDetailsList = Record<string, OnyxTypes.PersonalDetails \| null>;

	let allPersonalDetails: OnyxEntry<Record<string, OnyxTypes.PersonalDetails>> = {};
	let allPersonalDetails: OnyxEntry<PersonalDetailsList> = {};

[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript #30169

[TS migration] Migrate 'PersonalDetailsUtils.js' lib to TypeScript #30169

Uh oh!

Conversation

BartoszGrajdek commented Oct 23, 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!

Uh oh!

Uh oh!

fabioh8010 Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek commented Oct 26, 2023

Uh oh!

fabioh8010 commented Oct 26, 2023

Uh oh!

fabioh8010 commented Oct 30, 2023

Uh oh!

melvin-bot bot commented Nov 24, 2023

Uh oh!

BartoszGrajdek commented Nov 29, 2023

Uh oh!

thesahindia commented Nov 30, 2023

Uh oh!

BartoszGrajdek commented Dec 3, 2023

Uh oh!

BartoszGrajdek commented Dec 7, 2023

Uh oh!

thesahindia commented Dec 10, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 10, 2023

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

MonilBhavsar Dec 11, 2023

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

MonilBhavsar commented Dec 15, 2023

Uh oh!

MonilBhavsar commented Dec 15, 2023

Uh oh!

BartoszGrajdek commented Dec 18, 2023

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 18, 2023

Uh oh!

OSBotify commented Dec 19, 2023

Uh oh!

OSBotify commented Dec 19, 2023

Uh oh!

paultsimura Dec 19, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

BartoszGrajdek commented Oct 23, 2023 •

edited

Loading