react-native-screens 4.2.0 → 4.3.0

package/android/src/main/java/com/swmansion/rnscreens/InsetsObserverProxy.kt

@@ -1,12 +1,15 @@
 package com.swmansion.rnscreens
 
+import android.util.Log
 import android.view.View
 import androidx.core.view.OnApplyWindowInsetsListener
 import androidx.core.view.ViewCompat
 import androidx.core.view.WindowInsetsCompat
+import com.facebook.react.bridge.LifecycleEventListener
+import com.facebook.react.bridge.ReactApplicationContext
 import java.lang.ref.WeakReference
 
-object InsetsObserverProxy : OnApplyWindowInsetsListener {
+object InsetsObserverProxy : OnApplyWindowInsetsListener, LifecycleEventListener {
     private val listeners: ArrayList<OnApplyWindowInsetsListener> = arrayListOf()
     private var eventSourceView: WeakReference<View> = WeakReference(null)
 
@@ -15,8 +18,16 @@ object InsetsObserverProxy : OnApplyWindowInsetsListener {
     // whether this observer has been initially registered.
     private var hasBeenRegistered: Boolean = false
 
+    // Mainly debug variable to log warnings in case we missed some code path regarding
+    // context lifetime handling.
+    private var isObservingContextLifetime: Boolean = false
+
     private var shouldForwardInsetsToView = true
 
+    // Allow only when we have not been registered yet or the view we're observing has been
+    // invalidated due to some lifecycle we have not observed.
+    private val allowRegistration get() = !hasBeenRegistered || eventSourceView.get() == null
+
     override fun onApplyWindowInsets(
         v: View,
         insets: WindowInsetsCompat,
@@ -34,6 +45,34 @@ object InsetsObserverProxy : OnApplyWindowInsetsListener {
         return rollingInsets
     }
 
+    // Call this method to ensure that the observer proxy is
+    // unregistered when apps is destroyed or we change activity.
+    fun registerWithContext(context: ReactApplicationContext) {
+        if (isObservingContextLifetime) {
+            Log.w(
+                "[RNScreens]",
+                "InsetObserverProxy registers on new context while it has not been invalidated on the old one. Please report this as issue at https://github.com/software-mansion/react-native-screens/issues",
+            )
+        }
+
+        isObservingContextLifetime = true
+        context.addLifecycleEventListener(this)
+    }
+
+    override fun onHostResume() = Unit
+
+    override fun onHostPause() = Unit
+
+    override fun onHostDestroy() {
+        val observedView = getObservedView()
+        if (hasBeenRegistered && observedView != null) {
+            ViewCompat.setOnApplyWindowInsetsListener(observedView, null)
+            hasBeenRegistered = false
+            eventSourceView.clear()
+        }
+        isObservingContextLifetime = false
+    }
+
     fun addOnApplyWindowInsetsListener(listener: OnApplyWindowInsetsListener) {
         listeners.add(listener)
     }
@@ -42,16 +81,17 @@ object InsetsObserverProxy : OnApplyWindowInsetsListener {
         listeners.remove(listener)
     }
 
-    fun registerOnView(view: View) {
-        if (!hasBeenRegistered) {
+    /**
+     * @return boolean whether the proxy registered as a listener on a view
+     */
+    fun registerOnView(view: View): Boolean {
+        if (allowRegistration) {
             ViewCompat.setOnApplyWindowInsetsListener(view, this)
             eventSourceView = WeakReference(view)
             hasBeenRegistered = true
-        } else if (getObservedView() != view) {
-            throw IllegalStateException(
-                "[RNScreens] Attempt to register InsetsObserverProxy on $view while it has been already registered on ${getObservedView()}",
-            )
+            return true
         }
+        return false
     }
 
     fun unregister() {

package/android/src/main/java/com/swmansion/rnscreens/RNScreensPackage.kt

@@ -29,6 +29,10 @@ class RNScreensPackage : TurboReactPackage() {
             screenDummyLayoutHelper = ScreenDummyLayoutHelper(reactContext)
         }
 
+        // Proxy needs to register for lifecycle events in order to unregister itself
+        // on activity restarts.
+        InsetsObserverProxy.registerWithContext(reactContext)
+
         return listOf<ViewManager<*, *>>(
             ScreenContainerViewManager(),
             ScreenViewManager(),

package/android/src/main/java/com/swmansion/rnscreens/Screen.kt

@@ -17,6 +17,7 @@ import androidx.swiperefreshlayout.widget.SwipeRefreshLayout
 import com.facebook.react.bridge.GuardedRunnable
 import com.facebook.react.bridge.ReactContext
 import com.facebook.react.uimanager.PixelUtil
+import com.facebook.react.uimanager.ReactClippingViewGroup
 import com.facebook.react.uimanager.UIManagerHelper
 import com.facebook.react.uimanager.UIManagerModule
 import com.facebook.react.uimanager.events.EventDispatcher
@@ -383,6 +384,7 @@ class Screen(
         parent?.let {
             for (i in 0 until it.childCount) {
                 val child = it.getChildAt(i)
+
                 if (parent is SwipeRefreshLayout && child is ImageView) {
                     // SwipeRefreshLayout class which has CircleImageView as a child,
                     // does not handle `startViewTransition` properly.
@@ -394,20 +396,35 @@ class Screen(
                 } else {
                     child?.let { view -> it.startViewTransition(view) }
                 }
+
                 if (child is ScreenStackHeaderConfig) {
                     // we want to start transition on children of the toolbar too,
                     // which is not a child of ScreenStackHeaderConfig
                     startTransitionRecursive(child.toolbar)
                 }
+
                 if (child is ViewGroup) {
                     // The children are miscounted when there's removeClippedSubviews prop
                     // set to true (which is the default for FlatLists).
                     // Unless the child is a ScrollView it's safe to assume that it's true
                     // and add a simple view for each possibly clipped item to make it work as expected.
                     // See https://github.com/software-mansion/react-native-screens/pull/2495
-                    if (child !is ReactScrollView && child !is ReactHorizontalScrollView) {
-                        for (j in 0 until child.childCount) {
-                            child.addView(View(context))
+
+                    if (child is ReactClippingViewGroup &&
+                        child.removeClippedSubviews &&
+                        child !is ReactScrollView &&
+                        child !is ReactHorizontalScrollView
+                    ) {
+                        // We need to workaround the issue until our changes land in core.
+                        // Some views do not accept any children or have set amount and they throw
+                        // when we want to brute-forcefully manipulate that.
+                        // Is this ugly? Very. Do we have better option before changes land in core?
+                        // I'm not aware of any.
+                        try {
+                            for (j in 0 until child.childCount) {
+                                child.addView(View(context))
+                            }
+                        } catch (_: Exception) {
                         }
                     }
                     startTransitionRecursive(child)

package/android/src/main/java/com/swmansion/rnscreens/bottomsheet/DimmingFragment.kt

@@ -208,7 +208,7 @@ class DimmingFragment(
     override fun onStart() {
         // This is the earliest we can access child fragment manager & present another fragment
         super.onStart()
-        insetsProxy.registerOnView(requireRootView())
+        insetsProxy.registerOnView(requireDecorView())
         presentNestedFragment()
     }
 
@@ -307,7 +307,7 @@ class DimmingFragment(
             }
     }
 
-    private fun requireRootView(): View =
+    private fun requireDecorView(): View =
         checkNotNull(screen.reactContext.currentActivity) { "[RNScreens] Attempt to access activity on detached context" }
             .window.decorView
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-screens",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Native navigation primitives for your React Native app.",
   "scripts": {
     "submodules": "git submodule update --init --recursive && (cd react-navigation && yarn)",