The central page page is not rendered when resized to narrow and then to wide view again #53466

WojtekBoman · 2024-12-03T13:51:49Z

Explanation of Change

useNavigationResetOnLayoutChange was modified to reset navigation state using the resetRoot method. Due to this change, the FullScreenNavigator state could not be reset because this navigator is nested in rootState. This PR introduces useNavigationResetRootOnLayoutChange and restores useNavigationResetOnLayoutChange as it was previously implemented to fix resetting FullScreenNavigator.

Fixed Issues

$ #53445
$ #53395
PROPOSAL:

Tests

Log in to the app on a wide layout.
Verify if the initial chat screen is displayed
Go to the settings tab.
Open the workspaces list.
Open any workspace.
Resize the app to the narrow layout.
Go back to the workspace initial page.
Resize the app to the wide layout.
Verify if the Workspace Profile page is displayed.

Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

MacOS: Chrome / Safari

Screen.Recording.2024-12-03.at.15.36.47.mov

MacOS: Desktop

Screen.Recording.2024-12-03.at.15.21.46.mp4

adamgrzybowski · 2024-12-03T13:53:20Z

Makes sense to me

melvin-bot · 2024-12-03T14:42:56Z

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

ntdiary · 2024-12-03T15:06: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: 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

53466-android-native.mp4

Android: mWeb Chrome

53466-android-web.mp4

iOS: Native

53466-ios-native.mp4

iOS: mWeb Safari

53466-ios-safari.mp4

MacOS: Chrome / Safari

53466-mac-chrome.mp4

MacOS: Desktop

53466-mac-desktop.mp4

mountiny · 2024-12-03T15:15:43Z

@ntdiary kicked off a build

github-actions · 2024-12-03T15:16:07Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2024-12-03T15:41:23Z

🧪🧪 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/53466/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53466/index.html

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

👀 View the workflow run that generated this build 👀

ntdiary

LGTM. The original change was made to resolve the reload problem, and it is working fine now. :)

puneetlath

Is there any way for us to add a unit test or UI test for this?

puneetlath · 2024-12-03T16:41:06Z

src/libs/Navigation/AppNavigator/useNavigationResetRootOnLayoutChange.ts

+import useResponsiveLayout from '@hooks/useResponsiveLayout';
+import navigationRef from '@libs/Navigation/navigationRef';
+
+function useNavigationResetRootOnLayoutChange() {


Can we add a comment description of what this is used for.

Would be good to start setting this up for more unit tests in the navigation are too @WojtekBoman @adamgrzybowski

mountiny · 2024-12-06T16:10:44Z

@adamgrzybowski @WojtekBoman What do you think about the tests, can you add some now? what is your ETA if so? thanks!

adamgrzybowski · 2024-12-06T16:29:54Z

@mountiny, @WojtekBoman is working on tests but he was on sick leave today 🦷

We looked into the react-navigation repo to learn how to test navigation and we found some nice examples. Currently, we are figuring out what is the best way to test navigation in the context of Expensify as we only tested single screens so far (I think).

We may need to create some generic utils for future tests.

This specific case above may be a little problematic. We should test resizing. For testing, we use the react-native testing library and there is no resizing on the native version of Expensify 😄. We have some ideas though.

We will get back to you on Monday.

WojtekBoman · 2024-12-09T17:00:09Z

@mountiny

I'm still working on tests for that issue. I've already prepared some and they seem to work, however I'm still investigating how to cleanly mock functions and components that I'm testing

WojtekBoman · 2024-12-10T14:29:00Z

@mountiny @puneetlath @ntdiary @adamgrzybowski

Tests are ready 🫡

mountiny

Great! Thank you very much! @ntdiary can you also check out the code please

ntdiary · 2024-12-11T02:15:31Z

tests/ui/ResizeScreenTests.tsx

+const mockedUseResponsiveLayout = useResponsiveLayout as jest.MockedFunction<typeof useResponsiveLayout>;
+
+describe('Resize screen', () => {
+    it('Should display the settings profile after resizing the screen with the settings page opened to the wide layout', () => {


A great test case! As described, it ensures that when resizing the screen on the /settings page, useNavigationResetRootOnLayoutChange takes effect, and getAdaptedState pushes profile into the routes and then renders it (i.e., /settings/profile).

App/src/libs/Navigation/linkingConfig/getAdaptedStateFromPath.ts

Lines 365 to 367 in f9ec4fa

const matchingCentralPaneRoute = getMatchingCentralPaneRouteForState(state);

if (matchingCentralPaneRoute) {

routes.push(matchingCentralPaneRoute);

As for the /settings/workspaces/xxx and /settings/workspaces/xxx/profile pages, their route switching happens here:

App/src/libs/Navigation/AppNavigator/createCustomFullScreenNavigator/CustomFullScreenRouter.tsx

Lines 51 to 54 in f9ec4fa

// If the screen is wide, there should be at least two screens inside:

// - WORKSPACE.INITIAL to cover left pane.

// - WORKSPACE.PROFILE (first workspace settings screen) to cover central pane.

if (!isNarrowLayout) {

If needed, maybe similar test case could be added for them as well? I’m not a test expert, so not entirely sure. :)

cc @mountiny @WojtekBoman

Yes, it's a good point :) We're going to add this test in our PR including nav refactor as it contains many changes related to this code. I believe we can go ahead with this PR for now :)

Same, I think we can keep on adding more test cases in future, but its good for this PR

OSBotify · 2024-12-11T11:41:05Z

✋ 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-12-12T01:58:53Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.75-0 🚀

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

github-actions · 2024-12-13T15:40:58Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.75-6 🚀

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

Add useNavigationResetRootOnLayoutChange

1c83a60

WojtekBoman marked this pull request as ready for review December 3, 2024 14:42

WojtekBoman requested a review from a team as a code owner December 3, 2024 14:42

melvin-bot bot requested review from ntdiary and removed request for a team December 3, 2024 14:42

mountiny added the Ready To Build label Dec 3, 2024

ntdiary approved these changes Dec 3, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath December 3, 2024 16:13

puneetlath requested changes Dec 3, 2024

View reviewed changes

Add comments to useNavigationResetOnLayoutChange hooks

5b46385

mountiny assigned WojtekBoman Dec 4, 2024

Add ResizeScreenTests

de1a3d3

mountiny approved these changes Dec 10, 2024

View reviewed changes

mountiny requested a review from puneetlath December 10, 2024 16:03

puneetlath requested a review from ntdiary December 10, 2024 16:48

puneetlath approved these changes Dec 10, 2024

View reviewed changes

ntdiary reviewed Dec 11, 2024

View reviewed changes

mountiny merged commit b49e1bd into Expensify:main Dec 11, 2024
20 checks passed

github-actions bot mentioned this pull request Dec 12, 2024

Deploy Checklist: New Expensify 2024-12-12 #53978

Closed

55 tasks

This was referenced Dec 13, 2024

[HOLD for payment 2024-12-20] The central page page is not rendered when resized to narrow and then to wide view again #53445

Closed

[HOLD for payment 2024-12-20] [$250] Web - Workspace - Central pane gets blank after resizing and clicking back icon #53395

Closed

This was referenced Dec 18, 2024

Revert "The central page page is not rendered when resized to narrow and then to wide view again" #54328

Closed

[HOLD for payment 2025-01-02] [HOLD for payment 2024-12-30] [$500] Onboarding flow is not showing upon first sign in #54322

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The central page page is not rendered when resized to narrow and then to wide view again #53466

The central page page is not rendered when resized to narrow and then to wide view again #53466

WojtekBoman commented Dec 3, 2024 •

edited

Loading

adamgrzybowski commented Dec 3, 2024

melvin-bot bot commented Dec 3, 2024

ntdiary commented Dec 3, 2024 •

edited

Loading

mountiny commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

ntdiary left a comment

puneetlath left a comment

puneetlath Dec 3, 2024

mountiny Dec 4, 2024

mountiny commented Dec 6, 2024

adamgrzybowski commented Dec 6, 2024

WojtekBoman commented Dec 9, 2024

WojtekBoman commented Dec 10, 2024

mountiny left a comment

ntdiary Dec 11, 2024

WojtekBoman Dec 11, 2024 •

edited

Loading

mountiny Dec 11, 2024

OSBotify commented Dec 11, 2024

github-actions bot commented Dec 12, 2024

github-actions bot commented Dec 13, 2024

	const matchingCentralPaneRoute = getMatchingCentralPaneRouteForState(state);
	if (matchingCentralPaneRoute) {
	routes.push(matchingCentralPaneRoute);

	// If the screen is wide, there should be at least two screens inside:
	// - WORKSPACE.INITIAL to cover left pane.
	// - WORKSPACE.PROFILE (first workspace settings screen) to cover central pane.
	if (!isNarrowLayout) {

The central page page is not rendered when resized to narrow and then to wide view again #53466

The central page page is not rendered when resized to narrow and then to wide view again #53466

Conversation

WojtekBoman commented Dec 3, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

adamgrzybowski commented Dec 3, 2024

melvin-bot bot commented Dec 3, 2024

ntdiary commented Dec 3, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

ntdiary left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath Dec 3, 2024

Choose a reason for hiding this comment

mountiny Dec 4, 2024

Choose a reason for hiding this comment

mountiny commented Dec 6, 2024

adamgrzybowski commented Dec 6, 2024

WojtekBoman commented Dec 9, 2024

WojtekBoman commented Dec 10, 2024

mountiny left a comment

Choose a reason for hiding this comment

ntdiary Dec 11, 2024

Choose a reason for hiding this comment

WojtekBoman Dec 11, 2024 • edited Loading

Choose a reason for hiding this comment

mountiny Dec 11, 2024

Choose a reason for hiding this comment

OSBotify commented Dec 11, 2024

github-actions bot commented Dec 12, 2024

github-actions bot commented Dec 13, 2024

WojtekBoman commented Dec 3, 2024 •

edited

Loading

ntdiary commented Dec 3, 2024 •

edited

Loading

WojtekBoman Dec 11, 2024 •

edited

Loading