expo-modules-core 1.11.3 → 1.11.4

package/CHANGELOG.md

@@ -10,12 +10,17 @@
 
 ### 💡 Others
 
+## 1.11.4 — 2023-12-21
+
+_This version does not introduce any user-facing changes._
+
 ## 1.11.3 — 2023-12-19
 
 ### 🐛 Bug fixes
 
 - [iOS] Fixed `SharedObjectRegistry` crash for accessing internal data structures from multi-threads. ([#25997](https://github.com/expo/expo/pull/25997) by [@kudo](https://github.com/kudo))
 - Fixed splash screen view flickering in dark mode on iOS. ([#26015](https://github.com/expo/expo/pull/26015), [#26029](https://github.com/expo/expo/pull/26029) by [@kudo](https://github.com/kudo))
+- Fixed `SharedObject` leakage on Android. ([#25995](https://github.com/expo/expo/pull/25995) by [@kudo](https://github.com/kudo))
 
 ## 1.11.2 — 2023-12-15
 

package/android/build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '1.11.3'
+version = '1.11.4'
 
 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.3"
+    versionName "1.11.4"
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled.toString()
 
     testInstrumentationRunner "expo.modules.TestRunner"

package/android/src/main/cpp/JavaScriptObject.cpp

@@ -4,6 +4,7 @@
 #include "JavaScriptValue.h"
 #include "JavaScriptFunction.h"
 #include "JavaScriptRuntime.h"
+#include "JavaScriptWeakObject.h"
 #include "JSITypeConverter.h"
 #include "ObjectDeallocator.h"
 #include "JavaReferencesCache.h"
@@ -15,6 +16,7 @@ void JavaScriptObject::registerNatives() {
                    makeNativeMethod("hasProperty", JavaScriptObject::jniHasProperty),
                    makeNativeMethod("getProperty", JavaScriptObject::jniGetProperty),
                    makeNativeMethod("getPropertyNames", JavaScriptObject::jniGetPropertyNames),
+                   makeNativeMethod("createWeak", JavaScriptObject::createWeak),
                    makeNativeMethod("setBoolProperty", JavaScriptObject::setProperty<bool>),
                    makeNativeMethod("setDoubleProperty", JavaScriptObject::setProperty<double>),
                    makeNativeMethod("setStringProperty",
@@ -109,6 +111,14 @@ jni::local_ref<jni::JArrayClass<jstring>> JavaScriptObject::jniGetPropertyNames(
   return paredResult;
 }
 
+jni::local_ref<jni::HybridClass<JavaScriptWeakObject, Destructible>::javaobject> JavaScriptObject::createWeak() {
+  return JavaScriptWeakObject::newInstance(
+    runtimeHolder.getModuleRegistry(),
+    runtimeHolder,
+    get()
+  );
+}
+
 jni::local_ref<JavaScriptFunction::javaobject> JavaScriptObject::jniAsFunction() {
   auto &jsRuntime = runtimeHolder.getJSRuntime();
   auto jsFuncion = std::make_shared<jsi::Function>(jsObject->asFunction(jsRuntime));
@@ -167,7 +177,7 @@ void JavaScriptObject::defineNativeDeallocator(
     rt,
     jsObject,
     [globalRef = std::move(globalRef)]() mutable {
-      auto args = jni::Environment::current()->NewObjectArray(
+      auto args = jni::Environment::ensureCurrentThreadIsAttached()->NewObjectArray(
         0,
         JavaReferencesCache::instance()->getJClass("java/lang/Object").clazz,
         nullptr

package/android/src/main/cpp/JavaScriptObject.h

@@ -19,9 +19,11 @@ namespace jni = facebook::jni;
 namespace jsi = facebook::jsi;
 
 namespace expo {
-class JavaScriptValue;
 
 class JavaScriptFunction;
+class JavaScriptValue;
+class JavaScriptWeakObject;
+
 
 /**
  * Represents any JavaScript object. Its purpose is to exposes `jsi::Object` API back to Kotlin.
@@ -91,6 +93,8 @@ private:
 
   jni::local_ref<jni::JArrayClass<jstring>> jniGetPropertyNames();
 
+  jni::local_ref<jni::HybridClass<JavaScriptWeakObject, Destructible>::javaobject> createWeak();
+
   jni::local_ref<jni::HybridClass<JavaScriptFunction, Destructible>::javaobject> jniAsFunction();
 
   /**

package/android/src/main/cpp/JavaScriptWeakObject.cpp

@@ -0,0 +1,49 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#include "JavaScriptWeakObject.h"
+#include "JSIInteropModuleRegistry.h"
+
+namespace expo {
+
+void JavaScriptWeakObject::registerNatives() {
+  registerHybrid({
+      makeNativeMethod("lock", JavaScriptWeakObject::lock),
+  });
+}
+
+jni::local_ref<JavaScriptObject::javaobject> JavaScriptWeakObject::lock() {
+  jsi::Runtime &rt = _runtimeHolder.getJSRuntime();
+
+  jsi::Value value = _weakObject->lock(rt);
+  if (value.isUndefined()) {
+    return nullptr;
+  }
+  std::shared_ptr<jsi::Object> objectPtr =
+      std::make_shared<jsi::Object>(value.asObject(rt));
+  if (!objectPtr) {
+    return nullptr;
+  }
+  return JavaScriptObject::newInstance(_runtimeHolder.getModuleRegistry(),
+                                       _runtimeHolder, objectPtr);
+}
+
+jni::local_ref<jni::HybridClass<JavaScriptWeakObject, Destructible>::javaobject>
+JavaScriptWeakObject::newInstance(
+    JSIInteropModuleRegistry *jsiInteropModuleRegistry,
+    std::weak_ptr<JavaScriptRuntime> runtime,
+    std::shared_ptr<jsi::Object> jsObject) {
+  auto weakObject = JavaScriptWeakObject::newObjectCxxArgs(std::move(runtime),
+                                                           std::move(jsObject));
+  jsiInteropModuleRegistry->jniDeallocator->addReference(weakObject);
+  return weakObject;
+}
+
+JavaScriptWeakObject::JavaScriptWeakObject(
+    WeakRuntimeHolder runtime, std::shared_ptr<jsi::Object> jsObject)
+    : _runtimeHolder(std::move(runtime)) {
+  _runtimeHolder.ensureRuntimeIsValid();
+  jsi::Runtime &rt = _runtimeHolder.getJSRuntime();
+  _weakObject = std::make_shared<jsi::WeakObject>(rt, *jsObject);
+}
+
+} // namespace expo

package/android/src/main/cpp/JavaScriptWeakObject.h

@@ -0,0 +1,52 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#pragma once
+
+#include "JNIDeallocator.h"
+#include "JavaScriptObject.h"
+#include "WeakRuntimeHolder.h"
+
+#include <fbjni/fbjni.h>
+#include <jsi/jsi.h>
+
+#include <memory>
+
+namespace jni = facebook::jni;
+namespace jsi = facebook::jsi;
+
+namespace expo {
+
+class JavaScriptObject;
+
+/**
+ * Represents to a jsi::WeakObject.
+ */
+class JavaScriptWeakObject
+    : public jni::HybridClass<JavaScriptWeakObject, Destructible> {
+public:
+  static auto constexpr kJavaDescriptor =
+      "Lexpo/modules/kotlin/jni/JavaScriptWeakObject;";
+  static auto constexpr TAG = "JavaScriptWeakObject";
+
+  static void registerNatives();
+
+  static jni::local_ref<
+      jni::HybridClass<JavaScriptWeakObject, Destructible>::javaobject>
+  newInstance(JSIInteropModuleRegistry *jsiInteropModuleRegistry,
+              std::weak_ptr<JavaScriptRuntime> runtime,
+              std::shared_ptr<jsi::Object> jsObject);
+
+  jni::local_ref<JavaScriptObject::javaobject> lock();
+
+private:
+  JavaScriptWeakObject(WeakRuntimeHolder runtime,
+                       std::shared_ptr<jsi::Object> jsObject);
+
+private:
+  friend HybridBase;
+
+  WeakRuntimeHolder _runtimeHolder;
+  std::shared_ptr<jsi::WeakObject> _weakObject;
+};
+
+} // namespace expo

package/android/src/main/java/expo/modules/kotlin/jni/JavaScriptObject.kt

@@ -43,6 +43,8 @@ open class JavaScriptObject @DoNotStrip internal constructor(@DoNotStrip private
   }
 
   external fun getPropertyNames(): Array<String>
+  external fun createWeak(): JavaScriptWeakObject
+
   private external fun setBoolProperty(name: String, value: Boolean)
   private external fun setDoubleProperty(name: String, value: Double)
   private external fun setStringProperty(name: String, value: String?)

package/android/src/main/java/expo/modules/kotlin/jni/JavaScriptWeakObject.kt

@@ -0,0 +1,22 @@
+package expo.modules.kotlin.jni
+
+import com.facebook.jni.HybridData
+import expo.modules.core.interfaces.DoNotStrip
+
+/**
+ * A Kotlin representation to a jsi::WeakObject
+ * Should be used only on the runtime thread.
+ */
+@Suppress("KotlinJniMissingFunction")
+@DoNotStrip
+class JavaScriptWeakObject @DoNotStrip internal constructor(@DoNotStrip private val mHybridData: HybridData) : Destructible {
+  @Throws(Throwable::class)
+  protected fun finalize() {
+    deallocate()
+  }
+
+  override fun deallocate() {
+    mHybridData.resetNative()
+  }
+  external fun lock(): JavaScriptObject
+}

package/android/src/main/java/expo/modules/kotlin/sharedobjects/SharedObject.kt

@@ -9,4 +9,9 @@ open class SharedObject {
    * When the object is not linked with any JavaScript object, its value is 0.
    */
   internal var sharedObjectId: SharedObjectId = SharedObjectId(0)
+
+  /**
+   * Called when the shared object being deallocated.
+   */
+  open fun deallocate() {}
 }

package/android/src/main/java/expo/modules/kotlin/sharedobjects/SharedObjectRegistry.kt

@@ -2,6 +2,7 @@ package expo.modules.kotlin.sharedobjects
 
 import expo.modules.kotlin.AppContext
 import expo.modules.kotlin.jni.JavaScriptObject
+import expo.modules.kotlin.jni.JavaScriptWeakObject
 
 @JvmInline
 value class SharedObjectId(val value: Int) {
@@ -15,8 +16,7 @@ value class SharedObjectId(val value: Int) {
   }
 }
 
-// TODO(@lukmccall): use weak ref to hold js object
-typealias SharedObjectPair = Pair<SharedObject, JavaScriptObject>
+typealias SharedObjectPair = Pair<SharedObject, JavaScriptWeakObject>
 
 const val sharedObjectIdPropertyName = "__expo_shared_object_id__"
 
@@ -25,7 +25,7 @@ class SharedObjectRegistry {
 
   internal var pairs = mutableMapOf<SharedObjectId, SharedObjectPair>()
 
-  private fun pullNextId(): SharedObjectId {
+  private fun pullNextId(): SharedObjectId = synchronized(this) {
     val current = currentId
     currentId = SharedObjectId(current.value + 1)
     return current
@@ -40,21 +40,27 @@ class SharedObjectRegistry {
       delete(id)
     }
 
-    pairs[id] = native to js
+    val jsWeakObject = js.createWeak()
+    synchronized(this) {
+      pairs[id] = native to jsWeakObject
+    }
     return id
   }
 
   internal fun delete(id: SharedObjectId) {
-    pairs.remove(id)?.let { (native, js) ->
+    val removedObject: SharedObjectPair? = synchronized(this) {
+      return@synchronized pairs.remove(id)
+    }
+    removedObject?.let { (native, js) ->
       native.sharedObjectId = SharedObjectId(0)
-      if (js.isValid()) {
-        js.defineProperty(sharedObjectIdPropertyName, 0)
-      }
+      native.deallocate()
     }
   }
 
   internal fun toNativeObject(id: SharedObjectId): SharedObject? {
-    return pairs[id]?.first
+    return synchronized(this) {
+      pairs[id]?.first
+    }
   }
 
   internal fun toNativeObject(js: JavaScriptObject): SharedObject? {
@@ -67,6 +73,8 @@ class SharedObjectRegistry {
   }
 
   internal fun toJavaScriptObject(native: SharedObject): JavaScriptObject? {
-    return pairs[native.sharedObjectId]?.second
+    return synchronized(this) {
+      pairs[native.sharedObjectId]?.second?.lock()
+    }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-modules-core",
-  "version": "1.11.3",
+  "version": "1.11.4",
   "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": "43f1b4f8a5a9bca649e4e7ca6e4155482a162431"
+  "gitHead": "36402c8b2bc9b63f003c04642d97bf091b35fe16"
 }