Skip to content

[NoQA] Add tests for switch to Expensify classic flow#52754

Merged
mountiny merged 13 commits intoExpensify:mainfrom
hungvu193:followup/51703
Nov 25, 2024
Merged

[NoQA] Add tests for switch to Expensify classic flow#52754
mountiny merged 13 commits intoExpensify:mainfrom
hungvu193:followup/51703

Conversation

@hungvu193
Copy link
Copy Markdown
Contributor

@hungvu193 hungvu193 commented Nov 19, 2024

Explanation of Change

Add tests for recently added logic:

    if (shouldOpenBookACall) {
        Navigation.navigate(ROUTES.SETTINGS_EXIT_SURVERY_BOOK_CALL.route);
        return;
    }
    Navigation.navigate(ROUTES.SETTINGS_EXIT_SURVEY_CONFIRM.route);

Fixed Issues

$ #51703
PROPOSAL: N/A

Tests

  1. From your root project, run the following command:
TZ=utc NODE_OPTIONS=--experimental-vm-modules jest tests/ui/InitialSettingPageTest.tsx
  1. Verify that all the tests passed.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
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
Screen.Recording.2024-11-22.at.13.52.01.mov
Android: mWeb Chrome
Screen.Recording.2024-11-22.at.13.52.01.mov
iOS: Native
Screen.Recording.2024-11-22.at.13.52.01.mov
iOS: mWeb Safari
Screen.Recording.2024-11-22.at.13.52.01.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-22.at.13.52.01.mov
MacOS: Desktop
Screen.Recording.2024-11-22.at.13.52.01.mov

@mountiny mountiny self-requested a review November 20, 2024 10:25
@mountiny mountiny changed the title Follow-up Add test for switch to Expensify classic flow [NoQA] Add test for switch to Expensify classic flow Nov 20, 2024
@mountiny
Copy link
Copy Markdown
Contributor

@hungvu193 how is this going?

@hungvu193
Copy link
Copy Markdown
Contributor Author

Still stuck on the second test, I will raise a slack convo to get some helps.

@hungvu193 hungvu193 marked this pull request as ready for review November 22, 2024 06:53
@hungvu193 hungvu193 requested a review from a team as a code owner November 22, 2024 06:53
@melvin-bot melvin-bot bot requested review from Ollyws and removed request for a team November 22, 2024 06:53
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Nov 22, 2024

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

@hungvu193
Copy link
Copy Markdown
Contributor Author

Oh weird. I think you can ignore this PR @Ollyws, I'm not sure why you're assigned, @shubham1206agra is the C+ on the linked issue, he will handle this one. Ty

@hungvu193 hungvu193 changed the title [NoQA] Add test for switch to Expensify classic flow [NoQA] Add tests for switch to Expensify classic flow Nov 22, 2024
@shubham1206agra
Copy link
Copy Markdown
Contributor

@mountiny I don't think this test is helpful since it creates a function and tests the same function.

@hungvu193
Copy link
Copy Markdown
Contributor Author

hungvu193 commented Nov 22, 2024

My initial tests were:

  1. Render the App
  2. Go to Settings.
  3. Trigger the Switch To Expensify Class Button.

However while debugging the tests, the logic inside action of Switch To Expensify Class Button was never triggered, which made me stuck there. Any suggestions?

@shubham1206agra
Copy link
Copy Markdown
Contributor

My initial tests were:

1. Render the .

2. Go to Settings.

3. Trigger the `Switch To Expensify Class Button`.

However while debugging the tests, the logic inside action of Switch To Expensify Class Button was never triggered, which made me stuck there. Any suggestions?

@hungvu193 Can you check if action was mocked anywhere?

@hungvu193
Copy link
Copy Markdown
Contributor Author

@hungvu193 Can you check if action was mocked anywhere?

I don't think I mocked action, this is the old test btw
https://github.com/Expensify/App/blob/1fa2c4e15881b380ea7116f5166b834904a731c9/tests/unit/InitialSettingPageTest.tsx

@hungvu193
Copy link
Copy Markdown
Contributor Author

Updated the tests @shubham1206agra.

@shubham1206agra
Copy link
Copy Markdown
Contributor

@hungvu193 Can you add this test to test suite so it will run in CI?

@shubham1206agra
Copy link
Copy Markdown
Contributor

@hungvu193 Is there a reason why test takes 50 sec to run?

@hungvu193
Copy link
Copy Markdown
Contributor Author

@hungvu193 Can you add this test to test suite so it will run in CI?

How to do that? Sorry I'm new with this one.

@hungvu193 Is there a reason why test takes 50 sec to run?

Mine takes 4.5 seconds to run both tests. I think every test case needs to re-render and login the App (also wait for Onyx data..etc) it probably takes longer based on our connection?

Screenshot 2024-11-22 at 16 29 17

@shubham1206agra
Copy link
Copy Markdown
Contributor

@hungvu193 Can you add this test to test suite so it will run in CI?

How to do that? Sorry I'm new with this one.

Sorry, I got confused. Can you put this test under ui folder since test is related to UI?

@hungvu193 Is there a reason why test takes 50 sec to run?

Mine takes 4.5 seconds to run both tests. I think every test case needs to re-render and login the App (also wait for Onyx data..etc) it probably takes longer based on our connection?
Screenshot 2024-11-22 at 16 29 17

Yeah, my system nows shows 5 sec to run the test.

@hungvu193
Copy link
Copy Markdown
Contributor Author

Sorry, I got confused. Can you put this test under ui folder since test is related to UI?

Done 😄

@shubham1206agra
Copy link
Copy Markdown
Contributor

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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mountiny mountiny removed the request for review from Ollyws November 25, 2024 13:47
mountiny
mountiny previously approved these changes Nov 25, 2024
Copy link
Copy Markdown
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Code looks good to me but its not clear to me why the test is name this way?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this a correct file name?

@hungvu193
Copy link
Copy Markdown
Contributor Author

Code looks good to me but its not clear to me why the test is name this way?

Do you have any suggestions? I was about to name it "SwitchToExpensifyClassicFlow" but then I changed my mind cause I think in the future we might add more tests to this file whenever we added new logic into InitialSettingPage.

Copy link
Copy Markdown
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks!

@mountiny mountiny merged commit 70dfbb7 into Expensify:main Nov 25, 2024
@github-actions
Copy link
Copy Markdown
Contributor

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

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

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.67-9 🚀

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

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.

3 participants