Handle API errors to trigger force upgrades of the app

[marcaaron]

cc @grgia in case you want to help review?

cc @puneetlath if you can double check the changes where I am removing the migration for the participants key 🙏

Details

Adds an update required view and allows for deprecating older App versions.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/340997

Tests

Setup:

Apply this diff so that the upgrade works. It will be disabled on dev and staging:

diff --git a/src/libs/actions/AppUpdate/index.ts b/src/libs/actions/AppUpdate/index.ts
index 7db334919b..d76b89f6ed 100644
--- a/src/libs/actions/AppUpdate/index.ts
+++ b/src/libs/actions/AppUpdate/index.ts
@@ -17,9 +17,9 @@ function triggerUpgradeRequired() {
     // We should only update the minimum app version in the API after all platforms of a new version have been deployed to PRODUCTION.
     // As staging is always ahead of production there is no reason to "force update" those apps.
     getEnvironment().then((environment) => {
-        if (environment !== CONST.ENVIRONMENT.PRODUCTION) {
-            return;
-        }
+        // if (environment !== CONST.ENVIRONMENT.PRODUCTION) {
+        //     return;
+        // }

         Onyx.set(ONYXKEYS.UPDATE_REQUIRED, true);
     });

1. In Web-Expensify modify the Request::MINIMUM_APP_VERSION variable here so that it is higher than the current app version.
2. Navigate to NewDot (fully logged out)
3. Try to log in
4. Verify you get the "Update required" view
5. Reset the Request::MINIMUM_APP_VERSION
6. Refresh app/page
7. Verify you do not see the "Update required" view anymore
8. Sign in
9. Modify the Request::MINIMUM_APP_VERSION variable here so that it is higher than the current app version
10. Take some action in the app
11. Verify you get the "Update required" view

Test "Update" button behavior

Web/mWeb - App should refresh page
Android - App should go to the Play Store
iOS - App should go to the App Store
Desktop - App should auto

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

QA is not possible for these changes.

• 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 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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 - I tested on all platforms. However, there were some changes to the body copy so the screenshots do not 100% reflect where we landed.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[marcaaron]

Will do some testing for this one tomorrow and get some design feedback.

[marcaaron]

I am not able to test it on mWeb

Can you tell me why? I think you can force the screen to show and confirm the styles look OK? Let me know how I can help.

My comment here is suggesting that you should be able to test on all platforms by forcing the screen to show. Maybe it looked like I implied we did not need to test on the other platforms? We should test on all platforms! Thanks!

[c3024]

I got the screen with overriding network request in Chrome Devtools for Web Chrome and directly throwing the error in HttpUtils for Desktop.

I tried throwing the error directly in HttpUtils with iOS Safari but the update screen does not show up. I think the error is caught somewhere up? Let me try again once. I'll get back if I need help. I will finish this up today. Thanks.

[c3024]

Space between the 'Update required' text and the animation on the top and the 'Update' button and the bottom of the screen is asymmetric.

Android mWeb

iOS mWeb

iOS Native

[c3024]

LGTM

[melvin-bot]

🎯 @c3024, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #34825.

[marcaaron]

Thanks for the review! @c3024

Space between the 'Update required' text and the animation on the top and the 'Update' button and the bottom of the screen is asymmetric.

This is the same in the mock provided by design so I believe the intention is for the main view to be centered.

I think it looks pretty decent - people will see this very very very infrequently in any case 😄

But speak now or forever hold your peace

[marcaaron]

This one's just waiting for a final review from an internal reviewer if @puneetlath @grgia @MonilBhavsar have a chance to give a final review. 🙇

[marcaaron]

Bump for reviews.

[MonilBhavsar]

@marcaaron I commented here yesterday https://github.com/Expensify/App/pull/32326/files#r1461660832
That's the only clarification I need. Looks good overall

[marcaaron]

@puneetlath @grgia would one of you mind reviewing and/or approving this? Checked out @MonilBhavsar's question and don't think it's a blocker.

[puneetlath]

Looks good to me!

[OSBotify]

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

[hannojg]

This PR broke my development environment, as it introduced a bunch (~20) of require cycles (thus making modules undefined).

 WARN  Require cycle: src/libs/Log.ts -> src/libs/Network/index.ts -> src/libs/Network/MainQueue.ts -> src/libs/Request.ts -> src/libs/HttpUtils.ts -> src/libs/actions/UpdateRequired.ts -> src/libs/Environment/getEnvironment/index.native.ts -> src/libs/Environment/betaChecker/index.android.ts -> src/libs/actions/AppUpdate/index.ts -> src/libs/actions/AppUpdate/updateApp/index.android.ts -> src/libs/actions/Link.ts -> src/libs/API.ts -> src/libs/Log.ts

Require cycles are allowed, but can result in uninitialized values. Consider refactoring to remove the need for a cycle.
 WARN  Require cycle: src/libs/Log.ts -> src/libs/Network/index.ts -> src/libs/Network/MainQueue.ts -> src/libs/Request.ts -> src/libs/HttpUtils.ts -> src/libs/actions/UpdateRequired.ts -> src/libs/Environment/getEnvironment/index.native.ts -> src/libs/Environment/betaChecker/index.android.ts -> src/libs/actions/AppUpdate/index.ts -> src/libs/actions/AppUpdate/updateApp/index.android.ts -> src/libs/actions/Link.ts -> src/libs/API.ts -> src/libs/Middleware/index.ts -> src/libs/Middleware/Logging.ts -> src/libs/Log.ts

First documented here:
https://expensify.slack.com/archives/C01GTK53T8Q/p1706084435877639

[mountiny]

@marcaaron I went ahead with straight revert to unblock the testing environment nad fix the crash.

Seems like there must have been some issue after merging with main as you have tested on android and it clearly worked. Hopefully it will be quick fix

[c3024]

There are two cycles.

1. Using getEnvironment in UpdateRequired.ts: We might fix this with moving this check in UpdateRequired.ts to here in Expensify.js
2. Using Link in updateApp/index.android.ts: We might fix this by using Linking.openURL using Linking from react-native instead of Link.openExternalLink from userActions/Link

[marcaaron]

Oh great 😄

[marcaaron]

@c3024 Did you test on Android here? Curious how we missed this one..

[marcaaron]

I remember fixing these issues at one point. And they came back. I think maybe when I tried to resolve some unverified commits I must have reintroduced the bad code.

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.31-7 🚀

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