chore: migrate AuthScreens from withOnyx to useOnyx
Explanation of Change
migrate AuthScreens component to have useOnyx instead of withOnyx
Fixed Issues
$ https://github.com/Expensify/App/issues/49103 PROPOSAL: https://github.com/Expensify/App/issues/49103#issuecomment-2346849357
Tests
This is migration task
-
Verify if all the flows on app same as before
-
Test if loading spinner is shown
-
Test removing report id from url and if correct report id is shown
-
[x] Verify that no errors appear in the JS console
Offline tests
Same as above, migration task. App should behave as it was
QA Steps
// TODO: These must be filled out, or the issue title must include "[No QA]."
same as above
- [x] Verify that no errors appear in the JS console
PR Author Checklist
- [x] I linked the correct issue in the
### Fixed Issuessection above - [x] I wrote clear testing steps that cover the changes made in this PR
- [x] I added steps for local testing in the
Testssection - [x] I added steps for the expected offline behavior in the
Offline stepssection - [x] I added steps for Staging and/or Production testing in the
QA stepssection - [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- [x] 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)
- [x] 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).
- [x] I added steps for local testing in the
- [x] I included screenshots or videos for tests on all platforms
- [x] I ran the tests on all platforms & verified they passed on:
- [x] Android: Native
- [x] Android: mWeb Chrome
- [x] iOS: Native
- [x] iOS: mWeb Safari
- [x] MacOS: Chrome / Safari
- [x] MacOS: Desktop
- [x] 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)
- [x] I followed proper code patterns (see Reviewing the code)
- [x] 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.
toggleReportand notonIconClick) - [x] I verified that comments were added to code that is not self explanatory
- [x] 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.
- [x] I verified any copy / text shown in the product is localized by adding it to
src/languages/*files and using the translation method- [x] 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:
- [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- [x] 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)
- [x] 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.
- [x] I verified the JSDocs style guidelines (in
STYLE.md) were followed
- [x] 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.
- [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- [x] I followed the guidelines as stated in the Review Guidelines
- [x] 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 usingAvatarare working as expected) - [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- [x] 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
- [x] I verified that if a function's arguments changed that all usages have also been updated correctly
- [x] If any new file was added I verified that:
- [x] 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
- [x] If a new CSS style is added I verified that:
- [x] A similar style doesn't already exist
- [x] The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
- [x] 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.
- [x] 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
Avataris modified, I verified thatAvataris working as expected in all cases) - [x] 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.
- [x] 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.
- [x] 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:
- [x] I verified that all the inputs inside a form are aligned with each other.
- [x] I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- [x] If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - [x] If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.
Screenshots/Videos
Android: Native
https://github.com/user-attachments/assets/6b05ccc9-3563-445b-9484-d21bb490077f
Android: mWeb Chrome
https://github.com/user-attachments/assets/15a5527a-5bc3-4535-89d0-4a18eb0c11b5
iOS: Native
https://github.com/user-attachments/assets/d5b39d47-e1ab-4a79-8749-12b578e163a7
iOS: mWeb Safari
https://github.com/user-attachments/assets/ce23cbb6-527b-4c57-ac13-f38a6bd39ce8
MacOS: Chrome / Safari
https://github.com/user-attachments/assets/26c9b979-91e4-4ea6-8c20-882a5a33ef14
MacOS: Desktop
https://github.com/user-attachments/assets/6f728494-59b0-499d-bf58-a40bb911d86c
@deetergp 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]
@c3024 Ready for review
Logging out and logging back into an account navigates to the Profile page instead of LHN and Report Central Pane. This is fine on staging.
https://github.com/user-attachments/assets/918f5786-bfe2-410d-8433-07429ce3e584
https://github.com/user-attachments/assets/e76a0051-dd27-4e0a-9f91-107cf205c5b4
@BhuvaneshPatil any thoughts on the above comment?
@BhuvaneshPatil 👋
I spent some time on that not able to figure out what is root cause
@BhuvaneshPatil Are you saying we need to close this PR and re-open the GH for other proposals?
@BhuvaneshPatil if you could please let us know ^
@deetergp We can pull current C+ to take a closer look.
@c3024 Do you have any thoughts on this?
@blazejkustra
Can you please help here?
With this suggestion, if we logout and log back into an account it navigates to Profile Settings page instead of a Report page as mentioned here.
I see that we found two regressions with the previous PR #49185
I think the previous PR #49185 can be modified to fix these like
(1) using a FullScreenLoadingIndicator here
(2) with modifying this useEffect to run only once after all values are loaded
const isAnyOnyxValueStillLoading = isLoadingOnyxValue(sessionStatus, lastOpenedPublicRoomIDStatus, initialLastUpdateIDAppliedToClientStatus);
const areAllOnyxValuesLoadedFirstTime = useRef(true);
useEffect(() => {
if (!areAllOnyxValuesLoadedFirstTime.current || !isAnyOnyxValueStillLoading) {
return;
}
areAllOnyxValuesLoadedFirstTime.current = false;
.....
}, [isAnyOnyxValueStillLoading]);
@BhuvaneshPatil
Can you try the changes specified above and see if you find any issue?
@blazejkustra
Can you please help here?
Sorry, I was OOO last week. Let me take a look now 👀
I agree with @c3024, let's try this route. Meanwhile, do we have an understanding of what is the route cause for this bug?
The LAST_VISITED_PATH does not get reset and stays as settings/profile after logging out. I was not able to identify the exact root cause. React Navigation seems to not reset this.
Hey @c3024, are you sure the LAST_VISITED_PATH isn't updated correctly? I tested it on this branch BhuvaneshPatil:49103-onyx-migration and it seems to work fine
https://github.com/user-attachments/assets/f70b49b4-c704-427b-b9fc-e46e21974e88
Yes, my mistake!
(1) using a FullScreenLoadingIndicator here
@BhuvaneshPatil Let's just do this change and we should be good 🚀
I recently changed how initialReportID is created, so maybe that helped with the other issue @c3024. Now it uses useState:
const [initialReportID] = useState(() => {
const currentURL = getCurrentUrl();
const reportIdFromPath = currentURL && new URL(currentURL).pathname.match(CONST.REGEX.REPORT_ID_FROM_PATH)?.at(1);
if (reportIdFromPath) {
return reportIdFromPath;
}
const initialReport = ReportUtils.findLastAccessedReport(!canUseDefaultRooms, shouldOpenOnAdminRoom(), activeWorkspaceID);
return initialReport?.reportID ?? '';
});
@BhuvaneshPatil Has any of this helped you resolve this one?
@c3024 This didn't work. I am updating the PR with those changes. Please try it your end as well.
https://github.com/user-attachments/assets/ef0bdf39-b12d-4241-beae-9028c5deb9af
- I tried those changes on the previously reverted PR as the base, and they worked. But, if we apply the changes from that PR (migrate to useOnyx) to the latest main, the issue of navigating to the profile page on logging in occurs as well. So, this issue of incorrect navigation is not related to any changes (including these) made in this PR.
- This navigation to the profile page upon logging in could be related to the recent navigation refactors.
@c3024 If I understand correctly, it sounds like we don't need to hold this PR up any further then?
@deetergp
No. This PR migrates withOnyx usage in AuthScreens to useOnyx. But, this migration is causing an issue where navigation to the profile page occurs upon login. I have not yet identified the root cause.
I think someone from the expert agency group can help here.
I think someone from the expert agency group can help here.
FYI, Software Mansion is OOO until January 7. We'll come back to this issue then
Heya @blazejkustra Happy New Year! Is SWM back in action now?
Hi @deetergp! This is something I wanted to check out today, but I had to finish a few other things. I will look into it on Monday. Thanks for your patience! 🙇
Monday sounds fine @adamgrzybowski, thanks!
Hi, I'm from SWM and I took over this task from @adamgrzybowski, I'm investigating it now
Hey, I'm still investigating it, I already have an idea how to fix it but I want to check it more thoroughly, I'll come back tomorrow with the next update