@capgo/capacitor-updater 8.47.8 → 8.47.10

package/README.md

@@ -633,6 +633,11 @@ The bundle must include an `index.html` file at the root level.
 For encrypted bundles, provide the `sessionKey` and `checksum` parameters.
 For multi-file delta updates, provide the `manifest` array.
 
+**Android Background Runner note:** `@capacitor/background-runner` loads its
+configured runner script from native APK assets. Live updates cannot replace
+that runner script. Keep it stable across OTA updates and ship a native app
+update when the runner code changes.
+
 | Param         | Type                                                        | Description                                                                                  |
 | ------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
 | **`options`** | <code><a href="#downloadoptions">DownloadOptions</a></code> | The {@link <a href="#downloadoptions">DownloadOptions</a>} for downloading a new bundle zip. |
@@ -1188,6 +1193,9 @@ Use this to:
 - Check if a device is on a specific channel before showing features
 - Verify channel assignment after calling {@link setChannel}
 
+On native platforms, a successful response also refreshes the locally persisted
+default channel used by update checks.
+
 **Returns:** <code>Promise&lt;<a href="#getchannelres">GetChannelRes</a>&gt;</code>
 
 **Since:** 4.8.0

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

@@ -129,7 +129,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
     static final int APPLICATION_EXIT_REASON_USER_REQUESTED = 10;
     static final int APPLICATION_EXIT_REASON_DEPENDENCY_DIED = 12;
 
-    private final String pluginVersion = "8.47.8";
+    private final String pluginVersion = "8.47.9";
     private static final String DELAY_CONDITION_PREFERENCES = "";
 
     private SharedPreferences.Editor editor;
@@ -1995,6 +1995,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
                     CapacitorUpdaterPlugin.this.editor,
                     DEFAULT_CHANNEL_PREF_KEY,
                     CapacitorUpdaterPlugin.this.allowSetDefaultChannel,
+                    CapacitorUpdaterPlugin.this.getConfig().getString("defaultChannel", ""),
                     (res) -> {
                         JSObject jsRes = InternalUtils.mapToJSObject(res);
                         if (jsRes.has("error")) {
@@ -2043,21 +2044,25 @@ public class CapacitorUpdaterPlugin extends Plugin {
         try {
             logger.info("getChannel");
             startNewThread(() ->
-                CapacitorUpdaterPlugin.this.implementation.getChannel((res) -> {
-                    JSObject jsRes = InternalUtils.mapToJSObject(res);
-                    if (jsRes.has("error")) {
-                        String errorMessage = jsRes.has("message") ? jsRes.getString("message") : jsRes.getString("error");
-                        String errorCode = jsRes.getString("error");
+                CapacitorUpdaterPlugin.this.implementation.getChannel(
+                    (res) -> {
+                        JSObject jsRes = InternalUtils.mapToJSObject(res);
+                        if (jsRes.has("error")) {
+                            String errorMessage = jsRes.has("message") ? jsRes.getString("message") : jsRes.getString("error");
+                            String errorCode = jsRes.getString("error");
 
-                        JSObject errorObj = new JSObject();
-                        errorObj.put("message", errorMessage);
-                        errorObj.put("error", errorCode);
+                            JSObject errorObj = new JSObject();
+                            errorObj.put("message", errorMessage);
+                            errorObj.put("error", errorCode);
 
-                        call.reject(errorMessage, "GETCHANNEL_FAILED", null, errorObj);
-                    } else {
-                        call.resolve(jsRes);
-                    }
-                })
+                            call.reject(errorMessage, "GETCHANNEL_FAILED", null, errorObj);
+                        } else {
+                            call.resolve(jsRes);
+                        }
+                    },
+                    CapacitorUpdaterPlugin.this.editor,
+                    DEFAULT_CHANNEL_PREF_KEY
+                )
             );
         } catch (final Exception e) {
             logger.error("Failed to getChannel " + e.getMessage());
@@ -2514,7 +2519,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
         }
 
         final BundleInfo previewFallbackBundle = this.implementation.getPreviewFallbackBundle();
-        this.endPreviewSession();
+        this.endPreviewSession(true);
         final BundleInfo restoredNextBundle = this.implementation.getNextBundle();
         this.deletePreviewBundleIfUnused(previewBundle, previewFallbackBundle, restoredNextBundle);
         return true;
@@ -2523,16 +2528,11 @@ public class CapacitorUpdaterPlugin extends Plugin {
     private boolean leavePreviewSessionForIncomingPreviewLink() {
         this.showPreviewTransitionLoader("incoming-preview-deeplink");
         final BundleInfo previewBundle = this.implementation.getCurrentBundle();
-        final BundleInfo previewFallbackBundle = this.implementation.getPreviewFallbackBundle();
+        final BundleInfo previewFallbackBundle = this.resolvePreviewFallbackBundle("incoming preview deeplink");
         boolean didReload = false;
 
         try {
-            if (previewFallbackBundle == null || previewFallbackBundle.isErrorStatus()) {
-                logger.error("No preview fallback bundle available");
-                return false;
-            }
-            if (!this.implementation.canSet(previewFallbackBundle)) {
-                logger.error("Preview fallback bundle is not installable");
+            if (previewFallbackBundle == null) {
                 return false;
             }
 
@@ -2542,7 +2542,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
                 return false;
             }
 
-            if (!this._reload()) {
+            if (!this.reloadWithoutWaitingForAppReady()) {
                 this.implementation.restoreResetState(previousState);
                 this.restoreLiveBundleStateAfterFailedReload();
                 return false;
@@ -2590,13 +2590,8 @@ public class CapacitorUpdaterPlugin extends Plugin {
 
     private boolean leavePreviewSessionWithoutReload(final boolean keepPreviewGuard) {
         final BundleInfo previewBundle = this.implementation.getCurrentBundle();
-        final BundleInfo previewFallbackBundle = this.implementation.getPreviewFallbackBundle();
-        if (previewFallbackBundle == null || previewFallbackBundle.isErrorStatus()) {
-            logger.error("No preview fallback bundle available");
-            return false;
-        }
-        if (!this.implementation.canSet(previewFallbackBundle)) {
-            logger.error("Preview fallback bundle is not installable");
+        final BundleInfo previewFallbackBundle = this.resolvePreviewFallbackBundle("preview deeplink launch");
+        if (previewFallbackBundle == null) {
             return false;
         }
         if (!this.implementation.stagePreviewFallbackReload(previewFallbackBundle)) {
@@ -2649,20 +2644,15 @@ public class CapacitorUpdaterPlugin extends Plugin {
     }
 
     private boolean resetToPreviewFallbackBundle() {
-        final BundleInfo fallback = this.implementation.getPreviewFallbackBundle();
-        if (fallback == null || fallback.isErrorStatus()) {
-            logger.error("No preview fallback bundle available");
-            return false;
-        }
-        if (!this.implementation.canSet(fallback)) {
-            logger.error("Preview fallback bundle is not installable");
+        final BundleInfo fallback = this.resolvePreviewFallbackBundle("leave preview");
+        if (fallback == null) {
             return false;
         }
 
         final CapgoUpdater.ResetState previousState = this.implementation.captureResetState();
         final String previousBundleName = this.implementation.getCurrentBundle().getVersionName();
         logger.info("Resetting to preview fallback bundle: " + fallback.getVersionName());
-        if (this.implementation.stagePreviewFallbackReload(fallback) && this._reload()) {
+        if (this.implementation.stagePreviewFallbackReload(fallback) && this.reloadWithoutWaitingForAppReady()) {
             this.implementation.finalizeResetTransition(previousBundleName, false);
             this.notifyBundleSet(fallback);
             return true;
@@ -2672,6 +2662,29 @@ public class CapacitorUpdaterPlugin extends Plugin {
         return false;
     }
 
+    private BundleInfo resolvePreviewFallbackBundle(final String reason) {
+        final BundleInfo fallback = this.implementation.getPreviewFallbackBundle();
+        if (fallback != null && !fallback.isErrorStatus() && this.implementation.canSet(fallback)) {
+            return fallback;
+        }
+
+        if (fallback == null) {
+            logger.warn("No preview fallback bundle available for " + reason + ". Falling back to builtin bundle.");
+        } else if (fallback.isErrorStatus()) {
+            logger.warn("Preview fallback bundle is in error state for " + reason + ". Falling back to builtin bundle.");
+        } else {
+            logger.warn("Preview fallback bundle is not installable for " + reason + ". Falling back to builtin bundle.");
+        }
+
+        final BundleInfo builtin = this.implementation.getBundleInfo(BundleInfo.ID_BUILTIN);
+        if (builtin != null && !builtin.isErrorStatus() && this.implementation.canSet(builtin)) {
+            return builtin;
+        }
+
+        logger.error("Builtin bundle is not available to leave preview for " + reason);
+        return null;
+    }
+
     private void endPreviewSession() {
         this.endPreviewSession(false);
     }
@@ -2706,11 +2719,8 @@ public class CapacitorUpdaterPlugin extends Plugin {
 
     private void clearPreviewSessionBecauseDisabled() {
         logger.info("Preview session disabled by config; restoring preview fallback");
-        final BundleInfo fallback = this.implementation.getPreviewFallbackBundle();
-        final BundleInfo bundleToRestore =
-            fallback == null || fallback.isErrorStatus() ? this.implementation.getBundleInfo(BundleInfo.ID_BUILTIN) : fallback;
-
-        if (this.implementation.canSet(bundleToRestore)) {
+        final BundleInfo bundleToRestore = this.resolvePreviewFallbackBundle("preview disabled");
+        if (bundleToRestore != null) {
             this.implementation.stagePreviewFallbackReload(bundleToRestore);
         } else {
             logger.warn("Could not restore preview fallback while disabling preview");

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

@@ -18,12 +18,15 @@ import androidx.work.WorkManager;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.io.BufferedInputStream;
+import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.FilenameFilter;
 import java.io.IOException;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
 import java.security.SecureRandom;
 import java.util.ArrayList;
 import java.util.Date;
@@ -63,6 +66,8 @@ public class CapgoUpdater {
     private static final String PREVIEW_FALLBACK_VERSION = "previewFallbackVersion";
     private static final String bundleDirectory = "versions";
     private static final String TEMP_UNZIP_PREFIX = "capgo_unzip_";
+    private static final String CAPACITOR_CONFIG_ASSET = "capacitor.config.json";
+    private static final String BACKGROUND_RUNNER_CONFIG_KEY = "BackgroundRunner";
 
     public static final String TAG = "Capacitor-updater";
     public SharedPreferences.Editor editor;
@@ -920,6 +925,7 @@ public class CapgoUpdater {
     }
 
     private void setCurrentBundle(final File bundle) {
+        this.cancelBackgroundRunnerWorkBeforeBundleSwitch();
         this.editor.putString(this.CAP_SERVER_PATH, bundle.getPath());
         logger.info("Current bundle set to: " + bundle);
         this.editor.commit();
@@ -929,6 +935,73 @@ public class CapgoUpdater {
         return bundlePath != null && !bundlePath.trim().isEmpty() && !isBuiltin && !hasStoredBundleInfo;
     }
 
+    static String getBackgroundRunnerLabelFromConfig(final String configJson) {
+        if (configJson == null || configJson.trim().isEmpty()) {
+            return null;
+        }
+
+        try {
+            final JSONObject config = new JSONObject(configJson);
+            final JSONObject plugins = config.optJSONObject("plugins");
+            if (plugins == null) {
+                return null;
+            }
+
+            final JSONObject backgroundRunner = plugins.optJSONObject(BACKGROUND_RUNNER_CONFIG_KEY);
+            if (backgroundRunner == null) {
+                return null;
+            }
+
+            final String label = backgroundRunner.optString("label", "").trim();
+            return label.isEmpty() ? null : label;
+        } catch (JSONException ignored) {
+            return null;
+        }
+    }
+
+    private String readAssetAsString(final String assetPath) throws IOException {
+        final StringBuilder buffer = new StringBuilder();
+        try (
+            final BufferedReader reader = new BufferedReader(
+                new InputStreamReader(this.activity.getAssets().open(assetPath), StandardCharsets.UTF_8)
+            )
+        ) {
+            String line;
+            while ((line = reader.readLine()) != null) {
+                buffer.append(line).append('\n');
+            }
+        }
+        return buffer.toString();
+    }
+
+    private void cancelBackgroundRunnerWorkBeforeBundleSwitch() {
+        if (this.activity == null) {
+            return;
+        }
+
+        final String label;
+        try {
+            label = getBackgroundRunnerLabelFromConfig(this.readAssetAsString(CAPACITOR_CONFIG_ASSET));
+        } catch (IOException ignored) {
+            return;
+        }
+
+        if (label == null) {
+            return;
+        }
+
+        try {
+            final WorkManager workManager = WorkManager.getInstance(this.activity.getApplicationContext());
+            workManager.cancelUniqueWork(label);
+            workManager.cancelAllWorkByTag(label);
+            logger.info("Cancelled Background Runner work before bundle switch.");
+            logger.debug("Background Runner label: " + label);
+        } catch (Exception e) {
+            logger.warn("Failed to cancel Background Runner work before bundle switch.");
+            logger.debug("Background Runner cancellation error: " + e.getMessage());
+        }
+    }
+
     private boolean hasStoredBundleInfo(final String id) {
         return (
             id != null &&
@@ -1614,6 +1687,17 @@ public class CapgoUpdater {
         final String defaultChannelKey,
         final boolean allowSetDefaultChannel,
         final Callback callback
+    ) {
+        this.setChannel(channel, editor, defaultChannelKey, allowSetDefaultChannel, "", callback);
+    }
+
+    public void setChannel(
+        final String channel,
+        final SharedPreferences.Editor editor,
+        final String defaultChannelKey,
+        final boolean allowSetDefaultChannel,
+        final String configDefaultChannel,
+        final Callback callback
     ) {
         // Check if setting defaultChannel is allowed
         if (!allowSetDefaultChannel) {
@@ -1666,6 +1750,7 @@ public class CapgoUpdater {
                 // Clear persisted defaultChannel and revert to config value
                 editor.remove(defaultChannelKey);
                 editor.apply();
+                this.defaultChannel = configDefaultChannel;
                 logger.info("Public channel requested, channel override removed");
                 callback.callback(res);
             } else {
@@ -1680,6 +1765,10 @@ public class CapgoUpdater {
     }
 
     public void getChannel(final Callback callback) {
+        this.getChannel(callback, null, null);
+    }
+
+    public void getChannel(final Callback callback, final SharedPreferences.Editor editor, final String defaultChannelKey) {
         // Check if rate limit was exceeded
         if (rateLimitExceeded) {
             logger.debug("Skipping getChannel due to rate limit (429). Requests will resume after app restart.");
@@ -1798,6 +1887,7 @@ public class CapgoUpdater {
                                 ret.put(key, jsonResponse.get(key));
                             }
                         }
+                        persistDefaultChannelFromResponse(ret.get("channel"), editor, defaultChannelKey);
                         logger.info("Channel get to \"" + ret);
                         callback.callback(ret);
                     } catch (JSONException e) {
@@ -1811,6 +1901,24 @@ public class CapgoUpdater {
         );
     }
 
+    void persistDefaultChannelFromResponse(final Object channel, final SharedPreferences.Editor editor, final String defaultChannelKey) {
+        if (!(channel instanceof String)) {
+            return;
+        }
+
+        final String channelName = ((String) channel).trim();
+        if (channelName.isEmpty() || BundleInfo.ID_BUILTIN.equals(channelName)) {
+            return;
+        }
+
+        this.defaultChannel = channelName;
+        if (editor != null && defaultChannelKey != null && !defaultChannelKey.isEmpty()) {
+            editor.putString(defaultChannelKey, channelName);
+            editor.apply();
+        }
+        logger.info("defaultChannel synchronized from getChannel(): " + channelName);
+    }
+
     public void listChannels(final Callback callback) {
         // Check if rate limit was exceeded
         if (rateLimitExceeded) {

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

@@ -17,8 +17,8 @@ public class ShakeDetector implements SensorEventListener {
         void onShakeDetected();
     }
 
-    private static final float SHAKE_THRESHOLD = 12.0f; // Acceleration threshold for shake detection
-    private static final int SHAKE_TIMEOUT = 500; // Minimum time between shake events (ms)
+    private static final float SHAKE_THRESHOLD = 16.0f; // Acceleration threshold for shake detection
+    private static final int SHAKE_TIMEOUT = 1000; // Minimum time between shake events (ms)
 
     private Listener listener;
     private SensorManager sensorManager;
@@ -34,7 +34,7 @@ public class ShakeDetector implements SensorEventListener {
         this.accelerometer = sensorManager.getDefaultSensor(Sensor.TYPE_ACCELEROMETER);
 
         if (accelerometer != null) {
-            sensorManager.registerListener(this, accelerometer, SensorManager.SENSOR_DELAY_GAME);
+            sensorManager.registerListener(this, accelerometer, SensorManager.SENSOR_DELAY_UI);
         }
     }
 

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

@@ -542,6 +542,7 @@ public class ShakeMenu implements ShakeDetector.Listener {
                 new Thread(() -> {
                     final CapgoUpdater updater = plugin.implementation;
                     final Bridge bridge = activity.getBridge();
+                    final String configDefaultChannel = plugin.getConfig().getString("defaultChannel", "");
 
                     // Set the channel - respect plugin's allowSetDefaultChannel config
                     updater.setChannel(
@@ -549,6 +550,7 @@ public class ShakeMenu implements ShakeDetector.Listener {
                         updater.editor,
                         "CapacitorUpdater.defaultChannel",
                         plugin.allowSetDefaultChannel,
+                        configDefaultChannel,
                         (setRes) -> {
                             if (setRes == null) {
                                 activity.runOnUiThread(() -> {

package/dist/docs.json

@@ -156,7 +156,7 @@
             "text": "{Error} If the download fails or the bundle is invalid."
           }
         ],
-        "docs": "Download a new bundle from the provided URL for later installation.\n\nThe downloaded bundle is stored locally but not activated. To use it:\n- Call {@link next} to set it for installation on next app backgrounding/restart\n- Call {@link set} to activate it immediately (destroys current JavaScript context)\n\nThe URL should point to a zip file containing either:\n- Your app files directly in the zip root, or\n- A single folder containing all your app files\n\nThe bundle must include an `index.html` file at the root level.\n\nFor encrypted bundles, provide the `sessionKey` and `checksum` parameters.\nFor multi-file delta updates, provide the `manifest` array.",
+        "docs": "Download a new bundle from the provided URL for later installation.\n\nThe downloaded bundle is stored locally but not activated. To use it:\n- Call {@link next} to set it for installation on next app backgrounding/restart\n- Call {@link set} to activate it immediately (destroys current JavaScript context)\n\nThe URL should point to a zip file containing either:\n- Your app files directly in the zip root, or\n- A single folder containing all your app files\n\nThe bundle must include an `index.html` file at the root level.\n\nFor encrypted bundles, provide the `sessionKey` and `checksum` parameters.\nFor multi-file delta updates, provide the `manifest` array.\n\n**Android Background Runner note:** `@capacitor/background-runner` loads its\nconfigured runner script from native APK assets. Live updates cannot replace\nthat runner script. Keep it stable across OTA updates and ship a native app\nupdate when the runner code changes.",
         "complexTypes": [
           "BundleInfo",
           "DownloadOptions"
@@ -720,7 +720,7 @@
             "text": "4.8.0"
           }
         ],
-        "docs": "Get the current channel assigned to this device.\n\nReturns information about:\n- `channel`: The currently assigned channel name (if any)\n- `allowSet`: Whether the channel allows self-assignment\n- `status`: Operation status\n- `error`/`message`: Additional information (if applicable)\n\nUse this to:\n- Display current channel to users (e.g., \"You're on the Beta channel\")\n- Check if a device is on a specific channel before showing features\n- Verify channel assignment after calling {@link setChannel}",
+        "docs": "Get the current channel assigned to this device.\n\nReturns information about:\n- `channel`: The currently assigned channel name (if any)\n- `allowSet`: Whether the channel allows self-assignment\n- `status`: Operation status\n- `error`/`message`: Additional information (if applicable)\n\nUse this to:\n- Display current channel to users (e.g., \"You're on the Beta channel\")\n- Check if a device is on a specific channel before showing features\n- Verify channel assignment after calling {@link setChannel}\n\nOn native platforms, a successful response also refreshes the locally persisted\ndefault channel used by update checks.",
         "complexTypes": [
           "GetChannelRes"
         ],

package/dist/esm/definitions.d.ts

@@ -467,6 +467,11 @@ export interface CapacitorUpdaterPlugin {
      * For encrypted bundles, provide the `sessionKey` and `checksum` parameters.
      * For multi-file delta updates, provide the `manifest` array.
      *
+     * **Android Background Runner note:** `@capacitor/background-runner` loads its
+     * configured runner script from native APK assets. Live updates cannot replace
+     * that runner script. Keep it stable across OTA updates and ship a native app
+     * update when the runner code changes.
+     *
      * @example
      * const bundle = await CapacitorUpdater.download({
      *   url: `https://example.com/versions/${version}/dist.zip`,
@@ -909,6 +914,9 @@ export interface CapacitorUpdaterPlugin {
      * - Check if a device is on a specific channel before showing features
      * - Verify channel assignment after calling {@link setChannel}
      *
+     * On native platforms, a successful response also refreshes the locally persisted
+     * default channel used by update checks.
+     *
      * @returns {Promise<GetChannelRes>} The current channel information.
      * @throws {Error} If the operation fails.
      * @since 4.8.0