@capawesome/capacitor-live-update 7.5.0 → 7.5.2

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java

@@ -7,9 +7,11 @@ import android.content.pm.PackageManager;
 import android.content.res.AssetManager;
 import android.os.Build;
 import android.os.Handler;
+import android.os.Looper;
 import android.util.Base64;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.core.content.pm.PackageInfoCompat;
 import com.getcapacitor.Bridge;
 import com.getcapacitor.Logger;
 import com.getcapacitor.plugin.WebView;
@@ -102,7 +104,8 @@ public class LiveUpdate {
     private final SharedPreferences.Editor webViewSettingsEditor;
 
     private final String bundlesDirectory = "_capacitor_live_update_bundles"; // DO NOT CHANGE!
-    private final Handler rollbackHandler = new Handler();
+    private final String downloadsDirectory = "capawesome_capacitor_live_update_downloads";
+    private final Handler rollbackHandler = new Handler(Looper.getMainLooper());
     private final String manifestFileName = "capawesome-live-update-manifest.json"; // DO NOT CHANGE!
 
     private boolean initialPageLoaded = false;
@@ -123,6 +126,9 @@ public class LiveUpdate {
         // Set the device ID on the HTTP client (after any potential config reset)
         this.httpClient.setDeviceId(getDeviceId());
 
+        // Delete the leftovers of downloads that were interrupted by a process kill
+        tryDeleteDownloadsDirectory();
+
         // Start the rollback timer to rollback to the default bundle
         // if the app is not ready after a certain time
         startRollbackTimer();
@@ -530,7 +536,10 @@ public class LiveUpdate {
 
         // Move the bundle directory to the bundles directory
         File bundleDirectory = buildBundleDirectoryFor(bundleId);
-        indexHtmlFile.getParentFile().renameTo(bundleDirectory);
+        boolean moved = indexHtmlFile.getParentFile().renameTo(bundleDirectory);
+        if (!moved) {
+            throw new Exception(LiveUpdatePlugin.ERROR_BUNDLE_MOVE_FAILED);
+        }
     }
 
     private void addBundleOfTypeManifest(@NonNull String bundleId, @NonNull File directory) throws Exception {
@@ -539,7 +548,7 @@ public class LiveUpdate {
 
     private void addBundleOfTypeZip(@NonNull String bundleId, @NonNull File zipFile) throws Exception {
         // Unzip the file to the bundle directory
-        File unzippedDirectory = unzipFile(zipFile);
+        File unzippedDirectory = unzipDownloadedBundle(zipFile);
         // Add the bundle
         addBundle(bundleId, unzippedDirectory);
     }
@@ -552,14 +561,8 @@ public class LiveUpdate {
         return new File(plugin.getContext().getFilesDir(), bundlesDirectory + "/" + bundleId);
     }
 
-    private File buildTemporaryDirectory() {
-        String fileName = UUID.randomUUID().toString();
-        return new File(plugin.getContext().getCacheDir(), fileName);
-    }
-
-    private File buildTemporaryZipFile() {
-        String fileName = UUID.randomUUID().toString() + ".zip";
-        return new File(plugin.getContext().getCacheDir(), fileName);
+    private File buildDownloadsDirectory() {
+        return new File(plugin.getContext().getCacheDir(), downloadsDirectory);
     }
 
     private void copyCurrentBundleFile(@NonNull ManifestItem fileToCopy, @NonNull File destinationDirectory) throws IOException {
@@ -646,10 +649,10 @@ public class LiveUpdate {
         }
     }
 
-    private File createTemporaryDirectory() {
-        File file = buildTemporaryDirectory();
-        file.mkdir();
-        return file;
+    private File createTemporaryDownloadDirectory() {
+        File temporaryDirectory = new File(buildDownloadsDirectory(), UUID.randomUUID().toString());
+        temporaryDirectory.mkdirs();
+        return temporaryDirectory;
     }
 
     private void deleteBundleById(@NonNull String bundleId) {
@@ -675,6 +678,23 @@ public class LiveUpdate {
         file.delete();
     }
 
+    @NonNull
+    private EmptyCallback deleteTemporaryDirectoryOnCompletion(@NonNull File temporaryDirectory, @NonNull EmptyCallback callback) {
+        return new EmptyCallback() {
+            @Override
+            public void success() {
+                deleteFileRecursively(temporaryDirectory);
+                callback.success();
+            }
+
+            @Override
+            public void error(@NonNull Exception exception) {
+                deleteFileRecursively(temporaryDirectory);
+                callback.error(exception);
+            }
+        };
+    }
+
     private void deleteUnusedBundles() {
         String[] bundleIds = getDownloadedBundleIds();
         for (String bundleId : bundleIds) {
@@ -845,10 +865,10 @@ public class LiveUpdate {
         @NonNull String downloadUrl,
         @NonNull EmptyCallback completionCallback
     ) {
+        // Create a temporary directory that is deleted once the download completed or failed
+        File temporaryDirectory = createTemporaryDownloadDirectory();
+        EmptyCallback callback = deleteTemporaryDirectoryOnCompletion(temporaryDirectory, completionCallback);
         try {
-            // Create a temporary directory
-            File temporaryDirectory = createTemporaryDirectory();
-
             // Download the latest manifest
             downloadBundleFile(
                 downloadUrl,
@@ -898,31 +918,31 @@ public class LiveUpdate {
                                         try {
                                             // Add the bundle
                                             addBundleOfTypeManifest(bundleId, temporaryDirectory);
-                                            completionCallback.success();
+                                            callback.success();
                                         } catch (Exception e) {
-                                            completionCallback.error(e);
+                                            callback.error(e);
                                         }
                                     }
 
                                     @Override
                                     public void error(@NonNull Exception exception) {
-                                        completionCallback.error(exception);
+                                        callback.error(exception);
                                     }
                                 }
                             );
                         } catch (Exception e) {
-                            completionCallback.error(e);
+                            callback.error(e);
                         }
                     }
 
                     @Override
                     public void error(@NonNull Exception exception) {
-                        completionCallback.error(exception);
+                        callback.error(exception);
                     }
                 }
             );
         } catch (Exception e) {
-            completionCallback.error(e);
+            callback.error(e);
         }
     }
 
@@ -933,39 +953,42 @@ public class LiveUpdate {
         @NonNull String downloadUrl,
         @NonNull EmptyCallback completionCallback
     ) {
-        File file = buildTemporaryZipFile();
-        // Download the bundle
-        downloadAndVerifyFile(
-            downloadUrl,
-            file,
-            checksum,
-            signature,
-            (downloadedBytes, totalBytes) -> {
-                DownloadBundleProgressEvent event = new DownloadBundleProgressEvent(bundleId, downloadedBytes, totalBytes);
-                notifyDownloadBundleProgressListeners(event);
-            },
-            new EmptyCallback() {
-                @Override
-                public void success() {
-                    try {
-                        // Add the bundle
-                        addBundleOfTypeZip(bundleId, file);
-                        // Delete the temporary file
-                        file.delete();
-                        completionCallback.success();
-                    } catch (Exception e) {
-                        completionCallback.error(e);
+        // Create a temporary directory that is deleted once the download completed or failed
+        File temporaryDirectory = createTemporaryDownloadDirectory();
+        EmptyCallback callback = deleteTemporaryDirectoryOnCompletion(temporaryDirectory, completionCallback);
+        File zipFile = new File(temporaryDirectory, "bundle.zip");
+        try {
+            // Download the bundle
+            downloadAndVerifyFile(
+                downloadUrl,
+                zipFile,
+                checksum,
+                signature,
+                (downloadedBytes, totalBytes) -> {
+                    DownloadBundleProgressEvent event = new DownloadBundleProgressEvent(bundleId, downloadedBytes, totalBytes);
+                    notifyDownloadBundleProgressListeners(event);
+                },
+                new EmptyCallback() {
+                    @Override
+                    public void success() {
+                        try {
+                            // Add the bundle
+                            addBundleOfTypeZip(bundleId, zipFile);
+                            callback.success();
+                        } catch (Exception e) {
+                            callback.error(e);
+                        }
                     }
-                }
 
-                @Override
-                public void error(@NonNull Exception exception) {
-                    // Delete the temporary file on error
-                    file.delete();
-                    completionCallback.error(exception);
+                    @Override
+                    public void error(@NonNull Exception exception) {
+                        callback.error(exception);
+                    }
                 }
-            }
-        );
+            );
+        } catch (Exception e) {
+            callback.error(e);
+        }
     }
 
     private void fetchLatestBundleInternal(
@@ -1169,7 +1192,7 @@ public class LiveUpdate {
     }
 
     private int getVersionCodeAsInt() throws PackageManager.NameNotFoundException {
-        return getPackageInfo().versionCode;
+        return (int) PackageInfoCompat.getLongVersionCode(getPackageInfo());
     }
 
     private String getVersionCodeAsString() throws PackageManager.NameNotFoundException {
@@ -1431,8 +1454,12 @@ public class LiveUpdate {
         }
     }
 
-    private File unzipFile(@NonNull File zipFile) throws IOException {
-        File destination = buildTemporaryDirectory();
+    private void tryDeleteDownloadsDirectory() {
+        deleteFileRecursively(buildDownloadsDirectory());
+    }
+
+    private File unzipDownloadedBundle(@NonNull File zipFile) throws IOException {
+        File destination = new File(zipFile.getParentFile(), "bundle");
         String destinationPath = destination.getPath();
         ZipFile zip = new ZipFile(zipFile);
         // Clear stored Unix permissions to prevent EACCES errors on newer Android versions

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java

@@ -37,12 +37,13 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "7.5.0";
+    public static final String VERSION = "7.5.2";
     public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdate"; // DO NOT CHANGE
     public static final String ERROR_APP_ID_MISSING = "appId must be configured.";
     public static final String ERROR_BUNDLE_EXISTS = "bundle already exists.";
     public static final String ERROR_BUNDLE_ID_MISSING = "bundleId must be provided.";
     public static final String ERROR_BUNDLE_INDEX_HTML_MISSING = "The bundle does not contain an index.html file.";
+    public static final String ERROR_BUNDLE_MOVE_FAILED = "Bundle could not be moved.";
     public static final String ERROR_BUNDLE_NOT_FOUND = "bundle not found.";
     public static final String ERROR_CHECKSUM_CALCULATION_FAILED = "Failed to calculate checksum.";
     public static final String ERROR_CHECKSUM_MISMATCH = "Checksum mismatch.";

package/ios/Plugin/LiveUpdate.swift

@@ -13,6 +13,7 @@ import CommonCrypto
     private let config: LiveUpdateConfig
     private let defaultWebAssetDir = "public" // DO NOT CHANGE! (See https://dub.sh/Buvz4yj)
     private let defaultServerPathKey = "serverBasePath" // DO NOT CHANGE! (See https://dub.sh/ceDl0zT)
+    private let downloadsDirectory = "capawesome_capacitor_live_update_downloads"
     private let httpClient: LiveUpdateHttpClient
     private let libraryDirectoryUrl = FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
     private let manifestFileName = "capawesome-live-update-manifest.json" // DO NOT CHANGE!
@@ -37,6 +38,9 @@ import CommonCrypto
         // Set the device ID on the HTTP client (after any potential config reset)
         self.httpClient.setDeviceId(getDeviceId())
 
+        // Delete the leftovers of downloads that were interrupted by a process kill
+        tryDeleteDownloadsDirectory()
+
         // Start the rollback timer to rollback to the default bundle
         // if the app is not ready after a certain time
         startRollbackTimer()
@@ -352,7 +356,7 @@ import CommonCrypto
 
     private func addBundleOfTypeZip(bundleId: String, zipFile: URL) async throws {
         // Unzip the bundle
-        let unzippedDirectory = try self.unzipFile(zipFile: zipFile)
+        let unzippedDirectory = try self.unzipDownloadedBundle(zipFile: zipFile)
         // Add the bundle
         try self.addBundle(bundleId: bundleId, directory: unzippedDirectory)
     }
@@ -376,6 +380,10 @@ import CommonCrypto
         return url
     }
 
+    private func buildDownloadsDirectoryUrl() -> URL {
+        return cachesDirectoryUrl.appendingPathComponent(downloadsDirectory)
+    }
+
     private func copyCurrentBundleFile(fileToCopy: ManifestItem, toDirectory: URL) throws {
         let currentBundleId = getCurrentBundleId()
         let destination = toDirectory.appendingPathComponent(fileToCopy.href)
@@ -425,8 +433,8 @@ import CommonCrypto
         }
     }
 
-    private func createTemporaryDirectory() throws -> URL {
-        let temporaryDirectory = cachesDirectoryUrl.appendingPathComponent(UUID().uuidString)
+    private func createTemporaryDownloadDirectory() throws -> URL {
+        let temporaryDirectory = buildDownloadsDirectoryUrl().appendingPathComponent(UUID().uuidString)
         try FileManager.default.createDirectory(at: temporaryDirectory, withIntermediateDirectories: true, attributes: nil)
         return temporaryDirectory
     }
@@ -460,7 +468,8 @@ import CommonCrypto
 
     private func downloadAndVerifyFile(url: String, file: URL, checksum: String?, signature: String?, callback: ((Progress) -> Void)?) async throws {
         let destination: DownloadRequest.Destination = { _, _ in
-            return (file, [.createIntermediateDirectories])
+            // `removePreviousFile` ensures that a leftover file from a failed attempt does not fail the download
+            return (file, [.createIntermediateDirectories, .removePreviousFile])
         }
         let urlComponents = URLComponents(string: url)!
         let result = try await httpClient.download(url: urlComponents.asURL(), destination: destination, callback: callback)
@@ -533,8 +542,9 @@ import CommonCrypto
     }
 
     private func downloadBundleOfTypeManifest(bundleId: String, url: String) async throws {
-        // Create a temporary directory
-        let temporaryDirectory = try createTemporaryDirectory()
+        // Create a temporary directory that is deleted once the download completed or failed
+        let temporaryDirectory = try createTemporaryDownloadDirectory()
+        defer { tryDeleteDirectory(temporaryDirectory) }
         // Download the latest manifest
         let latestManifestFile = try await downloadBundleFile(baseUrl: url, href: manifestFileName, directory: temporaryDirectory, callback: nil)
         let latestManifest = try loadManifest(file: latestManifestFile)
@@ -565,15 +575,17 @@ import CommonCrypto
     }
 
     private func downloadBundleOfTypeZip(bundleId: String, checksum: String?, signature: String?, url: String) async throws {
-        let timestamp = String(Int(Date().timeIntervalSince1970))
-        let temporaryZipFileUrl = self.cachesDirectoryUrl.appendingPathComponent(timestamp + ".zip")
+        // Create a temporary directory that is deleted once the download completed or failed
+        let temporaryDirectory = try createTemporaryDownloadDirectory()
+        defer { tryDeleteDirectory(temporaryDirectory) }
+        let zipFile = temporaryDirectory.appendingPathComponent("bundle.zip")
         // Download the bundle
-        try await downloadAndVerifyFile(url: url, file: temporaryZipFileUrl, checksum: checksum, signature: signature, callback: { progress in
+        try await downloadAndVerifyFile(url: url, file: zipFile, checksum: checksum, signature: signature, callback: { progress in
             let event = DownloadBundleProgressEvent(bundleId: bundleId, downloadedBytes: progress.completedUnitCount, totalBytes: progress.totalUnitCount)
             self.notifyDownloadBundleProgressListeners(event)
         })
         // Add the bundle
-        try await addBundleOfTypeZip(bundleId: bundleId, zipFile: temporaryZipFileUrl)
+        try await addBundleOfTypeZip(bundleId: bundleId, zipFile: zipFile)
     }
 
     private func fetchLatestBundle(_ options: FetchLatestBundleOptions) async throws -> GetLatestBundleResponse? {
@@ -959,8 +971,23 @@ import CommonCrypto
         }
     }
 
-    private func unzipFile(zipFile: URL) throws -> URL {
-        let destinationDirectory = zipFile.deletingPathExtension()
+    private func tryDeleteDirectory(_ url: URL) {
+        guard FileManager.default.fileExists(atPath: url.path) else {
+            return
+        }
+        do {
+            try FileManager.default.removeItem(at: url)
+        } catch {
+            CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Failed to delete directory: \(url.path)")
+        }
+    }
+
+    private func tryDeleteDownloadsDirectory() {
+        tryDeleteDirectory(buildDownloadsDirectoryUrl())
+    }
+
+    private func unzipDownloadedBundle(zipFile: URL) throws -> URL {
+        let destinationDirectory = zipFile.deletingLastPathComponent().appendingPathComponent("bundle")
         try FileManager.default.createDirectory(at: destinationDirectory, withIntermediateDirectories: true, attributes: nil)
         try FileManager.default.unzipItem(at: zipFile, to: destinationDirectory)
         return destinationDirectory

package/ios/Plugin/LiveUpdateHttpClient.swift

@@ -27,13 +27,16 @@ public class LiveUpdateHttpClient: NSObject {
 
     public func download(url: URL, destination: @escaping DownloadRequest.Destination, callback: ((Progress) -> Void)?) async throws -> AFDownloadResponse<Data> {
         var request = URLRequest(url: url)
+        // Ignore the URL cache so that a cached response is never replayed for a deterministic request URL
+        request.cachePolicy = .reloadIgnoringLocalCacheData
         request.httpMethod = HTTPMethod.get.rawValue
         request.timeoutInterval = Double(config.httpTimeout) / 1000.0
         if let deviceId = deviceId, !deviceId.isEmpty {
             request.setValue(deviceId, forHTTPHeaderField: "X-Device-Id")
         }
         return try await withCheckedThrowingContinuation { continuation in
-            AF.download(request, to: destination).downloadProgress { progress in
+            // `validate()` treats non-2xx responses as errors so that an error body is never saved as a bundle file
+            AF.download(request, to: destination).validate().downloadProgress { progress in
                 if let callback = callback {
                     callback(progress)
                 }
@@ -45,6 +48,8 @@ public class LiveUpdateHttpClient: NSObject {
 
     public func request<T: Decodable>(url: URL, type: T.Type) async throws -> AFDataResponse<T> {
         var request = URLRequest(url: url)
+        // Ignore the URL cache so that a cached response is never replayed for a deterministic request URL
+        request.cachePolicy = .reloadIgnoringLocalCacheData
         request.httpMethod = HTTPMethod.get.rawValue
         request.timeoutInterval = Double(config.httpTimeout) / 1000.0
         if let deviceId = deviceId, !deviceId.isEmpty {

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "7.5.0"
+    public static let version = "7.5.2"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "7.5.0",
+  "version": "7.5.2",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",