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] Disable ExitSurvey in HybridApp #47856

Conversation

war-in
Copy link
Contributor

@war-in war-in commented Aug 22, 2024

Details

Fixed Issues

$ #43142
PROPOSAL:

Tests

On HybridApp (the NewApp flow should not change)

  1. Enter NewDot go to Settings -> Switch to Expensify Classic
  2. Be redirected immediately to the OldDot app

Offline tests

QA Steps

  1. Enter NewDot go to Settings -> Switch to Expensify Classic
  2. Be redirected immediately to the OldDot app

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

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

@war-in
Copy link
Contributor Author

war-in commented Aug 22, 2024

cc @staszekscp @mateuuszzzzz

@AndrewGable
Copy link
Contributor

Why do we need a timeout?

@war-in
Copy link
Contributor Author

war-in commented Aug 22, 2024

Why do we need a timeout?

@AndrewGable We need it because we can get stuck on that action if the connection is poor.
Those unfinished requests (if there are any) are persisted in onyx and will be fired once we enter ND again, so we don't lose any performed actions

@AndrewGable
Copy link
Contributor

Is it because the request will be canceled once we switch to Expensify Classic? And we need to wait for the API to finish before clearing out the values?

@war-in
Copy link
Contributor Author

war-in commented Aug 22, 2024

I think we have two issues here

  • first - survey fields were not cleared on the button click
  • second - user could get stuck in the ND app after clicking Switch to Expensify Classic button

The first problem is easy to solve (we could move clearing fields to the optimistic data) but the second issue is the harder one because we can't tell when the API request finishes. In that situation we need timeout to always redirect the user

@AndrewGable
Copy link
Contributor

Why can't we tell when the API finishes?

@war-in
Copy link
Contributor Author

war-in commented Aug 22, 2024

Why can't we tell when the API finishes?

Oh, sorry, I meant we can't predict how long the API call will take to end. And if so we could be showing a spinner for a long time. If the user decides to go back from the Switch ... page the call could end and he would get redirected in the middle of some action

@AndrewGable
Copy link
Contributor

Why can't we redirect the user when the API finishes? Why do we have to guess with a timeout?

@staszekscp
Copy link
Contributor

It also seems that the request just hanged, and was never resolved, nor rejected. If it did, the state of the form would have changed. The fact that button had the spinner indicates that the request never set finallyData.

In that case we believe it is better to set a timeout - if the request takes too long or hangs, it is better to just send the user to OldDot - also from the UX point of view 😄

@staszekscp
Copy link
Contributor

staszekscp commented Aug 22, 2024

Why can't we redirect the user when the API finishes? Why do we have to guess with a timeout?

I've posted the comment at the same time as you've asked the question, so to address it a bit better by adding a couple more words 😄

Previously we were setting the finallyData on the ExitSurvey.switchToOldDot API call, however because Onyx data was not changing (the inputs were filled as before, and the spinner was spinning) we assume that the call was never finished.

In that case we've decided that it is better to set a timeout, instead of waiting forever for the call to resolve. In the end, the most important thing for the user is to switch experience, and the result of this particular call is not essential for the app to work correctly 😄

@war-in
Copy link
Contributor Author

war-in commented Aug 23, 2024

Adding my two cents 😄

We found that the main cause of the issue (not clearing the survey values, and blocked button with a spinner) was the hanging SwitchToOldDot request. It occurred when the connection was bad/slow.
The values were not cleared because we removed them in finallyData when the request finished. If the request hangs finallyData is never reached and the user gets stuck on the spinning confirmation button. The user can still navigate through the app but may be redirected at some random moment when the request ends.

We decided that the best solution is to set a timeout and when the request hangs or takes way longer than expected we optimistically switch to NewDot. It helps us improve the UX because users won't get stuck in the NewDot app when they want to return to the OldDot.

If you've got any other ideas/opinions, we'd love to hear them!

@AndrewGable
Copy link
Contributor

I have been thinking about this:

  1. It feels like the wrong spot to set a timeout for a slow request, that feels like it should happen in the API side of things.
  2. I don't love that this button is blocked by the API and wish we could make it async.

@war-in
Copy link
Contributor Author

war-in commented Aug 26, 2024

@AndrewGable I tried making the button not async and this is the result :)
We're not blocking the flow on this button and switching to OldDot right after the click.

Screen.Recording.2024-08-26.at.13.16.38.mov

Thank you for your arguments and please let me know if you have any other questions/suggestions 🙏

@war-in war-in requested a review from staszekscp August 26, 2024 11:51
@AndrewGable
Copy link
Contributor

This looks great, but we just talked internally and I think we are OK to remove this survey all together for HybridApp

@war-in
Copy link
Contributor Author

war-in commented Aug 26, 2024

@AndrewGable Great news 🚀 Should I handle this here?

@AndrewGable
Copy link
Contributor

Yes, let's do that on this PR 🚀

@war-in war-in changed the title [HybridApp] Set timeout when switching to OldDot [HybridApp] Disable ExitSurvey in HybridApp Aug 26, 2024
@war-in war-in force-pushed the war-in/proceed-with-closing-ND-after-timeout branch from 643bff5 to 84788f1 Compare August 27, 2024 11:35
@war-in war-in marked this pull request as ready for review August 28, 2024 15:22
@war-in war-in requested a review from a team as a code owner August 28, 2024 15:22
@melvin-bot melvin-bot bot requested review from AndrewGable and hungvu193 August 28, 2024 15:22
Copy link

melvin-bot bot commented Aug 28, 2024

@hungvu193 @AndrewGable One of you needs to 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 removed the request for review from a team August 28, 2024 15:22
@melvin-bot melvin-bot bot removed the request for review from staszekscp August 28, 2024 15:22
@hungvu193
Copy link
Contributor

Does this need a C+ review 😄 ?

@war-in
Copy link
Contributor Author

war-in commented Aug 28, 2024

I think @AndrewGable will handle this one :)

@AndrewGable
Copy link
Contributor

Looks great!

Simulator.2024-08-29.at.15.33.06.mp4

@AndrewGable
Copy link
Contributor

AndrewGable commented Aug 29, 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
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@@ -206,7 +206,7 @@ function signOutAndRedirectToSignIn(shouldResetToHome?: boolean, shouldStashSess
if (!isAnonymousUser()) {
// In the HybridApp, we want the Old Dot to handle the sign out process
if (NativeModules.HybridAppModule && killHybridApp) {
NativeModules.HybridAppModule.closeReactNativeApp(true);
NativeModules.HybridAppModule.closeReactNativeApp(true, false);
Copy link
Contributor

Choose a reason for hiding this comment

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

Named parameters would be nice here

@AndrewGable AndrewGable merged commit eb57e57 into Expensify:main Aug 30, 2024
18 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

🚀 Deployed to staging by https://github.com/AndrewGable in version: 9.0.27-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 2, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.27-1 🚀

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.

5 participants