chore: migrate AuthScreens from withOnyx to useOnyx #49185

BhuvaneshPatil · 2024-09-13T17:22:38Z

Details

This is migration task, we are removing withOnyx and use useOnyx for AuthScreen component.

Fixed Issues

$ #49103
PROPOSAL: #49103 (comment)

Tests

Verify if application is working and showing correct data

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

Verify if application is working and showing correct data

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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-09-13.at.11.50.46.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-13.at.11.54.20.PM.mov

iOS: Native

Screen.Recording.2024-09-13.at.11.28.49.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-09-13.at.11.30.27.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-13.at.11.56.30.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-13.at.11.57.11.PM.mov

melvin-bot · 2024-09-13T17:23:08Z

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

…yx-migration

c3024 · 2024-09-14T05:25:43Z

The central pane is missing on logging in. I think this is because useOnyx does not wait till data is loaded.

centraPaneLoading.mp4

I think we need to get the loading status from useOnyx.

The useOnyx() hook won't delay the rendering of the component using it while the key/entity is being fetched and passed to the component. However, you can simulate this behavior by checking if the status of the hook's result metadata is loading. When status is loading it means that the Onyx data is being loaded into cache and thus is not immediately available, while loaded means that the data is already loaded and available to be consumed.

c3024

The central pane is missing on logging in. I think this is because useOnyx does not wait till data is loaded.

centraPaneLoading.mp4

I think we need to get the loading status from useOnyx.

The useOnyx() hook won't delay the rendering of the component using it while the key/entity is being fetched and passed to the component. However, you can simulate this behavior by checking if the status of the hook's result metadata is loading. When status is loading it means that the Onyx data is being loaded into cache and thus is not immediately available, while loaded means that the data is already loaded and available to be consumed.

BhuvaneshPatil · 2024-09-16T03:06:21Z

Screen.Recording.2024-09-16.at.8.35.03.AM.mov

c3024 · 2024-09-16T04:16:54Z

Can you please fix the unit tests also?

…yx-migration

blazejkustra · 2024-09-17T10:34:25Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

+    const [session, sessionStatus] = useOnyx(ONYXKEYS.SESSION);
+    const [lastOpenedPublicRoomID, lastOpenedPublicRoomIDStatus] = useOnyx(ONYXKEYS.LAST_OPENED_PUBLIC_ROOM_ID);
+    const [initialLastUpdateIDAppliedToClient, initialLastUpdateIDAppliedToClientStatus] = useOnyx(ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT);
+    const isSessionLoading = isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus);


Suggested change

const isSessionLoading = isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus);

blazejkustra · 2024-09-17T10:34:33Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

@@ -390,6 +384,9 @@ function AuthScreens({session, lastOpenedPublicRoomID, initialLastUpdateIDApplie
        // Prevent unnecessary scrolling
        cardStyle: styles.cardStyleNavigator,
    };
+    if (isSessionLoading) {


Suggested change

if (isSessionLoading) {

if (isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus)) {

blazejkustra · 2024-09-17T10:35:23Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

-        key: ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT,
-    },
-})(AuthScreensMemoized);
+export default AuthScreensMemoized;


Suggested change

export default AuthScreensMemoized;

export default memo(AuthScreens, () => true);

…yx-migration

BhuvaneshPatil · 2024-09-18T02:37:03Z

Still working on fixing the test cases

…til/App into 49103-onyx-migration

…yx-migration

BhuvaneshPatil · 2024-09-25T02:23:37Z

Fixed tests.
@c3024 Please review.

c3024 · 2024-09-25T15:57:28Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

authAndroid.mp4

Android: mWeb Chrome

authAndroidmWeb.mp4

iOS: Native

authiOS.mp4

iOS: mWeb Safari

authiOSmWeb.mp4

MacOS: Chrome / Safari

authChrome.mp4

MacOS: Desktop

authDesktop.mp4

c3024

LGTM!

OSBotify · 2024-09-25T20:12: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.

github-actions · 2024-09-27T17:58:56Z

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

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

kavimuru · 2024-09-27T18:42:50Z

@roryabraham @c3024 Any specific steps to be verified in QA section?

roryabraham · 2024-09-28T21:04:48Z

Not really. Just regression tests should cover this

github-actions · 2024-09-30T11:27:22Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/49185/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49185/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49185/NewExpensify.dmg	https://49185.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

Julesssss · 2024-09-30T12:10:55Z

FYI, introduced a regression.

blazejkustra · 2024-09-30T13:01:51Z

I also found another regression connected to this migration 😢

Go to `/r` when logged in

Actual behaviour:

User is redirected to ReportScreen /r/undefined

Expected behaviour:

User is automatically redirected to last accessed report

Video

Screen.Recording.2024-09-30.at.14.58.39.mov

edit: I found that removing this from AuthScreen fixes it:

  if (isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus)) {
        return;
    }

Julesssss · 2024-09-30T13:55:11Z

PR was reverted here

github-actions · 2024-09-30T22:40:43Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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

chore: migrate withOnyx to useOnyx

43746db

BhuvaneshPatil requested a review from a team as a code owner September 13, 2024 17:22

melvin-bot bot requested review from arosiclair and removed request for a team September 13, 2024 17:23

BhuvaneshPatil changed the title ~~chore: migrate withOnyx to useOnyx~~ chore: migrate AuthScreens from withOnyx to useOnyx Sep 13, 2024

BhuvaneshPatil added 4 commits September 13, 2024 23:59

lint fix

4df69bb

Merge branch 'main' of https://github.com/Expensify/App into 49103-on…

72c8de9

…yx-migration

revert podfile changes

94b1edd

revert podfile changes

b727cc4

BhuvaneshPatil mentioned this pull request Sep 13, 2024

[$100] Migrate AuthScreens to useOnyx #49103

Open

c3024 suggested changes Sep 14, 2024

View reviewed changes

fix showing indicator

250275b

BhuvaneshPatil added 2 commits September 16, 2024 12:07

Merge branch 'main' of https://github.com/Expensify/App into 49103-on…

b7c4821

…yx-migration

Merge branch 'main' of https://github.com/Expensify/App into 49103-on…

6dc4b1b

…yx-migration

arosiclair requested review from roryabraham and removed request for arosiclair September 16, 2024 16:51

blazejkustra approved these changes Sep 17, 2024

View reviewed changes

BhuvaneshPatil added 2 commits September 17, 2024 16:29

Merge branch 'main' of https://github.com/Expensify/App into 49103-on…

126c750

…yx-migration

refactoring

e605f51

situchan mentioned this pull request Sep 18, 2024

feat: Subscribe guides to a new presence pusher channel #48696

Merged

50 tasks

BhuvaneshPatil added 5 commits September 18, 2024 21:34

chore: migrate withOnyx to useOnyx

e00d4c6

lint fix

ba4e4ca

revert podfile changes

61afdee

revert podfile changes

003585e

modify

34dd64d

BhuvaneshPatil added 3 commits September 18, 2024 21:43

refactoring

4f3af39

fix tests

b5a4e3a

Merge branch '49103-onyx-migration' of https://github.com/BhuvaneshPa…

698d2c9

…til/App into 49103-onyx-migration

BhuvaneshPatil requested a review from a team as a code owner September 25, 2024 02:06

BhuvaneshPatil added 3 commits September 25, 2024 07:36

Merge branch 'main' of https://github.com/Expensify/App into 49103-on…

f24a9e6

…yx-migration

fix lint

de337ac

fix test

99edd39

BhuvaneshPatil requested review from c3024 and blazejkustra September 25, 2024 15:00

c3024 approved these changes Sep 25, 2024

View reviewed changes

roryabraham approved these changes Sep 25, 2024

View reviewed changes

roryabraham merged commit 912c330 into Expensify:main Sep 25, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 27, 2024

Deploy Checklist: New Expensify 2024-09-27 #49855

Closed

Nodebrute mentioned this pull request Sep 28, 2024

Workspace - Nothing happens after pressing ESC key on workspace editor #49869

Closed

6 tasks

Julesssss added the Ready To Build label Sep 30, 2024

truph01 mentioned this pull request Sep 30, 2024

[$250] [Waiting for payment - 2024-10-06] iOS - Login - White screen persists for some time after login #49880

Closed

6 tasks

Julesssss mentioned this pull request Sep 30, 2024

[CP] Revert "chore: migrate AuthScreens from withOnyx to useOnyx" #49922

Merged

blazejkustra mentioned this pull request Sep 30, 2024

Refactor NewDot and HybridApp onboarding flow #49586

Merged

53 tasks

c3024 mentioned this pull request Dec 7, 2024

chore: migrate AuthScreens from withOnyx to useOnyx #52417

Open

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: migrate AuthScreens from withOnyx to useOnyx #49185

chore: migrate AuthScreens from withOnyx to useOnyx #49185

BhuvaneshPatil commented Sep 13, 2024 •

edited

Loading

melvin-bot bot commented Sep 13, 2024

c3024 commented Sep 14, 2024

c3024 left a comment

BhuvaneshPatil commented Sep 16, 2024

c3024 commented Sep 16, 2024

blazejkustra Sep 17, 2024

blazejkustra Sep 17, 2024

blazejkustra Sep 17, 2024

BhuvaneshPatil commented Sep 18, 2024

BhuvaneshPatil commented Sep 25, 2024

c3024 commented Sep 25, 2024 •

edited

Loading

c3024 left a comment

OSBotify commented Sep 25, 2024

github-actions bot commented Sep 27, 2024

kavimuru commented Sep 27, 2024

roryabraham commented Sep 28, 2024

github-actions bot commented Sep 30, 2024

Julesssss commented Sep 30, 2024

blazejkustra commented Sep 30, 2024 •

edited

Loading

Julesssss commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

	if (isSessionLoading) {
	if (isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus)) {

	export default AuthScreensMemoized;
	export default memo(AuthScreens, () => true);

chore: migrate AuthScreens from withOnyx to useOnyx #49185

chore: migrate AuthScreens from withOnyx to useOnyx #49185

Conversation

BhuvaneshPatil commented Sep 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 13, 2024

c3024 commented Sep 14, 2024

c3024 left a comment

Choose a reason for hiding this comment

BhuvaneshPatil commented Sep 16, 2024

c3024 commented Sep 16, 2024

blazejkustra Sep 17, 2024

Choose a reason for hiding this comment

blazejkustra Sep 17, 2024

Choose a reason for hiding this comment

blazejkustra Sep 17, 2024

Choose a reason for hiding this comment

BhuvaneshPatil commented Sep 18, 2024

BhuvaneshPatil commented Sep 25, 2024

c3024 commented Sep 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 25, 2024

github-actions bot commented Sep 27, 2024

kavimuru commented Sep 27, 2024

roryabraham commented Sep 28, 2024

github-actions bot commented Sep 30, 2024

Julesssss commented Sep 30, 2024

blazejkustra commented Sep 30, 2024 • edited Loading

Go to /r when logged in

Actual behaviour:

Expected behaviour:

Video

Julesssss commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

BhuvaneshPatil commented Sep 13, 2024 •

edited

Loading

c3024 commented Sep 25, 2024 •

edited

Loading

blazejkustra commented Sep 30, 2024 •

edited

Loading

Go to `/r` when logged in