@capgo/capacitor-updater 6.14.29 → 6.14.36

package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift

@@ -54,7 +54,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "isShakeMenuEnabled", returnType: CAPPluginReturnPromise)
     ]
     public var implementation = CapgoUpdater()
-    private let PLUGIN_VERSION: String = "6.14.29"
+    private let PLUGIN_VERSION: String = "6.14.31"
     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"
@@ -76,6 +76,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     private var directUpdate = false
     private var directUpdateMode: String = "false"
     private var wasRecentlyInstalledOrUpdated = false
+    private var onLaunchDirectUpdateUsed = false
     private var autoSplashscreen = false
     private var autoSplashscreenLoader = false
     private var autoSplashscreenTimeout = 10000
@@ -113,9 +114,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         #endif
 
         self.semaphoreUp()
-        self.implementation.deviceID = (UserDefaults.standard.string(forKey: "appUUID") ?? UUID().uuidString).lowercased()
-        UserDefaults.standard.set( self.implementation.deviceID, forKey: "appUUID")
-        UserDefaults.standard.synchronize()
+        // Use DeviceIdHelper to get or create device ID that persists across reinstalls
+        self.implementation.deviceID = DeviceIdHelper.getOrCreateDeviceId()
         persistCustomId = getConfig().getBoolean("persistCustomId", false)
         if persistCustomId {
             let storedCustomId = UserDefaults.standard.string(forKey: customIdDefaultsKey) ?? ""
@@ -148,7 +148,13 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         // Handle directUpdate configuration - support string values and backward compatibility
         if let directUpdateString = getConfig().getString("directUpdate") {
             directUpdateMode = directUpdateString
-            directUpdate = directUpdateString == "always" || directUpdateString == "atInstall"
+            directUpdate = directUpdateString == "always" || directUpdateString == "atInstall" || directUpdateString == "onLaunch"
+            // Validate directUpdate value
+            if directUpdateString != "false" && directUpdateString != "always" && directUpdateString != "atInstall" && directUpdateString != "onLaunch" {
+                logger.error("Invalid directUpdate value: \"\(directUpdateString)\". Supported values are: false, \"always\", \"atInstall\", \"onLaunch\". Defaulting to false.")
+                directUpdateMode = "false"
+                directUpdate = false
+            }
         } else {
             let directUpdateBool = getConfig().getBoolean("directUpdate", false)
             if directUpdateBool {
@@ -1196,7 +1202,13 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                 return true
             }
             return false
+        case "onLaunch":
+            if !self.onLaunchDirectUpdateUsed {
+                return true
+            }
+            return false
         default:
+            logger.error("Invalid directUpdateMode: \"\(self.directUpdateMode)\". Supported values are: \"false\", \"always\", \"atInstall\", \"onLaunch\". Defaulting to false behavior.")
             return false
         }
     }
@@ -1287,6 +1299,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                 let directUpdateAllowed = plannedDirectUpdate && !self.autoSplashscreenTimedOut
                 if directUpdateAllowed {
                     self.logger.info("Direct update to builtin version")
+                    if self.directUpdateMode == "onLaunch" {
+                        self.onLaunchDirectUpdateUsed = true
+                        self.directUpdate = false
+                    }
                     _ = self._reset(toLastSuccessful: false)
                     self.endBackGroundTaskWithNotif(msg: "Updated to builtin version", latestVersionName: res.version, current: self.implementation.getCurrentBundle(), error: false)
                 } else {
@@ -1361,6 +1377,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                             self.endBackGroundTaskWithNotif(msg: "Update delayed until delay conditions met", latestVersionName: latestVersionName, current: next, error: false)
                             return
                         }
+                        if self.directUpdateMode == "onLaunch" {
+                            self.onLaunchDirectUpdateUsed = true
+                            self.directUpdate = false
+                        }
                         _ = self.implementation.set(bundle: next)
                         _ = self._reload()
                         self.endBackGroundTaskWithNotif(msg: "update installed", latestVersionName: latestVersionName, current: next, error: false)
@@ -1442,6 +1462,10 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         if self._isAutoUpdateEnabled() {
             self.backgroundDownload()
         } else {
+            let instanceDescriptor = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor()
+            if instanceDescriptor?.serverURL != nil {
+                self.implementation.sendStats(action: "blocked_by_server_url", versionName: current.getVersionName())
+            }
             logger.info("Auto update is disabled")
             self.sendReadyToJs(current: current, msg: "disabled")
         }
@@ -1495,7 +1519,11 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
             }
 
             if !self.shouldUseDirectUpdate() {
-                logger.warn("autoSplashscreen is enabled but directUpdate is not configured for immediate updates. Set directUpdate to 'always' or 'atInstall', or disable autoSplashscreen.")
+                if self.directUpdateMode == "false" {
+                    logger.warn("autoSplashscreen is enabled but directUpdate is not configured for immediate updates. Set directUpdate to 'always' or disable autoSplashscreen.")
+                } else if self.directUpdateMode == "atInstall" || self.directUpdateMode == "onLaunch" {
+                    logger.info("autoSplashscreen is enabled but directUpdate is set to \"\(self.directUpdateMode)\". This is normal. Skipping autoSplashscreen logic.")
+                }
                 canShowSplashscreen = false
             }
 

package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift

@@ -47,6 +47,9 @@ import UIKit
     // Flag to track if we received a 429 response - stops requests until app restart
     private static var rateLimitExceeded = false
 
+    // Flag to track if we've already sent the rate limit statistic - prevents infinite loop
+    private static var rateLimitStatisticSent = false
+
     private var userAgent: String {
         let safePluginVersion = PLUGIN_VERSION.isEmpty ? "unknown" : PLUGIN_VERSION
         let safeAppId = appId.isEmpty ? "unknown" : appId
@@ -95,6 +98,12 @@ import UIKit
      */
     private func checkAndHandleRateLimitResponse(statusCode: Int?) -> Bool {
         if statusCode == 429 {
+            // Send a statistic about the rate limit BEFORE setting the flag
+            // Only send once to prevent infinite loop if the stat request itself gets rate limited
+            if !CapgoUpdater.rateLimitExceeded && !CapgoUpdater.rateLimitStatisticSent {
+                CapgoUpdater.rateLimitStatisticSent = true
+                self.sendRateLimitStatistic()
+            }
             CapgoUpdater.rateLimitExceeded = true
             logger.warn("Rate limit exceeded (429). Stopping all stats and channel requests until app restart.")
             return true
@@ -102,6 +111,40 @@ import UIKit
         return false
     }
 
+    /**
+     * Send a synchronous statistic about rate limiting
+     */
+    private func sendRateLimitStatistic() {
+        guard !statsUrl.isEmpty else {
+            return
+        }
+
+        let current = getCurrentBundle()
+        var parameters = createInfoObject()
+        parameters.action = "rate_limit_reached"
+        parameters.version_name = current.getVersionName()
+        parameters.old_version_name = ""
+
+        // Send synchronously to ensure it goes out before the flag is set
+        let semaphore = DispatchSemaphore(value: 0)
+        self.alamofireSession.request(
+            self.statsUrl,
+            method: .post,
+            parameters: parameters,
+            encoder: JSONParameterEncoder.default,
+            requestModifier: { $0.timeoutInterval = self.timeout }
+        ).responseData { response in
+            switch response.result {
+            case .success:
+                self.logger.info("Rate limit statistic sent")
+            case let .failure(error):
+                self.logger.error("Error sending rate limit statistic: \(error.localizedDescription)")
+            }
+            semaphore.signal()
+        }
+        semaphore.wait()
+    }
+
     // MARK: Private
     private func hasEmbeddedMobileProvision() -> Bool {
         guard Bundle.main.path(forResource: "embedded", ofType: "mobileprovision") == nil else {

package/ios/Sources/CapacitorUpdaterPlugin/DeviceIdHelper.swift

@@ -0,0 +1,120 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import Foundation
+import Security
+
+/**
+ * Helper class to manage device ID persistence across app installations.
+ * Uses iOS Keychain to persist the device ID.
+ */
+class DeviceIdHelper {
+    private static let keychainService = "app.capgo.updater"
+    private static let keychainAccount = "deviceId"
+    private static let legacyDefaultsKey = "appUUID"
+
+    /**
+     * Gets or creates a device ID that persists across reinstalls.
+     *
+     * This method:
+     * 1. First checks for an existing ID in Keychain (persists across reinstalls)
+     * 2. Falls back to UserDefaults (for migration from older versions)
+     * 3. Generates a new UUID if neither exists
+     * 4. Stores the ID in Keychain for future use
+     *
+     * @return Device ID as a lowercase UUID string
+     */
+    static func getOrCreateDeviceId() -> String {
+        // Try to get device ID from Keychain first
+        if let keychainDeviceId = getDeviceIdFromKeychain() {
+            return keychainDeviceId.lowercased()
+        }
+
+        // Migration: Check UserDefaults for existing device ID
+        var deviceId = UserDefaults.standard.string(forKey: legacyDefaultsKey)
+
+        if deviceId == nil || deviceId!.isEmpty {
+            // Generate new device ID if none exists
+            deviceId = UUID().uuidString
+        }
+
+        // Ensure lowercase for consistency
+        deviceId = deviceId!.lowercased()
+
+        // Save to Keychain for persistence across reinstalls
+        saveDeviceIdToKeychain(deviceId: deviceId!)
+
+        return deviceId!
+    }
+
+    /**
+     * Retrieves the device ID from iOS Keychain.
+     *
+     * @return Device ID string or nil if not found
+     */
+    private static func getDeviceIdFromKeychain() -> String? {
+        let query: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount,
+            kSecReturnData as String: true,
+            kSecMatchLimit as String: kSecMatchLimitOne
+        ]
+
+        var result: AnyObject?
+        let status = SecItemCopyMatching(query as CFDictionary, &result)
+
+        guard status == errSecSuccess,
+              let data = result as? Data,
+              let deviceId = String(data: data, encoding: .utf8) else {
+            return nil
+        }
+
+        return deviceId
+    }
+
+    /**
+     * Saves the device ID to iOS Keychain with appropriate accessibility settings.
+     *
+     * Uses kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly:
+     * - Data persists across reinstalls
+     * - Data is NOT synced to iCloud
+     * - Data is accessible after first device unlock
+     * - Data stays on this device only (privacy-friendly)
+     *
+     * @param deviceId The device ID to save
+     */
+    private static func saveDeviceIdToKeychain(deviceId: String) {
+        guard let data = deviceId.data(using: .utf8) else {
+            return
+        }
+
+        // Delete any existing entry first
+        let deleteQuery: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount
+        ]
+        SecItemDelete(deleteQuery as CFDictionary)
+
+        // Add new entry with appropriate accessibility
+        let addQuery: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount,
+            kSecValueData as String: data,
+            // This ensures data persists across reinstalls but stays on device (not synced)
+            kSecAttrAccessible as String: kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly
+        ]
+
+        let status = SecItemAdd(addQuery as CFDictionary, nil)
+
+        if status != errSecSuccess {
+            // Log error but don't crash - we'll fall back to UserDefaults on next launch
+            print("Failed to save device ID to Keychain: \(status)")
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "6.14.29",
+  "version": "6.14.36",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",
@@ -52,8 +52,7 @@
     "eslint": "eslint . --ext .ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
     "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api CapacitorUpdaterPlugin --output-readme README.md --output-json dist/docs.json",
-    "docgen:api": "node scripts/generate-docs.js",
+    "docgen": "node scripts/generate-docs.js",
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",