Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: mWeb - Selector - User lands on the same WS when double tapping on different one on selector. #52438

Merged
merged 19 commits into from
Dec 9, 2024

Conversation

Krishna2323
Copy link
Contributor

Explanation of Change

  • This PR uses isFocused state to prevent multiple clicks on an option in workspace switcher page which was leading to multiple navigation issue.

Fixed Issues

$ #51402
PROPOSAL: #51402 (comment)

Tests

  1. Tap on Workspace selector on the top left corner.
  2. Change to any workspace on the list.
  3. Double tap on Expensify option.
  4. Verify that all the chats are displayed in LHN and Expensify is selected.
  5. Open Workspace selector again
  6. Double tap on the next workspace to the one selected.
  7. Verify that the chats of the selected workspace are displayed and the selected workspace is shown as the icon of workspace switcher selector.
  • Verify that no errors appear in the JS console

Offline tests

  1. Tap on Workspace selector on the top left corner.
  2. Change to any workspace on the list.
  3. Double tap on Expensify option.
  4. Verify that all the chats are displayed in LHN and Expensify is selected.
  5. Open Workspace selector again
  6. Double tap on the next workspace to the one selected.
  7. Verify that the chats of the selected workspace are displayed and the selected workspace is shown as the icon of workspace switcher selector.

QA Steps

  1. Tap on Workspace selector on the top left corner.
  2. Change to any workspace on the list.
  3. Double tap on Expensify option.
  4. Verify that all the chats are displayed in LHN and Expensify is selected.
  5. Open Workspace selector again
  6. Double tap on the next workspace to the one selected.
  7. Verify that the chats of the selected workspace are displayed and the selected workspace is shown as the icon of workspace switcher selector.

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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 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
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

…on different one on selector.

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323 Krishna2323 requested a review from a team as a code owner November 13, 2024 00:05
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team November 13, 2024 00:05
Copy link

melvin-bot bot commented Nov 13, 2024

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

@Krishna2323
Copy link
Contributor Author

I will work on unit test tomorrow.

@s77rt
Copy link
Contributor

s77rt commented Nov 13, 2024

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.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
android.mov
Android: mWeb Chrome
mweb-chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@Krishna2323
Copy link
Contributor Author

@s77rt, added the unit tests.

@s77rt
Copy link
Contributor

s77rt commented Nov 17, 2024

The test unit should fail if we remove the !isFocused from WorkspaceSwitcherPage but currently it does not because the solution is implemented in the test itself

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

The test unit should fail if we remove the !isFocused from WorkspaceSwitcherPage

@s77rt added a test for this case.

@s77rt
Copy link
Contributor

s77rt commented Nov 19, 2024

I don't see how the latest change will help. You should render the App (and the Workspace Switcher Page) from the app source and not by defining a function in the test. The function in the test will always pass since it will always has the solution in place.

@Krishna2323
Copy link
Contributor Author

@s77rt, Sorry for all the trouble I’ve caused. I’m writing UI tests for the first time and was trying to follow this file. Could you please guide me with some steps to follow? Do we also need to perform navigation in these tests?

@s77rt
Copy link
Contributor

s77rt commented Nov 20, 2024

Not a problem! Please use PaginationTest as a reference instead. We render the <App /> and add onyx sample data (workspaces in this case) then we navigate to the workspace switcher and fire the press button twice.

@Krishna2323
Copy link
Contributor Author

I'm working on writing the tests and will probably update them today.


async function navigateToWorkspaceSwitcher(): Promise<void> {
const hintText = Localize.translateLocal('workspace.switcher.headerTitle');
const optionRow = await screen.findByTestId(hintText);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s77rt, if you have a moment, could you please check why I'm getting Unable to find an element with testID: Choose a workspace here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MockedSidebarLinks is missing the <TopBar />

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this file


async function navigateToWorkspaceSwitcher(): Promise<void> {
const hintText = Localize.translateLocal('workspace.switcher.headerTitle');
const optionRow = await screen.findByTestId(hintText);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MockedSidebarLinks is missing the <TopBar />

@s77rt
Copy link
Contributor

s77rt commented Dec 1, 2024

@Krishna2323 Can you please let me know when this is ready for review

@Krishna2323 Krishna2323 marked this pull request as draft December 1, 2024 18:54
@Krishna2323
Copy link
Contributor Author

The MockedSidebarLinks is missing the

@s77rt, will try to finish this today, I added TopBar in MockedSidebarLinks and since then I'm facing multiple errors.

 TypeError: Cannot read properties of undefined (reading 'then')
   21 |         logError(errorMessage, errorObject, JSON.stringify(errorInfo));
  22 |         // We hide the splash screen since the error might happened during app init
  23 |         BootSplash.hide().then(() => setSplashScreenState(CONST.BOOT_SPLASH_STATE.HIDDEN));

Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

I'm sorry for the delay 🙏🏻. I'm currently stuck in a loop of errors while writing tests, and it's taking longer than expected. This is the first time I'm writing tests for the UI, and I'm feeling a bit clueless about it. I've already spent many hours trying to resolve the issues. I will try to finish this within the next 3 days, or I may ask for reassignment if needed.

@s77rt
Copy link
Contributor

s77rt commented Dec 3, 2024

import * as NativeNavigation from '@react-navigation/native';
import {act, fireEvent, render, screen} from '@testing-library/react-native';
import Onyx from 'react-native-onyx';
import * as Localize from '@libs/Localize';
import * as AppActions from '@userActions/App';
import * as User from '@userActions/User';
import App from '@src/App';
import ONYXKEYS, {OnyxKey} from '@src/ONYXKEYS';
import type {NativeNavigationMock} from '../../__mocks__/@react-navigation/native';
import * as LHNTestUtils from '../utils/LHNTestUtils';
import PusherHelper from '../utils/PusherHelper';
import * as TestHelper from '../utils/TestHelper';
import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';
import waitForBatchedUpdatesWithAct from '../utils/waitForBatchedUpdatesWithAct';

// We need a large timeout here as we are lazy loading React Navigation screens and this test is running against the entire mounted App
jest.setTimeout(60000);

jest.mock('@react-navigation/native');

TestHelper.setupApp();

async function navigateToWorkspaceSwitcher(): Promise<void> {
    const workspaceSwitcherButton = await screen.findByTestId('WorkspaceSwitcherButton');
    fireEvent(workspaceSwitcherButton, 'press');
    await act(() => {
        (NativeNavigation as NativeNavigationMock).triggerTransitionEnd();
    });
    await waitForBatchedUpdatesWithAct();
}

async function signInAndGetApp(): Promise<void> {
    // Render the App and sign in as a test user.
    render(<App />);
    await waitForBatchedUpdatesWithAct();

    const hintText = Localize.translateLocal('loginForm.loginForm');
    const loginForm = await screen.findAllByLabelText(hintText);
    expect(loginForm).toHaveLength(1);

    await act(async () => {
        await TestHelper.signInWithTestUser();
    });
    await waitForBatchedUpdatesWithAct();

    User.subscribeToUserEvents();
    await waitForBatchedUpdates();

    AppActions.setSidebarLoaded();

    await waitForBatchedUpdatesWithAct();
}

describe('WorkspaceSwitcherPage', () => {
    beforeEach(() => {
        jest.clearAllMocks();
        Onyx.clear();

        // Unsubscribe to pusher channels
        PusherHelper.teardown();
    });

    it('triggers press on workspaces list item only once', async () => {
        await signInAndGetApp();

        await Onyx.mergeCollection(ONYXKEYS.COLLECTION.POLICY, {
            [`${ONYXKEYS.COLLECTION.POLICY}1` as const]: LHNTestUtils.getFakePolicy('1', 'Workspace A'),
            [`${ONYXKEYS.COLLECTION.POLICY}2` as const]: LHNTestUtils.getFakePolicy('2', 'Workspace B'),
            [`${ONYXKEYS.COLLECTION.POLICY}3` as const]: LHNTestUtils.getFakePolicy('3', 'Workspace C'),
        });

        await navigateToWorkspaceSwitcher();

        const workspaceRow = screen.getByLabelText('Workspace A');
        expect(workspaceRow).toBeOnTheScreen();
    });
});

Here a simplified test that you can work on top of. Basically now we need to press on Workspace A once and verify it's selected. Then press on workspace B twice and verify that B is selected.

Let me know if you have any questions

@Krishna2323
Copy link
Contributor Author

Will start woking on this again in a hour. Thanks @s77rt for the help 🙇🏻❤️

Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

@s77rt, when I try to simulate multiple presses in a quick session, the tests throw this error:

image

@s77rt
Copy link
Contributor

s77rt commented Dec 7, 2024

@Krishna2323 Wrap the calls in act

@Krishna2323
Copy link
Contributor Author

@s77rt, testing Library utilities are already wrapped in act and I get a warning when trying to do so: Avoid wrapping Testing Library util calls in act

React Testing Library’s utility functions, like fireEvent and userEvent, are designed to work with the act context. They internally wrap their operations in act, ensuring that any updates are processed before making assertions.

@s77rt
Copy link
Contributor

s77rt commented Dec 7, 2024

@Krishna2323 Instead of trying to fire the press event twice, mock useIsFocused to return false and fire the press event and verify that we weren't navigated. Then make the mock return true and this time we should get navigated

Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

Thanks again for the help, @s77rt 🙇🏻. The tests have been updated, and I also verified the test by removing the isFocused check from the WorkspaceSwitcherPage.tsx.

@Krishna2323 Krishna2323 marked this pull request as ready for review December 8, 2024 01:49
src/types/onyx/Policy.ts Outdated Show resolved Hide resolved
Comment on lines +21 to +28
jest.mock('@react-navigation/native', () => {
const actualNav = jest.requireActual<typeof Navigation>('@react-navigation/native');
return {
...actualNav,
useIsFocused: jest.fn(),
triggerTransitionEnd: jest.fn(),
};
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we not use the actualNav and just return useIsFocused

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried removing the actualNav and we can't remove it as causes issues for other missing methods in nav.

tests/ui/WorkspaceSwitcherTest.tsx Outdated Show resolved Hide resolved
tests/ui/WorkspaceSwitcherTest.tsx Outdated Show resolved Hide resolved
tests/ui/WorkspaceSwitcherTest.tsx Outdated Show resolved Hide resolved
Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thank you for writing the test! Not easy to initialize a test suite for this case but our codebase is better for it!

@blimpich blimpich merged commit dc07fc6 into Expensify:main Dec 9, 2024
17 of 18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 9, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.74-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.74-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants