@capgo/capacitor-updater 3.3.12 → 4.0.0-alpha.1

package/ios/Plugin/CapacitorUpdater.swift

@@ -10,6 +10,11 @@ extension URL {
         return FileManager().fileExists(atPath: self.path)
     }
 }
+extension Date {
+    func adding(minutes: Int) -> Date {
+        return Calendar.current.date(byAdding: .minute, value: minutes, to: self)!
+    }
+}
 struct AppVersionDec: Decodable {
     let version: String?
     let url: String?
@@ -36,9 +41,43 @@ extension Bundle {
     }
 }
 
+extension ISO8601DateFormatter {
+    convenience init(_ formatOptions: Options) {
+        self.init()
+        self.formatOptions = formatOptions
+    }
+}
+extension Formatter {
+    static let iso8601withFractionalSeconds = ISO8601DateFormatter([.withInternetDateTime, .withFractionalSeconds])
+}
+extension Date {
+    var iso8601withFractionalSeconds: String { return Formatter.iso8601withFractionalSeconds.string(from: self) }
+}
+extension String {
+    
+    var fileURL: URL {
+        return URL(fileURLWithPath: self)
+    }
+    
+    var lastPathComponent:String {
+        get {
+            return fileURL.lastPathComponent
+        }
+    }
+    var iso8601withFractionalSeconds: Date? {
+        return Formatter.iso8601withFractionalSeconds.date(from: self)
+    }
+    func trim(using characterSet: CharacterSet = .whitespacesAndNewlines) -> String {
+        return trimmingCharacters(in: characterSet)
+    }
+}
+
 enum CustomError: Error {
     // Throw when an unzip fail
     case cannotUnzip
+    case cannotUnflat
+    case cannotCreateDirectory
+    case cannotDeleteDirectory
 
     // Throw in all other cases
     case unexpected(code: Int)
@@ -52,6 +91,21 @@ extension CustomError: LocalizedError {
                 "The file cannot be unzip",
                 comment: "Invalid zip"
             )
+        case .cannotCreateDirectory:
+            return NSLocalizedString(
+                "The folder cannot be created",
+                comment: "Invalid folder"
+            )
+        case .cannotDeleteDirectory:
+            return NSLocalizedString(
+                "The folder cannot be deleted",
+                comment: "Invalid folder"
+            )
+        case .cannotUnflat:
+            return NSLocalizedString(
+                "The file cannot be unflat",
+                comment: "Invalid folder"
+            )
         case .unexpected(_):
             return NSLocalizedString(
                 "An unexpected error occurred.",
@@ -63,21 +117,29 @@ extension CustomError: LocalizedError {
 
 @objc public class CapacitorUpdater: NSObject {
     
-    private var versionBuild = Bundle.main.releaseVersionNumber ?? ""
-    private var versionCode = Bundle.main.buildVersionNumber ?? ""
-    private var versionOs = ProcessInfo().operatingSystemVersion.getFullVersion()
+    private let versionBuild = Bundle.main.releaseVersionNumber ?? ""
+    private let versionCode = Bundle.main.buildVersionNumber ?? ""
+    private let versionOs = ProcessInfo().operatingSystemVersion.getFullVersion()
+    private let documentsDir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
+    private let libraryDir = FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
+    private let bundleDirectoryHot = "versions"
+    private let DEFAULT_FOLDER = ""
+    private let bundleDirectory = "NoCloud/ionic_built_snapshots"
+    private let INFO_SUFFIX = "_info"
+    private let FALLBACK_VERSION = "pastVersion"
+    private let NEXT_VERSION = "nextVersion"
+
     private var lastPathHot = ""
     private var lastPathPersist = ""
-    private let basePathHot = "versions"
-    private let basePathPersist = "NoCloud/ionic_built_snapshots"
-    private let documentsUrl = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
-    private let libraryUrl = FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
     
+    public let TAG = "✨  Capacitor-updater:";
+    public let CAP_SERVER_PATH = "serverBasePath"
+    public let pluginVersion = "4.0.0-alpha.1"
     public var statsUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""
-    public var notifyDownload: (Int) -> Void = { _ in }
-    public var pluginVersion = "3.2.0"
+    
+    public var notifyDownload: (String, Int) -> Void = { _,_  in }
 
     private func calcTotalPercent(percent: Int, min: Int, max: Int) -> Int {
         return (percent * (max - min)) / 100 + min;
@@ -92,25 +154,27 @@ extension CustomError: LocalizedError {
     // Hot Reload path /var/mobile/Containers/Data/Application/8C0C07BE-0FD3-4FD4-B7DF-90A88E12B8C3/Documents/FOLDER
     // Normal /private/var/containers/Bundle/Application/8C0C07BE-0FD3-4FD4-B7DF-90A88E12B8C3/App.app/public
     
-    private func prepareFolder(source: URL) {
+    private func prepareFolder(source: URL) throws {
         if (!FileManager.default.fileExists(atPath: source.path)) {
             do {
                 try FileManager.default.createDirectory(atPath: source.path, withIntermediateDirectories: true, attributes: nil)
             } catch {
-                print("✨  Capacitor-updater: Cannot createDirectory \(source.path)")
+                print("\(self.TAG) Cannot createDirectory \(source.path)")
+                throw CustomError.cannotCreateDirectory
             }
         }
     }
     
-    private func deleteFolder(source: URL) {
+    private func deleteFolder(source: URL) throws {
         do {
             try FileManager.default.removeItem(atPath: source.path)
         } catch {
-            print("✨  Capacitor-updater: File not removed. \(source.path)")
+            print("\(self.TAG) File not removed. \(source.path)")
+            throw CustomError.cannotDeleteDirectory
         }
     }
     
-    private func unflatFolder(source: URL, dest: URL) -> Bool {
+    private func unflatFolder(source: URL, dest: URL) throws -> Bool {
         let index = source.appendingPathComponent("index.html")
         do {
             let files = try FileManager.default.contentsOfDirectory(atPath: source.path)
@@ -122,37 +186,37 @@ extension CustomError: LocalizedError {
                 return false
             }
         } catch {
-            print("✨  Capacitor-updater: File not moved. source: \(source.path) dest: \(dest.path)")
-            return true
+            print("\(self.TAG) File not moved. source: \(source.path) dest: \(dest.path)")
+            throw CustomError.cannotUnflat
         }
     }
     
-    private func saveDownloaded(sourceZip: URL, version: String, base: URL) throws {
-        prepareFolder(source: base)
-        let destHot = base.appendingPathComponent(version)
-        let destUnZip = documentsUrl.appendingPathComponent(randomString(length: 10))
+    private func saveDownloaded(sourceZip: URL, id: String, base: URL) throws {
+        try prepareFolder(source: base)
+        let destHot = base.appendingPathComponent(id)
+        let destUnZip = documentsDir.appendingPathComponent(randomString(length: 10))
         if (!SSZipArchive.unzipFile(atPath: sourceZip.path, toDestination: destUnZip.path)) {
             throw CustomError.cannotUnzip
         }
-        if (unflatFolder(source: destUnZip, dest: destHot)) {
-            deleteFolder(source: destUnZip)
+        if (try unflatFolder(source: destUnZip, dest: destHot)) {
+            try deleteFolder(source: destUnZip)
         }
     }
 
     public func getLatest(url: URL) -> AppVersion? {
         let semaphore = DispatchSemaphore(value: 0)
         let latest = AppVersion()
-        let headers: HTTPHeaders = [
-            "cap_platform": "ios",
-            "cap_device_id": self.deviceID,
-            "cap_app_id": self.appId,
-            "cap_version_build": self.versionBuild,
-            "cap_version_code": self.versionCode,
-            "cap_version_os": self.versionOs,
-            "cap_plugin_version": self.pluginVersion,
-            "cap_version_name": UserDefaults.standard.string(forKey: "versionName") ?? "builtin"
+        let parameters: [String: String] = [
+            "platform": "ios",
+            "device_id": self.deviceID,
+            "app_id": self.appId,
+            "version_build": self.versionBuild,
+            "version_code": self.versionCode,
+            "version_os": self.versionOs,
+            "plugin_version": self.pluginVersion,
+            "version_name": self.getCurrentBundle().getVersionName()
         ]
-        let request = AF.request(url, headers: headers)
+        let request = AF.request(url, method: .post,parameters: parameters, encoder: JSONParameterEncoder.default)
 
         request.validate().responseDecodable(of: AppVersionDec.self) { response in
             switch response.result {
@@ -168,9 +232,10 @@ extension CustomError: LocalizedError {
                     }
                     if let message = response.value?.message {
                         latest.message = message
+                        print("\(self.TAG) Auto-update message: \(message)")
                     }
                 case let .failure(error):
-                    print("✨  Capacitor-updater: Error getting Latest", error )
+                    print("\(self.TAG) Error getting Latest", error )
             }
             semaphore.signal()
         }
@@ -178,9 +243,15 @@ extension CustomError: LocalizedError {
         return latest.url != "" ? latest : nil
     }
     
-    public func download(url: URL) throws -> String {
+    private func setCurrentBundle(bundle: String) {
+        UserDefaults.standard.set(bundle, forKey: self.CAP_SERVER_PATH)
+        print("\(self.TAG) Current bundle set to: \(bundle)")
+        UserDefaults.standard.synchronize()
+    }
+
+    public func download(url: URL, version: String) throws -> BundleInfo {
         let semaphore = DispatchSemaphore(value: 0)
-        var version: String = ""
+        let id: String = self.randomString(length: 10)
         var mainError: NSError? = nil
         let destination: DownloadRequest.Destination = { _, _ in
             let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
@@ -192,112 +263,143 @@ extension CustomError: LocalizedError {
         
         request.downloadProgress { progress in
             let percent = self.calcTotalPercent(percent: Int(progress.fractionCompleted * 100), min: 10, max: 70)
-            self.notifyDownload(percent)
+            self.notifyDownload(id, percent)
         }
         request.responseURL { (response) in
             if let fileURL = response.fileURL {
                 switch response.result {
                 case .success:
-                    self.notifyDownload(71);
-                    version = self.randomString(length: 10)
+                    self.notifyDownload(id, 71)
                     do {
-                        try self.saveDownloaded(sourceZip: fileURL, version: version, base: self.documentsUrl.appendingPathComponent(self.basePathHot))
-                        self.notifyDownload(85);
-                        try self.saveDownloaded(sourceZip: fileURL, version: version, base: self.libraryUrl.appendingPathComponent(self.basePathPersist))
-                        self.notifyDownload(100);
-                        self.deleteFolder(source: fileURL)
+                        try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.documentsDir.appendingPathComponent(self.bundleDirectoryHot))
+                        self.notifyDownload(id, 85)
+                        try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.libraryDir.appendingPathComponent(self.bundleDirectory))
+                        self.notifyDownload(id, 100)
+                        try self.deleteFolder(source: fileURL)
                     } catch {
-                        print("✨  Capacitor-updater: download unzip error", error)
+                        print("\(self.TAG) download unzip error", error)
                         mainError = error as NSError
                     }
                 case let .failure(error):
-                    print("✨  Capacitor-updater: download error", error)
+                    print("\(self.TAG) download error", error)
                     mainError = error as NSError
                 }
             }
             semaphore.signal()
         }
-        self.notifyDownload(0);
+        self.saveBundleInfo(id: id, bundle: BundleInfo(id: id, version: version, status: BundleStatus.DOWNLOADING, downloaded: Date()))
+        self.notifyDownload(id, 0)
         semaphore.wait()
         if (mainError != nil) {
             throw mainError!
         }
-        return version
+        let info: BundleInfo = BundleInfo(id: id, version: version, status: BundleStatus.PENDING, downloaded: Date())
+        self.saveBundleInfo(id: id, bundle: info)
+        return info
     }
 
-    public func list() -> [String] {
-        let dest = documentsUrl.appendingPathComponent(basePathHot)
+    public func list() -> [BundleInfo] {
+        let dest = documentsDir.appendingPathComponent(bundleDirectoryHot)
         do {
             let files = try FileManager.default.contentsOfDirectory(atPath: dest.path)
-            return files
+            var res: [BundleInfo] = []
+            print("\(self.TAG) list File : \(dest.path)")
+            if (dest.exist) {
+                for id in files {
+                    res.append(self.getBundleInfo(id: id));
+                }
+            }
+            return res
         } catch {
-            print("✨  Capacitor-updater: No version available \(dest.path)")
+            print("\(self.TAG) No version available \(dest.path)")
             return []
         }
     }
     
-    public func delete(version: String, versionName: String) -> Bool {
-        let destHot = documentsUrl.appendingPathComponent(basePathHot).appendingPathComponent(version)
-        let destPersist = libraryUrl.appendingPathComponent(basePathPersist).appendingPathComponent(version)
+    public func delete(id: String) -> Bool {
+        let deleted: BundleInfo = self.getBundleInfo(id: id)
+        let destHot = documentsDir.appendingPathComponent(bundleDirectoryHot).appendingPathComponent(id)
+        let destPersist = libraryDir.appendingPathComponent(bundleDirectory).appendingPathComponent(id)
         do {
             try FileManager.default.removeItem(atPath: destHot.path)
         } catch {
-            print("✨  Capacitor-updater: Hot Folder \(destHot.path), not removed.")
+            print("\(self.TAG) Hot Folder \(destHot.path), not removed.")
         }
         do {
             try FileManager.default.removeItem(atPath: destPersist.path)
         } catch {
-            print("✨  Capacitor-updater: Folder \(destPersist.path), not removed.")
+            print("\(self.TAG) Folder \(destPersist.path), not removed.")
             return false
         }
-        sendStats(action: "delete", version: versionName)
+        self.removeBundleInfo(id: id)
+        self.sendStats(action: "delete", bundle: deleted)
         return true
     }
 
-    public func set(version: String, versionName: String) -> Bool {
-        let destHot = documentsUrl.appendingPathComponent(basePathHot).appendingPathComponent(version)
+    public func getBundleDirectory(id: String) -> URL {
+        return libraryDir.appendingPathComponent(self.bundleDirectory).appendingPathComponent(id)
+    }
+
+    public func set(bundle: BundleInfo) -> Bool {
+        return self.set(id: bundle.getId());
+    }
+
+    public func set(id: String) -> Bool {
+        let destHot = self.getPathHot(id: id)
+        let destHotPersist = self.getPathPersist(id: id)
         let indexHot = destHot.appendingPathComponent("index.html")
-        let destHotPersist = libraryUrl.appendingPathComponent(basePathPersist).appendingPathComponent(version)
         let indexPersist = destHotPersist.appendingPathComponent("index.html")
-        if (destHot.isDirectory && destHotPersist.isDirectory && indexHot.exist && indexPersist.exist) {
-            UserDefaults.standard.set(destHot.path, forKey: "lastPathHot")
-            UserDefaults.standard.set(destHotPersist.path, forKey: "lastPathPersist")
-            UserDefaults.standard.set(versionName, forKey: "versionName")
-            sendStats(action: "set", version: versionName)
+        let existing: BundleInfo = self.getBundleInfo(id: id)
+        let bundle: URL = self.getBundleDirectory(id: id)
+        print("bundle", bundle.path)
+        if (bundle.isDirectory && destHotPersist.isDirectory && indexHot.exist && indexPersist.exist) {
+            self.setCurrentBundle(bundle: String(bundle.path.suffix(10)))
+            self.setBundleStatus(id: id, status: BundleStatus.PENDING)
+            sendStats(action: "set", bundle: existing)
             return true
         }
-        sendStats(action: "set_fail", version: versionName)
+        sendStats(action: "set_fail", bundle: existing)
         return false
     }
     
-    public func getLastPathHot() -> String {
-        return UserDefaults.standard.string(forKey: "lastPathHot") ?? ""
+    public func getPathHot(id: String) -> URL {
+        return documentsDir.appendingPathComponent(self.bundleDirectoryHot).appendingPathComponent(id)
     }
     
-    public func getVersionName() -> String {
-        return UserDefaults.standard.string(forKey: "versionName") ?? ""
+    public func getPathPersist(id: String) -> URL {
+        return libraryDir.appendingPathComponent(self.bundleDirectory).appendingPathComponent(id)
     }
     
-    public func getLastPathPersist() -> String {
-        return UserDefaults.standard.string(forKey: "lastPathPersist") ?? ""
+    public func reset() {
+        self.reset(isInternal: false)
     }
     
-    public func reset() {
-        let version = UserDefaults.standard.string(forKey: "versionName") ?? ""
-        sendStats(action: "reset", version: version)
-        UserDefaults.standard.set("", forKey: "lastPathHot")
-        UserDefaults.standard.set("", forKey: "lastPathPersist")
-        UserDefaults.standard.set("", forKey: "versionName")
+    public func reset(isInternal: Bool) {
+        self.setCurrentBundle(bundle: "")
+        self.setFallbackVersion(fallback: Optional<BundleInfo>.none)
+        let _ = self.setNextVersion(next: Optional<String>.none)
         UserDefaults.standard.synchronize()
+        if(!isInternal) {
+            sendStats(action: "reset", bundle: self.getCurrentBundle())
+        }
+    }
+    
+    public func commit(bundle: BundleInfo) {
+        self.setBundleStatus(id: bundle.getId(), status: BundleStatus.SUCCESS)
+        self.setFallbackVersion(fallback: bundle)
+    }
+    
+    public func rollback(bundle: BundleInfo) {
+        self.setBundleStatus(id: bundle.getId(), status: BundleStatus.ERROR);
     }
 
-    func sendStats(action: String, version: String) {
+    func sendStats(action: String, bundle: BundleInfo) {
         if (statsUrl == "") { return }
         let parameters: [String: String] = [
             "platform": "ios",
             "action": action,
             "device_id": self.deviceID,
-            "version_name": version,
+            "version_name": bundle.getVersionName(),
             "version_build": self.versionBuild,
             "version_code": self.versionCode,
             "version_os": self.versionOs,
@@ -307,8 +409,122 @@ extension CustomError: LocalizedError {
 
         DispatchQueue.global(qos: .background).async {
             let _ = AF.request(self.statsUrl, method: .post,parameters: parameters, encoder: JSONParameterEncoder.default)
-            print("✨  Capacitor-updater: Stats send for \(action), version \(version)")
+            print("\(self.TAG) Stats send for \(action), version \(bundle.getVersionName())")
         }
     }
-    
+
+    public func getBundleInfo(id: String = BundleInfo.ID_BUILTIN) -> BundleInfo {
+        print("\(self.TAG) Getting info for bundle [\(id)]")
+        if(BundleInfo.ID_BUILTIN == id) {
+            return BundleInfo(id: id, version: "", status: BundleStatus.SUCCESS)
+        }
+        do {
+            let result: BundleInfo = try UserDefaults.standard.getObj(forKey: "\(id)\(self.INFO_SUFFIX)", castTo: BundleInfo.self)
+            print("\(self.TAG) Returning info bundle [\(id)]", result.toString())
+            return result
+        } catch {
+            print("\(self.TAG) Failed to parse info for bundle [\(id)]", error.localizedDescription)
+            return BundleInfo(id: id, version: "", status: BundleStatus.PENDING)
+        }
+    }
+
+    public func getBundleInfoByVersionName(version: String) -> BundleInfo? {
+        let installed : Array<BundleInfo> = self.list()
+        for i in installed {
+            if(i.getVersionName() == version) {
+                return i
+            }
+        }
+        return nil
+    }
+
+    private func removeBundleInfo(id: String) {
+        self.saveBundleInfo(id: id, bundle: nil)
+    }
+
+    private func saveBundleInfo(id: String, bundle: BundleInfo?) {
+        if (bundle != nil && (bundle!.isBuiltin() || bundle!.isUnknown())) {
+            print("\(self.TAG) Not saving info for bundle [\(id)]", bundle!.toString())
+            return
+        }
+        if(bundle == nil) {
+            print("\(self.TAG) Removing info for bundle [\(id)]")
+            UserDefaults.standard.removeObject(forKey: "\(id)\(self.INFO_SUFFIX)")
+        } else {
+            let update = bundle!.setId(id: id)
+            print("\(self.TAG) Storing info for bundle [\(id)]", update.toString())
+            do {
+                try UserDefaults.standard.setObj(update, forKey: "\(id)\(self.INFO_SUFFIX)")
+            } catch {
+                print("\(self.TAG) Failed to save info for bundle [\(id)]", error.localizedDescription)
+            }
+        }
+        UserDefaults.standard.synchronize()
+    }
+
+    public func setVersionName(id: String, version: String) {
+        print("\(self.TAG) Setting version for folder [\(id)] to \(version)")
+        let info = self.getBundleInfo(id: id)
+        self.saveBundleInfo(id: id, bundle: info.setVersionName(version: version))
+    }
+
+    private func setBundleStatus(id: String, status: BundleStatus) {
+        print("\(self.TAG) Setting status for bundle [\(id)] to \(status)")
+        let info = self.getBundleInfo(id: id)
+        self.saveBundleInfo(id: id, bundle: info.setStatus(status: status.localizedString))
+    }
+
+    private func getCurrentBundleVersion() -> String {
+        if(self.isUsingBuiltin()) {
+            return BundleInfo.ID_BUILTIN
+        } else {
+            let path: String = self.getCurrentBundleId()
+            return path.lastPathComponent
+        }
+    }
+
+    public func getCurrentBundle() -> BundleInfo {
+        return self.getBundleInfo(id: self.getCurrentBundleId());
+    }
+
+    public func getCurrentBundleId() -> String {
+        return UserDefaults.standard.string(forKey: self.CAP_SERVER_PATH) ?? self.DEFAULT_FOLDER
+    }
+
+    public func isUsingBuiltin() -> Bool {
+        return self.getCurrentBundleId() == self.DEFAULT_FOLDER
+    }
+
+    public func getFallbackVersion() -> BundleInfo {
+        let id: String = UserDefaults.standard.string(forKey: self.FALLBACK_VERSION) ?? BundleInfo.ID_BUILTIN
+        return self.getBundleInfo(id: id)
+    }
+
+    private func setFallbackVersion(fallback: BundleInfo?) {
+        UserDefaults.standard.set(fallback == nil ? BundleInfo.ID_BUILTIN : fallback!.getId(), forKey: self.FALLBACK_VERSION)
+    }
+
+    public func getNextVersion() -> BundleInfo? {
+        let id: String = UserDefaults.standard.string(forKey: self.NEXT_VERSION) ?? ""
+        if(id != "") {
+            return self.getBundleInfo(id: id)
+        } else {
+            return nil
+        }
+    }
+
+    public func setNextVersion(next: String?) -> Bool {
+        if (next == nil) {
+            UserDefaults.standard.removeObject(forKey: self.NEXT_VERSION)
+        } else {
+            let bundle: URL = self.getBundleDirectory(id: next!)
+            if (!bundle.exist) {
+                return false
+            }
+            UserDefaults.standard.set(next, forKey: self.NEXT_VERSION)
+            self.setBundleStatus(id: next!, status: BundleStatus.PENDING);
+        }
+        UserDefaults.standard.synchronize()
+        return true
+    }
 }

package/ios/Plugin/CapacitorUpdaterPlugin.m

@@ -11,9 +11,10 @@ CAP_PLUGIN(CapacitorUpdaterPlugin, "CapacitorUpdater",
            CAP_PLUGIN_METHOD(reset, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(current, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(reload, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(versionName, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(notifyAppReady, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(delayUpdate, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setDelay, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getId, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getPluginVersion, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(next, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(isAutoUpdateEnabled, CAPPluginReturnPromise);
 )