@capgo/capacitor-updater 7.51.20 → 7.51.23

package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift

@@ -96,7 +96,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     deinit {
         implementation.shutdown()
     }
-    private let pluginVersion: String = "7.51.20"
+    private let pluginVersion: String = "7.51.23"
     private let launchStartedAtMs = Int64(Date().timeIntervalSince1970 * 1000)
     static let updateUrlDefault = "https://plugin.capgo.app/updates"
     static let statsUrlDefault = "https://plugin.capgo.app/stats"
@@ -582,8 +582,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         var dest: URL
         if BundleInfo.ID_BUILTIN == id {
             dest = Bundle.main.resourceURL!.appendingPathComponent("public")
+        } else if let bundleDir = try? self.implementation.getBundleDirectory(id: id) {
+            dest = bundleDir
         } else {
-            dest = self.implementation.getBundleDirectory(id: id)
+            dest = Bundle.main.resourceURL!.appendingPathComponent("public")
         }
 
         if !FileManager.default.fileExists(atPath: dest.path) {
@@ -1611,7 +1613,19 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             throw makePreviewError("Invalid download URL")
         }
 
+        if !self.implementation.publicKey.isEmpty && !CryptoCipher.isValidSessionKey(sessionKey) {
+            self.logger.error("Public key present but no valid session key provided")
+            self.implementation.sendStats(action: "session_key_required", versionName: version)
+            throw makePreviewError("Session key required when public key is present")
+        }
+
         var checksum = rawChecksum
+        if manifestEntries == nil && checksum.isEmpty {
+            self.logger.error("No checksum provided")
+            self.implementation.sendStats(action: "checksum_required", versionName: version)
+            throw makePreviewError("Checksum required")
+        }
+
         let next: BundleInfo
         if let manifestEntries = manifestEntries {
             next = try self.implementation.downloadManifest(manifest: manifestEntries, version: version, sessionKey: sessionKey)
@@ -1619,29 +1633,20 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             next = try self.implementation.download(url: url, version: version, sessionKey: sessionKey)
         }
 
-        if self.implementation.publicKey != "" && checksum == "" {
-            self.logger.error("Public key present but no checksum provided")
-            self.implementation.sendStats(action: "checksum_required", versionName: next.getVersionName())
-            let id = next.getId()
-            let resDel = self.implementation.delete(id: id)
-            if !resDel {
-                self.logger.error("Delete failed, id \(id) doesn't exist")
-            }
-            throw ObjectSavableError.checksum
-        }
-
-        checksum = try CryptoCipher.decryptChecksum(checksum: checksum, publicKey: self.implementation.publicKey)
-        CryptoCipher.logChecksumInfo(label: "Bundle checksum", hexChecksum: next.getChecksum())
-        CryptoCipher.logChecksumInfo(label: "Expected checksum", hexChecksum: checksum)
-        if (checksum != "" || self.implementation.publicKey != "") && next.getChecksum() != checksum {
-            self.logger.error("Error checksum \(next.getChecksum()) \(checksum)")
-            self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
-            let id = next.getId()
-            let resDel = self.implementation.delete(id: id)
-            if !resDel {
-                self.logger.error("Delete failed, id \(id) doesn't exist")
+        if manifestEntries == nil {
+            checksum = try CryptoCipher.decryptChecksum(checksum: checksum, publicKey: self.implementation.publicKey)
+            CryptoCipher.logChecksumInfo(label: "Bundle checksum", hexChecksum: next.getChecksum())
+            CryptoCipher.logChecksumInfo(label: "Expected checksum", hexChecksum: checksum)
+            if next.getChecksum() != checksum {
+                self.logger.error("Error checksum \(next.getChecksum()) \(checksum)")
+                self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
+                let id = next.getId()
+                let resDel = self.implementation.delete(id: id)
+                if !resDel {
+                    self.logger.error("Delete failed, id \(id) doesn't exist")
+                }
+                throw ObjectSavableError.checksum
             }
-            throw ObjectSavableError.checksum
         }
 
         self.logger.info("Good checksum \(next.getChecksum()) \(checksum)")
@@ -1693,8 +1698,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         let id = self.implementation.getCurrentBundleId()
         if BundleInfo.ID_BUILTIN == id {
             return Bundle.main.resourceURL!.appendingPathComponent("public")
+        } else if let bundleDir = try? self.implementation.getBundleDirectory(id: id) {
+            return bundleDir
         } else {
-            return self.implementation.getBundleDirectory(id: id)
+            return Bundle.main.resourceURL!.appendingPathComponent("public")
         }
     }
 
@@ -3498,13 +3505,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     private func performHideSplashscreen() {
-        self.cancelSplashscreenTimeout()
         self.removeSplashscreenLoader()
         self.splashscreenInvocationToken += 1
-        self.invokeSplashscreenMethod(
-            methodName: "hide",
-            callbackId: "autoHideSplashscreen",
-            options: self.splashscreenOptions(methodName: "hide"),
+        self.invokeSplashscreenAction(
+            .hide,
             retriesRemaining: self.splashscreenMaxRetries,
             requestToken: self.splashscreenInvocationToken
         )
@@ -3524,10 +3528,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         self.cancelSplashscreenTimeout()
         self.autoSplashscreenTimedOut = false
         self.splashscreenInvocationToken += 1
-        self.invokeSplashscreenMethod(
-            methodName: "show",
-            callbackId: "autoShowSplashscreen",
-            options: self.splashscreenOptions(methodName: "show"),
+        self.invokeSplashscreenAction(
+            .show,
             retriesRemaining: self.splashscreenMaxRetries,
             requestToken: self.splashscreenInvocationToken
         )
@@ -3537,7 +3539,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     private func splashscreenOptions(methodName: String) -> [String: Any] {
-        methodName == "show" ? ["autoHide": false] : [:]
+        methodName == "show" ? ["autoHide": false, "fadeInDuration": 0] : [:]
     }
 
     private func splashscreenCompletedMessage(methodName: String) -> String {
@@ -3556,20 +3558,59 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         self.splashscreenInvocationToken += 1
     }
 
-    private func makeSplashscreenCall(callbackId: String, options: [String: Any], methodName: String) -> CAPPluginCall {
-        CAPPluginCall(callbackId: callbackId, methodName: methodName, options: options, success: { [weak self] (_, _) in
-            guard let self = self else { return }
-            self.logger.info(self.splashscreenCompletedMessage(methodName: methodName))
-        }, error: { [weak self] (_) in
-            guard let self = self else { return }
-            self.logger.error("Failed to auto-\(methodName) splashscreen")
-        })
+    private enum SplashscreenAction {
+        case show
+        case hide
+
+        var methodName: String {
+            switch self {
+            case .show:
+                return "show"
+            case .hide:
+                return "hide"
+            }
+        }
+
+        var unavailableMessageVerb: String {
+            switch self {
+            case .show:
+                return "showing"
+            case .hide:
+                return "hiding"
+            }
+        }
     }
 
-    private func invokeSplashscreenMethod(
-        methodName: String,
-        callbackId: String,
-        options: [String: Any],
+    private func splashscreenOptionsJSON(methodName: String) -> String {
+        let options = self.splashscreenOptions(methodName: methodName)
+        guard !options.isEmpty,
+              let data = try? JSONSerialization.data(withJSONObject: options),
+              let json = String(data: data, encoding: .utf8) else {
+            return "{}"
+        }
+        return json
+    }
+
+    private func splashscreenPluginExposesMethod(_ methodName: String, on plugin: CAPPlugin) -> Bool {
+        guard let bridgedPlugin = plugin as? CAPBridgedPlugin else {
+            return false
+        }
+        return bridgedPlugin.pluginMethods.contains { $0.name == methodName }
+    }
+
+    private func splashscreenBridgeScript(for action: SplashscreenAction) -> String {
+        let optionsJSON = self.splashscreenOptionsJSON(methodName: action.methodName)
+        return """
+        var cap = window.Capacitor;
+        if (!cap || typeof cap.nativePromise !== 'function') {
+          throw new Error('Capacitor bridge not ready');
+        }
+        return await cap.nativePromise('\(self.splashscreenPluginName)', '\(action.methodName)', \(optionsJSON));
+        """
+    }
+
+    private func invokeSplashscreenAction(
+        _ action: SplashscreenAction,
         retriesRemaining: Int,
         requestToken: Int
     ) {
@@ -3578,22 +3619,18 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
 
         guard let bridge = self.bridge else {
-            self.retrySplashscreenMethod(
-                methodName: methodName,
-                callbackId: callbackId,
-                options: options,
+            self.retrySplashscreenAction(
+                action,
                 retriesRemaining: retriesRemaining,
                 requestToken: requestToken,
-                message: "Bridge not available for \(methodName == "show" ? "showing" : "hiding") splashscreen with autoSplashscreen"
+                message: "Bridge not available for \(action.unavailableMessageVerb) splashscreen with autoSplashscreen"
             )
             return
         }
 
         guard let splashScreenPlugin = bridge.plugin(withName: self.splashscreenPluginName) else {
-            self.retrySplashscreenMethod(
-                methodName: methodName,
-                callbackId: callbackId,
-                options: options,
+            self.retrySplashscreenAction(
+                action,
                 retriesRemaining: retriesRemaining,
                 requestToken: requestToken,
                 message: "autoSplashscreen: SplashScreen plugin not found. Install @capacitor/splash-screen plugin."
@@ -3601,37 +3638,86 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             return
         }
 
-        let selector = NSSelectorFromString("\(methodName):")
-        guard splashScreenPlugin.responds(to: selector) else {
-            self.retrySplashscreenMethod(
-                methodName: methodName,
-                callbackId: callbackId,
-                options: options,
+        guard self.splashscreenPluginExposesMethod(action.methodName, on: splashScreenPlugin) else {
+            self.retrySplashscreenAction(
+                action,
+                retriesRemaining: retriesRemaining,
+                requestToken: requestToken,
+                message: "autoSplashscreen: SplashScreen plugin does not expose \(action.methodName)(). Make sure @capacitor/splash-screen plugin is properly installed."
+            )
+            return
+        }
+
+        guard let webView = bridge.webView else {
+            self.retrySplashscreenAction(
+                action,
                 retriesRemaining: retriesRemaining,
                 requestToken: requestToken,
-                message: "autoSplashscreen: SplashScreen plugin does not respond to \(methodName): method. Make sure @capacitor/splash-screen plugin is properly installed."
+                message: "WebView not available for \(action.unavailableMessageVerb) splashscreen with autoSplashscreen"
             )
             return
         }
 
-        let call = self.makeSplashscreenCall(callbackId: callbackId, options: options, methodName: methodName)
-        _ = splashScreenPlugin.perform(selector, with: call)
-        self.logger.info("Called SplashScreen \(methodName) method")
+        let script = self.splashscreenBridgeScript(for: action)
+        let runInvocation = { [weak self] in
+            guard let self = self, requestToken == self.splashscreenInvocationToken else {
+                return
+            }
+            webView.callAsyncJavaScript(
+                script,
+                arguments: [:],
+                in: nil,
+                in: .page
+            ) { [weak self] (result: Result<Any, Error>) in
+                guard let self = self, requestToken == self.splashscreenInvocationToken else {
+                    return
+                }
+                if case .failure(let error) = result {
+                    self.retrySplashscreenAction(
+                        action,
+                        retriesRemaining: retriesRemaining,
+                        requestToken: requestToken,
+                        message: "Failed to invoke SplashScreen \(action.methodName) via Capacitor bridge: \(error.localizedDescription)"
+                    )
+                    return
+                }
+                if action == .hide {
+                    self.cancelSplashscreenTimeout()
+                }
+                self.logger.info("Called SplashScreen \(action.methodName) method")
+                self.logger.info(self.splashscreenCompletedMessage(methodName: action.methodName))
+            }
+        }
+
+        if Thread.isMainThread {
+            runInvocation()
+        } else {
+            DispatchQueue.main.async(execute: runInvocation)
+        }
     }
 
-    private func retrySplashscreenMethod(
-        methodName: String,
-        callbackId: String,
-        options: [String: Any],
+    private func retrySplashscreenAction(
+        _ action: SplashscreenAction,
         retriesRemaining: Int,
         requestToken: Int,
         message: String
     ) {
         guard retriesRemaining > 0 else {
-            if methodName == "show" {
+            if action == .show {
                 self.logger.warn(message)
-            } else {
-                self.logger.error(message)
+                return
+            }
+
+            self.logger.error("\(message). Scheduling another hide retry.")
+            DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(self.splashscreenRetryDelayMilliseconds)) { [weak self] in
+                guard let self = self, requestToken == self.splashscreenInvocationToken else {
+                    return
+                }
+                self.invokeSplashscreenAction(
+                    action,
+                    retriesRemaining: self.splashscreenMaxRetries,
+                    requestToken: requestToken
+                )
             }
             return
         }
@@ -3641,10 +3727,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             guard let self = self, requestToken == self.splashscreenInvocationToken else {
                 return
             }
-            self.invokeSplashscreenMethod(
-                methodName: methodName,
-                callbackId: callbackId,
-                options: options,
+            self.invokeSplashscreenAction(
+                action,
                 retriesRemaining: retriesRemaining - 1,
                 requestToken: requestToken
             )
@@ -4097,6 +4181,22 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         self.updateUrl = updateUrl
     }
 
+    func downloadBundleForTesting(
+        urlString: String,
+        version: String,
+        sessionKey: String,
+        checksum: String,
+        manifestEntries: [ManifestEntry]?
+    ) throws -> BundleInfo {
+        try downloadBundle(
+            urlString: urlString,
+            version: version,
+            sessionKey: sessionKey,
+            checksum: checksum,
+            manifestEntries: manifestEntries
+        )
+    }
+
     func setAutoUpdateModeForTesting(_ autoUpdateMode: String) {
         self.autoUpdateMode = Self.normalizedAutoUpdateMode(autoUpdateMode)
         self.autoUpdate = Self.isAutoUpdateModeEnabled(self.autoUpdateMode)
@@ -4432,6 +4532,17 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             if latestVersionName != "" && current.getVersionName() != latestVersionName {
                 do {
                     self.logger.info("New bundle: \(latestVersionName) found. Current is: \(current.getVersionName()). \(messageUpdate)")
+                    if !self.implementation.publicKey.isEmpty && !CryptoCipher.isValidSessionKey(sessionKey) {
+                        self.logger.error("Public key present but no valid session key provided")
+                        self.implementation.sendStats(action: "session_key_required", versionName: latestVersionName)
+                        self.endBackGroundTaskWithNotif(
+                            msg: "Session key required when public key is present",
+                            latestVersionName: latestVersionName,
+                            current: current,
+                            plannedDirectUpdate: plannedDirectUpdate
+                        )
+                        return
+                    }
                     var nextImpl = self.implementation.getBundleInfoByVersionName(version: latestVersionName)
                     let needsDownload = nextImpl.map(Self.shouldRetryDownloadForExistingBundle) ?? true
                     if needsDownload {
@@ -4449,6 +4560,17 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                         if res.manifest != nil {
                             nextImpl = try self.implementation.downloadManifest(manifest: res.manifest!, version: latestVersionName, sessionKey: sessionKey, link: res.link, comment: res.comment)
                         } else {
+                            if res.checksum.isEmpty {
+                                self.logger.error("No checksum provided")
+                                self.implementation.sendStats(action: "checksum_required", versionName: latestVersionName)
+                                self.endBackGroundTaskWithNotif(
+                                    msg: "Checksum required",
+                                    latestVersionName: latestVersionName,
+                                    current: current,
+                                    plannedDirectUpdate: plannedDirectUpdate
+                                )
+                                return
+                            }
                             nextImpl = try self.implementation.download(url: downloadUrl, version: latestVersionName, sessionKey: sessionKey, link: res.link, comment: res.comment)
                         }
                     }
@@ -4477,24 +4599,26 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                         self.endBackGroundTask()
                         return
                     }
-                    res.checksum = try CryptoCipher.decryptChecksum(checksum: res.checksum, publicKey: self.implementation.publicKey)
-                    CryptoCipher.logChecksumInfo(label: "Bundle checksum", hexChecksum: next.getChecksum())
-                    CryptoCipher.logChecksumInfo(label: "Expected checksum", hexChecksum: res.checksum)
-                    if res.checksum != "" && next.getChecksum() != res.checksum && res.manifest == nil {
-                        self.logger.error("Error checksum \(next.getChecksum()) \(res.checksum)")
-                        self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
-                        let id = next.getId()
-                        let resDel = self.implementation.delete(id: id)
-                        if !resDel {
-                            self.logger.error("Delete failed, id \(id) doesn't exist")
+                    if res.manifest == nil {
+                        res.checksum = try CryptoCipher.decryptChecksum(checksum: res.checksum, publicKey: self.implementation.publicKey)
+                        CryptoCipher.logChecksumInfo(label: "Bundle checksum", hexChecksum: next.getChecksum())
+                        CryptoCipher.logChecksumInfo(label: "Expected checksum", hexChecksum: res.checksum)
+                        if next.getChecksum() != res.checksum {
+                            self.logger.error("Error checksum \(next.getChecksum()) \(res.checksum)")
+                            self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
+                            let id = next.getId()
+                            let resDel = self.implementation.delete(id: id)
+                            if !resDel {
+                                self.logger.error("Delete failed, id \(id) doesn't exist")
+                            }
+                            self.endBackGroundTaskWithNotif(
+                                msg: "Error checksum",
+                                latestVersionName: latestVersionName,
+                                current: current,
+                                plannedDirectUpdate: plannedDirectUpdate
+                            )
+                            return
                         }
-                        self.endBackGroundTaskWithNotif(
-                            msg: "Error checksum",
-                            latestVersionName: latestVersionName,
-                            current: current,
-                            plannedDirectUpdate: plannedDirectUpdate
-                        )
-                        return
                     }
                     if self.shouldBlockAutoUpdateForPreviewSession() {
                         self.clearDownloadInProgressState()