@capgo/capacitor-updater 8.45.11 → 8.46.0

package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift

@@ -47,8 +47,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "setMultiDelay", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "cancelDelay", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getLatest", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "triggerUpdateCheck", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setChannel", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "unsetChannel", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "reportWebViewError", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getChannel", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "listChannels", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setCustomId", returnType: CAPPluginReturnPromise),
@@ -74,7 +76,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "completeFlexibleUpdate", returnType: CAPPluginReturnPromise)
     ]
     public var implementation = CapgoUpdater()
-    private let pluginVersion: String = "8.45.11"
+    private let pluginVersion: String = "8.46.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"
@@ -130,6 +132,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     private var persistModifyUrl = false
     private var allowManualBundleError = false
     private var keepUrlPathFlagLastValue: Bool?
+    private var appHealthTracker: AppHealthTracker?
+    private var webViewStatsReporter: WebViewStatsReporter?
     public var shakeMenuEnabled = false
     public var shakeChannelSelectorEnabled = false
     let semaphoreReady = DispatchSemaphore(value: 0)
@@ -145,6 +149,9 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         } else {
             logger.error("Failed to get webView for logging")
         }
+        let webViewStatsReporter = WebViewStatsReporter(implementation: implementation)
+        self.webViewStatsReporter = webViewStatsReporter
+        webViewStatsReporter.install(on: self.bridge?.webView)
         #if targetEnvironment(simulator)
         logger.info("::::: SIMULATOR :::::")
         logger.info("Application directory: \(NSHomeDirectory())")
@@ -225,12 +232,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         resetWhenUpdate = getConfig().getBoolean("resetWhenUpdate", true)
         shakeMenuEnabled = getConfig().getBoolean("shakeMenu", false)
         shakeChannelSelectorEnabled = getConfig().getBoolean("allowShakeChannelSelector", false)
-        let periodCheckDelayValue = getConfig().getInt("periodCheckDelay", 0)
-        if periodCheckDelayValue >= 0 && periodCheckDelayValue > 600 {
-            periodCheckDelay = 600
-        } else {
-            periodCheckDelay = periodCheckDelayValue
-        }
+        periodCheckDelay = Self.normalizedPeriodCheckDelaySeconds(getConfig().getInt("periodCheckDelay", 0))
 
         implementation.setPublicKey(getConfig().getString("publicKey") ?? "")
         implementation.notifyDownloadRaw = notifyDownload
@@ -289,6 +291,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             implementation.defaultChannel = getConfig().getString("defaultChannel", "")!
         }
         self.implementation.autoReset()
+        let appHealthTracker = AppHealthTracker(implementation: self.implementation)
+        self.appHealthTracker = appHealthTracker
+        appHealthTracker.reportPreviousUncleanForegroundExit()
+        appHealthTracker.startSession()
 
         // Check if app was recently installed/updated BEFORE cleanup updates the stored native build version.
         self.wasRecentlyInstalledOrUpdated = self.checkIfRecentlyInstalledOrUpdated()
@@ -312,6 +318,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         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)
+        nc.addObserver(self, selector: #selector(appWillTerminate), name: UIApplication.willTerminateNotification, object: nil)
+        nc.addObserver(self, selector: #selector(appDidReceiveMemoryWarning), name: UIApplication.didReceiveMemoryWarningNotification, object: nil)
 
         // Check for 'kill' delay condition on app launch
         // This handles cases where the app was killed (willTerminateNotification is not reliable for system kills)
@@ -368,6 +376,22 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    @objc private func appWillTerminate() {
+        appHealthTracker?.markForeground(false)
+    }
+
+    @objc private func appDidReceiveMemoryWarning() {
+        appHealthTracker?.reportMemoryWarning()
+    }
+
+    @objc func reportWebViewError(_ call: CAPPluginCall) {
+        guard let webViewStatsReporter = webViewStatsReporter else {
+            call.resolve()
+            return
+        }
+        webViewStatsReporter.reportError(call)
+    }
+
     private func initialLoad() -> Bool {
         guard let bridge = self.bridge else { return false }
         if keepUrlPathAfterReload {
@@ -1028,6 +1052,27 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    public func triggerBackgroundUpdateCheck() -> String {
+        guard !self.updateUrl.isEmpty, URL(string: self.updateUrl) != nil else {
+            logger.error("Error no url or wrong format")
+            return "unavailable"
+        }
+        if self.isDownloadStuckOrTimedOut() {
+            logger.info("Download already in progress, skipping duplicate download request")
+            return "already_running"
+        }
+        self.backgroundDownload()
+        return "queued"
+    }
+
+    @objc func triggerUpdateCheck(_ call: CAPPluginCall) {
+        let status = self.triggerBackgroundUpdateCheck()
+        call.resolve([
+            "status": status,
+            "queued": status == "queued"
+        ])
+    }
+
     @objc func unsetChannel(_ call: CAPPluginCall) {
         let triggerAutoUpdate = call.getBool("triggerAutoUpdate", false)
         self.saveCallForAsyncHandling(call)
@@ -1719,6 +1764,13 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         plannedDirectUpdate && directUpdateMode == "onLaunch"
     }
 
+    static func normalizedPeriodCheckDelaySeconds(_ value: Int) -> Int {
+        guard value > 0 else {
+            return 0
+        }
+        return max(600, value)
+    }
+
     private func getOnLaunchDirectUpdateUsed() -> Bool {
         self.onLaunchDirectUpdateStateLock.lock()
         defer { self.onLaunchDirectUpdateStateLock.unlock() }
@@ -1769,13 +1821,17 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         self.notifyListeners("majorAvailable", data: payload)
     }
 
-    private func updateResponseKind(kind: String?) -> String {
+    static func normalizedUpdateResponseKind(kind: String?) -> String {
         if let kind, ["up_to_date", "blocked", "failed"].contains(kind) {
             return kind
         }
         return "failed"
     }
 
+    private func updateResponseKind(kind: String?) -> String {
+        Self.normalizedUpdateResponseKind(kind: kind)
+    }
+
     private func endBackgroundDownloadAfterLatestError(
         backendError: String,
         res: AppVersion,
@@ -2153,6 +2209,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     @objc func appMovedToForeground() {
+        appHealthTracker?.markForeground(true)
         let current: BundleInfo = self.implementation.getCurrentBundle()
         self.implementation.sendStats(action: "app_moved_to_foreground", versionName: current.getVersionName())
         self.delayUpdateUtils.checkCancelDelay(source: .foreground)
@@ -2219,6 +2276,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     @objc func appMovedToBackground() {
         // Reset timeout flag at start of each background cycle
         self.autoSplashscreenTimedOut = false
+        appHealthTracker?.markForeground(false)
 
         let current: BundleInfo = self.implementation.getCurrentBundle()
         self.implementation.sendStats(action: "app_moved_to_background", versionName: current.getVersionName())

package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift

@@ -2256,6 +2256,14 @@ import UIKit
     }()
 
     func sendStats(action: String, versionName: String? = nil, oldVersionName: String? = "") {
+        sendStatsWithMetadata(action: action, versionName: versionName, oldVersionName: oldVersionName, metadata: nil)
+    }
+
+    func sendStats(action: String, versionName: String?, oldVersionName: String?, metadata: [String: String]) {
+        sendStatsWithMetadata(action: action, versionName: versionName, oldVersionName: oldVersionName, metadata: metadata)
+    }
+
+    private func sendStatsWithMetadata(action: String, versionName: String?, oldVersionName: String?, metadata: [String: String]?) {
         // Check if rate limit was exceeded
         if CapgoUpdater.rateLimitExceeded {
             logger.debug("Skipping sendStats due to rate limit (429). Stats will resume after app restart.")
@@ -2286,6 +2294,7 @@ import UIKit
             channel: info.channel,
             defaultChannel: info.defaultChannel,
             key_id: info.key_id,
+            metadata: metadata,
             timestamp: Int64(Date().timeIntervalSince1970 * 1000)
         )
 

package/ios/Sources/CapacitorUpdaterPlugin/InternalUtils.swift

@@ -183,6 +183,7 @@ struct StatsEvent: Codable {
     let channel: String?
     let defaultChannel: String?
     let key_id: String?
+    let metadata: [String: String]?
     let timestamp: Int64
 }
 // swiftlint:enable identifier_name

package/ios/Sources/CapacitorUpdaterPlugin/WebViewStatsReporter.swift

@@ -0,0 +1,276 @@
+import Capacitor
+import Foundation
+import WebKit
+
+final class WebViewStatsReporter {
+    static let script = """
+    (function(){
+      if(window.__capgoWebViewErrorReporterInstalled){return;}
+      window.__capgoWebViewErrorReporterInstalled=true;
+      var maxReports=20,sentReports=0,queue=[],seen={};
+      var sessionKey='CapacitorUpdater.webViewSession';
+      var sessionId=String(Date.now())+'-'+Math.random().toString(36).slice(2);
+      function s(value){
+        try{
+          if(value===undefined){return '';}
+          if(value===null){return 'null';}
+          if(typeof value==='string'){return value;}
+          if(value&&typeof value.message==='string'){return value.message;}
+          return String(value);
+        }catch(_){return '';}
+      }
+      function stack(value){
+        try{return value&&value.stack?String(value.stack):'';}catch(_){return '';}
+      }
+      function updater(){
+        var cap=window.Capacitor;
+        if(!cap||!cap.Plugins){return null;}
+        return cap.Plugins.CapacitorUpdater||null;
+      }
+      function flush(){
+        var plugin=updater();
+        if(!plugin||typeof plugin.reportWebViewError!=='function'){return false;}
+        while(queue.length){
+          var payload=queue.shift();
+          try{
+            var result=plugin.reportWebViewError(payload);
+            if(result&&typeof result.catch==='function'){result.catch(function(){});}
+          }catch(_){}
+        }
+        return true;
+      }
+      var retries=0;
+      function scheduleFlush(){
+        if(flush()){return;}
+        if(retries++<40){setTimeout(scheduleFlush,250);}
+      }
+      function send(payload){
+        try{
+          if(sentReports>=maxReports){return;}
+          payload.href=payload.href||location.href||'';
+          payload.user_agent=navigator.userAgent||'';
+          payload.session_id=sessionId;
+          var key=[payload.type,payload.message,payload.source,payload.line,payload.column,payload.tag_name].join('|');
+          if(seen[key]){return;}
+          seen[key]=true;
+          sentReports+=1;
+          queue.push(payload);
+          scheduleFlush();
+        }catch(_){}
+      }
+      function readSession(){
+        try{return JSON.parse(localStorage.getItem(sessionKey)||'null')||null;}catch(_){return null;}
+      }
+      function writeSession(active){
+        try{
+          localStorage.setItem(sessionKey,JSON.stringify({
+            id:sessionId,
+            active:active,
+            href:location.href||'',
+            started_at:window.__capgoWebViewSessionStartedAt,
+            updated_at:String(Date.now())
+          }));
+        }catch(_){}
+      }
+      window.__capgoWebViewSessionStartedAt=String(Date.now());
+      var previous=readSession();
+      if(previous&&previous.active){
+        send({
+          type:'webview_unclean_restart',
+          message:'WebView restarted without a clean page unload',
+          previous_session_id:s(previous.id),
+          previous_href:s(previous.href),
+          previous_started_at:s(previous.started_at),
+          previous_updated_at:s(previous.updated_at)
+        });
+      }
+      writeSession(true);
+      setInterval(function(){writeSession(true);},15000);
+      function markClean(){writeSession(false);}
+      window.addEventListener('pagehide',markClean,true);
+      window.addEventListener('beforeunload',markClean,true);
+      window.addEventListener('error',function(event){
+        var target=event&&event.target;
+        if(target&&target!==window&&(target.src||target.href)){
+          send({
+            type:'resource_error',
+            message:'Resource failed to load',
+            source:s(target.src||target.href),
+            tag_name:s(target.tagName)
+          });
+          return;
+        }
+        send({
+          type:'javascript_error',
+          message:s((event&&event.message)||(event&&event.error)),
+          source:s(event&&event.filename),
+          line:s(event&&event.lineno),
+          column:s(event&&event.colno),
+          stack:stack(event&&event.error)
+        });
+      },true);
+      window.addEventListener('unhandledrejection',function(event){
+        var reason=event&&event.reason;
+        send({type:'unhandled_rejection',message:s(reason),stack:stack(reason)});
+      },true);
+      document.addEventListener('securitypolicyviolation',function(event){
+        send({
+          type:'security_policy_violation',
+          message:s(event&&event.violatedDirective),
+          source:s(event&&event.blockedURI)
+        });
+      },true);
+      document.addEventListener('deviceready',scheduleFlush,false);
+      setTimeout(scheduleFlush,0);
+    })();
+    """
+
+    private let implementation: CapgoUpdater
+    private var installed = false
+
+    init(implementation: CapgoUpdater) {
+        self.implementation = implementation
+    }
+
+    func install(on webView: WKWebView?) {
+        guard !installed else {
+            return
+        }
+        guard let webView else {
+            return
+        }
+
+        installed = true
+        let userScript = WKUserScript(source: Self.script, injectionTime: .atDocumentStart, forMainFrameOnly: true)
+        webView.configuration.userContentController.addUserScript(userScript)
+        webView.evaluateJavaScript(Self.script, completionHandler: nil)
+    }
+
+    func reportError(_ call: CAPPluginCall) {
+        let errorType = call.getString("type") ?? "javascript_error"
+        let current = implementation.getCurrentBundle()
+        implementation.sendStats(
+            action: Self.statsAction(for: errorType),
+            versionName: current.getVersionName(),
+            oldVersionName: "",
+            metadata: Self.buildMetadata([
+                "type": errorType,
+                "message": call.getString("message"),
+                "source": call.getString("source"),
+                "line": call.getString("line") ?? call.getString("lineno"),
+                "column": call.getString("column") ?? call.getString("colno"),
+                "stack": call.getString("stack"),
+                "tag_name": call.getString("tag_name"),
+                "href": call.getString("href"),
+                "user_agent": call.getString("user_agent"),
+                "session_id": call.getString("session_id"),
+                "previous_session_id": call.getString("previous_session_id"),
+                "previous_href": call.getString("previous_href"),
+                "previous_started_at": call.getString("previous_started_at"),
+                "previous_updated_at": call.getString("previous_updated_at")
+            ])
+        )
+        call.resolve()
+    }
+
+    static func statsAction(for type: String) -> String {
+        switch type {
+        case "unhandled_rejection":
+            return "webview_unhandled_rejection"
+        case "resource_error":
+            return "webview_resource_error"
+        case "security_policy_violation":
+            return "webview_security_policy_violation"
+        case "webview_unclean_restart":
+            return "webview_unclean_restart"
+        case "render_process_gone":
+            return "webview_render_process_gone"
+        case "web_content_process_terminated":
+            return "webview_content_process_terminated"
+        case "javascript_error":
+            return "webview_javascript_error"
+        default:
+            return "webview_javascript_error"
+        }
+    }
+
+    static func buildMetadata(_ values: [String: String?]) -> [String: String] {
+        var metadata: [String: String] = [:]
+        put(&metadata, key: "error_type", value: payloadValue(values, "type") ?? "javascript_error", maxLength: 64)
+        put(&metadata, key: "message", value: payloadValue(values, "message"), maxLength: 1_024)
+        put(&metadata, key: "source", value: sanitizeUrl(payloadValue(values, "source")), maxLength: 512)
+        put(&metadata, key: "line", value: payloadValue(values, "line"), maxLength: 32)
+        put(&metadata, key: "column", value: payloadValue(values, "column"), maxLength: 32)
+        put(&metadata, key: "stack", value: payloadValue(values, "stack"), maxLength: 2_048)
+        put(&metadata, key: "tag_name", value: payloadValue(values, "tag_name"), maxLength: 64)
+        put(&metadata, key: "href", value: sanitizeUrl(payloadValue(values, "href")), maxLength: 512)
+        put(&metadata, key: "user_agent", value: payloadValue(values, "user_agent"), maxLength: 256)
+        put(&metadata, key: "session_id", value: payloadValue(values, "session_id"), maxLength: 128)
+        put(&metadata, key: "previous_session_id", value: payloadValue(values, "previous_session_id"), maxLength: 128)
+        put(&metadata, key: "previous_href", value: sanitizeUrl(payloadValue(values, "previous_href")), maxLength: 512)
+        put(&metadata, key: "previous_started_at", value: payloadValue(values, "previous_started_at"), maxLength: 64)
+        put(&metadata, key: "previous_updated_at", value: payloadValue(values, "previous_updated_at"), maxLength: 64)
+        return metadata
+    }
+
+    private static func payloadValue(_ values: [String: String?], _ key: String) -> String? {
+        guard let value = values[key] else {
+            return nil
+        }
+        return value
+    }
+
+    static func sanitizeUrl(_ value: String?) -> String? {
+        guard let value = value, !value.isEmpty else {
+            return value
+        }
+
+        if var components = URLComponents(string: value), components.scheme != nil, components.host != nil {
+            components.user = nil
+            components.password = nil
+            components.query = nil
+            components.fragment = nil
+            components.path = sanitizeUrlPath(components.path)
+            return components.string ?? stripUrlQueryAndFragment(value)
+        }
+
+        return stripUrlQueryAndFragment(value)
+    }
+
+    private static func sanitizeUrlPath(_ path: String) -> String {
+        guard !path.isEmpty else {
+            return path
+        }
+
+        return path
+            .split(separator: "/", omittingEmptySubsequences: false)
+            .map { isSensitiveUrlPathSegment(String($0)) ? "redacted" : String($0) }
+            .joined(separator: "/")
+    }
+
+    private static func isSensitiveUrlPathSegment(_ segment: String) -> Bool {
+        segment.range(of: #"^[0-9]{6,}$"#, options: .regularExpression) != nil ||
+            segment.range(of: #"^[0-9a-fA-F]{16,}$"#, options: .regularExpression) != nil ||
+            segment.range(
+                of: #"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"#,
+                options: .regularExpression
+            ) != nil
+    }
+
+    private static func stripUrlQueryAndFragment(_ value: String) -> String {
+        let queryIndex = value.firstIndex(of: "?")
+        let fragmentIndex = value.firstIndex(of: "#")
+        let endIndexes = [queryIndex, fragmentIndex].compactMap { $0 }
+        guard let endIndex = endIndexes.min() else {
+            return value
+        }
+        return String(value[..<endIndex])
+    }
+
+    private static func put(_ metadata: inout [String: String], key: String, value: String?, maxLength: Int) {
+        guard let value = value, !value.isEmpty else {
+            return
+        }
+        metadata[key] = String(value.prefix(maxLength))
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "8.45.11",
+  "version": "8.46.0",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",
@@ -45,6 +45,15 @@
     "verify:ios": "xcodebuild -scheme CapgoCapacitorUpdater -destination generic/platform=iOS",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "bun run build",
+    "native:compile": "./scripts/native-platform.sh compile all",
+    "native:compile:ios": "./scripts/native-platform.sh compile ios",
+    "native:compile:android": "./scripts/native-platform.sh compile android",
+    "native:test": "./scripts/native-platform.sh test all",
+    "native:test:ios": "./scripts/native-platform.sh test ios",
+    "native:test:android": "./scripts/native-platform.sh test android",
+    "native:contract": "bun run native:contract:ios && bun run native:contract:android",
+    "native:contract:ios": "./scripts/test-ios.sh -only-testing:CapacitorUpdaterPluginTests/NativeContractTests",
+    "native:contract:android": "cd android && ./gradlew testDebugUnitTest --tests ee.forgr.capacitor_updater.NativeContractTest && cd ..",
     "test": "bun run test:ios && bun run test:android",
     "test:ios": "./scripts/test-ios.sh",
     "test:android": "cd android && ./gradlew test && cd ..",