expo-modules-core 0.12.0 → 0.13.1

package/CHANGELOG.md

@@ -10,6 +10,36 @@
 
 ### 💡 Others
 
+## 0.13.1 — 2022-10-27
+
+### 🐛 Bug fixes
+
+- Fixed `~CallbackWrapper()` dangling pointer crashes when reloading the app on Android. ([#19699](https://github.com/expo/expo/pull/19699) by [@kudo](https://github.com/kudo), [@kudo](https://github.com/kudo))
+
+## 0.13.0 — 2022-10-25
+
+### 🛠 Breaking changes
+
+- Convertible enums must inherit from `expo.modules.kotlin.types.Enumerable` on Android. ([#19551](https://github.com/expo/expo/pull/19551) by [@lukmccall](https://github.com/lukmccall))
+- `AppContext.currentActivity` is not longer returning `AppCompatActivity`, but an instance of `android.app.Activity` class. ([#19573](https://github.com/expo/expo/pull/19573) by [@lukmccall](https://github.com/lukmccall))
+
+### ⚠️ Notices
+
+- Deprecated `ConvertibleArgument` in favor of `Convertible` and `EnumArgument` in favor of `Enumerable`. ([#19612](https://github.com/expo/expo/pull/19612) by [@tsapeta](https://github.com/tsapeta))
+
+### 🎉 New features
+
+- Implemented a mechanism for hooking into to the view lifecycle events (introduces new `OnViewDidUpdateProps` definition component). ([#19549](https://github.com/expo/expo/pull/19549) by [@tsapeta](https://github.com/tsapeta))
+
+### 🐛 Bug fixes
+
+- Fixed records aren't correctly converted to JS objects in the release builds on Android. ([#19551](https://github.com/expo/expo/pull/19551) by [@lukmccall](https://github.com/lukmccall))
+- Reject promises with a `CodedError` instead of a plain object. ([#19605](https://github.com/expo/expo/pull/19605) by [@tsapeta](https://github.com/tsapeta))
+
+### 💡 Others
+
+- Simplified dispatching view events. ([#19537](https://github.com/expo/expo/pull/19537) by [@tsapeta](https://github.com/tsapeta))
+
 ## 0.12.0 — 2022-10-06
 
 ### 🛠 Breaking changes
@@ -43,6 +73,7 @@
 - Add the `RegisterActivityContracts` component to register all of activity result contracts on Android. ([#19180](https://github.com/expo/expo/pull/19180) by [@lukmccall](https://github.com/lukmccall))
 - Improves JSI/JNI type conversion to support complex function arguments on Android. ([#19120](https://github.com/expo/expo/pull/19120) & [#19094](https://github.com/expo/expo/pull/19094) by [@lukmccall](https://github.com/lukmccall))
 - Using JSI instead of the bridge to call native methods also on legacy modules on iOS. ([#19209](https://github.com/expo/expo/pull/19209) by [@lukmccall](https://github.com/lukmccall))
+- Added `cacheDirectory` and `persistentFilesDirectory` to `AppContext` on Android to fix cache directories being incorrect in new Sweet API modules. It uses a new `AppDirectoriesModule` to get correct scoped directories from old module API. ([#19205](https://github.com/expo/expo/pull/19205) by [@aleqsio](https://github.com/aleqsio))
 
 ### 🐛 Bug fixes
 
@@ -51,6 +82,7 @@
 - Update gradle excludes to fix detox tests. ([#19254](https://github.com/expo/expo/pull/19254) by [@esamelson](https://github.com/esamelson))
 - Fixed event listeners do not work when running with remote debugging mode on iOS. ([#19211](https://github.com/expo/expo/pull/19211) by [@kudo](https://github.com/kudo))
 - Use shared C++ runtime to reduce library size on Android. ([#19372](https://github.com/expo/expo/pull/19372) by [@kudo](https://github.com/kudo))
+- Fixed `JSCRuntime destroyed with a dangling API object` on Android. ([#19487](https://github.com/expo/expo/pull/19487) by [@lukmccall](https://github.com/lukmccall))
 
 ### 💡 Others
 

package/android/CMakeLists.txt

@@ -85,7 +85,7 @@ if(${UNIT_TEST})
         PATHS ${HERMES_SO_DIR}
         NO_CMAKE_FIND_ROOT_PATH
     )
-    set(JSEXECUTOR_INCLUDE "${HERMES_HEADER_DIR}")
+    set(JSEXECUTOR_INCLUDE ${HERMES_HEADER_DIR} ${HERMES_HEADER_DIR}/API ${HERMES_HEADER_DIR}/public)
   else()
     find_library(
         JSEXECUTOR_LIB

package/android/build.gradle

@@ -6,7 +6,7 @@ apply plugin: 'maven-publish'
 apply plugin: "de.undercouch.download"
 
 group = 'host.exp.exponent'
-version = '0.12.0'
+version = '0.13.1'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -39,12 +39,6 @@ buildscript {
   }
 }
 
-def isAndroidTest = {
-  Gradle gradle = getGradle()
-  String tskReqStr = gradle.getStartParameter().getTaskRequests().toString()
-  return tskReqStr.contains("AndroidTest")
-}.call()
-
 def isExpoModulesCoreTests = {
   Gradle gradle = getGradle()
   String tskReqStr = gradle.getStartParameter().getTaskRequests().toString()
@@ -89,7 +83,12 @@ def currentHermesVersion = file("${REACT_NATIVE_DIR}/sdks/.hermesversion").exist
 def hasHermesProject = findProject(":ReactAndroid:hermes-engine") != null
 def prebuiltHermesCacheHit = hasHermesProject && currentHermesVersion == prebuiltHermesVersion
 
+// By default we are going to download and unzip hermes inside the /sdks/hermes folder
+// but you can provide an override for where the hermes source code is located.
+def hermesDir = System.getenv("REACT_NATIVE_OVERRIDE_HERMES_DIR") ?: file("${REACT_NATIVE_DIR}/sdks/hermes")
+
 def USE_HERMES = false
+def NEED_DOWNLOAD_HERMES = false
 def HERMES_HEADER_DIR = null
 def HERMES_AAR = null
 if (findProject(":app")) {
@@ -114,19 +113,14 @@ if (USE_HERMES) {
     HERMES_HEADER_DIR = file("${thirdPartyNdkDir}/hermes/prefab/modules/libhermes/include")
     HERMES_AAR = file("${REACT_NATIVE_DIR}/ReactAndroid/hermes-engine/build/outputs/aar/hermes-engine-debug.aar")
   } else {
-    // The `hermes-engine` package doesn't contain the correct version of the Hermes.
-    // The AAR we need to import is located in the React Native package.
-    // However, the version from RN doesn't include header files.
-    // To get those, we must fall back to the `hermes-engine` package.
-    def hermesEngineDir = new File(["node", "--print", "require.resolve('hermes-engine/package.json')"].execute(null, rootDir).text.trim()).parent
-
     def prebuiltAAR = fileTree(REACT_NATIVE_DIR).matching { include "**/hermes-engine/**/hermes-engine-*-debug.aar" }
     if (prebuiltAAR.any()) {
       HERMES_AAR = prebuiltAAR.singleFile
     } else {
       HERMES_AAR = file("${hermesEngineDir}/android/hermes-debug.aar")
     }
-    HERMES_HEADER_DIR = file("${hermesEngineDir}/android/include")
+    HERMES_HEADER_DIR = file("${hermesDir}")
+    NEED_DOWNLOAD_HERMES = true
   }
 }
 // END HERMES
@@ -160,6 +154,24 @@ afterEvaluate {
 android {
   compileSdkVersion safeExtGet("compileSdkVersion", 31)
 
+  if (REACT_NATIVE_BUILD_FROM_SOURCE) {
+    if (rootProject.hasProperty("ndkPath")) {
+      ndkPath rootProject.ext.ndkPath
+    }
+    if (rootProject.hasProperty("ndkVersion")) {
+      ndkVersion rootProject.ext.ndkVersion
+    }
+  } else {
+    // This ndkVersion should align to prebuilt react-native building ndkVersion.
+    // Because the unwind library is different before NDK r23 and after,
+    // if we build this library with newer NDK, C++ exceptions are incompatible between these libraries.
+    // For example, C++ exceptions throwing from hermes are not catchable from this library.
+    // Ref: https://android.googlesource.com/platform/ndk/+/master/docs/BuildSystemMaintainers.md#unwinding
+    //
+    // TODO: Revisit this version when upgrade react-native 0.71 (Expo SDK 48)
+    ndkVersion = "21.4.7075529"
+  }
+
   compileOptions {
     sourceCompatibility JavaVersion.VERSION_11
     targetCompatibility JavaVersion.VERSION_11
@@ -174,7 +186,7 @@ android {
     targetSdkVersion safeExtGet("targetSdkVersion", 31)
     consumerProguardFiles 'proguard-rules.pro'
     versionCode 1
-    versionName "0.12.0"
+    versionName "0.13.1"
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled.toString()
 
     testInstrumentationRunner "expo.modules.TestRunner"
@@ -237,15 +249,9 @@ android {
     // In android (instrumental) tests, we want to package all so files to enable our JSI functionality.
     // Otherwise, those files should be excluded, because will be loaded by the application.
     if (isExpoModulesCoreTests) {
-      excludes = []
-      pickFirsts = sharedLibraries
+      pickFirsts += sharedLibraries
     } else {
-      excludes = sharedLibraries
-    }
-    if (isExpoModulesCoreTests || isAndroidTest) {
-      excludes.add("META-INF/MANIFEST.MF")
-      excludes.add("META-INF/com.android.tools/proguard/coroutines.pro")
-      excludes.add("META-INF/proguard/coroutines.pro")
+      excludes += sharedLibraries
     }
   }
 
@@ -469,12 +475,36 @@ task prepareFolly(dependsOn: [downloadFolly], type: Copy) {
   includeEmptyDirs = false
   into("$thirdPartyNdkDir/folly")
 }
-// END FOLLy
+// END FOLLY
+
+task downloadHermes(type: Download) {
+  def hermesVersion = currentHermesVersion ?: "main"
+  src("https://github.com/facebook/hermes/tarball/${hermesVersion}")
+  onlyIfNewer(true)
+  overwrite(false)
+  dest(new File(downloadsDir, "hermes-${hermesVersion}.tar.gz"))
+}
+
+task unzipHermes(dependsOn: downloadHermes, type: Copy) {
+  from(tarTree(downloadHermes.dest)) {
+    eachFile { file ->
+      // We flatten the unzip as the tarball contains a `facebook-hermes-<SHA>`
+      // folder at the top level.
+      if (file.relativePath.segments.size() > 1) {
+        file.relativePath = new org.gradle.api.file.RelativePath(!file.isDirectory(), file.relativePath.segments.drop(1))
+      }
+    }
+  }
+  into(hermesDir)
+}
 
 task prepareHermes(dependsOn: createNativeDepsDirectories) {
   if (!USE_HERMES) {
     return
   }
+  if (NEED_DOWNLOAD_HERMES) {
+    dependsOn(unzipHermes)
+  }
 
   doLast {
     def files = zipTree(HERMES_AAR).matching({ it.include "**/*.so", "prefab/modules/libhermes/include/**/*" })

package/android/proguard-rules.pro

@@ -11,3 +11,10 @@
 -keepclassmembers class * {
   @expo.modules.core.interfaces.DoNotStrip *;
 }
+
+-keep class * implements expo.modules.kotlin.records.Record {
+  *;
+}
+-keepclassmembers enum * implements expo.modules.kotlin.types.Enumerable {
+  *; 
+}

package/android/src/main/cpp/Exceptions.cpp

@@ -46,9 +46,27 @@ jni::local_ref<UnexpectedException> UnexpectedException::create(const std::strin
   );
 }
 
+jsi::Value makeCodedError(
+  jsi::Runtime &rt,
+  jsi::String code,
+  jsi::String message
+) {
+  auto codedErrorConstructor = rt
+    .global()
+    .getProperty(rt, "ExpoModulesCore_CodedError")
+    .asObject(rt)
+    .asFunction(rt);
+
+  return codedErrorConstructor.callAsConstructor(
+    rt, {
+      jsi::Value(rt, code),
+      jsi::Value(rt, message)
+    }
+  );
+}
+
 void rethrowAsCodedError(
   jsi::Runtime &rt,
-  JSIInteropModuleRegistry *registry,
   jni::JniException &jniException
 ) {
   jni::local_ref<jni::JThrowable> unboxedThrowable = jniException.getThrowable();
@@ -57,25 +75,40 @@ void rethrowAsCodedError(
     auto code = codedException->getCode();
     auto message = codedException->getLocalizedMessage();
 
-    auto *codedErrorPointer = registry->jsRegistry->getOptionalObject<jsi::Function>(
-      JSReferencesCache::JSKeys::CODED_ERROR
+    auto codedError = makeCodedError(
+      rt,
+      jsi::String::createFromUtf8(rt, code),
+      jsi::String::createFromUtf8(rt, message.value_or(""))
+    );
+
+    throw jsi::JSError(
+      message.value_or(""),
+      rt,
+      std::move(codedError)
     );
-    if (codedErrorPointer != nullptr) {
-      auto &jsCodedError = *codedErrorPointer;
-
-      throw jsi::JSError(
-        message.value_or(""),
-        rt,
-        jsCodedError.callAsConstructor(
-          rt,
-          jsi::String::createFromUtf8(rt, code),
-          jsi::String::createFromUtf8(rt, message.value_or(""))
-        )
-      );
-    }
   }
 
   // Rethrow error if we can't wrap it.
   throw;
 }
+
+void throwPendingJniExceptionAsCppException() {
+  JNIEnv* env = jni::Environment::current();
+  if (env->ExceptionCheck() == JNI_FALSE) {
+    return;
+  }
+
+  auto throwable = env->ExceptionOccurred();
+  if (!throwable) {
+    throw std::runtime_error("Unable to get pending JNI exception.");
+  }
+  env->ExceptionClear();
+
+  throw jni::JniException(jni::adopt_local(throwable));
+}
+
+void throwNewJavaException(jthrowable throwable) {
+  throw jni::JniException(jni::wrap_alias(throwable));
+}
+
 } // namespace expo

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

@@ -65,7 +65,23 @@ public:
  */
 [[noreturn]] void rethrowAsCodedError(
   jsi::Runtime &rt,
-  JSIInteropModuleRegistry *registry,
   jni::JniException &jniException
 );
+
+jsi::Value makeCodedError(
+  jsi::Runtime &runtime,
+  jsi::String code,
+  jsi::String message
+);
+
+/**
+ * fbjni@0.2.2 is built by ndk r21, its exceptions are not catchable by expo-modules-core built by ndk r23+.
+ * To catch these excetptions, we copy the `facebook::jni::throwPendingJniExceptionAsCppException` here and throw exceptions on our own.
+ */
+void throwPendingJniExceptionAsCppException();
+
+/**
+ * Same as `facebook::jni::throwNewJavaException` but throwing exceptions on our own.
+ */
+[[noreturn]] void throwNewJavaException(jthrowable throwable);
 } // namespace expo

package/android/src/main/cpp/ExpoModulesHostObject.cpp

@@ -12,6 +12,14 @@ namespace expo {
 ExpoModulesHostObject::ExpoModulesHostObject(JSIInteropModuleRegistry *installer)
   : installer(installer) {}
 
+/**
+ * Clears jsi references held by JSRegistry and JavaScriptRuntime. 
+ */
+ExpoModulesHostObject::~ExpoModulesHostObject() {
+  installer->jsRegistry.reset();
+  installer->runtimeHolder.reset();
+}
+
 jsi::Value ExpoModulesHostObject::get(jsi::Runtime &runtime, const jsi::PropNameID &name) {
   auto cName = name.utf8(runtime);
   auto module = installer->getModule(cName);

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

@@ -20,6 +20,8 @@ class ExpoModulesHostObject : public jsi::HostObject {
 public:
   ExpoModulesHostObject(JSIInteropModuleRegistry *installer);
 
+  ~ExpoModulesHostObject() override;
+
   jsi::Value get(jsi::Runtime &, const jsi::PropNameID &name) override;
 
   void set(jsi::Runtime &, const jsi::PropNameID &name, const jsi::Value &value) override;

package/android/src/main/cpp/JNIFunctionBody.cpp

@@ -1,12 +1,14 @@
 // Copyright © 2021-present 650 Industries, Inc. (aka Expo)
 
 #include "JNIFunctionBody.h"
+#include "Exceptions.h"
 #include "JavaReferencesCache.h"
 
 namespace jni = facebook::jni;
 namespace react = facebook::react;
 
 namespace expo {
+
 jni::local_ref<jni::JObject>
 JNIFunctionBody::invoke(jobjectArray args) {
   // Do NOT use getClass here!
@@ -20,7 +22,9 @@ JNIFunctionBody::invoke(jobjectArray args) {
       "([Ljava/lang/Object;)Ljava/lang/Object;"
     );
 
-  return method(this->self(), args);
+  auto result = jni::Environment::current()->CallObjectMethod(this->self(), method.getId(), args);
+  throwPendingJniExceptionAsCppException();
+  return jni::adopt_local(static_cast<jni::JniType<jni::JObject>>(result));
 }
 
 void JNIAsyncFunctionBody::invoke(
@@ -40,6 +44,8 @@ void JNIAsyncFunctionBody::invoke(
       "([Ljava/lang/Object;Lexpo/modules/kotlin/jni/PromiseImpl;)V"
     );
 
-  method(this->self(), args, promise);
+  jni::Environment::current()->CallVoidMethod(this->self(), method.getId(), args, promise);
+  throwPendingJniExceptionAsCppException();
 }
+
 } // namespace expo

package/android/src/main/cpp/JSReferencesCache.cpp

@@ -8,16 +8,6 @@ JSReferencesCache::JSReferencesCache(jsi::Runtime &runtime) {
       runtime.global().getPropertyAsFunction(runtime, "Promise")
     )
   );
-
-  if (runtime.global().hasProperty(runtime, "ExpoModulesCore_CodedError")) {
-    auto jsCodedError = runtime.global()
-      .getPropertyAsFunction(runtime, "ExpoModulesCore_CodedError");
-
-    jsObjectRegistry.emplace(
-      JSKeys::CODED_ERROR,
-      std::make_unique<jsi::Object>(std::move(jsCodedError))
-    );
-  }
 }
 
 jsi::PropNameID &JSReferencesCache::getPropNameID(

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

@@ -21,8 +21,7 @@ namespace expo {
 class JSReferencesCache {
 public:
   enum class JSKeys {
-    PROMISE,
-    CODED_ERROR
+    PROMISE
   };
 
   JSReferencesCache() = delete;

package/android/src/main/cpp/JavaScriptModuleObject.cpp

@@ -72,6 +72,7 @@ void JavaScriptModuleObject::registerSyncFunction(
 
   methodsMetadata.try_emplace(
     cName,
+    longLivedObjectCollection_,
     cName,
     args,
     false,
@@ -90,6 +91,7 @@ void JavaScriptModuleObject::registerAsyncFunction(
 
   methodsMetadata.try_emplace(
     cName,
+    longLivedObjectCollection_,
     cName,
     args,
     true,
@@ -107,6 +109,7 @@ void JavaScriptModuleObject::registerProperty(
   auto cName = name->toStdString();
 
   auto getterMetadata = MethodMetadata(
+    longLivedObjectCollection_,
     cName,
     0,
     false,
@@ -117,6 +120,7 @@ void JavaScriptModuleObject::registerProperty(
   auto types = std::vector<std::unique_ptr<AnyType>>();
   types.push_back(std::make_unique<AnyType>(jni::make_local(expectedArgType)));
   auto setterMetadata = MethodMetadata(
+    longLivedObjectCollection_,
     cName,
     1,
     false,
@@ -135,6 +139,19 @@ void JavaScriptModuleObject::registerProperty(
 JavaScriptModuleObject::HostObject::HostObject(
   JavaScriptModuleObject *jsModule) : jsModule(jsModule) {}
 
+/**
+ * Clears all the JSI references held by the `JavaScriptModuleObject`.
+ */
+JavaScriptModuleObject::HostObject::~HostObject() {
+  if (jsModule->jsiObject != nullptr) {
+    jsModule->jsiObject.reset();
+  }
+  jsModule->methodsMetadata.clear();
+  jsModule->constants.clear();
+  jsModule->properties.clear();
+  jsModule->longLivedObjectCollection_->clear();
+}
+
 jsi::Value JavaScriptModuleObject::HostObject::get(jsi::Runtime &runtime,
                                                    const jsi::PropNameID &name) {
   auto cName = name.utf8(runtime);
@@ -214,4 +231,10 @@ std::vector<jsi::PropNameID> JavaScriptModuleObject::HostObject::getPropertyName
 
   return result;
 }
+
+JavaScriptModuleObject::JavaScriptModuleObject(jni::alias_ref<jhybridobject> jThis)
+  : javaPart_(jni::make_global(jThis)) {
+  longLivedObjectCollection_ = std::make_shared<react::LongLivedObjectCollection>();
+}
+
 } // namespace expo

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

@@ -4,6 +4,7 @@
 
 #include <fbjni/fbjni.h>
 #include <jsi/jsi.h>
+#include <react/bridging/LongLivedObject.h>
 #include <react/jni/ReadableNativeArray.h>
 #include <jni/JCallback.h>
 
@@ -104,6 +105,8 @@ public:
   public:
     HostObject(JavaScriptModuleObject *);
 
+  ~HostObject() override;
+
     jsi::Value get(jsi::Runtime &, const jsi::PropNameID &name) override;
 
     void set(jsi::Runtime &, const jsi::PropNameID &name, const jsi::Value &value) override;
@@ -114,6 +117,9 @@ public:
     JavaScriptModuleObject *jsModule;
   };
 
+private:
+  explicit JavaScriptModuleObject(jni::alias_ref<jhybridobject> jThis);
+
 private:
   friend HybridBase;
   /**
@@ -139,7 +145,10 @@ private:
    */
   std::map<std::string, std::pair<MethodMetadata, MethodMetadata>> properties;
 
-  explicit JavaScriptModuleObject(jni::alias_ref<jhybridobject> jThis)
-    : javaPart_(jni::make_global(jThis)) {}
+  /**
+   * The `LongLivedObjectCollection` to hold `LongLivedObject` (callbacks or promises) for this module.
+   */
+  std::shared_ptr<react::LongLivedObjectCollection> longLivedObjectCollection_;
+
 };
 } // namespace expo

package/android/src/main/cpp/JavaScriptValue.cpp

@@ -78,7 +78,7 @@ std::string JavaScriptValue::kind() {
     return "object";
   }
 
-  jni::throwNewJavaException(
+  throwNewJavaException(
     UnexpectedException::create("Unknown type").get()
   );
 }