Migrate AuthScreens to useOnyx by WojtekBoman · Pull Request #55528 · Expensify/App

WojtekBoman · 2025-01-21T13:50:58Z

Explanation of Change

This PR includes the migration of withOnyx to useOnyx in AuthScreens. Additionally, it was necessary to make some navigation changes. Changes introduced in this PR:

fixed navigation state reset after logout
fixed default reportID value in ReportScreen
due to earlier AuthScreens rendering, two additional hooks were separated to handle the logic related to the values obtained from useOnyx

Fixed Issues

$ #49103
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Verify that the login flow works the same as before the migration.
Verify whether opening reports works the same as before the migration.

Offline tests

QA Steps

Verify that no errors appear in the JS console

Verify that the login flow works the same as before the migration.
Verify whether opening reports works the same as before the migration.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-01-21.at.15.32.35.mp4

MacOS: Desktop

Screen.Recording.2025-01-21.at.15.29.02.mp4

…eset after logout

…Client in AuthScreens

blazejkustra

Looks good to me! 🚀

blazejkustra · 2025-01-21T14:46:04Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

-        key: ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT,
-    },
-})(AuthScreensMemoized);
+export default memo(AuthScreens, () => true);


Is this memoization necessary?

Good point 👌 I believe it might be removed

I decided to revert this change and wrap it with memo 🙈 It is safer to have it memoized

No worries, lgtm either way

adamgrzybowski

🚀

melvin-bot · 2025-01-22T15:17:49Z

@c3024 @MonilBhavsar One of you needs to 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]

c3024 · 2025-01-23T08:00:20Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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.mov

Android: mWeb Chrome

authAndroidmWeb.mp4

iOS: Native

authiOS.mov

iOS: mWeb Safari

authiOSmWeb.MP4

MacOS: Chrome / Safari

authChrome.mov

MacOS: Desktop

authDesktop.mov

c3024

LGTM!

blazejkustra · 2025-01-23T08:13:41Z

This is exciting, great work @WojtekBoman!

MonilBhavsar · 2025-01-23T15:59:21Z

src/libs/actions/Session/index.ts

-        });
-
-        Navigation.setParams(emptyParams, homeRoute?.key ?? '');
-        Onyx.set(ONYXKEYS.IS_CHECKING_PUBLIC_ROOM, false);


Curious why we didn't migrate this?

OSBotify · 2025-01-23T18:47:43Z

✋ 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 · 2025-01-23T19:28:55Z

🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.89-1 🚀

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

fabioh8010 · 2025-01-24T10:38:41Z

src/CONST.ts

    CLOUDFRONT_URL,
    EMPTY_ARRAY,
    EMPTY_OBJECT,
+    EMPTY_STRING: '',


@WojtekBoman Could we please revert this? I understand why you did it but adding this constant will encourage contributors to use it to default String IDs and bypass our guidelines. We just had the same issue a while ago and we removed the same constant.

cc @MonilBhavsar @deetergp

Sure, thanks for noticing that :) I'll prepare a PR

Here's the PR #55714

fabioh8010 · 2025-01-24T10:43:07Z

src/libs/Navigation/linkingConfig/config.ts

+            parse: {
+                reportID: (reportID: string | undefined) => reportID ?? CONST.EMPTY_STRING,
+            },
+            stringify: {
+                reportID: (reportID: string | undefined) => reportID ?? CONST.EMPTY_STRING,
+            },


Suggested change

parse: {

reportID: (reportID: string | undefined) => reportID ?? CONST.EMPTY_STRING,

},

stringify: {

reportID: (reportID: string | undefined) => reportID ?? CONST.EMPTY_STRING,

},

parse: {

// eslint-disable-next-line

reportID: (reportID: string | undefined) => reportID ?? '',

},

stringify: {

// eslint-disable-next-line

reportID: (reportID: string | undefined) => reportID ?? '',

},

…/auth-screens" This reverts commit fd66e86, reversing changes made to fc199fa.

AndrewGable · 2025-01-27T22:33:49Z

Hello - This PR is causing this deploy blocker: #55681

We are going to revert this PR now. Please re-test with this blocker in mind, thank you!

Revert "Merge pull request #55528 from software-mansion-labs/use-onyx/auth-screens

Revert "Merge pull request #55528 from software-mansion-labs/use-onyx/auth-screens (cherry picked from commit 9388747) (CP triggered by yuwenmemon)

* main: (76 commits) Update Mobile-Expensify to 9.0.89-7 Update version to 9.0.89-7 Revert "Merge pull request #55528 from software-mansion-labs/use-onyx/auth-screens" Match the horizontal padding in the search router with LHN Update redirects.csv Fix padding in TravelTerms close RHP after provisioning Fix routes to work after page refresh Close RHP Fix bottom padding Add unit test Update redirects.csv Update and rename SAML-SSO.md to Managing-Single-Sign-On-(SSO)-in-Expensify.md Update SAML-SSO.md Make code more readable Add title in the header Fix lint errors Update comment Hide Split Expense from trip rooms Use TextLink and and styles instead of RenderHTML ... # Conflicts: # Mobile-Expensify

github-actions · 2025-01-28T01:53:09Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

github-actions · 2025-01-28T02:16:40Z

🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.90-0 🚀

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

WojtekBoman · 2025-01-28T13:15:23Z

Hello - This PR is causing this deploy blocker: #55681

We are going to revert this PR now. Please re-test with this blocker in mind, thank you!

Hey 👋
I started working on that 🫡

github-actions · 2025-01-29T06:24:31Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

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

WojtekBoman added 5 commits January 21, 2025 11:00

Migrate withOnyx to useOnyx in AuthScreens and fix navigation state r…

df546bf

…eset after logout

Fix showing /r/undefined url

fd3dca0

Add hooks for lastOpenedPublicRoomID and initialLastUpdateIDAppliedTo…

dea4b7c

…Client in AuthScreens

Fix lint

4ab55e6

Fix generating default reportID value in linkingConfig

65d97cf

blazejkustra approved these changes Jan 21, 2025

View reviewed changes

Remove memo from AuthScreens

c0247f5

adamgrzybowski approved these changes Jan 21, 2025

View reviewed changes

WojtekBoman mentioned this pull request Jan 21, 2025

chore: migrate AuthScreens from withOnyx to useOnyx #52417

Closed

49 tasks

deetergp self-requested a review January 21, 2025 16:47

Wrap AuthScreens with React.memo

1a79d00

WojtekBoman marked this pull request as ready for review January 22, 2025 15:17

WojtekBoman requested a review from a team as a code owner January 22, 2025 15:17

melvin-bot bot requested review from MonilBhavsar and c3024 January 22, 2025 15:17

melvin-bot bot removed the request for review from a team January 22, 2025 15:17

c3024 approved these changes Jan 23, 2025

View reviewed changes

MonilBhavsar reviewed Jan 23, 2025

View reviewed changes

deetergp approved these changes Jan 23, 2025

View reviewed changes

deetergp merged commit fd66e86 into Expensify:main Jan 23, 2025
3 checks passed

github-actions bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

fabioh8010 reviewed Jan 24, 2025

View reviewed changes

WojtekBoman mentioned this pull request Jan 24, 2025

[No QA] Remove CONST.EMPTY_STRING #55714

Merged

50 tasks

AndrewGable mentioned this pull request Jan 27, 2025

[HOLD for payment 2025-02-05] [HOLD for payment 2025-02-04] [$250] Desktop - App auto relogins after signing out #55681

Closed

8 tasks

AndrewGable added a commit that referenced this pull request Jan 27, 2025

Revert "Merge pull request #55528 from software-mansion-labs/use-onyx…

b59a06c

…/auth-screens" This reverts commit fd66e86, reversing changes made to fc199fa.

yuwenmemon added a commit that referenced this pull request Jan 27, 2025

Merge pull request #55815 from Expensify/andrew-revert-55528

9388747

Revert "Merge pull request #55528 from software-mansion-labs/use-onyx/auth-screens

OSBotify pushed a commit that referenced this pull request Jan 27, 2025

Merge pull request #55815 from Expensify/andrew-revert-55528

3ee7a7f

Revert "Merge pull request #55528 from software-mansion-labs/use-onyx/auth-screens (cherry picked from commit 9388747) (CP triggered by yuwenmemon)

github-actions bot mentioned this pull request Jan 28, 2025

Deploy Checklist: New Expensify 2025-01-28 #55824

Closed

82 tasks

melvin-bot bot mentioned this pull request Jan 28, 2025

[Due for payment 2025-04-03] [Due for payment earliest: 2025-03-21][$100] Migrate AuthScreens to useOnyx #49103

Closed

WojtekBoman mentioned this pull request Jan 29, 2025

Migrate AuthScreens to useOnyx v2 #55966

Merged

50 tasks

WojtekBoman mentioned this pull request Mar 7, 2025

Migrate AuthScreens to useOnyx v3 #58006

Merged

50 tasks

fabioh8010 mentioned this pull request Jul 25, 2025

Migrate from withOnyx to useOnyx in AuthScreens #66093

Merged

49 tasks

Conversation

WojtekBoman commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

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

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamgrzybowski left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jan 22, 2025

Uh oh!

c3024 commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

c3024 left a comment

Choose a reason for hiding this comment

Uh oh!

blazejkustra commented Jan 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Jan 23, 2025

Uh oh!

github-actions bot commented Jan 23, 2025

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!

AndrewGable commented Jan 27, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

WojtekBoman commented Jan 28, 2025

Uh oh!

github-actions bot commented Jan 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

WojtekBoman commented Jan 21, 2025 •

edited

Loading

c3024 commented Jan 23, 2025 •

edited

Loading