Android ReactActivity Destroy Prevents Successful OnActivityResult Calls

Question

Android ReactActivity Destroy Prevents Successful OnActivityResult Calls

zsweigart opened this issue 4 years ago · 19 comments

Description

If a native module opens an activity that redirects out of the application and the application is killed in the background by the Android OS, the react context is lost and the native module's activity is unable to call onActivityResult.

If the redirect from the third party app is back to the activity in the native module, the ReactActivity is not created at this point. When the native activity then sets result and finishes to return back to the ReactActivity the ReactActivity has to start up.

The React Native startup flow is:

ReactActivity#onCreate
ReactActivityDelegate#onCreate
ReactActivityDelegate#loadApp
ReactDelegate#loadApp
ReactRootView#startReactApplication
ReactInstanceManager#createReactContextInBackground
ReactInstanceManager#recreateReactContextInBackgroundInner
ReactInstanceManager#recreateReactContextInBackgroundFromBundleLoader
ReactInstanceManager#recreateReactContextInBackground
ReactInstanceManager#runCreateReactContextOnNewThread

At this point ReactInstanceManager#setupReactContext is called on a background thread.

Meanwhile, ReactActivity#onActivityResult is called. In the Android activity lifecycle onActivityResult is called even before onResume (for reference. The calls from ReactActivity#onActivityResult pass through a few layers and end up at ReactInstanceManager#onActivityResult which checks if the ReactContext is null

  @ThreadConfined(UI)
  public void onActivityResult(Activity activity, int requestCode, int resultCode, Intent data) {
    ReactContext currentContext = getCurrentReactContext();
    if (currentContext != null) {
      currentContext.onActivityResult(activity, requestCode, resultCode, data);
    }
  }

Because the context is being built on a background thread there is no guarantee that currentContext will be initialized at this point. Furthermore ReactInstanceManager#createReactContext is a fairly intensive function so it is actually very likely that currentContext is null.

This means that ReactContext#onActivityResult is not called and therefore, the data cannot be passed back to the ActivityEventListener which in my sample is the ReactContextBaseJavaModule.

React Native version:

System:
    OS: macOS 10.15.7
    CPU: (12) x64 Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz
    Memory: 118.90 MB / 32.00 GB
    Shell: 3.2.57 - /bin/bash
  Binaries:
    Node: 13.14.0 - ~/.nvm/versions/node/v13.14.0/bin/node
    Yarn: 1.22.5 - /usr/local/bin/yarn
    npm: 6.14.4 - ~/.nvm/versions/node/v13.14.0/bin/npm
    Watchman: 4.9.0 - /usr/local/bin/watchman
  Managers:
    CocoaPods: 1.9.3 - /usr/local/bin/pod
  SDKs:
    iOS SDK:
      Platforms: iOS 13.6, DriverKit 19.0, macOS 10.15, tvOS 13.4, watchOS 6.2
    Android SDK:
      API Levels: 19, 23, 26, 27, 28, 29
      Build Tools: 27.0.3, 28.0.3, 29.0.0, 29.0.1, 29.0.2
      System Images: android-21 | Google APIs Intel x86 Atom, android-23 | Google APIs Intel x86 Atom, android-26 | Google Play Intel x86 Atom, android-28 | Google APIs Intel x86 Atom, android-29 | Google Play Intel x86 Atom, android-Q | Android TV Intel x86 Atom
      Android NDK: Not Found
  IDEs:
    Android Studio: 4.0 AI-193.6911.18.40.6626763
    Xcode: 11.6/11E708 - /usr/bin/xcodebuild
  Languages:
    Java: 1.8.0_265 - /usr/bin/javac
    Python: 2.7.16 - /usr/bin/python
  npmPackages:
    @react-native-community/cli: Not Found
    react: 16.13.1 => 16.13.1 
    react-native: 0.63.3 => 0.63.3 
    react-native-macos: Not Found
  npmGlobalPackages:
    *react-native*: Not Found

Steps To Reproduce

Clone
https://github.com/zsweigart/react-native-crash
cd into the directory and run react-native run-android
On your device or emulator go to developer options
Turn Do Not Keep Activities to On
Set Background Process Limit to No background processes
Click Open Activity
Click Go to Web -> This should kill the original process in the background due to your developer settings; however, on some emulators I have noticed it does not. One way to guarantee this is to run adb shell am kill com.react_native_crash which will simulate a system process kill. Note you cannot kill the process by swiping it away because the OS will lose the information about the backstack.
Next run adb shell am start -n com.react_native_crash/.RedirectActivity -d "redirect://crash"
Click Return Result

Expected Results

After these steps in the console you should see

 LOG      RESULT
 LOG      Completed

which would indicate the onActivityResult was called properly and the callback to the js code was executed.

Snack, code example, screenshot, or link to a repository:

https://github.com/zsweigart/react-native-crash

Answer 1 · 2020-11-25T06:28:39.000Z

Are there any updates on this issue? This is a problem with low memory devices as well when the main application launches other activities (like launching camera) and then the Android OS kills the activity that launched the camera along with the ReactContext.

Answer 2 · 2020-11-26T10:22:43.000Z

@zsweigart Did you find any workaround for this issue? Maybe provide an own ReactInstanceManager implementation?

Answer 3 · 2020-11-30T20:03:10.000Z

We have not worked on finding a work around and are currently accepting the rate errors until this is fixed

Answer 4 · 2021-02-22T10:24:16.000Z

For the sake of cross-referencing most related issues from other modules and working on a workaround, I've created a repo: https://github.com/HugoGresse/react-native-issue-30277/blob/main/README.md

Answer 5 · 2021-02-23T15:39:43.000Z

Workaround for react-native-image-crop-picker here

Answer 6 · 2021-07-13T10:46:00.000Z

What changed to cause this? Is it a ReactNative change or an Android SDK update?

Answer 7 · 2021-09-22T16:49:24.000Z

I can't believe there is no update on this issue.

Answer 8 · 2022-01-09T04:46:20.000Z

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs. You may also label this issue as a "Discussion" or add it to the "Backlog" and I will leave it open. Thank you for your contributions.

Answer 9 · 2022-01-09T13:02:04.000Z

This issue needs attention, it impact a lot of apps through many libraries.

Answer 10 · 2022-01-13T17:41:14.000Z

Same problem (image-crop-picker).

Answer 11 · 2022-03-07T07:33:04.000Z

Facing the same issue... I think this issue needs attention.

Answer 12 · 2022-04-05T16:25:49.000Z

This issue needs attention, facing the same thing!

Answer 13 · 2022-05-12T12:57:31.000Z

Any one with a solution?

Answer 14 · 2022-10-04T09:25:21.000Z

Currently facing the same issue with react-native-app-auth
FormidableLabs/react-native-app-auth#773

Answer 15 · 2023-05-12T07:20:40.000Z

As a workaround, I can imagine one would use a Handler on the main thread (which is guaranteed here anyway), poll whether reactContext is still null and give up after a few retries (trying to cover as many crashes as possible but not waiting too long).
Obviously, one would need to patch react-native using patch-package to achieve that, but it would work across libraries.
It would be good to only keep a WeakReference to the activity to not leak it, unless this would be the last reference to it, in which case it'd be necessary to keep it around for those few seconds until the React context initializes.

Answer 16 · 2023-07-17T10:05:57.000Z

Facing the same issue... I think this issue needs attention.

Answer 17 · 2024-01-14T05:01:13.000Z

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

Answer 18 · 2024-01-14T05:13:33.000Z

This issue needs attention!

Answer 19 · 2024-04-23T10:32:47.000Z

any solutions?