expo-manifests 0.5.2 → 0.7.0

package/CHANGELOG.md

@@ -10,7 +10,31 @@
 
 ### 💡 Others
 
-## 0.5.2 — 2023-02-21
+## 0.7.0 — 2023-06-21
+
+### 📚 3rd party library updates
+
+- Updated `junit` to `4.13.2`. ([#22395](https://github.com/expo/expo/pull/22395) by [@josephyanks](https://github.com/josephyanks))
+
+### 🎉 New features
+
+- Added `Manifests.getPluginProperties()` helper to query dedicated package's properties inside the `plugins` config. ([#22701](https://github.com/expo/expo/pull/22701) by [@kudo](https://github.com/kudo))
+
+### 🐛 Bug fixes
+
+- Fixed Android build warnings for Gradle version 8. ([#22537](https://github.com/expo/expo/pull/22537), [#22609](https://github.com/expo/expo/pull/22609) by [@kudo](https://github.com/kudo))
+
+## 0.6.0 — 2023-05-08
+
+### 🎉 New features
+
+- Support new SDK version field in new manifests. ([#22356](https://github.com/expo/expo/pull/22356) by [@wschurman](https://github.com/wschurman))
+
+### 💡 Others
+
+- Convert iOS implementation to Swift. ([#21298](https://github.com/expo/expo/pull/21298), [#21648](https://github.com/expo/expo/pull/21648) by [@wschurman](https://github.com/wschurman))
+
+## 0.5.2 - 2023-02-21
 
 ### 🐛 Bug fixes
 

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '0.5.2'
+version = '0.7.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -35,19 +35,11 @@ buildscript {
   }
 }
 
-// Creating sources with comments
-task androidSourcesJar(type: Jar) {
-  classifier = 'sources'
-  from android.sourceSets.main.java.srcDirs
-}
-
 afterEvaluate {
   publishing {
     publications {
       release(MavenPublication) {
         from components.release
-        // Add additional sourcesJar to artifacts
-        artifact(androidSourcesJar)
       }
     }
     repositories {
@@ -70,11 +62,12 @@ android {
     jvmTarget = JavaVersion.VERSION_11.majorVersion
   }
 
+  namespace "expo.modules.manifests"
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 31
-    versionName '0.5.2'
+    versionName '0.7.0'
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
   }
   lintOptions {
@@ -86,21 +79,22 @@ android {
   sourceSets {
     androidTest.assets.srcDirs += files("$projectDir/src/androidTest/schemas".toString())
   }
+  publishing {
+    singleVariant("release") {
+      withSourcesJar()
+    }
+  }
 }
 
 dependencies {
   implementation project(':expo-json-utils')
 
-  testImplementation 'junit:junit:4.12'
-  testImplementation 'androidx.test:core:1.4.0'
-  testImplementation 'org.mockito:mockito-core:1.10.19'
-  testImplementation 'io.mockk:mockk:1.12.3'
-
-  androidTestImplementation 'androidx.test:runner:1.4.0'
-  androidTestImplementation 'androidx.test:core:1.4.0'
-  androidTestImplementation 'androidx.test:rules:1.4.0'
-  androidTestImplementation 'org.mockito:mockito-android:3.7.7'
-  androidTestImplementation 'io.mockk:mockk-android:1.12.3'
+  testImplementation 'junit:junit:4.13.2'
+  testImplementation 'androidx.test:core:1.5.0'
+  testImplementation 'org.mockito:mockito-core:4.0.0'
+  testImplementation 'io.mockk:mockk:1.13.5'
+  testImplementation 'org.json:json:20230227'
+  testImplementation "com.google.truth:truth:1.1.2"
 
   implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${getKotlinVersion()}"
 }

package/android/src/main/AndroidManifest.xml

@@ -1,3 +1,2 @@
-<manifest package="expo.modules.manifests"
-    xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 </manifest>

package/android/src/main/java/expo/modules/manifests/core/BaseLegacyManifest.kt

@@ -18,7 +18,7 @@ abstract class BaseLegacyManifest(json: JSONObject) : Manifest(json) {
   @Throws(JSONException::class)
   override fun getBundleURL(): String = json.require("bundleUrl")
 
-  override fun getSDKVersion(): String? = json.getNullable("sdkVersion")
+  override fun getExpoGoSDKVersion(): String? = json.getNullable("sdkVersion")
 
   override fun getExpoGoConfigRootObject(): JSONObject? {
     return json

package/android/src/main/java/expo/modules/manifests/core/JSONObjectExtension.kt

@@ -0,0 +1,17 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+package expo.modules.manifests.core
+
+import org.json.JSONObject
+
+/**
+ * Convert a [JSONObject] to Map<String, Any> recursively
+ */
+fun JSONObject.toMap(): Map<String, Any> {
+  return keys().asSequence().associateWith {
+    when (val value = this@toMap[it]) {
+      is JSONObject -> value.toMap()
+      else -> value
+    }
+  }
+}

package/android/src/main/java/expo/modules/manifests/core/Manifest.kt

@@ -70,7 +70,11 @@ abstract class Manifest(protected val json: JSONObject) {
 
   fun getMetadata(): JSONObject? = json.getNullable("metadata")
 
-  abstract fun getSDKVersion(): String?
+  /**
+   * Get the SDK version that should be attempted to be used in Expo Go. If no SDK version can be
+   * determined, returns null
+   */
+  abstract fun getExpoGoSDKVersion(): String?
 
   abstract fun getAssets(): JSONArray?
 
@@ -172,7 +176,7 @@ abstract class Manifest(protected val json: JSONObject) {
     var result = expoClientConfig
       ?.getNullable<JSONObject>("android")?.getNullable<String>("jsEngine") ?: expoClientConfig?.getNullable<String>("jsEngine")
     if (result == null) {
-      val sdkVersionComponents = getSDKVersion()?.split(".")
+      val sdkVersionComponents = getExpoGoSDKVersion()?.split(".")
       val sdkMajorVersion = if (sdkVersionComponents?.size == 3) sdkVersionComponents[0].toIntOrNull() else 0
       result = if (sdkMajorVersion in 1..47) "jsc" else "hermes"
     }
@@ -226,6 +230,18 @@ abstract class Manifest(protected val json: JSONObject) {
   @Throws(JSONException::class)
   fun getFacebookAutoInitEnabled(): Boolean = getExpoClientConfigRootObject()!!.require("facebookAutoInitEnabled")
 
+  /**
+   * Queries the dedicated package properties in `plugins`
+   */
+  @Throws(JSONException::class, IllegalArgumentException::class)
+  fun getPluginProperties(packageName: String): Map<String, Any>? {
+    val pluginsRawValue = getExpoClientConfigRootObject()?.getNullable<JSONArray>("plugins") ?: return null
+    val plugins = PluginType.fromRawArrayValue(pluginsRawValue) ?: return null
+    return plugins.filterIsInstance<PluginType.WithProps>()
+      .firstOrNull { it.plugin.first == packageName }
+      ?.plugin?.second
+  }
+
   companion object {
     @JvmStatic fun fromManifestJson(manifestJson: JSONObject): Manifest {
       return when {
@@ -242,3 +258,41 @@ abstract class Manifest(protected val json: JSONObject) {
     }
   }
 }
+
+internal typealias PluginWithProps = Pair<String, Map<String, Any>>
+internal typealias PluginWithoutProps = String
+internal sealed class PluginType {
+  data class WithProps(val plugin: PluginWithProps) : PluginType()
+  data class WithoutProps(val plugin: PluginWithoutProps) : PluginType()
+
+  companion object {
+    @Throws(IllegalArgumentException::class)
+    private fun fromRawValue(value: Any): PluginType? {
+      return when (value) {
+        is JSONArray -> {
+          if (value.length() != 2) {
+            throw IllegalArgumentException("Value for (key = plugins) has incorrect type")
+          }
+          val name = value.get(0) as? String ?: return null
+          val props = value.get(1) as? JSONObject ?: return null
+          WithProps(name to props.toMap())
+        }
+        is String -> {
+          WithoutProps(value)
+        }
+        else -> throw IllegalArgumentException("Value for (key = plugins) has incorrect type")
+      }
+    }
+
+    @Throws(IllegalArgumentException::class)
+    fun fromRawArrayValue(value: JSONArray): List<PluginType> {
+      return mutableListOf<PluginType>().apply {
+        for (i in 0 until value.length()) {
+          fromRawValue(value.get(i))?.let {
+            add(it)
+          }
+        }
+      }
+    }
+  }
+}

package/android/src/main/java/expo/modules/manifests/core/NewManifest.kt

@@ -33,7 +33,8 @@ class NewManifest(json: JSONObject) : Manifest(json) {
   @Throws(JSONException::class)
   override fun getBundleURL(): String = getLaunchAsset().require("url")
 
-  override fun getSDKVersion(): String? {
+  @Deprecated(message = "exposdk:... runtime version is deprecated")
+  private fun getSDKVersionFromRuntimeVersion(): String? {
     val runtimeVersion = getRuntimeVersion()
     if (runtimeVersion == "exposdk:UNVERSIONED") {
       return "UNVERSIONED"
@@ -47,6 +48,10 @@ class NewManifest(json: JSONObject) : Manifest(json) {
     return null
   }
 
+  override fun getExpoGoSDKVersion(): String? {
+    return getExpoClientConfigRootObject()?.getString("sdkVersion") ?: getSDKVersionFromRuntimeVersion()
+  }
+
   @Throws(JSONException::class)
   fun getLaunchAsset(): JSONObject = json.require("launchAsset")
 

package/android/src/test/java/expo/modules/manifests/core/ManifestTest.kt

@@ -0,0 +1,59 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+package expo.modules.manifests.core
+
+import com.google.common.truth.Truth
+import org.json.JSONObject
+import org.junit.Test
+
+class ManifestTest {
+  @Test
+  fun getPluginProperties_emptyManifest_returnsNull() {
+    val manifestJson = JSONObject(emptyMap<String, Any>())
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    Truth.assertThat(manifest.getPluginProperties("test")).isNull()
+  }
+
+  @Test
+  fun getPluginProperties_emptyPlugins_returnsNull() {
+    val manifestJson = JSONObject(mapOf<String, Any>("plugins" to emptyArray<Any>()))
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    Truth.assertThat(manifest.getPluginProperties("test")).isNull()
+  }
+
+  @Test
+  fun getPluginProperties_nonMatchedPlugins_returnsNull() {
+    val manifestJson = JSONObject(mapOf<String, Any>("plugins" to arrayOf("hello")))
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    Truth.assertThat(manifest.getPluginProperties("test")).isNull()
+  }
+
+  @Test
+  fun getPluginProperties_matchedPluginWithoutProps_returnsNull() {
+    val manifestJson = JSONObject(mapOf<String, Any>("plugins" to arrayOf("test")))
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    Truth.assertThat(manifest.getPluginProperties("test")).isNull()
+  }
+
+  @Test
+  fun getPluginProperties_matchedPluginWithProps_returnsProps() {
+    val props = mapOf<String, Any>("foo" to "bar")
+    val pluginWithProp = arrayOf("test", props)
+    val manifestJson = JSONObject(mapOf<String, Any>("plugins" to arrayOf(pluginWithProp)))
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    val result = manifest.getPluginProperties("test")
+    Truth.assertThat(result).isNotNull()
+    Truth.assertThat(result).containsExactlyEntriesIn(props)
+  }
+
+  @Test
+  fun getPluginProperties_matchedPluginWithNestedProps_returnsNestedProps() {
+    val props = mapOf<String, Any>("nested" to mapOf<String, Any>("insideNested" to true))
+    val pluginWithProp = arrayOf("test", props)
+    val manifestJson = JSONObject(mapOf<String, Any>("plugins" to arrayOf(pluginWithProp)))
+    val manifest = Manifest.fromManifestJson(manifestJson)
+    val result = manifest.getPluginProperties("test")
+    Truth.assertThat(result).isNotNull()
+    Truth.assertThat(result).containsExactlyEntriesIn(props)
+  }
+}

package/android/src/{androidTest → test}/java/expo/modules/manifests/core/NewManifestTest.kt

@@ -1,12 +1,9 @@
 package expo.modules.manifests.core
 
-import androidx.test.internal.runner.junit4.AndroidJUnit4ClassRunner
 import org.json.JSONObject
 import org.junit.Assert
 import org.junit.Test
-import org.junit.runner.RunWith
 
-@RunWith(AndroidJUnit4ClassRunner::class)
 class NewManifestTest {
   @Test
   @Throws(Exception::class)
@@ -15,7 +12,7 @@ class NewManifestTest {
     val manifestJson =
       "{\"runtimeVersion\":\"$runtimeVersion\"}"
     val manifest = NewManifest(JSONObject(manifestJson))
-    Assert.assertEquals(manifest.getSDKVersion(), "39.0.0")
+    Assert.assertEquals(manifest.getExpoGoSDKVersion(), "39.0.0")
   }
 
   @Test
@@ -25,7 +22,7 @@ class NewManifestTest {
     val manifestJson =
       "{\"runtimeVersion\":\"$runtimeVersion\"}"
     val manifest = NewManifest(JSONObject(manifestJson))
-    Assert.assertEquals(manifest.getSDKVersion(), "UNVERSIONED")
+    Assert.assertEquals(manifest.getExpoGoSDKVersion(), "UNVERSIONED")
   }
 
   @Test
@@ -43,7 +40,7 @@ class NewManifestTest {
       val manifestJson =
         "{\"runtimeVersion\":\"$runtimeVersion\"}"
       val manifest = NewManifest(JSONObject(manifestJson))
-      Assert.assertNull(manifest.getSDKVersion())
+      Assert.assertNull(manifest.getExpoGoSDKVersion())
     }
   }
 }

package/ios/EXManifests/BareManifest.swift

@@ -0,0 +1,19 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+
+import Foundation
+
+@objc(EXManifestsBareManifest)
+@objcMembers
+public class BareManifest: BaseLegacyManifest {
+  public func rawId() -> String {
+    return rawManifestJSON().requiredValue(forKey: "id")
+  }
+
+  public func commitTimeNumber() -> Int {
+    return rawManifestJSON().requiredValue(forKey: "commitTime")
+  }
+
+  public func metadata() -> [String: Any]? {
+    return rawManifestJSON().optionalValue(forKey: "metadata")
+  }
+}

package/ios/EXManifests/BaseLegacyManifest.swift

@@ -0,0 +1,39 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+
+import Foundation
+
+@objc(EXManifestBaseLegacyManifest)
+@objcMembers
+public class BaseLegacyManifest: Manifest {
+  override func expoClientConfigRootObject() -> [String: Any]? {
+    return rawManifestJSON()
+  }
+
+  override func expoGoConfigRootObject() -> [String: Any]? {
+    return rawManifestJSON()
+  }
+
+  public override func stableLegacyId() -> String {
+    return rawManifestJSON().optionalValue(forKey: "originalFullName") ?? legacyId()
+  }
+
+  public override func scopeKey() -> String {
+    return rawManifestJSON().optionalValue(forKey: "scopeKey") ?? stableLegacyId()
+  }
+
+  public override func easProjectId() -> String? {
+    return rawManifestJSON().optionalValue(forKey: "projectId")
+  }
+
+  public override func bundleUrl() -> String {
+    return rawManifestJSON().requiredValue(forKey: "bundleUrl")
+  }
+
+  public override func expoGoSDKVersion() -> String? {
+    return rawManifestJSON().optionalValue(forKey: "sdkVersion")
+  }
+
+  public func assets() -> [[String: Any]]? {
+    return self.rawManifestJSON().optionalValue(forKey: "assets")
+  }
+}

package/ios/EXManifests/LegacyManifest.swift

@@ -0,0 +1,30 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+import Foundation
+
+@objc(EXManifestsLegacyManifest)
+@objcMembers
+public class LegacyManifest: BaseLegacyManifest {
+  public func releaseID() -> String {
+    return rawManifestJSON().requiredValue(forKey: "releaseId")
+  }
+
+  public func commitTime() -> String {
+    return rawManifestJSON().requiredValue(forKey: "commitTime")
+  }
+
+  public func bundledAssets() -> [Any]? {
+    return rawManifestJSON().optionalValue(forKey: "bundledAssets")
+  }
+
+  public func runtimeVersion() -> Any? {
+    return rawManifestJSON().optionalValue(forKey: "runtimeVersion")
+  }
+
+  public func bundleKey() -> String? {
+    return rawManifestJSON().optionalValue(forKey: "bundleKey")
+  }
+
+  public func assetUrlOverride() -> String? {
+    return rawManifestJSON().optionalValue(forKey: "assetUrlOverride")
+  }
+}