@capgo/capacitor-updater 4.0.0-alpha.8 → 4.0.1

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -9,9 +9,10 @@ import Version
 @objc(CapacitorUpdaterPlugin)
 public class CapacitorUpdaterPlugin: CAPPlugin {
     private var implementation = CapacitorUpdater()
-    static let updateUrlDefault = "https://xvwzpoazmxkqosrdewyv.functions.supabase.co/updates"
-    static let statsUrlDefault = "https://xvwzpoazmxkqosrdewyv.functions.supabase.co/stats"
-    static let DELAY_UPDATE = "delayUpdate"
+    static let updateUrlDefault = "https://api.capgo.app/updates"
+    static let statsUrlDefault = "https://api.capgo.app/stats"
+    let DELAY_UPDATE = "delayUpdate"
+    let DELAY_UPDATE_VAL = "delayUpdateVal"
     private var updateUrl = ""
     private var statsUrl = ""
     private var currentVersionNative: Version = "0.0.0"
@@ -23,17 +24,18 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
     private var autoDeletePrevious = false
     
     override public func load() {
+        print("\(self.implementation.TAG) init for device \(self.implementation.deviceID)")
         do {
-            currentVersionNative = try Version(Bundle.main.buildVersionNumber ?? "0.0.0")
+            currentVersionNative = try Version(Bundle.main.versionName ?? "0.0.0")
         } catch {
             print("\(self.implementation.TAG) Cannot get version native \(currentVersionNative)")
         }
-        autoDeleteFailed = getConfigValue("autoDeleteFailed") as? Bool ?? false
-        autoDeletePrevious = getConfigValue("autoDeletePrevious") as? Bool ?? false
-        updateUrl = getConfigValue("updateUrl") as? String ?? CapacitorUpdaterPlugin.updateUrlDefault
-        autoUpdate = getConfigValue("autoUpdate") as? Bool ?? false
-        appReadyTimeout = getConfigValue("appReadyTimeout") as? Int ?? 10000
-        resetWhenUpdate = getConfigValue("resetWhenUpdate") as? Bool ?? true
+        autoDeleteFailed = getConfig().getBoolean("autoDeleteFailed", true)
+        autoDeletePrevious = getConfig().getBoolean("autoDeletePrevious", true)
+        updateUrl = getConfig().getString("updateUrl") ?? CapacitorUpdaterPlugin.updateUrlDefault
+        autoUpdate = getConfig().getBoolean("autoUpdate", false)
+        appReadyTimeout = getConfig().getInt("appReadyTimeout", 10000)
+        resetWhenUpdate = getConfig().getBoolean("resetWhenUpdate", true)
 
         implementation.appId = Bundle.main.bundleIdentifier ?? ""
         implementation.notifyDownload = notifyDownload
@@ -41,14 +43,14 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         if (config?["appId"] != nil) {
             implementation.appId = config?["appId"] as! String
         }
-        implementation.statsUrl = getConfigValue("statsUrl") as? String ?? CapacitorUpdaterPlugin.statsUrlDefault
-
+        implementation.statsUrl = getConfig().getString("statsUrl") ?? CapacitorUpdaterPlugin.updateUrlDefault
         if (resetWhenUpdate) {
             self.cleanupObsoleteVersions()
         }
         let nc = NotificationCenter.default
         nc.addObserver(self, selector: #selector(appMovedToBackground), name: UIApplication.didEnterBackgroundNotification, object: nil)
         nc.addObserver(self, selector: #selector(appMovedToForeground), name: UIApplication.willEnterForegroundNotification, object: nil)
+        self._checkCancelDelay(killed: true)
         self.appMovedToForeground()
     }
 
@@ -61,8 +63,6 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         }
         if (LatestVersionNative != "0.0.0" && currentVersionNative.major > LatestVersionNative.major) {
             _ = self._reset(toLastSuccessful: false)
-            UserDefaults.standard.set("", forKey: "LatestVersionAutoUpdate")
-            UserDefaults.standard.set("", forKey: "LatestVersionNameAutoUpdate")
             let res = implementation.list()
             res.forEach { version in
                 print("\(self.implementation.TAG) Deleting obsolete bundle: \(version)")
@@ -81,8 +81,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         }
     }
 
-    @objc func getId(_ call: CAPPluginCall) {
-        call.resolve(["id": implementation.deviceID])
+    @objc func getDeviceId(_ call: CAPPluginCall) {
+        call.resolve(["deviceId": implementation.deviceID])
     }
 
     @objc func getPluginVersion(_ call: CAPPluginCall) {
@@ -106,6 +106,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             let res = try implementation.download(url: url!, version: version)
             call.resolve(res.toJSON())
         } catch {
+            print("\(self.implementation.TAG) download failed \(error.localizedDescription)")
+            self.notifyListeners("downloadFailed", data: ["version": version])
             call.reject("download failed", error.localizedDescription)
         }
     }
@@ -127,8 +129,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         if (self._reload()) {
             call.resolve()
         } else {
-            call.reject("Reload failed")
             print("\(self.implementation.TAG) Reload failed")
+            call.reject("Reload failed")
         }
     }
 
@@ -138,9 +140,9 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             call.reject("Next called without id")
             return
         }
-
         print("\(self.implementation.TAG) Setting next active id \(id)")
-        if (!self.implementation.setNextVersion(next: id)) {
+        if (!self.implementation.setNextBundle(next: id)) {
+            print("\(self.implementation.TAG) Set next version failed. id \(id) does not exist.")
             call.reject("Set next version failed. id \(id) does not exist.")
         } else {
             call.resolve(self.implementation.getBundleInfo(id: id).toJSON())
@@ -173,6 +175,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         if (res) {
             call.resolve()
         } else {
+            print("\(self.implementation.TAG) Delete failed, id \(id) doesn't exist")
             call.reject("Delete failed, id \(id) doesn't exist")
         }
     }
@@ -190,14 +193,14 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
 
     @objc func getLatest(_ call: CAPPluginCall) {
         let res = self.implementation.getLatest(url: URL(string: self.updateUrl)!)
-        call.resolve((res?.toDict())!)
+        call.resolve(res.toDict())
     }
 
     @objc func _reset(toLastSuccessful: Bool) -> Bool {
         guard let bridge = self.bridge else { return false }
 
         if let vc = bridge.viewController as? CAPBridgeViewController {
-            let fallback: BundleInfo = self.implementation.getFallbackVersion()
+            let fallback: BundleInfo = self.implementation.getFallbackBundle()
             if (toLastSuccessful && !fallback.isBuiltin()) {
                 print("\(self.implementation.TAG) Resetting to: \(fallback.toString())")
                 return self.implementation.set(bundle: fallback) && self._reload()
@@ -219,6 +222,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         if (self._reset(toLastSuccessful: toLastSuccessful)) {
             return call.resolve()
         }
+        print("\(self.implementation.TAG) Reset failed")
         call.reject("\(self.implementation.TAG) Reset failed")
     }
     
@@ -226,27 +230,79 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         let bundle: BundleInfo = self.implementation.getCurrentBundle()
         call.resolve([
             "bundle": bundle.toJSON(),
-            "native": self.currentVersionNative
+            "native": self.currentVersionNative.description
         ])
     }
 
     @objc func notifyAppReady(_ call: CAPPluginCall) {
-        print("\(self.implementation.TAG) Current bundle loaded successfully. ['notifyAppReady()' was called]")
         let version = self.implementation.getCurrentBundle()
-        self.implementation.commit(bundle: version)
+        self.implementation.setSuccess(bundle: version, autoDeletePrevious: self.autoDeletePrevious)
+        print("\(self.implementation.TAG) Current bundle loaded successfully. ['notifyAppReady()' was called] \(version.toString())")
         call.resolve()
     }
     
     @objc func setDelay(_ call: CAPPluginCall) {
-        guard let delay = call.getBool("delay") else {
-            print("\(self.implementation.TAG) setDelay called without delay")
-            call.reject("setDelay called without delay")
+        guard let kind = call.getString("kind") else {
+            print("\(self.implementation.TAG) setDelay called without kind")
+            call.reject("setDelay called without kind")
             return
         }
-        UserDefaults.standard.set(delay, forKey: "delayUpdate")
+        let val = call.getString("value") ?? ""
+        UserDefaults.standard.set(kind, forKey: DELAY_UPDATE)
+        UserDefaults.standard.set(val, forKey: DELAY_UPDATE_VAL)
+        UserDefaults.standard.synchronize()
+        print("\(self.implementation.TAG) Delay update saved.", kind, val)
         call.resolve()
     }
-    
+
+    private func _cancelDelay(source: String) -> Void {
+        print("\(self.implementation.TAG) delay Canceled from \(source)")
+        UserDefaults.standard.removeObject(forKey: DELAY_UPDATE)
+        UserDefaults.standard.removeObject(forKey: DELAY_UPDATE_VAL)
+        UserDefaults.standard.synchronize()
+    }
+
+    @objc func cancelDelay(_ call: CAPPluginCall) {
+        self._cancelDelay(source: "JS")
+        call.resolve()
+    }
+
+    private func _checkCancelDelay(killed: Bool) -> Void {
+        let delayUpdate = UserDefaults.standard.string(forKey: DELAY_UPDATE)
+        if (delayUpdate != nil) {
+            if (delayUpdate == "background" && !killed) {
+                self._cancelDelay(source: "background check")
+            } else if (delayUpdate == "kill" && killed) {
+                self._cancelDelay(source: "kill check")
+            }
+            guard let delayVal = UserDefaults.standard.string(forKey: DELAY_UPDATE_VAL) else {
+                self._cancelDelay(source: "delayVal absent")
+                return
+            }
+            if (delayUpdate == "date") {
+                let dateFormatter = ISO8601DateFormatter()
+                guard let ExpireDate = dateFormatter.date(from: delayVal) else {
+                    self._cancelDelay(source: "date parsing issue")
+                    return
+                }
+                if (ExpireDate < Date())  {
+                    self._cancelDelay(source: "date expired")
+                }
+            } else if (delayUpdate == "nativeVersion") {
+                do {
+                    let versionLimit = try Version(delayVal)
+                    if (self.currentVersionNative >= versionLimit) {
+                        self._cancelDelay(source: "nativeVersion above limit")
+                    }
+                } catch {
+                    self._cancelDelay(source: "nativeVersion parsing issue")
+                }
+            }
+        }
+
+        self.checkAppReady()
+    }
+
     private func _isAutoUpdateEnabled() -> Bool {
         return self.autoUpdate && self.updateUrl != ""
     }
@@ -266,7 +322,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(self.appReadyTimeout), execute: self.appReadyCheck!)
     }
 
-    func DeferredNotifyAppReadyCheck() {
+    func checkRevert() {
         // Automatically roll back to fallback version if notifyAppReady has not been called yet
         let current: BundleInfo = self.implementation.getCurrentBundle()
         if(current.isBuiltin()) {
@@ -274,16 +330,33 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             return
         }
 
+        print("\(self.implementation.TAG) Current bundle is: \(current.toString())")
+
         if(BundleStatus.SUCCESS.localizedString != current.getStatus()) {
             print("\(self.implementation.TAG) notifyAppReady was not called, roll back current bundle: \(current.toString())")
-            self.implementation.rollback(bundle: current)
-            let res = self._reset(toLastSuccessful: true)
-            if (!res) {
-                return
+            print("\(self.implementation.TAG) Did you forget to call 'notifyAppReady()' in your Capacitor App code?")
+            self.notifyListeners("updateFailed", data: [
+                "bundle": current.toJSON()
+            ])
+            self.implementation.sendStats(action: "update_fail", versionName: current.getVersionName())
+            self.implementation.setError(bundle: current)
+            _ = self._reset(toLastSuccessful: true)
+            if (self.autoDeleteFailed && !current.isBuiltin()) {
+                print("\(self.implementation.TAG) Deleting failing bundle: \(current.toString())")
+                let res = self.implementation.delete(id: current.getId(), removeInfo: false)
+                if (!res) {
+                    print("\(self.implementation.TAG) Delete version deleted: \(current.toString())")
+                } else {
+                    print("\(self.implementation.TAG) Failed to delete failed bundle: \(current.toString())")
+                }
             }
         } else {
             print("\(self.implementation.TAG) notifyAppReady was called. This is fine: \(current.toString())")
         }
+    }
+
+    func DeferredNotifyAppReadyCheck() {
+        self.checkRevert()
         self.appReadyCheck = nil
     }
 
@@ -293,45 +366,51 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                 print("\(self.implementation.TAG) Check for update via \(self.updateUrl)")
                 let url = URL(string: self.updateUrl)!
                 let res = self.implementation.getLatest(url: url)
-                if (res == nil) {
-                    print("\(self.implementation.TAG) No result found in \(self.updateUrl)")
-                    return
-                }
-                if ((res?.message) != nil) {
-                    print("\(self.implementation.TAG) message \(res!.message ?? "")")
-                    if (res?.major == true) {
-                        self.notifyListeners("majorAvailable", data: ["version": res?.version ?? "0.0.0"])
+                let current = self.implementation.getCurrentBundle()
+ 
+                if ((res.message) != nil) {
+                    print("\(self.implementation.TAG) message \(res.message ?? "")")
+                    if (res.major == true) {
+                        self.notifyListeners("majorAvailable", data: ["version": res.version])
                     }
+                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     return
                 }
-                guard let downloadUrl = URL(string: res?.url ?? "") else {
+                guard let downloadUrl = URL(string: res.url) else {
                     print("\(self.implementation.TAG) Error no url or wrong format")
+                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     return
                 }
-                let current = self.implementation.getCurrentBundle()
-                let latestVersionName = res?.version
-                if (latestVersionName != nil && latestVersionName != "" && current.getVersionName() != latestVersionName) {
-                    let latest = self.implementation.getBundleInfoByVersionName(version: latestVersionName!)
+                let latestVersionName = res.version
+                if (latestVersionName != "" && current.getVersionName() != latestVersionName) {
+                    let latest = self.implementation.getBundleInfoByVersionName(version: latestVersionName)
                     if (latest != nil) {
                         if(latest!.isErrorStatus()) {
                             print("\(self.implementation.TAG) Latest version already exists, and is in error state. Aborting update.")
+                            self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                             return
                         }
                         if(latest!.isDownloaded()){
                             print("\(self.implementation.TAG) Latest version already exists and download is NOT required. Update will occur next time app moves to background.")
-                            let _ = self.implementation.setNextVersion(next: latest!.getId())
+                            self.notifyListeners("updateAvailable", data: ["bundle": current.toJSON()])
+                            let _ = self.implementation.setNextBundle(next: latest!.getId())
                             return
                         }
                     }
 
                     do {
-                        print("\(self.implementation.TAG) New bundle: \(latestVersionName!) found. Current is: \(current.getVersionName()). Update will occur next time app moves to background.")
-                        let next = try self.implementation.download(url: downloadUrl, version: latestVersionName!)
-
-                        let _ = self.implementation.setNextVersion(next: next.getId())
+                        print("\(self.implementation.TAG) New bundle: \(latestVersionName) found. Current is: \(current.getVersionName()). Update will occur next time app moves to background.")
+                        let next = try self.implementation.download(url: downloadUrl, version: latestVersionName)
+                        self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()])
+                        let _ = self.implementation.setNextBundle(next: next.getId())
                     } catch {
                         print("\(self.implementation.TAG) Error downloading file", error.localizedDescription)
+                        self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
+                        self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     }
+                } else {
+                    print("\(self.implementation.TAG) No need to update, \(current.getId()) is the latest bundle.")
+                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                 }
             }
         }
@@ -340,85 +419,24 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
     }
 
     @objc func appMovedToBackground() {
-        print("\(self.implementation.TAG) Check for waiting update")
-        let delayUpdate = UserDefaults.standard.bool(forKey: "delayUpdate")
-        UserDefaults.standard.set(false, forKey: "delayUpdate")
-        if (delayUpdate) {
+        print("\(self.implementation.TAG) Check for pending update")
+        let delayUpdate = UserDefaults.standard.string(forKey: DELAY_UPDATE)
+        self._checkCancelDelay(killed: false)
+        if (delayUpdate != nil) {
             print("\(self.implementation.TAG) Update delayed to next backgrounding")
             return
         }
 
-        let fallback: BundleInfo = self.implementation.getFallbackVersion()
         let current: BundleInfo = self.implementation.getCurrentBundle()
-        let next: BundleInfo? = self.implementation.getNextVersion()
-
-        let success: Bool = current.getStatus() == BundleStatus.SUCCESS.localizedString
+        let next: BundleInfo? = self.implementation.getNextBundle()
 
-        print("\(self.implementation.TAG) Fallback bundle is: \(fallback.toString())")
-        print("\(self.implementation.TAG) Current bundle is: \(current.toString())")
-
-        if (next != nil && !next!.isErrorStatus() && (next!.getVersionName() != current.getVersionName())) {
+        if (next != nil && !next!.isErrorStatus() && next!.getVersionName() != current.getVersionName()) {
             print("\(self.implementation.TAG) Next bundle is: \(next!.toString())")
             if (self.implementation.set(bundle: next!) && self._reload()) {
-                print("\(self.implementation.TAG) Updated to bundle: \(next!)")
-                let _ = self.implementation.setNextVersion(next: Optional<String>.none)
-            } else {
-                print("\(self.implementation.TAG) Updated to bundle: \(next!) Failed!")
-            }
-        } else if (!success) {
-            // There is a no next version, and the current version has failed
-
-            if(!current.isBuiltin()) {
-                // Don't try to roll back the builtin version. Nothing we can do.
-
-                self.implementation.rollback(bundle: current)
-                
-                print("\(self.implementation.TAG) Update failed: 'notifyAppReady()' was never called.")
-                print("\(self.implementation.TAG) Version: \(current.toString()), is in error state.")
-                print("\(self.implementation.TAG) Will fallback to: \(fallback.toString()) on application restart.")
-                print("\(self.implementation.TAG) Did you forget to call 'notifyAppReady()' in your Capacitor App code?")
-
-                self.notifyListeners("updateFailed", data: [
-                    "bundle": current.toJSON()
-                ])
-                self.implementation.sendStats(action: "revert", bundle: current)
-                if (!fallback.isBuiltin() && !(fallback == current)) {
-                    let res = self.implementation.set(bundle: fallback)
-                    if (res && self._reload()) {
-                        print("\(self.implementation.TAG) Revert to bundle: \(fallback.toString())")
-                    } else {
-                        print("\(self.implementation.TAG) Revert to bundle: \(fallback.toString()) Failed!")
-                    }
-                } else {
-                    if (self._reset(toLastSuccessful: false)) {
-                        print("\(self.implementation.TAG) Reverted to 'builtin' bundle.")
-                    }
-                }
-
-                if (self.autoDeleteFailed) {
-                    print("\(self.implementation.TAG) Deleting failing bundle: \(current.toString())")
-                    let res = self.implementation.delete(id: current.getId())
-                    if (!res) {
-                        print("\(self.implementation.TAG) Delete version deleted: \(current.toString())")
-                    } else {
-                        print("\(self.implementation.TAG) Failed to delete failed bundle: \(current.toString())")
-                    }
-                }
+                print("\(self.implementation.TAG) Updated to bundle: \(next!.toString())")
+                let _ = self.implementation.setNextBundle(next: Optional<String>.none)
             } else {
-                // Nothing we can/should do by default if the 'builtin' bundle fails to call 'notifyAppReady()'.
-            }
-        } else if (!fallback.isBuiltin()) {
-            // There is a no next version, and the current version has succeeded
-            self.implementation.commit(bundle: current)
-
-            if(self.autoDeletePrevious) {
-                print("\(self.implementation.TAG) Version successfully loaded: \(current.toString())")
-                let res = self.implementation.delete(id: fallback.getId())
-                if (res) {
-                    print("\(self.implementation.TAG) Deleted previous bundle: \(fallback.toString())")
-                } else {
-                    print("\(self.implementation.TAG) Failed to delete previous bundle: \(fallback.toString())")
-                }
+                print("\(self.implementation.TAG) Update to bundle: \(next!.toString()) Failed!")
             }
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.0.0-alpha.8",
-  "license": "AGPL-3.0-only",
+  "version": "4.0.1",
+  "license": "LGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -68,7 +68,7 @@
     "typescript": "^4.6.2"
   },
   "peerDependencies": {
-    "@capacitor/core": "^3.0.0"
+    "@capacitor/core": "^3.0.0 || ^4.0.0 || ^4.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",