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

[HybridApp] Add explanation modal #39074

Merged

Conversation

mateuuszzzzz
Copy link
Contributor

@mateuuszzzzz mateuuszzzzz commented Mar 27, 2024

Details

OldDot part of this PR: https://github.com/Expensify/Mobile-Expensify/pull/12779

Fixed Issues

$ #37860
PROPOSAL:

Tests

One remark before tests:
Branch of this PR was created on our fork.
This means it's impossible to switch to this branch in HybridApp's react-native submodule.
One need to remove react-native submodule folder and then clone our fork.
git clone {ssh/https repo url} react-native

For OldDot repository one need to switch to this branch set-explanation-modal-key-in-od

It can be tested only on HybridApp

  • Create fresh account (make sure it's not native app, it can be desktop or web)
  • Finish or skip onboarding flow.
  • Open HybridApp (OldDot) and go to NewDot.
  • After opening NewDot one should see Explanation modal. (if onboarding is not finished then after closing explanation modal, onboarding modal should appear)
  • Go back to Expensify Classic.
  • Kill the app.
  • Open once again and go to NewDot.
  • Verify that explanation modal opens only once. (in this step it should not open)

Offline tests

QA Steps

Same as tests

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 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
      • 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

NOTE: All videos were recorded with a trigger from the troubleshooting section. On videos, I included the old onboarding flow after dismissing the explanation modal. Once stage 1 is ready it will be changed to a new onboarding flow.
Especially, those videos don't include full HybridApp flow.

Android: Native
demo-android.mov
Android: mWeb Chrome -
iOS: Native
Explanation.Modal.iOS.mov
iOS: mWeb Safari -
MacOS: Chrome / Safari -
MacOS: Desktop -

Copy link

melvin-bot bot commented Mar 27, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@AndrewGable AndrewGable changed the title [HybridApp] Add explanation modal [HOLD PR #37733][HybridApp] Add explanation modal Mar 28, 2024
@mateuuszzzzz mateuuszzzzz changed the title [HOLD PR #37733][HybridApp] Add explanation modal [HybridApp] Add explanation modal Apr 10, 2024
@mateuuszzzzz mateuuszzzzz marked this pull request as ready for review April 12, 2024 12:46
@mateuuszzzzz mateuuszzzzz requested a review from a team as a code owner April 12, 2024 12:46
@melvin-bot melvin-bot bot removed the request for review from a team April 12, 2024 12:46
Copy link

melvin-bot bot commented Apr 12, 2024

@Santhosh-Sellavel 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]

@melvin-bot melvin-bot bot requested a review from Santhosh-Sellavel April 12, 2024 12:46
@Santhosh-Sellavel
Copy link
Collaborator

Conflicts again

@Santhosh-Sellavel
Copy link
Collaborator

Bump @mateuuszzzzz

@mateuuszzzzz
Copy link
Contributor Author

Bump @mateuuszzzzz

@Santhosh-Sellavel I resolved conflicts

@Santhosh-Sellavel
Copy link
Collaborator

@mateuuszzzzz

New Login Case

Onboarding not complete

When onboarding is not complete: additionally one should be navigated to the onboarding flow.

This case fails

Screen.Recording.2024-04-17.at.11.15.29.PM.mov

While window is resized content is not responsive

Unable to scroll, not fit properly

Screen.Recording.2024-04-17.at.11.16.24.PM.mov

@mateuuszzzzz
Copy link
Contributor Author

@mateuuszzzzz

New Login Case

Onboarding not complete

When onboarding is not complete: additionally one should be navigated to the onboarding flow.

This case fails

Screen.Recording.2024-04-17.at.11.15.29.PM.mov

While window is resized content is not responsive

Unable to scroll, not fit properly

Screen.Recording.2024-04-17.at.11.16.24.PM.mov

This looks like regressions introduced after merging main. I will investigate it.

@Santhosh-Sellavel
Copy link
Collaborator

@mateuuszzzzz bump!

@mateuuszzzzz
Copy link
Contributor Author

@mateuuszzzzz bump!

I'm on it

@mateuuszzzzz
Copy link
Contributor Author

mateuuszzzzz commented Apr 22, 2024

@Santhosh-Sellavel could you verify if you can see onboarding flow after creating new account but on main branch?

When I initially tested this PR it worked, but now I cannot see onboarding flow even on main so perhaps this is not PR related 🤔

In general NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER seems to behave non-deterministically.

EDIT: I got confirmation that this NVP onyx key updates to false very fast which generates problems with current flow.
In the new onboarding flow this key is not used anymore. The problem is that at the moment this is best what we have to handle explanation modal logic.

We need to come up with new approach which won't be buggy. This will be handled internally by Expensify.

@mateuuszzzzz mateuuszzzzz marked this pull request as draft June 4, 2024 17:57
Copy link
Contributor

@AndrewGable AndrewGable left a comment

Choose a reason for hiding this comment

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

Looking good!

@mateuuszzzzz mateuuszzzzz marked this pull request as ready for review June 26, 2024 11:33
@mateuuszzzzz mateuuszzzzz requested a review from a team as a code owner June 26, 2024 11:33
@mateuuszzzzz
Copy link
Contributor Author

mateuuszzzzz commented Jun 26, 2024

One important remark. Due to poor transitions we have very weird behaviour on Android. Navigation behaves a bit different than it should (see video for Android native). I can't do much about it in this PR.

I want to fix it in oncoming improved transitions PR where I will delegate handling HybridApp onboarding flow to "HybridApp middleware". This should guarantee us that navigation on Android works correctly. cc: @AndrewGable

If this is a problem at the moment, we can disable Explanation Modal for Android and enable it again in improved transitions PR.

EDIT: Fix is already here #44471
Perhaps we should close this PR since more complete version is here cc: @AndrewGable

@AndrewGable
Copy link
Contributor

Perhaps we should close this PR since more complete version is #44471 cc: @AndrewGable

I kinda think we should keep this one separate and just merge main into #44471 once this is merged

AndrewGable
AndrewGable previously approved these changes Jun 26, 2024
Copy link
Contributor

@AndrewGable AndrewGable left a comment

Choose a reason for hiding this comment

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

Looking really good! I will do checklist soon.

@AndrewGable
Copy link
Contributor

AndrewGable commented Jun 26, 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 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

Simulator 2024-06-26 at 14 29 36

iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@AndrewGable
Copy link
Contributor

Conflicts, but code looks good to me!

Simulator 2024-06-26 at 14 29 36

AndrewGable
AndrewGable previously approved these changes Jun 27, 2024
@AndrewGable AndrewGable merged commit 24b7c48 into Expensify:main Jun 27, 2024
15 checks passed
@OSBotify
Copy link
Contributor

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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