@bundle-pilot/capacitor 0.2.4 → 0.3.0

package/README.md

@@ -44,8 +44,9 @@ into it.
 - **Rolls back by itself.** A bundle that never starts is rolled back by Capgo,
   and one that fails to bootstrap is reset by `startOta().failed()`. A bundle
   that rolled back is not offered again.
-- **Never slows a start.** The last answer is remembered. While it needs no
-  update, the app starts at once and asks again in the background.
+- **Updates before the app goes on.** The first navigation of a session waits
+  for the gateway (each request times out after 5 s), so an update installs right away instead of
+  at a later tap. Later navigations go on at once.
 - **Knows the native app.** The app's native version goes along with every
   question, so a bundle that needs newer native plugins never reaches an app
   that cannot run it.
@@ -133,7 +134,7 @@ navigation through. The same code therefore runs in `ng serve` and on the web.
 
 Upload `4.80.0` to the gateway, and add a rule such as
 `{ "when": { "storeID": ["2020210"] }, "bundle": "4.80.0" }`. Devices of that
-store pick it up at their next navigation, while everyone else stays put. To
+store pick it up at their next start, while everyone else stays put. To
 widen the rollout, change the rule. To back out, block the bundle in the admin
 UI.
 
@@ -220,10 +221,10 @@ built-in one. Off the native platform it does nothing.
 1. **Ask.** The first `check` for a set of facts posts them, along with the
    native app version, to `POST /__gateway/data`. This happens once per
    session, through Capacitor's native HTTP, so CORS does not apply.
-2. **Answer from memory.** The last answer is kept. While it names the running
-   bundle, or one that rolled back, `check` returns `true` at once and the
-   question runs in the background. An update it finds installs at the next
-   navigation.
+2. **Wait for the answer.** That first `check` waits for the gateway. When the
+   answer names the running bundle, or one that rolled back, it returns `true`,
+   and so does every later `check` for those facts, at once. Otherwise the
+   update installs before the navigation goes on.
 3. **Verify.** The pilot fetches `bundle.sha256` and its signature, and checks
    them with WebCrypto Ed25519. An unsigned or tampered bundle is never
    downloaded.
@@ -241,7 +242,6 @@ current bundle and is not retried until the next start.
 
 | Key | |
 |---|---|
-| `ota.decision` | the gateway's last answer, so a start never waits on it |
 | `ota.trying` | the bundle being started, to detect a rollback |
 | `ota.failed` | the last bundle that rolled back; it is not offered again |
 | `ota.manifest.<id>` | the digest of the manifest a downloaded bundle came from |

package/dist/index.d.ts

@@ -15,9 +15,9 @@ export interface OtaOptions {
  * A Pilot for native apps: asks the OTA gateway which bundle these facts get, verifies its signed
  * manifest, downloads it with Capgo and reloads into it. Off the native platform it always stays.
  *
- * One question per facts per session. While the last answer for these facts needs no update, check()
- * goes on at once and the question revalidates in the background; an update it finds installs at the
- * next navigation. A failure stays and is not retried that session.
+ * One question per facts per session. The first check() for these facts waits for the answer, so an
+ * update installs before the app goes on; once the answer needs no update, check() goes on at once.
+ * A failure stays and is not retried that session.
  */
 export declare function createOtaPilot(o: OtaOptions): Pilot;
 /**

package/dist/index.js

@@ -5,29 +5,24 @@ import { CapacitorUpdater } from '@capgo/capacitor-updater';
 import { entries, verifyManifest } from './manifest.js';
 const TIMEOUT = 5000; // per request
 const DOWNLOAD_TIMEOUT = 60_000;
-// The first three are kept from the app this code came from, so devices in the field keep their state.
+// Kept from the app this code came from, so devices in the field keep their state.
 const TRYING = 'ota.trying'; // the bundle set() is about to start
 const FAILED = 'ota.failed'; // a bundle Capgo rolled back: never offered again
 const MANIFEST = 'ota.manifest.'; // + bundle id: digest of the manifest it was downloaded with
-const DECISION = 'ota.decision'; // the gateway's last answer, { key, bundle }, so a start never waits on it
 /**
  * A Pilot for native apps: asks the OTA gateway which bundle these facts get, verifies its signed
  * manifest, downloads it with Capgo and reloads into it. Off the native platform it always stays.
  *
- * One question per facts per session. While the last answer for these facts needs no update, check()
- * goes on at once and the question revalidates in the background; an update it finds installs at the
- * next navigation. A failure stays and is not retried that session.
+ * One question per facts per session. The first check() for these facts waits for the answer, so an
+ * update installs before the app goes on; once the answer needs no update, check() goes on at once.
+ * A failure stays and is not retried that session.
  */
 export function createOtaPilot(o) {
     if (!Capacitor.isNativePlatform() || !o.gateway || !o.publicKey)
         return { version: o.version, check: () => true };
     const api = `${o.gateway.replace(/\/+$/, '')}/__gateway`;
     const stays = (v) => !v || v === o.version || v === localStorage.getItem(FAILED);
-    let last = null;
-    try {
-        last = JSON.parse(localStorage.getItem(DECISION) ?? 'null');
-    }
-    catch { }
+    let last = null; // this session's answer
     const asked = new Map();
     let installing;
     const ask = (k, facts) => App.getInfo()
@@ -43,7 +38,6 @@ export function createOtaPilot(o) {
         if (typeof v !== 'string' || !v)
             return null;
         last = { key: k, bundle: v };
-        localStorage.setItem(DECISION, JSON.stringify(last));
         return v;
     })
         .catch(() => null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bundle-pilot/capacitor",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Over-the-air updates for Capacitor apps: install the signed bundle Bundle Pilot picks, with Capgo.",
   "license": "MIT",
   "repository": {
@@ -23,7 +23,7 @@
     "dist"
   ],
   "dependencies": {
-    "@bundle-pilot/core": "0.2.4"
+    "@bundle-pilot/core": "0.3.0"
   },
   "peerDependencies": {
     "@capacitor/app": ">=8.0.0",