[TS migration] Migrate 'User.js' lib to TypeScript #28695

fvlvte · 2023-10-03T09:15:24Z

Details

Migrated 'User.js' lib to TypeScript.

Fixed Issues

$ #24924
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console
Sign in to the account
Request secondary auth code
Verify that You received two auth codes on e-mail
Enter sign in code from e-mail
Set custom status
Verify custom status is set

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

android-nt.mov

Android: mWeb Chrome

chrome-android.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

mac-web.mov

MacOS: Desktop

mac-desktop.mov

src/libs/actions/User.ts

rezkiy37 · 2023-10-03T09:29:53Z

src/libs/actions/User.ts

@@ -512,7 +498,7 @@ function subscribeToUserEvents() {
            previousUpdateID: Number(pushJSON.previousUpdateID || 0),
        };
        if (!OnyxUpdates.doesClientNeedToBeUpdated(Number(pushJSON.previousUpdateID || 0))) {
-            OnyxUpdates.apply(updates);
+            OnyxUpdates.apply(updates as any);


Does this type match?

Suggested change

OnyxUpdates.apply(updates as any);

OnyxUpdates.apply(updates as OnyxUpdate[]);

needs to be as unknown as OnyxUpdate so kinda ugly cast

Do you mean updates a kind of as unknown as OnyxUpdate[]? Just to clarify:updates - is an array of OnyxUpdate's?

no type is not applicable to onyx update, that why it needs to be as unknown as OnyxUpdate

First, lets type updates object to be OnyxUpdatesFromServer.

Then, I think we can remove these two lines from apply(). They are not doing anything additional there and is causing issues here.

rezkiy37

Left comments.

src/libs/actions/User.ts

# Conflicts: # src/libs/actions/User.ts

src/libs/actions/User.ts

VickyStash · 2023-11-15T07:53:00Z

src/types/onyx/OnyxUpdatesFromServer.ts

@@ -2,9 +2,11 @@ import {OnyxUpdate} from 'react-native-onyx';
 import Request from './Request';
 import Response from './Response';

+type OnyxServerUpdate = OnyxUpdate & {shouldNotify?: boolean};


Not sure about this update, maybe it makes sense to update OnyxUpdate type in the onyx lib if we really need shouldNotify field

@fabioh8010 what do You think about it?

@VickyStash If I remember correctly it was me that suggested to create this separate type. The reason for that is because the OnyxUpdate from Onyx itself doesn't have shouldNotify, but Expensify backend often sends Onyx updates with this property together, so that's why I advised @fvlvte to create a separate type.

src/libs/actions/User.ts

fabioh8010 · 2023-11-15T09:34:39Z

src/libs/actions/User.ts

+            key: ONYXKEYS.PERSONAL_DETAILS_LIST,
+            value: {
+                [currentUserAccountID]: {
+                    status: status.text,


Why did you change from status, to status: status.text,?

Type mismatch, we use status as text in personal details list and CustomStatus is an object composed of text, emojiCode, expiresAt (according to JSDoc).

This could cause regression, our type maybe was wrong? Either way let's test it @fvlvte

I've aligned types in Onyx, and aligned usage in Sidebar component.
It was mistyped in PersonalDetails and misused in Sidebar component as object treated as string.
I think this feature was bugged originally, now seems working fine.

src/libs/actions/User.ts

fabioh8010 · 2023-11-15T09:37:43Z

src/types/onyx/OnyxUpdatesFromServer.ts

@@ -2,9 +2,11 @@ import {OnyxUpdate} from 'react-native-onyx';
 import Request from './Request';
 import Response from './Response';

+type OnyxServerUpdate = OnyxUpdate & {shouldNotify?: boolean};


@VickyStash If I remember correctly it was me that suggested to create this separate type. The reason for that is because the OnyxUpdate from Onyx itself doesn't have shouldNotify, but Expensify backend often sends Onyx updates with this property together, so that's why I advised @fvlvte to create a separate type.

# Conflicts: # src/libs/actions/User.ts

src/libs/actions/User.ts

blazejkustra · 2023-11-29T10:49:20Z

src/libs/actions/User.ts

+            key: ONYXKEYS.PERSONAL_DETAILS_LIST,
+            value: {
+                [currentUserAccountID]: {
+                    status: status.text,


This could cause regression, our type maybe was wrong? Either way let's test it @fvlvte

src/libs/actions/User.ts

blazejkustra · 2023-12-08T09:23:53Z

Ops @fvlvte @fabioh8010 😅

fvlvte · 2023-12-08T09:27:33Z

Ye, reverting it right now

# Conflicts: # src/libs/actions/User.ts

fvlvte · 2023-12-12T00:22:53Z

@blazejkustra ready to re-review, answered and addressed to all comments i guess and fixed this custom status in sidebar :P

jjcoffee · 2024-01-02T11:12:08Z

@fvlvte I think we're still waiting for updated QA steps per your comment? Also would be good if you could upload the test videos. Thanks!

fvlvte · 2024-01-02T11:14:03Z

Yes, im working on new steps and videos right now.

fvlvte · 2024-01-02T13:20:45Z

Steps added and videos updated.

jjcoffee

LGTM!

melvin-bot · 2024-01-02T13:41:52Z

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

jjcoffee · 2024-01-02T13:44:36Z

PR review checklist updated!

src/libs/actions/User.ts

roryabraham · 2024-01-02T21:09:49Z

src/libs/actions/User.ts

+        },
+    ];
+
+    type CloseAccountParams = {message: string};


NAB necessarily for this PR, but maybe worth a discussion ... this feels like it could be better. I'm not entirely sure what pattern we've followed so far, but I feel like the best pattern to follow would be to basically have a centralized APIParamMap somewhere that define the params accepted by each API endpoint, and which ensures that the parameters passed to a specific endpoint match the type defined for that endpoint.

cc @fabioh8010 @blazejkustra what do you think? Long-term this could lend itself to some compile-time validation across the front-end and the API that ensures that the params expected by each API endpoint (defined in the API layer) are provided by the front-end (verified via TypeScript)

Great thinking @roryabraham! 🙌

Actually this is our plan with @fabioh8010 to have a central point with an object with command names and params. We want to implement it in a separate PR once all libs are migrated to Typescript.

More context: That's why we decided to have these Params types defined in the bodies of action functions, so it is easier to extract in the future.

Ok, let's make an issue and start now and do the migration incrementally? Not going to block on this for this PR but let's discuss in slack.

src/libs/actions/User.ts

roryabraham · 2024-01-02T21:12:35Z

src/libs/actions/User.ts

 */
 function clearDraftCustomStatus() {
-    Onyx.merge(ONYXKEYS.CUSTOM_STATUS_DRAFT, {text: '', emojiCode: '', clearAfter: '', customDateTemporary: ''});
+    Onyx.merge(ONYXKEYS.CUSTOM_STATUS_DRAFT, {text: '', emojiCode: '', clearAfter: ''});


Why was customDateTemporary removed here?

It's not used anywhere and it's missing on our Onyx type, so removed it to get rid of type errors.

fvlvte · 2024-01-03T09:59:20Z

@roryabraham - PR updated and answered.

roryabraham

@fvlvte I think this will cause lint errors on main because we just merged #32475

Please merge main into your branch and fix lint. Thanks!

fvlvte · 2024-01-04T08:55:35Z

Done @roryabraham

OSBotify · 2024-01-09T04:39: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 · 2024-01-09T05:35:30Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.23-0 🚀

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

OSBotify · 2024-01-10T06:02:45Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀

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

fvlvte added 2 commits October 3, 2023 11:10

Migrated User.js lib to TypeScript.

6ffc105

Uninlined types.

7dbca33

rezkiy37 reviewed Oct 3, 2023

View reviewed changes

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

rezkiy37 reviewed Oct 3, 2023

View reviewed changes

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

rezkiy37 reviewed Oct 3, 2023

View reviewed changes

BeeMargarida reviewed Oct 3, 2023

View reviewed changes

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

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

fabioh8010 reviewed Oct 3, 2023

View reviewed changes

fvlvte added 6 commits October 5, 2023 10:10

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

a19115f

WIP: Work sync

45b40db

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

6a57481

# Conflicts: # src/libs/actions/User.ts

User.ts remigrated.

9ce5237

User.ts remigrated.

c2f91ce

Small alignments.

cba3f8c

VickyStash suggested changes Nov 15, 2023

View reviewed changes

Changes after review.

85a2c93

fabioh8010 reviewed Nov 15, 2023

View reviewed changes

fvlvte added 3 commits November 15, 2023 10:46

Changes after review.

60be018

Changes after review.

ee33de2

Changes after review.

6ce19e4

fabioh8010 approved these changes Nov 15, 2023

View reviewed changes

fvlvte changed the title ~~[No QA][TS migration] Migrate 'User.js' lib to TypeScript~~ [TS migration] Migrate 'User.js' lib to TypeScript Nov 15, 2023

fvlvte added 2 commits November 27, 2023 09:47

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

5772bd0

# Conflicts: # src/libs/actions/User.ts

Prettier fix.

4edce16

blazejkustra suggested changes Nov 29, 2023

View reviewed changes

fvlvte force-pushed the 24924-migrate-user.js-lib-to-typescript branch from 85dafb7 to 4edce16 Compare December 8, 2023 13:45

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

df342c7

# Conflicts: # src/libs/actions/User.ts

fvlvte added 3 commits January 2, 2024 12:24

Rolled back log changes.

2edfcca

Linter fixed.

e4371bc

Moved assertion.

b0ad835

jjcoffee approved these changes Jan 2, 2024

View reviewed changes

roryabraham reviewed Jan 2, 2024

View reviewed changes

fvlvte added 4 commits January 3, 2024 10:52

Requested changes.

a5ba1a3

Prettier & linter.

528f188

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

8db2435

Added type to EmptyObject.

079aa5c

roryabraham requested changes Jan 3, 2024

View reviewed changes

fvlvte added 2 commits January 4, 2024 09:52

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

221f766

Linter fixes.

e55a34c

Applied prettier.

5989090

roryabraham mentioned this pull request Jan 4, 2024

[$250] [HOLD for payment 2024-02-07] Create centralized types for API params #33965

Closed

Merge branch 'main' into 24924-migrate-user.js-lib-to-typescript

140abb5

fvlvte requested a review from roryabraham January 8, 2024 10:29

roryabraham approved these changes Jan 9, 2024

View reviewed changes

roryabraham merged commit 0c5a2cb into Expensify:main Jan 9, 2024
15 checks passed

github-actions bot mentioned this pull request Jan 9, 2024

Deploy Checklist: New Expensify 2024-01-09 #34121

Closed

87 tasks

melvin-bot bot mentioned this pull request Jan 10, 2024

[HOLD for payment 2024-01-17] [TS migration] Migrate 'User.js' lib to TypeScript #24924

Closed

	OnyxUpdates.apply(updates as any);
	OnyxUpdates.apply(updates as OnyxUpdate[]);

[TS migration] Migrate 'User.js' lib to TypeScript #28695

[TS migration] Migrate 'User.js' lib to TypeScript #28695

Conversation

fvlvte commented Oct 3, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra commented Dec 8, 2023

fvlvte commented Dec 8, 2023

fvlvte commented Dec 12, 2023 • edited Loading

jjcoffee commented Jan 2, 2024

fvlvte commented Jan 2, 2024

fvlvte commented Jan 2, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 2, 2024

jjcoffee commented Jan 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fvlvte commented Jan 3, 2024

roryabraham left a comment

Choose a reason for hiding this comment

fvlvte commented Jan 4, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

fvlvte commented Oct 3, 2023 •

edited

Loading

fvlvte commented Dec 12, 2023 •

edited

Loading

jjcoffee commented Jan 2, 2024 •

edited

Loading