react / react/react-native

Android ReactActivity Destroy Prevents Successful OnActivityResult Calls

Open
#30,277 35 comments 31 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Author Provided Repro Platform: Android
Dominant language
C++
Stars
127k
Forks
25.3k
Avg merge
1d 23h
Merged PRs (30d)
4

Description

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:

  1. ReactActivity#onCreate
  2. ReactActivityDelegate#onCreate
  3. ReactActivityDelegate#loadApp
  4. ReactDelegate#loadApp
  5. ReactRootView#startReactApplication
  6. ReactInstanceManager#createReactContextInBackground
  7. ReactInstanceManager#recreateReactContextInBackgroundInner
  8. ReactInstanceManager#recreateReactContextInBackgroundFromBundleLoader
  9. ReactInstanceManager#recreateReactContextInBackground
  10. 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

  1. Clone
  2. https://github.com/zsweigart/react-native-crash
  3. cd into the directory and run react-native run-android
  4. On your device or emulator go to developer options
  5. Turn Do Not Keep Activities to On
  6. Set Background Process Limit to No background processes
  7. Click Open Activity
  8. 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.
  9. Next run adb shell am start -n com.react_native_crash/.RedirectActivity -d "redirect://crash"
  10. 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the listed ReactActivity and ReactActivityDelegate startup flow, then inspect ReactInstanceManager#onActivityResult alongside setupReactContext and runCreateReactContextOnNewThread. Reproduce the case with the linked react-native-crash project and the adb commands; done means the console reports RESULT and Completed after Return Result, showing the callback reached JavaScript.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java, react-native
Domain
mobile-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.