Logging a soft error when ReactRootView has an id other than -1 instead of crashing the app in hybrid apps.

[KunalFarmah98]

Summary

As per commit: 4f3b174 which states that "React Native requires that the RootView id be managed entirely by React Native, and will crash in addRootView/startSurface if the native View id isn't set to NO_ID."

This behaviour can not be guaranteed in hybrid apps that have a native android layer over which ReactRootViews are added and the native views need to have ids on them in order to work. The control of views can jump back and forth between native android and react-native (fabric). As the ReactRootView is added to ViewGroups (or layouts) in Android Fragments and Activities, they contain ids on their views which might get passed down to the reactRootView by features like DataBinding

Hence this can cause unnecessary crashes at runtime for hybrid apps even when they are not changing the id of the reactRootView object they are adding to their ViewGroups.

Our app is a hybrid app that uses both native android and react-native on different screens and on one such screen that has a Fragment adding a ReactRootView to its FrameLayout to render native android views to render in ReactNative, this crash occurs on pressing the back button as well as on unlocking the screen while staying on the same screen.

The app was running fine on more than a 100 million devices on React Native 0.63.4 but after updating to 0.67.2, that features this commit, it crashes on the very first device it was tested on.

Refer to the issue: #33121 for more information on the crash

The fragment in which this issues arises is like this:

binding.frameLayout.addView(getReactRootView())

where getReactRootView() is like this:

    private var mReactRootView: ReactRootView? = null
    private var mReactInstanceManager: ReactInstanceManager? = null

    mReactRootView = ReactRootView(context)

        if (activity != null) {
            val application = activity?.application
            if (application is MainApplication) {
                mReactInstanceManager = application.reactInstanceManager
            }
        }

      fun getReactRootView():View?{
         return  mReactRootView
      }

So converting this to a soft exception such that pure react-native devs can still see the error while hybrid apps continue to run without crashes.

Snippet of the change:

if (getId() != View.NO_ID) {
        ReactSoftExceptionLogger.logSoftException(
            TAG,
            new IllegalViewOperationException(
              "Trying to attach a ReactRootView with an explicit id already set to ["
                  + getId()
                  + "]. React Native uses the id field to track react tags and will overwrite this"
                  + " field. If that is fine, explicitly overwrite the id field to View.NO_ID."));
    }

Changelog

[GENERAL] [ADDED] - A ReactSoftException log instead of a direct exception being thrown:

if (getId() != View.NO_ID) {
        ReactSoftExceptionLogger.logSoftException(
            TAG,
            new IllegalViewOperationException(
              "Trying to attach a ReactRootView with an explicit id already set to ["
                  + getId()
                  + "]. React Native uses the id field to track react tags and will overwrite this"
                  + " field. If that is fine, explicitly overwrite the id field to View.NO_ID."));
    }

[GENERAL] [REMOVED]- Directly throwing an exception even when the code is not responsible for this issue:

if (getId() != View.NO_ID) {
      throw new IllegalViewOperationException(
          "Trying to attach a ReactRootView with an explicit id already set to ["
              + getId()
              + "]. React Native uses the id field to track react tags and will overwrite this"
              + " field. If that is fine, explicitly overwrite the id field to View.NO_ID.");
    }

Test Plan

This crash is hard to reproduce but when it occurs, this is the only way to fix it.
If any app used to crash with this exact error, it will no longer crash but show an error log in Logcat for developers to be informed about the issue.

[analysis-bot]

Platform	Engine	Arch	Size (bytes)	Diff
ios	-	universal	n/a	--

Base commit: 062c1f7
Branch: main

[analysis-bot]

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	8,189,013	+757
android	hermes	armeabi-v7a	7,789,443	+1,064
android	hermes	x86	8,559,101	+896
android	hermes	x86_64	8,511,484	+239
android	jsc	arm64-v8a	9,857,573	+117
android	jsc	armeabi-v7a	8,842,892	+767
android	jsc	x86	9,824,271	+767
android	jsc	x86_64	10,420,738	+65

Base commit: 062c1f7
Branch: main

[facebook-github-bot]

@cortinico has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[KunalFarmah98]

@cortinico has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

The ios failure seems to be an intermittent one, rest 2 are warnings I guess.

[KunalFarmah98]

@cortinico, do I need to reindent the code?

[cortinico]

@cortinico, do I need to reindent the code?

Nope. We'll review this internally and get back to you (ping @JoshuaGross)

[KunalFarmah98]

@cortinico Why has this PR been closed?

[cortinico]

@cortinico Why has this PR been closed?

That's a bug in our infrastructure, not idea what happened exactly. I've re-fired the tests internally as there were some failures, and this might have triggered it. I've reopened it.

[KunalFarmah98]

@cortinico Why has this PR been closed?

That's a bug in our infrastructure, not idea what happened exactly. I've re-fired the tests internally as there were some failures, and this might have triggered it. I've reopened it.

Oh. Can you check my other PR as well. Both were opened on the same day. It also has been closed.
#33123

[KunalFarmah98]

Also can you check if any modifications are required from my side?

[cortinico]

Also can you check if any modifications are required from my side?

You're good to go. Let me get back to you next week

[react-native-bot]

This pull request was successfully merged by @Kunal-Airtel2022 in 1ca2c24.

^{When will my fix make it into a release? | Upcoming Releases}

[cortinico]

Sorry this took a bit longer to get merged @KunalFarmah98

[KunalFarmah98]

Sorry this took a bit longer to get merged @KunalFarmah98

No Issues @cortinico