Enable native staging apps to use Staging API by mountiny · Pull Request #13029 · Expensify/App

mountiny · 2022-11-24T22:40:52Z

Details

This PR will enable us to use staging API in native apps as well. This is a follow up to this PR #12880 which had to be reverted as after one refactor update the dev environment was not read correctly locally.

The shouldUseStaging variable will be false by default in native apps. In production App, user does not have access to the toggle hence they cannot switch production app to use Staging API. In staging, this means that before the Onyx data is available we will defer to production API, which is safe bet and how staging app works now. Once the settings is available we will decide based on the toggle state.

For desktop and web, we will keep the same behaviour which we achieve by using the getPlatfrom call to check for Web and desktop.

In case of Android and iOS, the Config file is not accessible in staging build (we use production env during building), therefore we need to rely only on the staging toggle in this case and that is why we add this platform specific check.

Fixed Issues

$ #11561
$ #11068

Tests

Verify that no errors appear in the JS console

Internal tests

Copy the contents from the .env.production to your .env file
Make changes to this line so the test preferences are shown in
Run the iOS and Android app
Make sure the toggle for staging api is turned on
Performs some actions in the app
Go to logs and search for the most recent actions by this account
Make sure the servers these request hit are staging servers
Go back to the settings and switch to production API
Repeat and confirm in the logs the request are hitting the production servers
Run the app in desktop with staging env
Confirm the correct servers are hit based on the toggle value
Run the app in desktop with production env
Confirm the production servers are used

Test that local development still works

Run with dev env and make sure the API hits your local VM

Offline tests

No offline tests here.

QA Steps

Verify that no errors appear in the JS console

Open the iOS and Android staging app
Make sure the toggle for staging api is turned on
Performs some actions in the app
Go to logs and search for the most recent actions by this account
Make sure the servers these request hit are staging servers
Go back to the settings and switch to production API
Repeat and confirm in the logs the request are hitting the production servers
Run the staging web
By checking the logs, confirm the correct servers are being hit based on what stage the toggle is at

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots/Videos

Using dev env confirming that is not broken:

in web:

in native also seems to point ot dev just fine:

Staging env on desktop

staging but toggling to use production api works well too

Staging env on native (that is how I can test locally the staging switch as the local build with production API is considered to be production app so no toggle shows up) - for this I had to force staging environment also here as the badge and the settings rely on request to play store to check the App version which obviously does not work locally.

the production api has been used if the toggle has changed back to prodcution

Using Production API

desktop

- native using production API correctly sends the requests to production

Web

with staging variables

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2022-11-24T22:41:20Z

@parasharrajat @marcochavezf 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]

mountiny · 2022-11-24T23:13:14Z

This is WIP because there will be still an issue now with Production native app pointing to staging.

After thinking about this for a while I think we dont have other option than to default the staging api toggle to false and hence start the staging apps with production API until the user changes this settings to staging API (in native at least).

I think it is not ideal but I think this is fine as it does not stop us from testing staging API

marcochavezf · 2022-12-01T00:36:24Z

In case of Android and iOS, the Config file is not accessible in staging build (we use production env during building)

@mountiny, I think this ^ is why IS_IN_STAGING is not setting the correct value, but we're already able to know if the env is staging on native apps (i.e. Android app from the internal beta program). For example, we display the TestToolMenu and the staging logo on staging native apps. So what if we use the same logic of the TestToolMenu or the staging log to use the Staging API in HttpUtils?

mountiny · 2022-12-01T13:38:26Z

@mountiny, I think this ^ is why IS_IN_STAGING is not setting the correct value, but we're already able to know if the env is staging on native apps (i.e. Android app from the internal beta program). For example, we display the TestToolMenu and the staging logo on staging native apps. So what if we use the same logic of the TestToolMenu or the staging log to use the Staging API in HttpUtils?

Hwy hey sorry I got lost in other issues before coming back to this one.

So we had been thinking about all those options, the problem with the approach you mention is that it needs to make a request to App stores to find out about the beta. Since the place where it makes sense to make this request is when the app is being loaded, we would block other request/slow them down if we would do this and initially we would use different api than expected.

Therefore the best solution which will work predictably and consistently is to default to production instead of staging and then just switch based on the toggle once onyx state if loaded (in case on native apps).

marcochavezf · 2022-12-01T20:05:58Z

the problem with the approach you mention is that it needs to make a request to App stores to find out about the beta. Since the place where it makes sense to make this request is when the app is being loaded, we would block other request/slow them down if we would do this and initially we would use different api than expected.

Ah why checking environment === CONST.ENVIRONMENT.STAGING directly in HttpUtils will make a request to App Stores and would block other requests?

My thinking is that IS_IN_STAGING is initialized (for some reason) with the wrong value, because environment === CONST.ENVIRONMENT.STAGING is true (expected value) in other parts of the staging native apps.

mountiny · 2022-12-01T23:04:59Z

because environment === CONST.ENVIRONMENT.STAGING is true (expected value) in other parts of the staging native apps

In other parts of the staging native apps we always use getEnvironment method which makes the API request

marcochavezf · 2022-12-02T05:58:30Z

In other parts of the staging native apps we always use getEnvironment method which makes the API request

Oh I see, but is there a problem if we block the other requests until the getEnvironment is completed?

Therefore the best solution which will work predictably and consistently is to default to production instead of staging and then just switch based on the toggle once onyx state if loaded (in case on native apps).

Sorry if I'm missing something, but how will we know that we have to turn on the staging switch automatically on staging apps? Isn't more reliable to wait until getEnvironment is completed before we make any other request?

mountiny · 2022-12-02T10:47:18Z

is there a problem if we block the other requests until the getEnvironment is completed?

Normally we dont call this as app start, which we would have to do here and also even in production since we dont have a way to know to not make this request if in production. If the request is made somewhere else in the App it is not such huge problem.

Sorry if I'm missing something, but how will we know that we have to turn on the staging switch automatically on staging apps? Isn't more reliable to wait until getEnvironment is completed before we make any other request?

the getEnvironment is used to decide if we should show the toggle, then if we are in staging, we show the toggle but its actual value is help only in Onyx and that is what will decide where we will point. We cannot however safely default to staging, we will need to default to production and then let the user who is on staging switch to staging. That will be saved until the onyx data is reset by signing out (I dont think we save this in database)

mountiny · 2022-12-05T15:10:23Z

@marcochavezf @parasharrajat Not sure how Rajat you can test this in native apps locally but this is ready for review/ testing.

I have included all my testing scenarios in the PR body, it took a while to test everything.

There is no ideal solution to this so I feel like this is the least evil route.

mountiny · 2022-12-05T15:16:45Z

        <TestToolRow title="Use Staging Server">
            <Switch
-                isOn={lodashGet(props, 'user.shouldUseStagingServer', true)}
+                isOn={lodashGet(props, 'user.shouldUseStagingServer', _.contains([CONST.PLATFORM.WEB, CONST.PLATFORM.DESKTOP], getPlatform()))}


Only default to true if we are in web or desktop which can read the correct config

marcochavezf · 2022-12-05T23:23:34Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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(themeColors.componentBG)
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Verifiying web is pointing to VM:

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Using staging:

Using production:

iOS

Android

marcochavezf

Thanks @mountiny! Tests went well

OSBotify · 2022-12-05T23:34:46Z

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

mountiny · 2022-12-06T09:23:20Z

Thank you @marcochavezf

mountiny · 2022-12-09T09:49:44Z

QAed this on web and iOS mobile and it works well 🎉

OSBotify · 2022-12-13T22:40:50Z

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

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

Make sure to use dev if dev environment is defined

aa10362

mountiny added the InternalQA This pull request required internal QA label Nov 24, 2022

mountiny self-assigned this Nov 24, 2022

mountiny requested a review from a team as a code owner November 24, 2022 22:40

melvin-bot Bot requested review from marcochavezf and parasharrajat and removed request for a team November 24, 2022 22:41

mountiny changed the title ~~Enable native staging apps to use Staging API~~ [WIP] Enable native staging apps to use Staging API Nov 24, 2022

mountiny added 3 commits November 24, 2022 23:00

Default to true

ba9786c

Merge main

5ada0b8

Resolve merge conflict

49c1478

mountiny mentioned this pull request Nov 24, 2022

Look at the platform to decide how to choose API #12880

Merged

98 tasks

Default to production apu in staging

b0cdfbf

marcochavezf mentioned this pull request Dec 1, 2022

[HOLD for payment 2022-12-20] Android/IOS- The flow to the transaction amount fields does not work in apps #11068

Closed

srikarparsi mentioned this pull request Dec 4, 2022

[$1000] User can't download the production app from playstore #11132

Closed

mountiny added 3 commits December 5, 2022 13:27

Merge branch 'main' into vit-experiementWithStagingNative

48c3daf

Update comment

0e3048e

Default to staging on web and dektop

56e5c32

mountiny changed the title ~~[WIP] Enable native staging apps to use Staging API~~ Enable native staging apps to use Staging API Dec 5, 2022

Use the correct default for staging server toggle

8aeeb5a

mountiny commented Dec 5, 2022

View reviewed changes

Rename variable

7c53f31

marcochavezf approved these changes Dec 5, 2022

View reviewed changes

marcochavezf merged commit 36a009b into main Dec 5, 2022

marcochavezf deleted the vit-experiementWithStagingNative branch December 5, 2022 23:30

francoisl mentioned this pull request Dec 8, 2022

Deploy Checklist: New Expensify 2022-12-07 #13431

Closed

72 tasks

melvin-bot Bot mentioned this pull request Dec 13, 2022

[HOLD for payment 2022-12-20] [$500] Allow native app releases to take staging env variables into consideration #11561

Closed

Uh oh!

Conversation

mountiny commented Nov 24, 2022 • edited by marcochavezf Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Test that local development still works

Offline tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Nov 24, 2022

Uh oh!

mountiny commented Nov 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcochavezf commented Dec 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Dec 1, 2022

Uh oh!

marcochavezf commented Dec 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Dec 1, 2022

Uh oh!

marcochavezf commented Dec 2, 2022

Uh oh!

mountiny commented Dec 2, 2022

Uh oh!

mountiny commented Dec 5, 2022

Uh oh!

mountiny Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

marcochavezf commented Dec 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

marcochavezf left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 5, 2022

Uh oh!

mountiny commented Dec 6, 2022

Uh oh!

mountiny commented Dec 9, 2022

Uh oh!

OSBotify commented Dec 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mountiny commented Nov 24, 2022 •

edited by marcochavezf

Loading

mountiny commented Nov 24, 2022 •

edited

Loading

marcochavezf commented Dec 1, 2022 •

edited

Loading

marcochavezf commented Dec 1, 2022 •

edited

Loading

marcochavezf commented Dec 5, 2022 •

edited

Loading