expo-modules-core 1.11.0 → 1.11.1

package/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### 💡 Others
 
+## 1.11.1 — 2023-12-12
+
+### 🐛 Bug fixes
+
+- [Android] Fixed `OnCreate` was called before the `React` instance was ready. ([#25866](https://github.com/expo/expo/pull/25866) by [@lukmccall](https://github.com/lukmccall))
+
 ## 1.11.0 — 2023-12-12
 
 ### 🎉 New features

package/android/build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '1.11.0'
+version = '1.11.1'
 
 def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
 if (expoModulesCorePlugin.exists()) {
@@ -143,7 +143,7 @@ android {
   defaultConfig {
     consumerProguardFiles 'proguard-rules.pro'
     versionCode 1
-    versionName "1.11.0"
+    versionName "1.11.1"
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled.toString()
 
     testInstrumentationRunner "expo.modules.TestRunner"

package/android/src/main/java/expo/modules/adapters/react/NativeModulesProxy.java

@@ -97,7 +97,10 @@ public class NativeModulesProxy extends ReactContextBaseJavaModule {
     }
 
     mModuleRegistry.ensureIsInitialized();
-    getKotlinInteropModuleRegistry().installJSIInterop();
+
+    KotlinInteropModuleRegistry kotlinModuleRegistry = getKotlinInteropModuleRegistry();
+    kotlinModuleRegistry.emitOnCreate();
+    kotlinModuleRegistry.installJSIInterop();
 
     Collection<ExportedModule> exportedModules = mModuleRegistry.getAllExportedModules();
 

package/android/src/main/java/expo/modules/kotlin/AppContext.kt

@@ -121,7 +121,7 @@ class AppContext(
       addActivityEventListener(reactLifecycleDelegate)
 
       // Registering modules has to happen at the very end of `AppContext` creation. Some modules need to access
-      // `AppContext` during their initialisation (or during `OnCreate` method), so we need to ensure all `AppContext`'s
+      // `AppContext` during their initialisation, so we need to ensure all `AppContext`'s
       // properties are initialized first. Not having that would trigger NPE.
       registry.register(ErrorManagerModule())
       registry.register(NativeModulesProxyModule())
@@ -131,6 +131,12 @@ class AppContext(
     }
   }
 
+  fun onCreate() = trace("AppContext.onCreate") {
+    registry.readyForPostingEvents()
+    registry.post(EventName.MODULE_CREATE)
+    registry.flushTheEventQueue()
+  }
+
   /**
    * Initializes a JSI part of the module registry.
    * It will be a NOOP if the remote debugging was activated.

package/android/src/main/java/expo/modules/kotlin/KotlinInteropModuleRegistry.kt

@@ -128,6 +128,10 @@ class KotlinInteropModuleRegistry(
     appContext.installJSIInterop()
   }
 
+  fun emitOnCreate() {
+    appContext.onCreate()
+  }
+
   fun setLegacyModulesProxy(proxyModule: NativeModulesProxy) {
     appContext.legacyModulesProxyHolder = WeakReference(proxyModule)
   }

package/android/src/main/java/expo/modules/kotlin/ModuleRegistry.kt

@@ -16,6 +16,10 @@ class ModuleRegistry(
   @PublishedApi
   internal val registry = mutableMapOf<String, ModuleHolder<*>>()
 
+  private val eventQueue = mutableListOf<PostponedEvent>()
+
+  private var isReadyForPostingEvents = false
+
   fun <T : Module> register(module: T) = trace("ModuleRegistry.register(${module.javaClass})") {
     module._appContext = requireNotNull(appContext.get()) { "Cannot create a module for invalid app context." }
 
@@ -30,7 +34,6 @@ class ModuleRegistry(
     }
 
     holder.apply {
-      post(EventName.MODULE_CREATE)
       registerContracts()
     }
 
@@ -73,20 +76,30 @@ class ModuleRegistry(
   }
 
   fun post(eventName: EventName) {
+    if (addToQueueIfNeeded(eventName)) {
+      return
+    }
+
     forEach {
       it.post(eventName)
     }
   }
 
-  @Suppress("UNCHECKED_CAST")
   fun <Sender> post(eventName: EventName, sender: Sender) {
+    if (addToQueueIfNeeded(eventName, sender)) {
+      return
+    }
+
     forEach {
       it.post(eventName, sender)
     }
   }
 
-  @Suppress("UNCHECKED_CAST")
   fun <Sender, Payload> post(eventName: EventName, sender: Sender, payload: Payload) {
+    if (addToQueueIfNeeded(eventName, sender, payload)) {
+      return
+    }
+
     forEach {
       it.post(eventName, sender, payload)
     }
@@ -98,4 +111,60 @@ class ModuleRegistry(
     registry.clear()
     logger.info("✅ ModuleRegistry was destroyed")
   }
+
+  /**
+   * Tell the modules registry it can handle events as they come, without adding them to the event queue.
+   */
+  fun readyForPostingEvents() = synchronized(this) {
+    isReadyForPostingEvents = true
+  }
+
+  fun flushTheEventQueue() = synchronized(this) {
+    eventQueue.forEach { event ->
+      forEach {
+        event.post(it)
+      }
+    }
+    eventQueue.clear()
+  }
+
+  /**
+   * It’s important that the [EventName.MODULE_CREATE] event is emitted first by the registry.
+   * However, some events like [EventName.ACTIVITY_ENTERS_FOREGROUND] are automatically emitted when the catalyst instance is created.
+   * To ensure the correct order of events, we capture all events that are emitted
+   * during the initialization phase and send them back to the modules later.
+   * This way, we can ensure that the order of events is correct.
+   */
+  private fun addToQueueIfNeeded(
+    eventName: EventName,
+    sender: Any? = null,
+    payload: Any? = null
+  ): Boolean = synchronized(this) {
+    if (isReadyForPostingEvents) {
+      return false
+    }
+
+    eventQueue.add(PostponedEvent(eventName, sender, payload))
+    return true
+  }
+
+  data class PostponedEvent(
+    val eventName: EventName,
+    val sender: Any? = null,
+    val payload: Any? = null
+  ) {
+    fun post(moduleHolder: ModuleHolder<*>) {
+      if (sender != null && payload != null) {
+        moduleHolder.post(eventName, sender, payload)
+        return
+      }
+
+      if (sender != null) {
+        moduleHolder.post(eventName, sender)
+        return
+      }
+
+      moduleHolder.post(eventName)
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-modules-core",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "description": "The core of Expo Modules architecture",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -44,5 +44,5 @@
     "@testing-library/react-hooks": "^7.0.1",
     "expo-module-scripts": "^3.0.0"
   },
-  "gitHead": "6aca7ce098ddc667776a3d7cf612adbb985e264a"
+  "gitHead": "298f6e97c5eda609a25e87a7951540480119a403"
 }