expo-manifests 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -10,6 +10,20 @@
 
 ### 💡 Others
 
+## 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

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '0.6.0'
+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.6.0'
+    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/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

@@ -230,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 {
@@ -246,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/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)

package/ios/EXManifests/Manifest.swift

@@ -3,7 +3,7 @@
 // this uses abstract class patterns
 // swiftlint:disable unavailable_function
 
-// swiftlint:disable type_body_length
+// swiftlint:disable type_body_length file_length
 
 import Foundation
 import UIKit
@@ -322,6 +322,56 @@ public class Manifest: NSObject {
     return jsEngine
   }
 
+  /**
+   Queries the dedicated package properties in `plugins`
+   */
+  public func getPluginProperties(packageName: String) -> [String: Any]? {
+    typealias PluginWithProps = (String, [String: Any])
+    typealias PluginWithoutProps = String
+    enum PluginType {
+      case withProps (PluginWithProps)
+      case withoutProps (PluginWithoutProps)
+
+      private static func fromRawValue(_ optionalValue: Any?) -> PluginType? {
+        guard let value = optionalValue else {
+          return nil
+        }
+        if let valueArray = value as? [Any],
+          let name = valueArray[0] as? String, let props = valueArray[1] as? [String: Any] {
+          return .withProps((name, props))
+        }
+        if let value = value as? String {
+          return .withoutProps(value)
+        }
+        let exception = NSException(
+          name: NSExceptionName.internalInconsistencyException,
+          reason: "Value for (key = plugins) has incorrect type",
+          userInfo: ["key": "plugins"]
+        )
+        exception.raise()
+        return nil
+      }
+
+      static func fromRawArrayValue(_ value: [Any]) -> [PluginType]? {
+        return value.compactMap { fromRawValue($0) }
+      }
+    }
+
+    guard let pluginsRawValue = expoClientConfigRootObject()?.optionalValue(forKey: "plugins") as [Any]?,
+      let plugins = PluginType.fromRawArrayValue(pluginsRawValue) else {
+      return nil
+    }
+
+    let firstMatchedPlugin = plugins.compactMap { item in
+      if case .withProps(let tuple) = item, tuple.0 == packageName {
+        return tuple
+      }
+      return nil
+    }.first
+
+    return firstMatchedPlugin?.1
+  }
+
   private func expoGoSDKMajorVersion() -> Int {
     let sdkVersion = expoGoSDKVersion()
     let components = sdkVersion?.components(separatedBy: ".")

package/ios/Tests/ManifestSpec.swift

@@ -0,0 +1,38 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+import ExpoModulesTestCore
+
+@testable import EXManifests
+
+final class ManifestSpec: ExpoSpec {
+  override func spec() {
+    describe("getPluginProperties") {
+      it("should return nil when plugin is not matched") {
+        var manifestJson: [String: Any] = [:]
+        var manifest = ManifestFactory.manifest(forManifestJSON: manifestJson)
+        expect(manifest.getPluginProperties(packageName: "test")).to(beNil())
+
+        manifestJson = ["plugins": []]
+        manifest = ManifestFactory.manifest(forManifestJSON: manifestJson)
+        expect(manifest.getPluginProperties(packageName: "test")).to(beNil())
+
+        manifestJson = ["plugins": ["hello"]]
+        manifest = ManifestFactory.manifest(forManifestJSON: manifestJson)
+        expect(manifest.getPluginProperties(packageName: "test")).to(beNil())
+      }
+
+      it("should return nil when the matched plugin has no properties") {
+        let manifestJson = ["plugins": ["test"]]
+        let manifest = ManifestFactory.manifest(forManifestJSON: manifestJson)
+        expect(manifest.getPluginProperties(packageName: "test")).to(beNil())
+      }
+
+      it("should return matched plugin properties") {
+        let manifestJson = ["plugins": [["test", ["foo": "bar"]]]]
+        let manifest = ManifestFactory.manifest(forManifestJSON: manifestJson)
+        let props = manifest.getPluginProperties(packageName: "test")
+        expect(props as? [String: String]) == ["foo": "bar"]
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-manifests",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Code to parse and use Expo and Expo Updates manifests.",
   "main": "index.js",
   "keywords": [
@@ -20,7 +20,7 @@
   "license": "MIT",
   "homepage": "https://docs.expo.dev/versions/latest/sdk/module-template",
   "dependencies": {
-    "expo-json-utils": "~0.6.0"
+    "expo-json-utils": "~0.7.0"
   },
-  "gitHead": "4ba50c428c8369bb6b3a51a860d4898ad4ccbe78"
+  "gitHead": "fa5ecca8251986b9f197cc14074eec0ab6dfb6db"
 }