@capawesome/capacitor-live-update 7.2.2 → 7.3.0

package/ios/Plugin/LiveUpdate.swift

@@ -11,6 +11,7 @@ import CommonCrypto
 
 // swiftlint:disable type_body_length
 @objc public class LiveUpdate: NSObject {
+    private let autoUpdateIntervalMs: Int64 = 15 * 60 * 1000 // 15 minutes
     private let bundlesDirectory = "NoCloud/ionic_built_snapshots" // DO NOT CHANGE! (See https://dub.sh/BLluidt)
     private let cachesDirectoryUrl = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first!
     private let config: LiveUpdateConfig
@@ -24,6 +25,8 @@ import CommonCrypto
 
     private var rollbackDispatchWorkItem: DispatchWorkItem?
     private var rollbackPerformed = false
+    private var lastAutoUpdateCheckTimestamp: Int64 = 0
+    private var syncInProgress = false
 
     init(config: LiveUpdateConfig, plugin: LiveUpdatePlugin) {
         self.config = config
@@ -128,6 +131,18 @@ import CommonCrypto
         completion(result, nil)
     }
 
+    @objc public func handleLoad() {
+        if config.autoUpdateStrategy == "background" {
+            performAutoUpdate()
+        }
+    }
+
+    @objc public func handleAppWillEnterForeground() {
+        if config.autoUpdateStrategy == "background" {
+            performAutoUpdate()
+        }
+    }
+
     @objc public func ready(completion: @escaping (Result?, Error?) -> Void) {
         CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "App is ready.")
         if config.readyTimeout <= 0 {
@@ -142,6 +157,10 @@ import CommonCrypto
         // Get the current and previous bundle IDs
         let currentBundleId = getCurrentBundleId()
         let previousBundleId = getPreviousBundleId()
+        // Block the rolled back bundle if enabled
+        if config.autoBlockRolledBackBundles && rollbackPerformed, let previousBundleId = previousBundleId {
+            addBlockedBundleId(previousBundleId)
+        }
         // Return the result
         let result = ReadyResult(currentBundleId: currentBundleId, previousBundleId: previousBundleId, rollback: rollbackPerformed)
         completion(result, nil)
@@ -194,6 +213,14 @@ import CommonCrypto
     }
 
     @objc public func sync(_ options: SyncOptions) async throws -> SyncResult {
+        if syncInProgress {
+            throw CustomError.syncInProgress
+        }
+        syncInProgress = true
+        defer {
+            syncInProgress = false
+        }
+
         let channel = options.getChannel()
         // Fetch the latest bundle
         let fetchLatestBundleOptions = FetchLatestBundleOptions(channel: channel)
@@ -206,6 +233,11 @@ import CommonCrypto
         let checksum = response.checksum
         let signature = response.signature
         let downloadUrl = response.url
+        // Check if the bundle is blocked
+        if isBlockedBundleId(latestBundleId) {
+            CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Bundle is blocked and will not be downloaded.")
+            return SyncResult(nextBundleId: nil)
+        }
         // Check if bundle already exists
         if hasBundleById(latestBundleId) {
             var nextBundleId: String?
@@ -645,6 +677,30 @@ import CommonCrypto
         plugin.notifyDownloadBundleProgressListeners(event)
     }
 
+    private func performAutoUpdate() {
+        // Check if enough time has passed since the last check
+        let now = Int64(Date().timeIntervalSince1970 * 1000)
+        if lastAutoUpdateCheckTimestamp > 0 && (now - lastAutoUpdateCheckTimestamp) < autoUpdateIntervalMs {
+            CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Auto-update skipped. Last check was less than 15 minutes ago.")
+            return
+        }
+
+        // Update the timestamp
+        lastAutoUpdateCheckTimestamp = now
+
+        // Run sync in background task
+        Task {
+            do {
+                CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Auto-update started.")
+                let options = SyncOptions(channel: nil)
+                _ = try await sync(options)
+                CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Auto-update completed successfully.")
+            } catch {
+                CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Auto-update failed: ", error.localizedDescription)
+            }
+        }
+    }
+
     private func rollback() {
         // Set the rollback flag
         rollbackPerformed = true
@@ -705,6 +761,51 @@ import CommonCrypto
     private func setNextBundleById(_ bundleId: String?) {
         let path = buildCapacitorServerPathFor(bundleId: bundleId)
         setNextCapacitorServerPath(path: path)
+
+        // Notify listeners
+        notifyNextBundleSetListeners(bundleId)
+    }
+
+    private func notifyNextBundleSetListeners(_ bundleId: String?) {
+        let event = NextBundleSetEvent(bundleId: bundleId)
+        plugin.notifyNextBundleSetListeners(event)
+    }
+
+    private func addBlockedBundleId(_ bundleId: String) {
+        var blockedList: [String] = []
+
+        // Parse existing blocked IDs
+        if let blockedIds = preferences.getBlockedBundleIds(), !blockedIds.isEmpty {
+            blockedList = blockedIds.split(separator: ",").map(String.init)
+        }
+
+        // Skip if already blocked
+        if blockedList.contains(bundleId) {
+            return
+        }
+
+        // Remove oldest if limit reached
+        if blockedList.count >= 100 {
+            blockedList.removeFirst()
+        }
+
+        // Add new bundle
+        blockedList.append(bundleId)
+
+        // Save back to preferences
+        let newBlockedIds = blockedList.joined(separator: ",")
+        preferences.setBlockedBundleIds(newBlockedIds)
+
+        CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Bundle blocked: ", bundleId)
+    }
+
+    private func isBlockedBundleId(_ bundleId: String) -> Bool {
+        guard let blockedIds = preferences.getBlockedBundleIds(), !blockedIds.isEmpty else {
+            return false
+        }
+
+        let blockedList = blockedIds.split(separator: ",").map(String.init)
+        return blockedList.contains(bundleId)
     }
 
     private func setNextCapacitorServerPath(path: String) {

package/ios/Plugin/LiveUpdateConfig.swift

@@ -1,6 +1,8 @@
 public struct LiveUpdateConfig {
     var appId: String?
+    var autoBlockRolledBackBundles = false
     var autoDeleteBundles = false
+    var autoUpdateStrategy = "none"
     var defaultChannel: String?
     var httpTimeout = 60000
     var publicKey: String?

package/ios/Plugin/LiveUpdateHttpClient.swift

@@ -7,11 +7,13 @@ public class LiveUpdateHttpClient: NSObject {
     private let config: LiveUpdateConfig
 
     public static func getChecksumFromResponse(response: HTTPURLResponse) -> String? {
-        return response.allHeaderFields["x-checksum"] as? String // Must be lowercase!
+        guard let headers = response.allHeaderFields as? [String: String] else { return nil }
+        return headers.first(where: { $0.key.lowercased() == "x-checksum" })?.value
     }
 
     public static func getSignatureFromResponse(response: HTTPURLResponse) -> String? {
-        return response.allHeaderFields["x-signature"] as? String // Must be lowercase!
+        guard let headers = response.allHeaderFields as? [String: String] else { return nil }
+        return headers.first(where: { $0.key.lowercased() == "x-signature" })?.value
     }
 
     init(config: LiveUpdateConfig) {

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "7.2.2"
+    public static let version = "7.3.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"
@@ -35,14 +35,25 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     ]
 
     private let eventDownloadBundleProgess = "downloadBundleProgress"
+    private let eventNextBundleSet = "nextBundleSet"
 
     private var config: LiveUpdateConfig?
     private var implementation: LiveUpdate?
-    private var syncInProgress = false
 
     override public func load() {
         self.config = liveUpdateConfig()
         self.implementation = LiveUpdate(config: config!, plugin: self)
+
+        // Notify implementation about load
+        implementation?.handleLoad()
+
+        // Register for app resume notifications
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(handleAppWillEnterForeground),
+            name: UIApplication.willEnterForegroundNotification,
+            object: nil
+        )
     }
 
     @objc func deleteBundle(_ call: CAPPluginCall) {
@@ -90,6 +101,11 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     @objc func fetchLatestBundle(_ call: CAPPluginCall) {
         Task {
             do {
+                guard let appId = config?.appId, !appId.isEmpty else {
+                    call.reject(CustomError.appIdMissing.localizedDescription)
+                    return
+                }
+
                 let options = FetchLatestBundleOptions(call)
                 let result = try await implementation?.fetchLatestBundle(options)
                 if let result = result?.toJSObject() as? JSObject {
@@ -265,25 +281,17 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     @objc func sync(_ call: CAPPluginCall) {
         Task {
             do {
-                guard let _ = config?.appId else {
+                guard let appId = config?.appId, !appId.isEmpty else {
                     call.reject(CustomError.appIdMissing.localizedDescription)
                     return
                 }
 
-                guard !syncInProgress else {
-                    call.reject(CustomError.syncInProgress.localizedDescription)
-                    return
-                }
-                syncInProgress = true
-
                 let options = SyncOptions(call)
                 let result = try await implementation?.sync(options)
-                self.syncInProgress = false
                 if let result = result?.toJSObject() as? JSObject {
                     resolveCall(call, result)
                 }
             } catch {
-                self.syncInProgress = false
                 rejectCall(call, error)
             }
         }
@@ -295,11 +303,21 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    func notifyNextBundleSetListeners(_ event: NextBundleSetEvent) {
+        notifyListeners(eventNextBundleSet, data: event.toJSObject(), retainUntilConsumed: false)
+    }
+
+    @objc private func handleAppWillEnterForeground() {
+        implementation?.handleAppWillEnterForeground()
+    }
+
     private func liveUpdateConfig() -> LiveUpdateConfig {
         var config = LiveUpdateConfig()
 
         config.appId = getConfig().getString("appId", config.appId)
+        config.autoBlockRolledBackBundles = getConfig().getBoolean("autoBlockRolledBackBundles", config.autoBlockRolledBackBundles)
         config.autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.autoDeleteBundles)
+        config.autoUpdateStrategy = getConfig().getString("autoUpdateStrategy", config.autoUpdateStrategy) ?? config.autoUpdateStrategy
         config.defaultChannel = getConfig().getString("defaultChannel", config.defaultChannel)
         config.httpTimeout = getConfig().getInt("httpTimeout", config.httpTimeout)
         config.publicKey = getConfig().getString("publicKey", config.publicKey)

package/ios/Plugin/LiveUpdatePreferences.swift

@@ -1,6 +1,7 @@
 import Foundation
 
 public class LiveUpdatePreferences: NSObject {
+    private let blockedBundleIdsKey = "blockedBundleIds" // DO NOT CHANGE
     private let channelKey = "channel" // DO NOT CHANGE
     private let customIdKey = "customId" // DO NOT CHANGE
     private let previousBundleIdKey = "previousBundleIdKey" // DO NOT CHANGE
@@ -17,6 +18,19 @@ public class LiveUpdatePreferences: NSObject {
         return UserDefaults.standard.string(forKey: applyPrefix(to: previousBundleIdKey))
     }
 
+    public func getBlockedBundleIds() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: blockedBundleIdsKey))
+    }
+
+    public func setBlockedBundleIds(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: blockedBundleIdsKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: blockedBundleIdsKey))
+        }
+        UserDefaults.standard.synchronize()
+    }
+
     public func setChannel(_ value: String?) {
         if let value = value {
             UserDefaults.standard.set(value, forKey: applyPrefix(to: channelKey))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "7.2.2",
+  "version": "7.3.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",