@capgo/capacitor-updater 7.20.0 → 7.22.0

package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift

@@ -7,6 +7,7 @@
 import Foundation
 import Capacitor
 import UIKit
+import WebKit
 import Version
 
 /**
@@ -27,6 +28,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "set", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "list", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "delete", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setBundleError", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "reset", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "current", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "reload", returnType: CAPPluginReturnPromise),
@@ -47,18 +49,21 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "getBuiltinVersion", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "isAutoUpdateAvailable", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getNextBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getFailedUpdate", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setShakeMenu", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "isShakeMenuEnabled", returnType: CAPPluginReturnPromise)
     ]
     public var implementation = CapgoUpdater()
-    private let PLUGIN_VERSION: String = "7.20.0"
+    private let PLUGIN_VERSION: String = "7.22.0"
     static let updateUrlDefault = "https://plugin.capgo.app/updates"
     static let statsUrlDefault = "https://plugin.capgo.app/stats"
     static let channelUrlDefault = "https://plugin.capgo.app/channel_self"
+    private let keepUrlPathFlagKey = "__capgo_keep_url_path_after_reload"
     private let customIdDefaultsKey = "CapacitorUpdater.customId"
     private let updateUrlDefaultsKey = "CapacitorUpdater.updateUrl"
     private let statsUrlDefaultsKey = "CapacitorUpdater.statsUrl"
     private let channelUrlDefaultsKey = "CapacitorUpdater.channelUrl"
+    private let lastFailedBundleDefaultsKey = "CapacitorUpdater.lastFailedBundle"
     // Note: DELAY_CONDITION_PREFERENCES is now defined in DelayUpdateUtils.DELAY_CONDITION_PREFERENCES
     private var updateUrl = ""
     private var backgroundTaskID: UIBackgroundTaskIdentifier = UIBackgroundTaskIdentifier.invalid
@@ -86,6 +91,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     private var periodCheckDelay = 0
     private var persistCustomId = false
     private var persistModifyUrl = false
+    private var allowManualBundleError = false
+    private var keepUrlPathFlagLastValue: Bool?
     public var shakeMenuEnabled = false
     let semaphoreReady = DispatchSemaphore(value: 0)
 
@@ -118,6 +125,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             }
         }
         persistModifyUrl = getConfig().getBoolean("persistModifyUrl", false)
+        allowManualBundleError = getConfig().getBoolean("allowManualBundleError", false)
         logger.info("init for device \(self.implementation.deviceID)")
         guard let versionName = getConfig().getString("version", Bundle.main.versionName) else {
             logger.error("Cannot get version name")
@@ -135,6 +143,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         autoDeleteFailed = getConfig().getBoolean("autoDeleteFailed", true)
         autoDeletePrevious = getConfig().getBoolean("autoDeletePrevious", true)
         keepUrlPathAfterReload = getConfig().getBoolean("keepUrlPathAfterReload", false)
+        syncKeepUrlPathFlag(enabled: keepUrlPathAfterReload)
 
         // Handle directUpdate configuration - support string values and backward compatibility
         if let directUpdateString = getConfig().getString("directUpdate") {
@@ -232,8 +241,58 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         self.checkForUpdateAfterDelay()
     }
 
+    private func syncKeepUrlPathFlag(enabled: Bool) {
+        let script: String
+        if enabled {
+            script = "(function(){ try { localStorage.setItem('\(keepUrlPathFlagKey)', '1'); } catch (err) {} window.__capgoKeepUrlPathAfterReload = true; var evt; try { evt = new CustomEvent('CapacitorUpdaterKeepUrlPathAfterReload', { detail: { enabled: true } }); } catch (e) { evt = document.createEvent('CustomEvent'); evt.initCustomEvent('CapacitorUpdaterKeepUrlPathAfterReload', false, false, { enabled: true }); } window.dispatchEvent(evt); })();"
+        } else {
+            script = "(function(){ try { localStorage.removeItem('\(keepUrlPathFlagKey)'); } catch (err) {} delete window.__capgoKeepUrlPathAfterReload; var evt; try { evt = new CustomEvent('CapacitorUpdaterKeepUrlPathAfterReload', { detail: { enabled: false } }); } catch (e) { evt = document.createEvent('CustomEvent'); evt.initCustomEvent('CapacitorUpdaterKeepUrlPathAfterReload', false, false, { enabled: false }); } window.dispatchEvent(evt); })();"
+        }
+        DispatchQueue.main.async { [weak self] in
+            guard let self = self, let webView = self.bridge?.webView else {
+                return
+            }
+            if self.keepUrlPathFlagLastValue != enabled {
+                let userScript = WKUserScript(source: script, injectionTime: .atDocumentStart, forMainFrameOnly: true)
+                webView.configuration.userContentController.addUserScript(userScript)
+                self.keepUrlPathFlagLastValue = enabled
+            }
+            webView.evaluateJavaScript(script, completionHandler: nil)
+        }
+    }
+
+    private func persistLastFailedBundle(_ bundle: BundleInfo?) {
+        if let bundle = bundle {
+            do {
+                try UserDefaults.standard.setObj(bundle, forKey: lastFailedBundleDefaultsKey)
+            } catch {
+                logger.error("Failed to persist failed bundle info \(error.localizedDescription)")
+            }
+        } else {
+            UserDefaults.standard.removeObject(forKey: lastFailedBundleDefaultsKey)
+        }
+        UserDefaults.standard.synchronize()
+    }
+
+    private func readLastFailedBundle() -> BundleInfo? {
+        do {
+            let bundle: BundleInfo = try UserDefaults.standard.getObj(forKey: lastFailedBundleDefaultsKey, castTo: BundleInfo.self)
+            return bundle
+        } catch ObjectSavableError.noValue {
+            return nil
+        } catch {
+            logger.error("Failed to read failed bundle info \(error.localizedDescription)")
+            UserDefaults.standard.removeObject(forKey: lastFailedBundleDefaultsKey)
+            UserDefaults.standard.synchronize()
+            return nil
+        }
+    }
+
     private func initialLoad() -> Bool {
         guard let bridge = self.bridge else { return false }
+        if keepUrlPathAfterReload {
+            syncKeepUrlPathFlag(enabled: true)
+        }
 
         let id = self.implementation.getCurrentBundleId()
         var dest: URL
@@ -460,34 +519,50 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             dest = self.implementation.getBundleDirectory(id: id)
         }
         logger.info("Reloading \(id)")
-        if let vc = bridge.viewController as? CAPBridgeViewController {
+
+        let performReload: () -> Bool = {
+            guard let vc = bridge.viewController as? CAPBridgeViewController else {
+                self.logger.error("Cannot get viewController")
+                return false
+            }
             guard let capBridge = vc.bridge else {
-                logger.error("Cannot get capBridge")
+                self.logger.error("Cannot get capBridge")
                 return false
             }
-            if keepUrlPathAfterReload {
-                DispatchQueue.main.async {
-                    guard let url = vc.webView?.url else {
-                        self.logger.error("vc.webView?.url is null?")
-                        return
-                    }
+            if self.keepUrlPathAfterReload {
+                if let currentURL = vc.webView?.url {
                     capBridge.setServerBasePath(dest.path)
                     var urlComponents = URLComponents(url: capBridge.config.serverURL, resolvingAgainstBaseURL: false)!
-                    urlComponents.path = url.path
+                    urlComponents.path = currentURL.path
+                    urlComponents.query = currentURL.query
+                    urlComponents.fragment = currentURL.fragment
                     if let finalUrl = urlComponents.url {
                         _ = vc.webView?.load(URLRequest(url: finalUrl))
+                    } else {
+                        self.logger.error("Unable to build final URL when keeping path after reload; falling back to base path")
+                        vc.setServerBasePath(path: dest.path)
                     }
+                } else {
+                    self.logger.error("vc.webView?.url is null? Falling back to base path reload.")
+                    vc.setServerBasePath(path: dest.path)
                 }
             } else {
                 vc.setServerBasePath(path: dest.path)
-
             }
-
             self.checkAppReady()
             self.notifyListeners("appReloaded", data: [:])
             return true
         }
-        return false
+
+        if Thread.isMainThread {
+            return performReload()
+        } else {
+            var result = false
+            DispatchQueue.main.sync {
+                result = performReload()
+            }
+            return result
+        }
     }
 
     @objc func reload(_ call: CAPPluginCall) {
@@ -545,6 +620,36 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    @objc func setBundleError(_ call: CAPPluginCall) {
+        if !allowManualBundleError {
+            logger.error("setBundleError called without allowManualBundleError")
+            call.reject("setBundleError not allowed. Set allowManualBundleError to true in your config to enable it.")
+            return
+        }
+        guard let id = call.getString("id") else {
+            logger.error("setBundleError called without id")
+            call.reject("setBundleError called without id")
+            return
+        }
+        let bundle = implementation.getBundleInfo(id: id)
+        if bundle.isUnknown() {
+            logger.error("setBundleError called with unknown bundle \(id)")
+            call.reject("Bundle \(id) does not exist")
+            return
+        }
+        if bundle.isBuiltin() {
+            logger.error("setBundleError called on builtin bundle")
+            call.reject("Cannot set builtin bundle to error state")
+            return
+        }
+        if self._isAutoUpdateEnabled() {
+            logger.warn("setBundleError used while autoUpdate is enabled; this method is intended for manual mode")
+        }
+        implementation.setError(bundle: bundle)
+        let updated = implementation.getBundleInfo(id: id)
+        call.resolve(["bundle": updated.toJSON()])
+    }
+
     @objc func list(_ call: CAPPluginCall) {
         let raw = call.getBool("raw", false)
         let res = implementation.list(raw: raw)
@@ -804,6 +909,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             self.notifyListeners("updateFailed", data: [
                 "bundle": current.toJSON()
             ])
+            self.persistLastFailedBundle(current)
             self.implementation.sendStats(action: "update_fail", versionName: current.getVersionName())
             self.implementation.setError(bundle: current)
             _ = self._reset(toLastSuccessful: true)
@@ -1085,6 +1191,15 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    private func notifyBreakingEvents(version: String) {
+        guard !version.isEmpty else {
+            return
+        }
+        let payload: [String: Any] = ["version": version]
+        self.notifyListeners("breakingAvailable", data: payload)
+        self.notifyListeners("majorAvailable", data: payload)
+    }
+
     func endBackGroundTaskWithNotif(
         msg: String,
         latestVersionName: String,
@@ -1144,8 +1259,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
 
             if let message = res.message, !message.isEmpty {
                 self.logger.info("API message: \(message)")
-                if res.major == true {
-                    self.notifyListeners("majorAvailable", data: ["version": res.version])
+                if res.breaking == true || res.major == true {
+                    self.notifyBreakingEvents(version: res.version)
                 }
                 self.endBackGroundTaskWithNotif(
                     msg: message,
@@ -1410,6 +1525,19 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         call.resolve(bundle!.toJSON())
     }
 
+    @objc func getFailedUpdate(_ call: CAPPluginCall) {
+        let bundle = self.readLastFailedBundle()
+        if bundle == nil || bundle?.isUnknown() == true {
+            call.resolve()
+            return
+        }
+
+        self.persistLastFailedBundle(nil)
+        call.resolve([
+            "bundle": bundle!.toJSON()
+        ])
+    }
+
     @objc func setShakeMenu(_ call: CAPPluginCall) {
         guard let enabled = call.getBool("enabled") else {
             logger.error("setShakeMenu called without enabled parameter")

package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift

@@ -289,6 +289,9 @@ import UIKit
                 if let major = response.value?.major {
                     latest.major = major
                 }
+                if let breaking = response.value?.breaking {
+                    latest.breaking = breaking
+                }
                 if let error = response.value?.error {
                     latest.error = error
                 }

package/ios/Sources/CapacitorUpdaterPlugin/InternalUtils.swift

@@ -157,6 +157,7 @@ struct AppVersionDec: Decodable {
     let error: String?
     let session_key: String?
     let major: Bool?
+    let breaking: Bool?
     let data: [String: String]?
     let manifest: [ManifestEntry]?
 }
@@ -169,6 +170,7 @@ public class AppVersion: NSObject {
     var error: String?
     var sessionKey: String?
     var major: Bool?
+    var breaking: Bool?
     var data: [String: String]?
     var manifest: [ManifestEntry]?
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "7.20.0",
+  "version": "7.22.0",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",