@otakit/capacitor-updater 1.2.0 → 2.0.1

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),
@@ -40,7 +38,8 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private var appReadyTimeoutMs = 10_000
   private var allowInsecureUrls = false
   private var updateMode: UpdateMode = .nextLaunch
-  private var updateUrl = UpdaterPlugin.defaultUpdateURL
+  private var ingestUrl = UpdaterPlugin.defaultIngestURL
+  private var cdnUrl = UpdaterPlugin.defaultCdnURL
   private var appId: String?
   private var channel: String?
   private var runtimeVersion: String?
@@ -50,15 +49,21 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private let isCheckInProgress = NSLock()
   private var checkInProgress = false
   private var foregroundObserver: NSObjectProtocol?
-  private static let defaultUpdateURL = "https://www.otakit.app/api/v1"
-  private static let apiPathSuffix = "/api/v1"
+  private static let defaultIngestURL = "https://ingest.otakit.app/v1"
+  private static let defaultCdnURL = "https://cdn.otakit.app"
+  private static let ingestPathSuffix = "/v1"
   private static let lastCheckTimestampKey = "otakit_last_check_timestamp"
 
   public override func load() {
-    let envUpdateUrl = ProcessInfo.processInfo.environment["OTAKIT_SERVER_URL"]
-    updateUrl = resolveUpdateUrl(
-      configured: getConfig().getString("serverUrl"),
-      env: envUpdateUrl
+    let envIngestUrl = ProcessInfo.processInfo.environment["OTAKIT_INGEST_URL"]
+    let envCdnUrl = ProcessInfo.processInfo.environment["OTAKIT_CDN_URL"]
+    ingestUrl = resolveIngestUrl(
+      configured: getConfig().getString("ingestUrl"),
+      env: envIngestUrl
+    )
+    cdnUrl = resolveCdnUrl(
+      configured: getConfig().getString("cdnUrl"),
+      env: envCdnUrl
     )
     appId = getConfig().getString("appId")
     channel = trimToNil(getConfig().getString("channel"))
@@ -88,7 +93,7 @@ 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
     }
 
@@ -154,7 +159,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)
@@ -166,7 +175,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         defer { releaseCheckInProgress() }
         do {
           let result = try await performCheckAndDownload(channel: nil, emitEvents: true)
-          recordCheckTimestamp()
           if result != nil {
             activateStagedBundleForReload()
             reloadWebView()
@@ -184,7 +192,6 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         defer { releaseCheckInProgress() }
         do {
           let result = try await performCheckAndDownload(channel: nil, emitEvents: true)
-          recordCheckTimestamp()
           if result != nil {
             activateStagedBundleForReload()
             reloadWebView()
@@ -282,27 +289,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] = [
@@ -329,9 +317,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 {
@@ -343,28 +333,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())
@@ -377,7 +347,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 {
@@ -424,9 +393,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         notifyListeners("appReady", data: current.toDictionary())
       }
 
-      sendStats(
+      sendDeviceEvent(
         action: .applied,
         bundleVersion: current.version,
+        runtimeVersion: current.runtimeVersion,
         channel: current.channel,
         releaseId: current.releaseId
       )
@@ -504,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,
       runtimeVersion: runtimeVersion,
-      platform: "ios",
       allowInsecureUrls: allowInsecureUrls,
       manifestKeys: manifestKeys.map {
         ManifestKey(kid: $0.kid, derData: $0.key)
@@ -542,6 +508,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       )
     }
 
+    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))
@@ -620,12 +593,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
           code: 1,
           userInfo: [NSLocalizedDescriptionKey: "Insufficient disk space"]
         )
-        sendStats(
+        sendDeviceEvent(
           action: .downloadError,
           bundleVersion: version,
+          runtimeVersion: runtimeVersion,
           channel: channel,
           releaseId: releaseId,
-          errorMessage: "insufficient_disk_space"
+          detail: "insufficient_disk_space"
         )
         throw error
       }
@@ -686,9 +660,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       cleanupSupersededStagedBundle(previousStagedId: previousStagedId, replacementId: bundleId)
 
       notifyListeners("downloadComplete", data: info.toDictionary())
-      sendStats(
+      sendDeviceEvent(
         action: .downloaded,
         bundleVersion: version,
+        runtimeVersion: runtimeVersion,
         channel: channel,
         releaseId: releaseId
       )
@@ -698,12 +673,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         "version": version,
         "error": error.localizedDescription,
       ])
-      sendStats(
+      sendDeviceEvent(
         action: .downloadError,
         bundleVersion: version,
+        runtimeVersion: runtimeVersion,
         channel: channel,
         releaseId: releaseId,
-        errorMessage: error.localizedDescription
+        detail: error.localizedDescription
       )
       throw error
     }
@@ -835,12 +811,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     store.setFailedBundle(failed)
     store.setStagedBundleId(nil)
 
-    sendStats(
+    sendDeviceEvent(
       action: .rollback,
       bundleVersion: current.version,
+      runtimeVersion: current.runtimeVersion,
       channel: current.channel,
       releaseId: current.releaseId,
-      errorMessage: reason
+      detail: reason
     )
 
     let fallback = store.getFallbackBundle()
@@ -933,12 +910,45 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     if let runtimeVersion = latest.runtimeVersion {
       payload["runtimeVersion"] = runtimeVersion
     }
-    if let releaseId = latest.releaseId {
-      payload["releaseId"] = releaseId
-    }
+    payload["releaseId"] = latest.releaseId
     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 bundleReleaseId = bundle.releaseId,
+       latest.releaseId == 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?
@@ -959,18 +969,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       return nil
     }
 
-    if let latestReleaseId = latest.releaseId,
-       let stagedReleaseId = staged.releaseId,
-       latestReleaseId == stagedReleaseId {
-      return staged
-    }
-
-    if latest.version == staged.version,
-       latest.sha256 == staged.sha256 {
-      return staged
-    }
-
-    return nil
+    return doesBundleMatchLatest(staged, latest: latest, targetChannel: targetChannel) ? staged : nil
   }
 
   private func pruneIncompatibleBundles() {
@@ -1025,26 +1024,41 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return "\(normalized)-\(suffix)"
   }
 
-  private func sendStats(
-    action: StatsAction,
+  private func sendDeviceEvent(
+    action: DeviceEventAction,
     bundleVersion: String? = nil,
+    runtimeVersion: String? = nil,
     channel: String? = nil,
     releaseId: String? = nil,
-    errorMessage: String? = nil
+    detail: String? = nil
   ) {
     guard let appId else {
       return
     }
-    StatsClient.send(
-      updateUrl: updateUrl,
+    guard let bundleVersion = trimToNil(bundleVersion) else {
+      print("[UpdateKit] Skipping device event without bundleVersion")
+      return
+    }
+    guard let releaseId = trimToNil(releaseId) else {
+      print("[UpdateKit] Skipping device event without releaseId")
+      return
+    }
+    let nativeBuild = store.nativeBuild.trimmingCharacters(in: .whitespacesAndNewlines)
+    guard !nativeBuild.isEmpty else {
+      print("[UpdateKit] Skipping device event without nativeBuild")
+      return
+    }
+    DeviceEventClient.send(
+      ingestUrl: ingestUrl,
       appId: appId,
       platform: "ios",
       action: action,
       bundleVersion: bundleVersion,
       channel: channel,
+      runtimeVersion: trimToNil(runtimeVersion),
       releaseId: releaseId,
-      nativeBuild: store.nativeBuild,
-      errorMessage: errorMessage
+      nativeBuild: nativeBuild,
+      detail: detail
     )
   }
 
@@ -1063,21 +1077,41 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return trimmed.isEmpty ? nil : trimmed
   }
 
-  private func resolveUpdateUrl(configured: String?, env: String?) -> String {
+  private func resolveIngestUrl(
+    configured: String?,
+    env: String?
+  ) -> String {
+    let configuredValue = configured?.trimmingCharacters(in: .whitespacesAndNewlines)
+    if let configuredValue, !configuredValue.isEmpty {
+      return normalizeIngestUrl(configuredValue)
+    }
+
+    let envValue = env?.trimmingCharacters(in: .whitespacesAndNewlines)
+    if let envValue, !envValue.isEmpty {
+      return normalizeIngestUrl(envValue)
+    }
+
+    return UpdaterPlugin.defaultIngestURL
+  }
+
+  private func resolveCdnUrl(
+    configured: String?,
+    env: String?
+  ) -> String {
     let configuredValue = configured?.trimmingCharacters(in: .whitespacesAndNewlines)
     if let configuredValue, !configuredValue.isEmpty {
-      return normalizeUpdateUrl(configuredValue)
+      return normalizeCdnUrl(configuredValue)
     }
 
     let envValue = env?.trimmingCharacters(in: .whitespacesAndNewlines)
     if let envValue, !envValue.isEmpty {
-      return normalizeUpdateUrl(envValue)
+      return normalizeCdnUrl(envValue)
     }
 
-    return UpdaterPlugin.defaultUpdateURL
+    return UpdaterPlugin.defaultCdnURL
   }
 
-  private func normalizeUpdateUrl(_ raw: String) -> String {
+  private func normalizeIngestUrl(_ raw: String) -> String {
     let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
     let withoutTrailingSlash = trimmed.replacingOccurrences(
       of: "/+$",
@@ -1085,11 +1119,17 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       options: .regularExpression
     )
 
-    if withoutTrailingSlash.lowercased().hasSuffix(UpdaterPlugin.apiPathSuffix) {
+    if withoutTrailingSlash.lowercased().hasSuffix(UpdaterPlugin.ingestPathSuffix) {
       return withoutTrailingSlash
     }
 
-    return withoutTrailingSlash + UpdaterPlugin.apiPathSuffix
+    return withoutTrailingSlash + UpdaterPlugin.ingestPathSuffix
+  }
+
+  private func normalizeCdnUrl(_ raw: String) -> String {
+    raw
+      .trimmingCharacters(in: .whitespacesAndNewlines)
+      .replacingOccurrences(of: "/+$", with: "", options: .regularExpression)
   }
 
   private func getFreeDiskSpace() -> Int64 {

package/package.json

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