expo-manifests 0.5.2 → 0.6.0

package/CHANGELOG.md

@@ -10,7 +10,17 @@
 
 ### 💡 Others
 
-## 0.5.2 — 2023-02-21
+## 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.6.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -74,7 +74,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 31
-    versionName '0.5.2'
+    versionName '0.6.0'
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
   }
   lintOptions {

package/android/src/androidTest/java/expo/modules/manifests/core/NewManifestTest.kt

@@ -15,7 +15,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 +25,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 +43,7 @@ class NewManifestTest {
       val manifestJson =
         "{\"runtimeVersion\":\"$runtimeVersion\"}"
       val manifest = NewManifest(JSONObject(manifestJson))
-      Assert.assertNull(manifest.getSDKVersion())
+      Assert.assertNull(manifest.getExpoGoSDKVersion())
     }
   }
 }

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/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"
     }

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/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")
+  }
+}

package/ios/EXManifests/Manifest.swift

@@ -0,0 +1,363 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+
+// this uses abstract class patterns
+// swiftlint:disable unavailable_function
+
+// swiftlint:disable type_body_length
+
+import Foundation
+import UIKit
+
+/**
+ Uses objective-c NSExceptions for field validation. This is to maintain
+ backwards compatibility with the previous objective-c implementation so that we don't need to do
+ error handling at every callsite. When all the code is swift, we might be able to use these exceptions.
+ */
+public extension Dictionary where Key == String {
+  func optionalValue<T>(forKey: String) -> T? {
+    guard let value = self[forKey] else {
+      return nil
+    }
+
+    if !(value is T) {
+      let exception = NSException(
+        name: NSExceptionName.internalInconsistencyException,
+        reason: "Value for (key = \(forKey)) has incorrect type",
+        userInfo: ["key": forKey]
+      )
+      exception.raise()
+    }
+    return value as? T
+  }
+
+  func requiredValue<T>(forKey: String) -> T {
+    let value = self[forKey]
+
+    if value == nil {
+      let exception = NSException(
+        name: NSExceptionName.internalInconsistencyException,
+        reason: "Value for (key = \(forKey)) is null",
+        userInfo: ["key": forKey]
+      )
+      exception.raise()
+    }
+
+    if !(value is T) {
+      let exception = NSException(
+        name: NSExceptionName.internalInconsistencyException,
+        reason: "Value for (key = \(forKey)) has incorrect type",
+        userInfo: ["key": forKey]
+      )
+      exception.raise()
+    }
+
+    // exception above will preempt force_cast
+    // swiftlint:disable:next force_cast
+    return value as! T
+  }
+}
+
+public extension Optional {
+  func `let`<U>(_ transform: (_ it: Wrapped) throws -> U?) rethrows -> U? {
+    if let x = self {
+      return try transform(x)
+    }
+    return nil
+  }
+}
+
+@objc(EXManifestsManifest)
+@objcMembers
+public class Manifest: NSObject {
+  private let rawManifestJSONInternal: [String: Any]
+
+  public required init(rawManifestJSON: [String: Any]) {
+    rawManifestJSONInternal = rawManifestJSON
+  }
+
+  public override var debugDescription: String {
+    return rawManifestJSONInternal.description
+  }
+
+  public func rawManifestJSON() -> [String: Any] {
+    return rawManifestJSONInternal
+  }
+
+  // MARK: - Abstract methods
+
+  /**
+   A best-effort immutable legacy ID for this experience. Stable through project transfers.
+   Should be used for calling Expo and EAS APIs during their transition to easProjectId.
+   */
+  @available(*, deprecated, message: "Prefer scopeKey or easProjectId depending on use case")
+  public func stableLegacyId() -> String {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  /**
+   A stable immutable scoping key for this experience. Should be used for scoping data on the
+   client for this project when running in Expo Go.
+   */
+  public func scopeKey() -> String {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  /**
+   A stable UUID for this EAS project. Should be used to call EAS APIs.
+   */
+  public func easProjectId() -> String? {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  /**
+   Get the SDK version that should be attempted to be used in Expo Go. If no SDK version can be
+   determined, returns null
+   */
+  public func expoGoSDKVersion() -> String? {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  public func bundleUrl() -> String {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  func expoGoConfigRootObject() -> [String: Any]? {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  func expoClientConfigRootObject() -> [String: Any]? {
+    preconditionFailure("Must override in concrete class")
+  }
+
+  // MARK: - Field Getters
+  /**
+   The legacy ID of this experience.
+   - For Bare manifests, formatted as a UUID.
+   - For Legacy manifests, formatted as @owner/slug. Not stable through project transfers.
+   - For New manifests, currently incorrect value is UUID.
+   Use this in cases where an identifier of the current manifest is needed (experience loading for example).
+   Use scopeKey for cases where a stable key is needed to scope data to this experience.
+   Use easProjectId for cases where a stable UUID identifier of the experience is needed to identify over EAS APIs.
+   Use stableLegacyId for cases where a stable legacy format identifier of the experience is needed
+    (experience scoping for example).
+   */
+  @available(*, deprecated, message: "Prefer scopeKey or projectId depending on use case")
+  public func legacyId() -> String {
+    return rawManifestJSONInternal.requiredValue(forKey: "id")
+  }
+
+  public func revisionId() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "revisionId")
+  }
+
+  public func slug() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "slug")
+  }
+
+  public func appKey() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "appKey")
+  }
+
+  public func isVerified() -> Bool {
+    return rawManifestJSONInternal.optionalValue(forKey: "isVerified") ?? false
+  }
+
+  public func name() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "name")
+  }
+
+  public func version() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "version")
+  }
+
+  public func notificationPreferences() -> [String: Any]? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "notification")
+  }
+
+  public func updatesInfo() -> [String: Any]? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "updates")
+  }
+
+  public func iosConfig() -> [String: Any]? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "ios")
+  }
+
+  public func hostUri() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "hostUri")
+  }
+
+  public func orientation() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "orientation")
+  }
+
+  public func experiments() -> [String: Any]? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "experiments")
+  }
+
+  public func developer() -> [String: Any]? {
+    return expoGoConfigRootObject()?.optionalValue(forKey: "developer")
+  }
+
+  public func logUrl() -> String? {
+    return expoGoConfigRootObject()?.optionalValue(forKey: "logUrl")
+  }
+
+  public func facebookAppId() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "facebookAppId")
+  }
+
+  public func facebookApplicationName() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "facebookDisplayName")
+  }
+
+  public func facebookAutoInitEnabled() -> Bool {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "facebookAutoInitEnabled") ?? false
+  }
+
+  // MARK: - Derived Methods
+  public func isDevelopmentMode() -> Bool {
+    guard let expoGoConfigRootObject = expoGoConfigRootObject(),
+      let packagerOptsConfig: [String: Any]? = expoGoConfigRootObject.optionalValue(forKey: "packagerOpts"),
+      let dev = packagerOptsConfig?["dev"] else {
+      return false
+    }
+
+    if developer() == nil {
+      return false
+    }
+
+    guard let dev = dev as? Bool else {
+      return false
+    }
+    return dev
+  }
+
+  public func isDevelopmentSilentLaunch() -> Bool {
+    guard let expoGoConfigRootObject = expoGoConfigRootObject(),
+      let developmentClientSettings: [String: Any]? =
+        expoGoConfigRootObject.optionalValue(forKey: "developmentClient"),
+      let silentLaunch = developmentClientSettings?["silentLaunch"] else {
+      return false
+    }
+
+    guard let silentLaunch = silentLaunch as? Bool else {
+      return false
+    }
+    return silentLaunch
+  }
+
+  public func isUsingDeveloperTool() -> Bool {
+    return developer()?["tool"] != nil
+  }
+
+  public func userInterfaceStyle() -> String? {
+    return iosConfig()?.optionalValue(forKey: "userInterfaceStyle") ??
+    (expoClientConfigRootObject()?.optionalValue(forKey: "userInterfaceStyle"))
+  }
+
+  public func iosOrRootBackgroundColor() -> String? {
+    return iosConfig()?.optionalValue(forKey: "backgroundColor") ??
+    (expoClientConfigRootObject()?.optionalValue(forKey: "backgroundColor"))
+  }
+
+  public func iosSplashBackgroundColor() -> String? {
+    return expoClientConfigRootObject().let { it in
+      Manifest.string(fromManifest: it, atPaths: [
+        ["ios", "splash", "backgroundColor"],
+        ["splash", "backgroundColor"]
+      ])
+    }
+  }
+
+  public func iosSplashImageUrl() -> String? {
+    return expoClientConfigRootObject().let { it in
+      Manifest.string(fromManifest: it, atPaths: [
+        UIDevice.current.userInterfaceIdiom == UIUserInterfaceIdiom.pad
+          ? ["ios", "splash", "tabletImageUrl"] : [],
+        ["ios", "splash", "imageUrl"],
+        ["splash", "imageUrl"]
+      ])
+    }
+  }
+
+  public func iosSplashImageResizeMode() -> String? {
+    return expoClientConfigRootObject().let { it in
+      Manifest.string(fromManifest: it, atPaths: [
+        ["ios", "splash", "resizeMode"],
+        ["splash", "resizeMode"]
+      ])
+    }
+  }
+
+  public func iosGoogleServicesFile() -> String? {
+    return iosConfig()?.optionalValue(forKey: "googleServicesFile")
+  }
+
+  public func supportsRTL() -> Bool {
+    guard let expoClientConfigRootObject = expoClientConfigRootObject(),
+      let extra: [String: Any]? = expoClientConfigRootObject.optionalValue(forKey: "extra"),
+      let supportsRTL: Bool = extra?.optionalValue(forKey: "supportsRTL") else {
+      return false
+    }
+
+    return supportsRTL
+  }
+
+  public func jsEngine() -> String {
+    let jsEngine = expoClientConfigRootObject().let { it in
+      Manifest.string(fromManifest: it, atPaths: [
+        ["ios", "jsEngine"],
+        ["jsEngine"]
+      ])
+    }
+
+    guard let jsEngine = jsEngine else {
+      let sdkMajorVersion = expoGoSDKMajorVersion()
+      if sdkMajorVersion > 0 && sdkMajorVersion < 48 {
+        return "jsc"
+      } else {
+        return "hermes"
+      }
+    }
+    return jsEngine
+  }
+
+  private func expoGoSDKMajorVersion() -> Int {
+    let sdkVersion = expoGoSDKVersion()
+    let components = sdkVersion?.components(separatedBy: ".")
+    guard let components = components else {
+      return 0
+    }
+    if components.count == 3 {
+      return Int(components[0]) ?? 0
+    }
+    return 0
+  }
+
+  private static func string(fromManifest: [String: Any], atPaths: [[String]]) -> String? {
+    for path in atPaths {
+      if let result = string(fromManifest: fromManifest, atPath: path) {
+        return result
+      }
+    }
+    return nil
+  }
+
+  private static func string(fromManifest: [String: Any], atPath: [String]) -> String? {
+    var json = fromManifest
+    for i in 0..<atPath.count {
+      let isLastKey = i == atPath.count - 1
+      let key = atPath[i]
+      let value = json[key]
+      if isLastKey, let value = value as? String {
+        return value
+      }
+      guard let newJson = value else {
+        return nil
+      }
+      // swiftlint:disable:next force_cast
+      json = newJson as! [String: Any]
+    }
+    return nil
+  }
+}

package/ios/EXManifests/ManifestFactory.swift

@@ -0,0 +1,17 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+
+import Foundation
+
+@objc(EXManifestsManifestFactory)
+@objcMembers
+public class ManifestFactory: NSObject {
+  public static func manifest(forManifestJSON: [String: Any]) -> Manifest {
+    if forManifestJSON["releaseId"] != nil {
+      return LegacyManifest(rawManifestJSON: forManifestJSON)
+    } else if forManifestJSON["metadata"] != nil {
+      return NewManifest(rawManifestJSON: forManifestJSON)
+    } else {
+      return BareManifest(rawManifestJSON: forManifestJSON)
+    }
+  }
+}

package/ios/EXManifests/NewManifest.swift

@@ -0,0 +1,83 @@
+//  Copyright © 2021 650 Industries. All rights reserved.
+
+import Foundation
+
+@objc(EXManifestsNewManifest)
+@objcMembers
+public class NewManifest: Manifest {
+  public func rawId() -> String {
+    return rawManifestJSON().requiredValue(forKey: "id")
+  }
+
+  public override func stableLegacyId() -> String {
+    return rawId()
+  }
+
+  public override func scopeKey() -> String {
+    let extra: [String: Any] = rawManifestJSON().requiredValue(forKey: "extra")
+    return extra.requiredValue(forKey: "scopeKey")
+  }
+
+  private func extra() -> [String: Any]? {
+    return rawManifestJSON().optionalValue(forKey: "extra")
+  }
+
+  public override func easProjectId() -> String? {
+    guard let easConfig: [String: Any] = extra()?.optionalValue(forKey: "eas") else {
+      return nil
+    }
+    return easConfig.optionalValue(forKey: "projectId")
+  }
+
+  public func createdAt() -> String {
+    return rawManifestJSON().requiredValue(forKey: "createdAt")
+  }
+
+  public func runtimeVersion() -> String {
+    return rawManifestJSON().requiredValue(forKey: "runtimeVersion")
+  }
+
+  private func getSDKVersionFromRuntimeVersion() -> String? {
+    let runtimeVersion = runtimeVersion()
+    if runtimeVersion == "exposdk:UNVERSIONED" {
+      return "UNVERSIONED"
+    }
+
+    // The pattern is valid, so it'll never throw
+    // swiftlint:disable:next force_try
+    let regex = try! NSRegularExpression(pattern: "^exposdk:(\\d+\\.\\d+\\.\\d+)$", options: [])
+    guard let match = regex.firstMatch(
+      in: runtimeVersion,
+      options: [],
+      range: NSRange(runtimeVersion.startIndex..<runtimeVersion.endIndex, in: runtimeVersion)
+    ),
+    let range = Range(match.range(at: 1), in: runtimeVersion) else {
+      return nil
+    }
+    return String(runtimeVersion[range])
+  }
+
+  public override func expoGoSDKVersion() -> String? {
+    return expoClientConfigRootObject()?.optionalValue(forKey: "sdkVersion") ?? getSDKVersionFromRuntimeVersion()
+  }
+
+  public func launchAsset() -> [String: Any] {
+    return rawManifestJSON().requiredValue(forKey: "launchAsset")
+  }
+
+  public func assets() -> [[String: Any]]? {
+    return rawManifestJSON().optionalValue(forKey: "assets")
+  }
+
+  public override func bundleUrl() -> String {
+    return launchAsset().requiredValue(forKey: "url")
+  }
+
+  override func expoClientConfigRootObject() -> [String: Any]? {
+    return extra()?.optionalValue(forKey: "expoClient")
+  }
+
+  override func expoGoConfigRootObject() -> [String: Any]? {
+    return extra()?.optionalValue(forKey: "expoGo")
+  }
+}