@otakit/capacitor-updater 1.1.0 → 2.0.0

package/ios/Sources/UpdaterPlugin/UpdaterPlugin.swift

@@ -23,8 +23,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     CAPPluginMethod(name: "download", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "apply", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "debugGetState", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugCheck", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugDownload", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "notifyAppReady", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "debugReset", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "debugListBundles", returnType: CAPPluginReturnPromise),
@@ -41,8 +39,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private var allowInsecureUrls = false
   private var updateMode: UpdateMode = .nextLaunch
   private var updateUrl = UpdaterPlugin.defaultUpdateURL
+  private var cdnUrl = UpdaterPlugin.defaultCdnURL
   private var appId: String?
   private var channel: String?
+  private var runtimeVersion: String?
   private var manifestKeys: [(kid: String, key: Data)] = []
   private var trialTimeoutWorkItem: DispatchWorkItem?
   private var checkIntervalMs: Int = 600_000
@@ -50,17 +50,26 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private var checkInProgress = false
   private var foregroundObserver: NSObjectProtocol?
   private static let defaultUpdateURL = "https://www.otakit.app/api/v1"
+  private static let defaultCdnURL = "https://cdn.otakit.app"
   private static let apiPathSuffix = "/api/v1"
   private static let lastCheckTimestampKey = "otakit_last_check_timestamp"
 
   public override func load() {
     let envUpdateUrl = ProcessInfo.processInfo.environment["OTAKIT_SERVER_URL"]
+    let envCdnUrl = ProcessInfo.processInfo.environment["OTAKIT_CDN_URL"]
     updateUrl = resolveUpdateUrl(
       configured: getConfig().getString("serverUrl"),
       env: envUpdateUrl
     )
+    cdnUrl = resolveCdnUrl(
+      configured: getConfig().getString("cdnUrl"),
+      env: envCdnUrl,
+      resolvedUpdateUrl: updateUrl
+    )
     appId = getConfig().getString("appId")
     channel = trimToNil(getConfig().getString("channel"))
+    runtimeVersion = trimToNil(getConfig().getString("runtimeVersion"))
+    store.appRuntimeVersion = runtimeVersion
     allowInsecureUrls = getConfig().getBoolean("allowInsecureUrls", false)
     let updateModeRaw = getConfig().getString("updateMode", UpdateMode.nextLaunch.rawValue)
     updateMode = resolveUpdateMode(configured: updateModeRaw)
@@ -85,10 +94,12 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       manifestKeys = [(kid: "_invalid_", key: Data())]
     }
 
-    if manifestKeys.isEmpty && HostedManifestKeys.matchesManagedServer(updateUrl) {
+    if manifestKeys.isEmpty && HostedManifestKeys.matchesManagedManifestURL(cdnUrl) {
       manifestKeys = HostedManifestKeys.defaults
     }
 
+    pruneIncompatibleBundles()
+
     var current = store.getCurrentBundle()
     if current.status == .trial {
       rollbackCurrentBundle(reason: "app_restarted_before_notify")
@@ -149,7 +160,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         return
       }
 
-      if shouldThrottleCheck() { return }
+      if updateMode != .immediate && shouldThrottleCheck() { return }
+    }
+
+    if trigger == .launch && updateMode != .immediate && shouldThrottleCheck() {
+      return
     }
 
     // Acquire in-flight guard (submit-time)
@@ -161,7 +176,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         defer { releaseCheckInProgress() }
         do {
           let result = try await performCheckAndDownload(channel: nil, emitEvents: true)
-          recordCheckTimestamp()
           if result != nil {
             activateStagedBundleForReload()
             reloadWebView()
@@ -179,7 +193,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         defer { releaseCheckInProgress() }
         do {
           let result = try await performCheckAndDownload(channel: nil, emitEvents: true)
-          recordCheckTimestamp()
           if result != nil {
             activateStagedBundleForReload()
             reloadWebView()
@@ -277,27 +290,8 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     call.resolve(payload)
   }
 
-  @objc func debugCheck(_ call: CAPPluginCall) {
-    let requestedChannel = call.getString("channel")
-    let targetChannel = resolveTargetChannel(requestedChannel)
-    Task {
-      do {
-        let latest = try await fetchLatest(channel: targetChannel)
-        if let latest {
-          let staged = findMatchingStagedBundle(latest: latest, targetChannel: targetChannel)
-          call.resolve(manifestToDictionary(latest, downloaded: staged != nil))
-        } else {
-          call.resolve()
-        }
-      } catch {
-        call.reject("debugCheck failed: \(error.localizedDescription)")
-      }
-    }
-  }
-
   @objc func check(_ call: CAPPluginCall) {
-    // Respect throttle — return staged bundle as a LatestVersion if available, else null
-    if shouldThrottleCheck() || !claimCheckInProgress() {
+    if !claimCheckInProgress() {
       if let stagedId = store.getStagedBundleId(),
          let staged = store.getBundle(id: stagedId) {
         var payload: [String: Any] = [
@@ -307,6 +301,9 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
           "size": 0,
           "downloaded": true,
         ]
+        if let runtimeVersion = staged.runtimeVersion {
+          payload["runtimeVersion"] = runtimeVersion
+        }
         if let releaseId = staged.releaseId {
           payload["releaseId"] = releaseId
         }
@@ -321,9 +318,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       defer { releaseCheckInProgress() }
       do {
         let latest = try await fetchLatest(channel: targetChannel)
-        // check() does NOT record timestamp — only download() and automatic paths do.
-        // This keeps check() -> download() working without the throttle blocking download().
         if let latest {
+          if isCurrentBundleLatest(latest: latest, targetChannel: targetChannel) {
+            call.resolve()
+            return
+          }
           let staged = findMatchingStagedBundle(latest: latest, targetChannel: targetChannel)
           call.resolve(manifestToDictionary(latest, downloaded: staged != nil))
         } else {
@@ -335,28 +334,8 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
   }
 
-  @objc func debugDownload(_ call: CAPPluginCall) {
-    let requestedChannel = call.getString("channel")
-    Task {
-      do {
-        let bundle = try await performCheckAndDownload(
-          channel: requestedChannel,
-          emitEvents: true
-        )
-        if let bundle {
-          call.resolve(bundle.toDictionary())
-        } else {
-          call.resolve()
-        }
-      } catch {
-        call.reject("debugDownload failed: \(error.localizedDescription)")
-      }
-    }
-  }
-
   @objc func download(_ call: CAPPluginCall) {
-    // Respect throttle — return staged info if available, else null
-    if shouldThrottleCheck() || !claimCheckInProgress() {
+    if !claimCheckInProgress() {
       if let stagedId = store.getStagedBundleId(),
          let staged = store.getBundle(id: stagedId) {
         call.resolve(staged.toDictionary())
@@ -369,7 +348,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       defer { releaseCheckInProgress() }
       do {
         let bundle = try await performCheckAndDownload(channel: nil, emitEvents: true)
-        recordCheckTimestamp()
         if let bundle {
           call.resolve(bundle.toDictionary())
         } else {
@@ -496,15 +474,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       throw NSError(domain: "OtaKit", code: 1, userInfo: [NSLocalizedDescriptionKey: "Missing appId in plugin config"])
     }
 
-    let current = store.getCurrentBundle()
     return try await ManifestClient.fetchLatest(
-      updateUrl: updateUrl,
+      cdnUrl: cdnUrl,
       appId: appId,
       channel: channel,
-      currentVersion: current.version,
-      currentReleaseId: current.releaseId,
-      nativeBuild: store.nativeBuild,
-      platform: "ios",
+      runtimeVersion: runtimeVersion,
       allowInsecureUrls: allowInsecureUrls,
       manifestKeys: manifestKeys.map {
         ManifestKey(kid: $0.kid, derData: $0.key)
@@ -526,6 +500,21 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       return nil
     }
 
+    guard isCompatibleRuntime(manifest.runtimeVersion) else {
+      throw NSError(
+        domain: "OtaKit",
+        code: 1,
+        userInfo: [NSLocalizedDescriptionKey: "Manifest runtimeVersion does not match the installed app runtime"]
+      )
+    }
+
+    if isCurrentBundleLatest(latest: manifest, targetChannel: targetChannel) {
+      if emitEvents {
+        notifyListeners("noUpdateAvailable", data: [:])
+      }
+      return nil
+    }
+
     let staged = findMatchingStagedBundle(latest: manifest, targetChannel: targetChannel)
     if emitEvents {
       notifyListeners("updateAvailable", data: manifestToDictionary(manifest, downloaded: staged != nil))
@@ -549,6 +538,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         version: manifest.version,
         expectedSha256: manifest.sha256,
         expectedSize: manifest.size,
+        runtimeVersion: manifest.runtimeVersion,
         channel: targetChannel,
         releaseId: manifest.releaseId
       )
@@ -568,6 +558,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         version: manifest.version,
         expectedSha256: manifest.sha256,
         expectedSize: manifest.size,
+        runtimeVersion: manifest.runtimeVersion,
         channel: targetChannel,
         releaseId: manifest.releaseId
       )
@@ -588,6 +579,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     version: String,
     expectedSha256: String,
     expectedSize: Int? = nil,
+    runtimeVersion: String? = nil,
     channel: String? = nil,
     releaseId: String? = nil
   ) async throws -> BundleInfo {
@@ -652,6 +644,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       let info = BundleInfo(
         id: bundleId,
         version: version,
+        runtimeVersion: runtimeVersion,
         status: .pending,
         downloadedAt: Date(),
         sha256: expectedSha256,
@@ -723,6 +716,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       store.setStagedBundleId(nil)
       return store.getCurrentBundle()
     }
+    guard isCompatibleRuntime(staged) else {
+      try? store.deleteBundle(id: staged.id)
+      return store.getCurrentBundle()
+    }
 
     store.setCurrentBundleId(staged.id)
     store.setStagedBundleId(nil)
@@ -737,6 +734,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       store.setStagedBundleId(nil)
       return
     }
+    guard isCompatibleRuntime(staged) else {
+      try? store.deleteBundle(id: staged.id)
+      return
+    }
 
     store.setCurrentBundleId(staged.id)
     store.setStagedBundleId(nil)
@@ -795,6 +796,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     let failed = BundleInfo(
       id: current.id,
       version: current.version,
+      runtimeVersion: current.runtimeVersion,
       status: .error,
       downloadedAt: current.downloadedAt,
       sha256: current.sha256,
@@ -901,15 +903,51 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       "size": latest.size,
       "downloaded": downloaded,
     ]
+    if let runtimeVersion = latest.runtimeVersion {
+      payload["runtimeVersion"] = runtimeVersion
+    }
     if let releaseId = latest.releaseId {
       payload["releaseId"] = releaseId
     }
-    if let minNativeBuild = latest.minNativeBuild {
-      payload["minNativeBuild"] = minNativeBuild
-    }
     return payload
   }
 
+  private func isCurrentBundleLatest(
+    latest: LatestManifest,
+    targetChannel: String?
+  ) -> Bool {
+    doesBundleMatchLatest(store.getCurrentBundle(), latest: latest, targetChannel: targetChannel)
+  }
+
+  private func doesBundleMatchLatest(
+    _ bundle: BundleInfo,
+    latest: LatestManifest,
+    targetChannel: String?
+  ) -> Bool {
+    if trimToNil(bundle.channel) != targetChannel {
+      return false
+    }
+
+    if trimToNil(bundle.runtimeVersion) != trimToNil(latest.runtimeVersion) {
+      return false
+    }
+
+    if let latestReleaseId = latest.releaseId,
+       let bundleReleaseId = bundle.releaseId,
+       latestReleaseId == bundleReleaseId {
+      return true
+    }
+
+    if !latest.sha256.isEmpty,
+       let bundleSha = bundle.sha256,
+       !bundleSha.isEmpty,
+       latest.sha256 == bundleSha {
+      return true
+    }
+
+    return latest.version == bundle.version
+  }
+
   private func findMatchingStagedBundle(
     latest: LatestManifest,
     targetChannel: String?
@@ -926,18 +964,29 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       return nil
     }
 
-    if let latestReleaseId = latest.releaseId,
-       let stagedReleaseId = staged.releaseId,
-       latestReleaseId == stagedReleaseId {
-      return staged
+    if trimToNil(staged.runtimeVersion) != trimToNil(latest.runtimeVersion) {
+      return nil
     }
 
-    if latest.version == staged.version,
-       latest.sha256 == staged.sha256 {
-      return staged
+    return doesBundleMatchLatest(staged, latest: latest, targetChannel: targetChannel) ? staged : nil
+  }
+
+  private func pruneIncompatibleBundles() {
+    for bundle in store.listDownloadedBundles() where !isCompatibleRuntime(bundle) {
+      try? store.deleteBundle(id: bundle.id)
     }
 
-    return nil
+    if let failed = store.getFailedBundle(), !isCompatibleRuntime(failed) {
+      store.setFailedBundle(nil)
+    }
+  }
+
+  private func isCompatibleRuntime(_ runtimeVersion: String?) -> Bool {
+    trimToNil(runtimeVersion) == self.runtimeVersion
+  }
+
+  private func isCompatibleRuntime(_ bundle: BundleInfo) -> Bool {
+    isCompatibleRuntime(bundle.runtimeVersion)
   }
 
   private func buildBundleId(from version: String) -> String {
@@ -1026,6 +1075,25 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return UpdaterPlugin.defaultUpdateURL
   }
 
+  private func resolveCdnUrl(configured: String?, env: String?, resolvedUpdateUrl: String) -> String {
+    let configuredValue = configured?.trimmingCharacters(in: .whitespacesAndNewlines)
+    if let configuredValue, !configuredValue.isEmpty {
+      return normalizeCdnUrl(configuredValue)
+    }
+
+    let envValue = env?.trimmingCharacters(in: .whitespacesAndNewlines)
+    if let envValue, !envValue.isEmpty {
+      return normalizeCdnUrl(envValue)
+    }
+
+    if resolvedUpdateUrl.lowercased() != UpdaterPlugin.defaultUpdateURL.lowercased(),
+       resolvedUpdateUrl.lowercased().hasSuffix(UpdaterPlugin.apiPathSuffix) {
+      return String(resolvedUpdateUrl.dropLast(UpdaterPlugin.apiPathSuffix.count))
+    }
+
+    return UpdaterPlugin.defaultCdnURL
+  }
+
   private func normalizeUpdateUrl(_ raw: String) -> String {
     let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
     let withoutTrailingSlash = trimmed.replacingOccurrences(
@@ -1041,6 +1109,12 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return withoutTrailingSlash + UpdaterPlugin.apiPathSuffix
   }
 
+  private func normalizeCdnUrl(_ raw: String) -> String {
+    raw
+      .trimmingCharacters(in: .whitespacesAndNewlines)
+      .replacingOccurrences(of: "/+$", with: "", options: .regularExpression)
+  }
+
   private func getFreeDiskSpace() -> Int64 {
     do {
       let attributes = try fileManager.attributesOfFileSystem(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@otakit/capacitor-updater",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Capacitor plugin for OTA updates",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",