[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript #27778

blazejkustra · 2023-09-19T12:55:22Z

Details

Migration of 'UserUtils.js' to Typescript.

Fixed Issues

$ #24882
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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

web.mov

Mobile Web - Chrome

a-web.mov

Mobile Web - Safari

i-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-09-20T15:58:06Z

@allroundexperts 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 · 2023-09-20T23:07:48Z

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

src/libs/UserUtils.ts

aldo-expensify · 2023-09-21T01:58:19Z

src/libs/UserUtils.ts

-function hasLoginListError(loginList) {
-    return _.some(loginList, (login) => _.some(lodashGet(login, 'errorFields', {}), (field) => !_.isEmpty(field)));
+function hasLoginListError(loginList: LoginList): boolean {
+    const errorFields = loginList?.errorFields ?? {};


Is the type loginList: LoginList correct? if it is, we wouldn't need the question mark in loginList?

Yes it's correct, the thing is that this function is still used in some JS files and wrong values are passed and tests were failing. Once we get to these files that use this function the underlying issue will be fixed.

Either way, it's okay to make code safe and use nullish coalescing and optional chaining even if types says it's not necessary.

Either way, it's okay to make code safe and use nullish coalescing and optional chaining even if types says it's not necessary.

I disagree with this, I expect to be able to trust our types, but I understand that this may be acceptable while in a transitional period

I'm not sure why we didn't prefer loginList: Login | undefined | null if we had cases where we are passing undefined or null 🤷

aldo-expensify

Some types don't seem to be correct

blazejkustra · 2023-09-21T13:44:24Z

@aldo-expensify Let's wait for Callstack review on this PR before merging.

src/libs/UserUtils.ts

src/ONYXKEYS.ts

fabioh8010

@blazejkustra LGTM, but we have a type error reported by typecheck.

…semver)

… follow semver)" This reverts commit 88bad87.

This reverts commit faf29b7.

fabioh8010 · 2023-09-27T07:47:05Z

@blazejkustra We have another lint error 😅

blazejkustra · 2023-09-27T10:00:27Z

Tests are failing due to this thread.

fabioh8010

LGTM, CK still need to do the checklist.

kubabutkiewicz · 2023-09-28T09:37:23Z

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 / Chrome
- iOS / native
- iOS / 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

Web

web.mp4

Mobile Web - Chrome

mobile-chrome.mp4

Mobile Web - Safari

mobile-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

blazejkustra · 2023-09-29T08:43:20Z

@aldo-expensify PR is all yours now!

aldo-expensify

Approving and merging because I think this is mostly correct, if we want to do something regarding this we can do it in a follow up!

Thanks for the work!

OSBotify · 2023-10-02T10:50:32Z

✋ 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-10-02T17:45:52Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.76-0 🚀

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

aldo-expensify · 2023-10-03T04:25:56Z

src/libs/UserUtils.ts

-function hasLoginListInfo(loginList) {
-    return _.some(loginList, (login) => _.isEmpty(login.validatedDate));
+function hasLoginListInfo(loginList: Login): boolean {
+    return !loginList.validatedDate;
 }


This change caused this regression: #28643

OSBotify · 2023-10-03T15:46:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

OSBotify · 2023-10-03T16:11:12Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.77-0 🚀

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

OSBotify · 2023-10-05T00:18:03Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

blazejkustra added 3 commits September 19, 2023 14:54

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

2327a44

Fix tests

adaca7d

Remove file from another migration

04cc1cb

blazejkustra changed the title ~~[TS migration] Migrate 'UserUtils.js' lib to TypeScript~~ [No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript Sep 20, 2023

Merge branch 'main' into ts-migration/UserUtils

ef5a4e5

blazejkustra marked this pull request as ready for review September 20, 2023 15:58

blazejkustra requested a review from a team as a code owner September 20, 2023 15:58

melvin-bot bot requested review from allroundexperts and removed request for a team September 20, 2023 15:58

allroundexperts approved these changes Sep 20, 2023

View reviewed changes

melvin-bot bot requested a review from aldo-expensify September 20, 2023 23:07

aldo-expensify reviewed Sep 21, 2023

View reviewed changes

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

aldo-expensify reviewed Sep 21, 2023

View reviewed changes

src/libs/UserUtils.ts Show resolved Hide resolved

aldo-expensify reviewed Sep 21, 2023

View reviewed changes

aldo-expensify requested changes Sep 21, 2023

View reviewed changes

Make param optional

c03f7e8

blazejkustra requested a review from aldo-expensify September 21, 2023 13:43

fabioh8010 reviewed Sep 25, 2023

View reviewed changes

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

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

Small improvements after review

f9ccb69

blazejkustra requested a review from fabioh8010 September 26, 2023 07:45

fabioh8010 reviewed Sep 26, 2023

View reviewed changes

blazejkustra added 6 commits September 26, 2023 13:15

Remove ^ (Compatible with version) for typescript (TS doesn't follow …

88bad87

…semver)

Revert "Remove ^ (Compatible with version) for typescript (TS doesn't…

a6f5d24

… follow semver)" This reverts commit 88bad87.

Fix type error

faf29b7

Revert "Fix type error"

ff6b622

This reverts commit faf29b7.

Another try

f5f1d1d

Merge branch 'main' into ts-migration/UserUtils

729f5c5

Fix error

42ae0f5

blazejkustra added 2 commits September 27, 2023 11:12

Remove unused import

84175dc

Rerun tests

50e1e79

fabioh8010 approved these changes Sep 27, 2023

View reviewed changes

kubabutkiewicz approved these changes Sep 28, 2023

View reviewed changes

Merge branch 'main' into ts-migration/UserUtils

d6b6fe2

aldo-expensify approved these changes Oct 2, 2023

View reviewed changes

aldo-expensify merged commit 2d07520 into Expensify:main Oct 2, 2023
13 checks passed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

marcaaron mentioned this pull request Oct 3, 2023

Revert "[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript" #28668

Closed

aldo-expensify reviewed Oct 3, 2023

View reviewed changes

aldo-expensify mentioned this pull request Oct 3, 2023

[CP Staging] Fix LoginList types #28686

Merged

59 tasks

melvin-bot bot mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-10] [TS migration] Migrate 'UserUtils.js' lib to TypeScript #24882

Closed

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

situchan mentioned this pull request Oct 10, 2023

[HOLD for payment 2023-10-12] [HOLD for payment 2023-10-10] [$250] Settings - Green dot appears even though there is no Contact methods #28643

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript #27778

[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript #27778

blazejkustra commented Sep 19, 2023 •

edited

Loading

melvin-bot bot commented Sep 20, 2023

melvin-bot bot commented Sep 20, 2023

aldo-expensify Sep 21, 2023

blazejkustra Sep 21, 2023

aldo-expensify Oct 2, 2023

aldo-expensify left a comment

blazejkustra commented Sep 21, 2023

fabioh8010 left a comment

fabioh8010 commented Sep 27, 2023

blazejkustra commented Sep 27, 2023

fabioh8010 left a comment

kubabutkiewicz commented Sep 28, 2023

blazejkustra commented Sep 29, 2023

aldo-expensify left a comment

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

aldo-expensify Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript #27778

[No QA][TS migration] Migrate 'UserUtils.js' lib to TypeScript #27778

Conversation

blazejkustra commented Sep 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 20, 2023

melvin-bot bot commented Sep 20, 2023

aldo-expensify Sep 21, 2023

Choose a reason for hiding this comment

blazejkustra Sep 21, 2023

Choose a reason for hiding this comment

aldo-expensify Oct 2, 2023

Choose a reason for hiding this comment

aldo-expensify left a comment

Choose a reason for hiding this comment

blazejkustra commented Sep 21, 2023

fabioh8010 left a comment

Choose a reason for hiding this comment

fabioh8010 commented Sep 27, 2023

blazejkustra commented Sep 27, 2023

fabioh8010 left a comment

Choose a reason for hiding this comment

kubabutkiewicz commented Sep 28, 2023

Reviewer Checklist

Screenshots/Videos

blazejkustra commented Sep 29, 2023

aldo-expensify left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

aldo-expensify Oct 3, 2023

Choose a reason for hiding this comment

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

blazejkustra commented Sep 19, 2023 •

edited

Loading