@capgo/capacitor-updater 4.0.0-alpha.31 → 4.0.0-alpha.35

package/README.md

@@ -133,6 +133,7 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
 * [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete)
 * [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
 * [`addListener('updateFailed', ...)`](#addlistenerupdatefailed)
+* [`addListener('downloadFailed', ...)`](#addlistenerdownloadfailed)
 * [`getId()`](#getid)
 * [`getPluginVersion()`](#getpluginversion)
 * [`isAutoUpdateEnabled()`](#isautoupdateenabled)
@@ -390,7 +391,7 @@ Listen for Major update event in the App, let you know when major update is bloc
 addListener(eventName: 'updateFailed', listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for update fail event in the App, let you know when update hs fail to install at next app start
+Listen for update fail event in the App, let you know when update has fail to install at next app start
 
 | Param              | Type                                                                  |
 | ------------------ | --------------------------------------------------------------------- |
@@ -404,6 +405,26 @@ Listen for update fail event in the App, let you know when update hs fail to ins
 --------------------
 
 
+### addListener('downloadFailed', ...)
+
+```typescript
+addListener(eventName: 'downloadFailed', listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for download fail event in the App, let you know when download has fail finished
+
+| Param              | Type                                                                      |
+| ------------------ | ------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadFailed'</code>                                             |
+| **`listenerFunc`** | <code><a href="#downloadfailedlistener">DownloadFailedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
 ### getId()
 
 ```typescript
@@ -478,6 +499,7 @@ removeAllListeners() => Promise<void>
 | **`id`**         | <code>string</code>                                   |
 | **`version`**    | <code>string</code>                                   |
 | **`downloaded`** | <code>string</code>                                   |
+| **`checksum`**   | <code>string</code>                                   |
 | **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
 
 
@@ -528,6 +550,13 @@ removeAllListeners() => Promise<void>
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a update failed to install. | 4.0.0 |
 
 
+#### DownloadFailedEvent
+
+| Prop          | Type                | Description                                 | Since |
+| ------------- | ------------------- | ------------------------------------------- | ----- |
+| **`version`** | <code>string</code> | Emit when a new major version is available. | 4.0.0 |
+
+
 ### Type Aliases
 
 
@@ -560,6 +589,11 @@ removeAllListeners() => Promise<void>
 
 <code>(state: <a href="#updatefailedevent">UpdateFailedEvent</a>): void</code>
 
+
+#### DownloadFailedListener
+
+<code>(state: <a href="#downloadfailedevent">DownloadFailedEvent</a>): void</code>
+
 </docgen-api>
 
 ### Listen to download events

package/android/src/main/java/ee/forgr/capacitor_updater/BundleInfo.java

@@ -21,6 +21,7 @@ public class BundleInfo {
     private final String downloaded;
     private final String id;
     private final String version;
+    private final String checksum;
     private final BundleStatus status;
 
     static {
@@ -28,17 +29,18 @@ public class BundleInfo {
     }
 
     public BundleInfo(final BundleInfo source) {
-        this(source.id, source.version, source.status, source.downloaded);
+        this(source.id, source.version, source.status, source.downloaded, source.checksum);
     }
 
-    public BundleInfo(final String id, final String version, final BundleStatus status, final Date downloaded) {
-        this(id, version, status, sdf.format(downloaded));
+    public BundleInfo(final String id, final String version, final BundleStatus status, final Date downloaded, final String checksum) {
+        this(id, version, status, sdf.format(downloaded), checksum);
     }
 
-    public BundleInfo(final String id, final String version, final BundleStatus status, final String downloaded) {
+    public BundleInfo(final String id, final String version, final BundleStatus status, final String downloaded, final String checksum) {
         this.downloaded = downloaded.trim();
         this.id = id;
         this.version = version;
+        this.checksum = checksum;
         this.status = status;
     }
 
@@ -60,7 +62,15 @@ public class BundleInfo {
     }
 
     public BundleInfo setDownloaded(Date downloaded) {
-        return new BundleInfo(this.id, this.version, this.status, downloaded);
+        return new BundleInfo(this.id, this.version, this.status, downloaded, this.checksum);
+    }
+
+    public String getChecksum() {
+        return this.isBuiltin() ? "" : this.checksum;
+    }
+
+    public BundleInfo setChecksum(String checksum) {
+        return new BundleInfo(this.id, this.version, this.status, this.downloaded, checksum);
     }
 
     public String getId() {
@@ -68,7 +78,7 @@ public class BundleInfo {
     }
 
     public BundleInfo setId(String id) {
-        return new BundleInfo(id, this.version, this.status, this.downloaded);
+        return new BundleInfo(id, this.version, this.status, this.downloaded, this.checksum);
     }
 
     public String getVersionName() {
@@ -76,7 +86,7 @@ public class BundleInfo {
     }
 
     public BundleInfo setVersionName(String version) {
-        return new BundleInfo(this.id, version, this.status, this.downloaded);
+        return new BundleInfo(this.id, version, this.status, this.downloaded, this.checksum);
     }
 
     public BundleStatus getStatus() {
@@ -84,7 +94,7 @@ public class BundleInfo {
     }
 
     public BundleInfo setStatus(BundleStatus status) {
-        return new BundleInfo(this.id, this.version, status, this.downloaded);
+        return new BundleInfo(this.id, this.version, status, this.downloaded, this.checksum);
     }
 
     public static BundleInfo fromJSON(final JSObject json) throws JSONException {
@@ -97,7 +107,8 @@ public class BundleInfo {
                 json.has("id") ? json.getString("id") : "",
                 json.has("version") ? json.getString("version") : BundleInfo.VERSION_UNKNOWN,
                 json.has("status") ? BundleStatus.fromString(json.getString("status")) : BundleStatus.PENDING,
-                json.has("downloaded") ? json.getString("downloaded") : ""
+                json.has("downloaded") ? json.getString("downloaded") : "",
+                json.has("checksum") ? json.getString("checksum") : ""
         );
     }
 
@@ -106,6 +117,7 @@ public class BundleInfo {
         result.put("id", this.getId());
         result.put("version", this.getVersionName());
         result.put("downloaded", this.getDownloaded());
+        result.put("checksum", this.getChecksum());
         result.put("status", this.getStatus());
         return result;
     }

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java

@@ -28,6 +28,7 @@ import java.security.SecureRandom;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.zip.CRC32;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
@@ -46,7 +47,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.0.0-alpha.31";
+    public static final String pluginVersion = "4.0.0-alpha.35";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;
@@ -212,13 +213,25 @@ public class CapacitorUpdater {
         this.editor.commit();
     }
 
+    private String getChecksum(File file) throws IOException {
+        byte[] bytes = new byte[(int) file.length()];
+        try(FileInputStream fis = new FileInputStream(file)){
+            fis.read(bytes);
+        }
+        CRC32 crc = new CRC32();
+        crc.update(bytes);
+        String enc = String.format("%08X", crc.getValue());
+        return enc.toLowerCase();
+    }
+
     public BundleInfo download(final String url, final String version) throws IOException {
         final String id = this.randomString(10);
-        this.saveBundleInfo(id, new BundleInfo(id, version, BundleStatus.DOWNLOADING, new Date(System.currentTimeMillis())));
+        this.saveBundleInfo(id, new BundleInfo(id, version, BundleStatus.DOWNLOADING, new Date(System.currentTimeMillis()), ""));
         this.notifyDownload(id, 0);
         final String idName = bundleDirectory + "/" + id;
         this.notifyDownload(id, 5);
         final File downloaded = this.downloadFile(id, url, this.randomString(10));
+        final String checksum = this.getChecksum(downloaded);
         this.notifyDownload(id, 71);
         final File unzipped = this.unzip(id, downloaded, this.randomString(10));
         downloaded.delete();
@@ -226,7 +239,7 @@ public class CapacitorUpdater {
         this.flattenAssets(unzipped, idName);
         this.notifyDownload(id, 100);
         this.saveBundleInfo(id, null);
-        BundleInfo info = new BundleInfo(id, version, BundleStatus.PENDING, new Date(System.currentTimeMillis()));
+        BundleInfo info = new BundleInfo(id, version, BundleStatus.PENDING, new Date(System.currentTimeMillis()), checksum);
         this.saveBundleInfo(id, info);
         return info;
     }
@@ -246,12 +259,14 @@ public class CapacitorUpdater {
         return res;
     }
 
-    public Boolean delete(final String id) throws IOException {
+    public Boolean delete(final String id, final Boolean removeInfo) throws IOException {
         final BundleInfo deleted = this.getBundleInfo(id);
         final File bundle = new File(this.documentsDir, bundleDirectory + "/" + id);
         if (bundle.exists()) {
             this.deleteDirectory(bundle);
-            this.removeBundleInfo(id);
+            if (removeInfo) {
+                this.removeBundleInfo(id);
+            }
             return true;
         }
         Log.e(TAG, "Directory not removed: " + bundle.getPath());
@@ -259,6 +274,10 @@ public class CapacitorUpdater {
         return false;
     }
 
+    public Boolean delete(final String id) throws IOException {
+        return this.delete(id, true);
+    }
+
     private File getBundleDirectory(final String id) {
         return new File(this.documentsDir, bundleDirectory + "/" + id);
     }
@@ -293,16 +312,16 @@ public class CapacitorUpdater {
         return false;
     }
 
-    public void commit(final BundleInfo bundle) {
-        this.setBundleStatus(bundle.getId(), BundleStatus.SUCCESS);
-        this.setFallbackBundle(bundle);
-    }
-
     public void reset() {
         this.reset(false);
     }
 
-    public void rollback(final BundleInfo bundle) {
+    public void setSuccess(final BundleInfo bundle) {
+        this.setBundleStatus(bundle.getId(), BundleStatus.SUCCESS);
+        this.setFallbackBundle(bundle);
+    }
+
+    public void setError(final BundleInfo bundle) {
         this.setBundleStatus(bundle.getId(), BundleStatus.ERROR);
     }
 
@@ -404,14 +423,14 @@ public class CapacitorUpdater {
         Log.d(TAG, "Getting info for bundle [" + id + "]");
         BundleInfo result;
         if(BundleInfo.ID_BUILTIN.equals(id)) {
-            result = new BundleInfo(id, (String) null, BundleStatus.SUCCESS, "");
+            result = new BundleInfo(id, (String) null, BundleStatus.SUCCESS, "", "");
         } else {
             try {
                 String stored = this.prefs.getString(id + INFO_SUFFIX, "");
                 result = BundleInfo.fromJSON(stored);
             } catch (JSONException e) {
                 Log.e(TAG, "Failed to parse info for bundle [" + id + "] ", e);
-                result = new BundleInfo(id, (String) null, BundleStatus.PENDING, "");
+                result = new BundleInfo(id, (String) null, BundleStatus.PENDING, "", "");
             }
         }
 

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java

@@ -202,6 +202,9 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                     } catch (final IOException e) {
                         Log.e(CapacitorUpdater.TAG, "download failed", e);
                         call.reject("download failed", e);
+                        final JSObject ret = new JSObject();
+                        ret.put("version", version);
+                        CapacitorUpdaterPlugin.this.notifyListeners("downloadFailed", ret);
                     }
                 }
             }).start();
@@ -399,7 +402,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         try {
             Log.i(CapacitorUpdater.TAG, "Current bundle loaded successfully. ['notifyAppReady()' was called]");
             final BundleInfo bundle = this.implementation.getCurrentBundle();
-            this.implementation.commit(bundle);
+            this.implementation.setSuccess(bundle);
             call.resolve();
         }
         catch(final Exception e) {
@@ -566,10 +569,15 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
                                             final String url = (String) res.get("url");
                                             final BundleInfo next = CapacitorUpdaterPlugin.this.implementation.download(url, latestVersionName);
-                                            this.notifyListeners("updateAvailable", next);
+                                            final JSObject ret = new JSObject();
+                                            ret.put("bundle", next.toJSON());
+                                            CapacitorUpdaterPlugin.this.notifyListeners("updateAvailable", ret);
                                             CapacitorUpdaterPlugin.this.implementation.setNextBundle(next.getId());
                                         } catch (final Exception e) {
                                             Log.e(CapacitorUpdater.TAG, "error downloading file", e);
+                                            final JSObject ret = new JSObject();
+                                            ret.put("version", latestVersionName);
+                                            CapacitorUpdaterPlugin.this.notifyListeners("downloadFailed", ret);
                                         }
                                     }
                                 }).start();
@@ -593,19 +601,13 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         try {
             final String delayUpdate = this.prefs.getString(DELAY_UPDATE, "");
             this._checkCancelDelay(false);
-            if ("".equals(delayUpdate)) {
+            if (!"".equals(delayUpdate)) {
                 Log.i(CapacitorUpdater.TAG, "Update delayed to next backgrounding");
                 return;
             }
-            final BundleInfo fallback = this.implementation.getFallbackBundle();
             final BundleInfo current = this.implementation.getCurrentBundle();
             final BundleInfo next = this.implementation.getNextBundle();
 
-            final Boolean success = current.getStatus() == BundleStatus.SUCCESS;
-
-            Log.d(CapacitorUpdater.TAG, "Fallback bundle is: " + fallback);
-            Log.d(CapacitorUpdater.TAG, "Current bundle is: " + current);
-
             if (next != null && !next.isErrorStatus() && (next.getId() != current.getId())) {
                 // There is a next bundle waiting for activation
                 Log.d(CapacitorUpdater.TAG, "Next bundle is: " + next.getVersionName());
@@ -615,70 +617,58 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                 } else {
                     Log.e(CapacitorUpdater.TAG, "Update to bundle: " + next.getVersionName() + " Failed!");
                 }
-            } else if (!success) {
-                // There is a no next bundle, and the current bundle has failed
-
-                if(!current.isBuiltin()) {
-                    // Don't try to roll back the builtin bundle. Nothing we can do.
+            }
+        }
+        catch(final Exception e) {
+            Log.e(CapacitorUpdater.TAG, "Error during onActivityStopped", e);
+        }
+    }
 
-                    this.implementation.rollback(current);
+    private void checkRevert() {
+        // Automatically roll back to fallback version if notifyAppReady has not been called yet
+        final BundleInfo current = this.implementation.getCurrentBundle();
+        final BundleInfo fallback = this.implementation.getFallbackBundle();
 
-                    Log.i(CapacitorUpdater.TAG, "Update failed: 'notifyAppReady()' was never called.");
-                    Log.i(CapacitorUpdater.TAG, "Bundle: " + current + ", is in error state.");
-                    Log.i(CapacitorUpdater.TAG, "Will fallback to: " + fallback + " on application restart.");
-                    Log.i(CapacitorUpdater.TAG, "Did you forget to call 'notifyAppReady()' in your Capacitor App code?");
-                    final JSObject ret = new JSObject();
-                    ret.put("bundle", current);
-                    this.notifyListeners("updateFailed", ret);
-                    this.implementation.sendStats("update_fail", current.getVersionName());
-                    if (!fallback.isBuiltin() && !fallback.equals(current)) {
-                        final Boolean res = this.implementation.set(fallback);
-                        if (res && this._reload()) {
-                            Log.i(CapacitorUpdater.TAG, "Revert to bundle: " + fallback.getVersionName());
-                        } else {
-                            Log.e(CapacitorUpdater.TAG, "Revert to bundle: " + fallback.getVersionName() + " Failed!");
-                        }
-                    } else {
-                        if (this._reset(false)) {
-                            Log.i(CapacitorUpdater.TAG, "Reverted to 'builtin' bundle.");
-                        }
-                    }
+        if(current.isBuiltin()) {
+            Log.i(CapacitorUpdater.TAG, "Built-in bundle is active. Nothing to do.");
+            return;
+        }
+        Log.d(CapacitorUpdater.TAG, "Fallback bundle is: " + fallback);
+        Log.d(CapacitorUpdater.TAG, "Current bundle is: " + current);
 
-                    if (this.autoDeleteFailed) {
-                        Log.i(CapacitorUpdater.TAG, "Deleting failing bundle: " + current.getVersionName());
-                        try {
-                            final Boolean res = this.implementation.delete(current.getId());
-                            if (res) {
-                                Log.i(CapacitorUpdater.TAG, "Failed bundle deleted: " + current.getVersionName());
-                            }
-                        } catch (final IOException e) {
-                            Log.e(CapacitorUpdater.TAG, "Failed to delete failed bundle: " + current.getVersionName(), e);
-                        }
+        if(BundleStatus.SUCCESS != current.getStatus()) {
+            Log.e(CapacitorUpdater.TAG, "notifyAppReady was not called, roll back current bundle: " + current.getId());
+            Log.i(CapacitorUpdater.TAG, "Did you forget to call 'notifyAppReady()' in your Capacitor App code?");
+            final JSObject ret = new JSObject();
+            ret.put("bundle", current.toJSON());
+            this.notifyListeners("updateFailed", ret);
+            this.implementation.sendStats("update_fail", current.getVersionName());
+            this.implementation.setError(current);
+            this._reset(true);
+            if (CapacitorUpdaterPlugin.this.autoDeleteFailed) {
+                Log.i(CapacitorUpdater.TAG, "Deleting failing bundle: " + current.getVersionName());
+                try {
+                    final Boolean res = this.implementation.delete(current.getId(), false);
+                    if (res) {
+                        Log.i(CapacitorUpdater.TAG, "Failed bundle deleted: " + current.getVersionName());
                     }
-                } else {
-                    // Nothing we can/should do by default if the 'builtin' bundle fails to call 'notifyAppReady()'.
+                } catch (final IOException e) {
+                    Log.e(CapacitorUpdater.TAG, "Failed to delete failed bundle: " + current.getVersionName(), e);
                 }
-
-            } else if (!fallback.isBuiltin()) {
-                // There is a no next bundle, and the current bundle has succeeded
-                this.implementation.commit(current);
-
-                if(this.autoDeletePrevious) {
-                    Log.i(CapacitorUpdater.TAG, "Bundle successfully loaded: " + current);
-                    try {
-                        final Boolean res = this.implementation.delete(fallback.getVersionName());
-                        if (res) {
-                            Log.i(CapacitorUpdater.TAG, "Deleted previous bundle: " + fallback.getVersionName());
-                        }
-                    } catch (final IOException e) {
-                        Log.e(CapacitorUpdater.TAG, "Failed to delete previous bundle: " + fallback.getVersionName(), e);
+            }
+        } else {
+            Log.i(CapacitorUpdater.TAG, "notifyAppReady was called. This is fine: " + current.getId());
+            if(this.autoDeletePrevious && !fallback.isBuiltin()) {
+                try {
+                    final Boolean res = this.implementation.delete(fallback.getId());
+                    if (res) {
+                        Log.i(CapacitorUpdater.TAG, "Deleted previous bundle: " + fallback.getVersionName());
                     }
+                } catch (final IOException e) {
+                    Log.e(CapacitorUpdater.TAG, "Failed to delete previous bundle: " + fallback.getVersionName(), e);
                 }
             }
         }
-        catch(final Exception e) {
-            Log.e(CapacitorUpdater.TAG, "Error during onActivityStopped", e);
-        }
     }
 
     private class DeferredNotifyAppReadyCheck implements Runnable {
@@ -687,21 +677,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
             try {
                 Log.i(CapacitorUpdater.TAG, "Wait for " + CapacitorUpdaterPlugin.this.appReadyTimeout + "ms, then check for notifyAppReady");
                 Thread.sleep(CapacitorUpdaterPlugin.this.appReadyTimeout);
-                // Automatically roll back to fallback version if notifyAppReady has not been called yet
-                final BundleInfo current = CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
-                if(current.isBuiltin()) {
-                    Log.i(CapacitorUpdater.TAG, "Built-in bundle is active. Nothing to do.");
-                    return;
-                }
-
-                if(BundleStatus.SUCCESS != current.getStatus()) {
-                    Log.e(CapacitorUpdater.TAG, "notifyAppReady was not called, roll back current bundle: " + current.getId());
-                    CapacitorUpdaterPlugin.this.implementation.rollback(current);
-                    CapacitorUpdaterPlugin.this._reset(true);
-                } else {
-                    Log.i(CapacitorUpdater.TAG, "notifyAppReady was called. This is fine: " + current.getId());
-                }
-
+                CapacitorUpdaterPlugin.this.checkRevert();
                 CapacitorUpdaterPlugin.this.appReadyCheck = null;
             } catch (final InterruptedException e) {
                 Log.e(CapacitorUpdater.TAG, DeferredNotifyAppReadyCheck.class.getName() + " was interrupted.");