@otakit/capacitor-updater 2.2.0 → 2.3.1

package/ios/Sources/UpdaterPlugin/ManifestClient.swift

@@ -11,9 +11,18 @@ struct ManifestEncryption {
   let nonce: String
 }
 
+struct ManifestFileEntry {
+  let path: String
+  let sha256: String
+  let size: Int?
+  let url: String
+}
+
 struct LatestManifest {
   let version: String
-  let url: String
+  /// Bundle zip URL. Present for the zip strategy; nil for deltas.
+  let url: String?
+  /// Zip hash for the zip strategy; canonical filesHash for deltas.
   let sha256: String
   let size: Int
   let runtimeVersion: String?
@@ -21,6 +30,8 @@ struct LatestManifest {
   let strategy: String
   let forceImmediate: Bool
   let encryption: ManifestEncryption?
+  /// Per-file entries for the deltas strategy; nil for zip.
+  let files: [ManifestFileEntry]?
 }
 
 struct ManifestSignature {
@@ -105,7 +116,6 @@ enum ManifestClient {
     guard
       let object = try JSONSerialization.jsonObject(with: data) as? [String: Any],
       let version = object["version"] as? String,
-      let downloadUrl = object["url"] as? String,
       let sha256 = object["sha256"] as? String,
       let size = object["size"] as? Int
     else {
@@ -129,10 +139,17 @@ enum ManifestClient {
     let forceImmediate = object["forceImmediate"] as? Bool ?? false
     let encryption = try parseEncryption(object["encryption"])
 
-    guard let dlURL = URL(string: downloadUrl) else {
-      throw ManifestClientError.invalidURL
+    let downloadUrl = (object["url"] as? String)?.nilIfEmpty
+    var files: [ManifestFileEntry]?
+
+    if strategy == "deltas" {
+      files = try parseFiles(object["files"], allowInsecureUrls: allowInsecureUrls)
+    } else {
+      guard let downloadUrl, let dlURL = URL(string: downloadUrl) else {
+        throw ManifestClientError.invalidResponse
+      }
+      try requireHTTPS(url: dlURL, allowInsecure: allowInsecureUrls)
     }
-    try requireHTTPS(url: dlURL, allowInsecure: allowInsecureUrls)
 
     if manifestKeys.isEmpty {
       print("[OtaKit] WARNING: No manifest signing keys configured — signature verification is disabled for this request.")
@@ -167,10 +184,41 @@ enum ManifestClient {
       releaseId: releaseId,
       strategy: strategy,
       forceImmediate: forceImmediate,
-      encryption: encryption
+      encryption: encryption,
+      files: files
     )
   }
 
+  private static func parseFiles(
+    _ rawValue: Any?,
+    allowInsecureUrls: Bool
+  ) throws -> [ManifestFileEntry] {
+    guard let rawFiles = rawValue as? [[String: Any]], !rawFiles.isEmpty else {
+      throw ManifestClientError.invalidResponse
+    }
+
+    var entries: [ManifestFileEntry] = []
+    entries.reserveCapacity(rawFiles.count)
+    for rawFile in rawFiles {
+      guard let path = rawFile["path"] as? String,
+            let sha256 = rawFile["sha256"] as? String,
+            let fileUrl = rawFile["url"] as? String,
+            let parsedUrl = URL(string: fileUrl) else {
+        throw ManifestClientError.invalidResponse
+      }
+      try requireHTTPS(url: parsedUrl, allowInsecure: allowInsecureUrls)
+      entries.append(
+        ManifestFileEntry(
+          path: path,
+          sha256: sha256,
+          size: rawFile["size"] as? Int,
+          url: fileUrl
+        )
+      )
+    }
+    return entries
+  }
+
   private static func parseEncryption(_ rawValue: Any?) throws -> ManifestEncryption? {
     guard let rawValue, !(rawValue is NSNull) else {
       return nil

package/ios/Sources/UpdaterPlugin/UpdaterPlugin.swift

@@ -1040,10 +1040,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   ) -> [String: Any] {
     var payload: [String: Any] = [
       "version": latest.version,
-      "url": latest.url,
       "sha256": latest.sha256,
       "size": latest.size,
+      "strategy": latest.strategy,
     ]
+    if let url = latest.url {
+      payload["url"] = url
+    }
     if let runtimeVersion = latest.runtimeVersion {
       payload["runtimeVersion"] = runtimeVersion
     }
@@ -1056,7 +1059,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     _ manifest: LatestManifest,
     targetChannel: String?
   ) async throws -> BundleInfo {
-    guard let url = URL(string: manifest.url) else {
+    if manifest.strategy == "deltas" {
+      return try await assembleAndStage(manifest: manifest, targetChannel: targetChannel)
+    }
+
+    guard let urlString = manifest.url, let url = URL(string: urlString) else {
       throw NSError(
         domain: "OtaKit",
         code: 1,
@@ -1076,6 +1083,163 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     )
   }
 
+  private static let bundleFileListName = "otakit_files.json"
+
+  /// Deltas strategy: fill content-cache misses and assemble the bundle from
+  /// the cache, then hand it to the same staging path the zip flow uses.
+  private func assembleAndStage(
+    manifest: LatestManifest,
+    targetChannel: String?
+  ) async throws -> BundleInfo {
+    // Same conservative disk-space guard as the zip path.
+    let requiredSpace = Int64(Double(manifest.size) * 2.5)
+    if getFreeDiskSpace() < requiredSpace {
+      sendDeviceEvent(
+        action: .downloadError,
+        bundleVersion: manifest.version,
+        runtimeVersion: manifest.runtimeVersion,
+        channel: targetChannel,
+        releaseId: manifest.releaseId,
+        detail: "insufficient_disk_space"
+      )
+      emitEvent(
+        "downloadFailed",
+        failureEventData(
+          version: manifest.version,
+          runtimeVersion: manifest.runtimeVersion,
+          channel: targetChannel,
+          releaseId: manifest.releaseId,
+          reason: "insufficient_disk_space"
+        )
+      )
+      throw NSError(
+        domain: "OtaKit",
+        code: 1,
+        userInfo: [NSLocalizedDescriptionKey: "Insufficient disk space"]
+      )
+    }
+
+    let assembleDirectory = fileManager.temporaryDirectory
+      .appendingPathComponent("otakit-assemble-\(UUID().uuidString)", isDirectory: true)
+    defer {
+      try? fileManager.removeItem(at: assembleDirectory)
+    }
+
+    do {
+      guard let files = manifest.files, !files.isEmpty else {
+        throw NSError(
+          domain: "OtaKit",
+          code: 1,
+          userInfo: [NSLocalizedDescriptionKey: "Delta manifest is missing its file list"]
+        )
+      }
+
+      let assembler = DeltaAssembler(
+        cacheDirectory: store.filesCacheDirectory,
+        downloader: downloader
+      )
+      try assembler.validate(files, expectedFilesHash: manifest.sha256)
+
+      if let builtinDirectory = Bundle.main.resourceURL?
+        .appendingPathComponent("public", isDirectory: true) {
+        assembler.seedFromBuiltinIfNeeded(
+          builtinDirectory: builtinDirectory,
+          nativeBuild: coordinator.nativeBuild
+        )
+      }
+
+      try await assembler.assemble(entries: files, into: assembleDirectory)
+
+      let bundleId = buildBundleId(
+        version: manifest.version,
+        releaseId: manifest.releaseId,
+        sha256: manifest.sha256
+      )
+      let destination = coordinator.bundleDirectory(for: bundleId)
+      if fileManager.fileExists(atPath: destination.path) {
+        try fileManager.removeItem(at: destination)
+      }
+      try fileManager.moveItem(at: assembleDirectory, to: destination)
+
+      // Record this bundle's content hashes for cache pruning.
+      let hashes = files.map { $0.sha256.lowercased() }
+      if let data = try? JSONSerialization.data(withJSONObject: hashes) {
+        try? data.write(
+          to: destination.appendingPathComponent(UpdaterPlugin.bundleFileListName),
+          options: .atomic
+        )
+      }
+
+      let info = BundleInfo(
+        id: bundleId,
+        version: manifest.version,
+        runtimeVersion: manifest.runtimeVersion,
+        status: .pending,
+        downloadedAt: Date(),
+        sha256: manifest.sha256,
+        path: destination.path,
+        channel: targetChannel,
+        releaseId: manifest.releaseId
+      )
+
+      let cleanupBundleIds = try coordinator.stageDownloadedBundle(info)
+      coordinator.cleanupBundles(cleanupBundleIds)
+
+      pruneDeltaCache(assembler: assembler)
+
+      sendDeviceEvent(
+        action: .downloaded,
+        bundleVersion: manifest.version,
+        runtimeVersion: manifest.runtimeVersion,
+        channel: targetChannel,
+        releaseId: manifest.releaseId
+      )
+      emitEvent("updateStaged", ["bundle": info.toDictionary()])
+      return info
+    } catch {
+      sendDeviceEvent(
+        action: .downloadError,
+        bundleVersion: manifest.version,
+        runtimeVersion: manifest.runtimeVersion,
+        channel: targetChannel,
+        releaseId: manifest.releaseId,
+        detail: error.localizedDescription
+      )
+      emitEvent(
+        "downloadFailed",
+        failureEventData(
+          version: manifest.version,
+          runtimeVersion: manifest.runtimeVersion,
+          channel: targetChannel,
+          releaseId: manifest.releaseId,
+          reason: failureReason(from: error)
+        )
+      )
+      throw error
+    }
+  }
+
+  /// Keep only cache entries referenced by live bundles (plus the builtin seed).
+  private func pruneDeltaCache(assembler: DeltaAssembler) {
+    var referenced = Set<String>()
+    let liveBundleIds = [
+      store.getCurrentBundleId(),
+      store.getFallbackBundleId(),
+      store.getStagedBundleId(),
+    ]
+    for bundleId in liveBundleIds {
+      guard let bundleId else { continue }
+      let listURL = store.bundleDirectory(for: bundleId)
+        .appendingPathComponent(UpdaterPlugin.bundleFileListName)
+      guard let data = try? Data(contentsOf: listURL),
+            let hashes = try? JSONSerialization.jsonObject(with: data) as? [String] else {
+        continue
+      }
+      referenced.formUnion(hashes.map { $0.lowercased() })
+    }
+    assembler.pruneCache(referencedHashes: referenced)
+  }
+
   private func pruneIncompatibleBundles() {
     let cleanupBundleIds = coordinator.pruneIncompatibleBundles(
       isCompatibleRuntime: isCompatibleRuntime

package/package.json

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