@scalebun/react-native 1.11.0 → 1.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/android/src/main/java/com/scalebun/replaysdk/tracking/InteractionTracker.kt +0 -1
- package/android/src/main/java/com/scalebun/rn/ota/SlotManager.kt +15 -3
- package/dist/scalebun.full.js +232 -69
- package/dist/scalebun.slim.js +232 -69
- package/ios/Ota/OtaSlotManager.swift +19 -5
- package/lib/commonjs/core/constants/version.js +1 -1
- package/lib/commonjs/features/ota/OtaOrchestrator.js +174 -48
- package/lib/commonjs/features/ota/OtaTypes.js +4 -0
- package/lib/commonjs/features/ota/useOtaUpdate.js +11 -2
- package/lib/commonjs/public/ScaleBunFacade.js +115 -2
- package/lib/module/core/constants/version.js +1 -1
- package/lib/module/features/ota/OtaOrchestrator.js +174 -48
- package/lib/module/features/ota/OtaTypes.js +1 -1
- package/lib/module/features/ota/useOtaUpdate.js +11 -2
- package/lib/module/public/ScaleBunFacade.js +115 -2
- package/lib/typescript/core/constants/version.d.ts +1 -1
- package/lib/typescript/features/ota/OtaEventEmitter.d.ts +15 -1
- package/lib/typescript/features/ota/OtaOrchestrator.d.ts +22 -3
- package/lib/typescript/features/ota/OtaTypes.d.ts +29 -32
- package/lib/typescript/public/ScaleBunFacade.d.ts +27 -0
- package/package.json +2 -2
- package/src/core/constants/version.ts +1 -1
- package/src/features/ota/OtaEventEmitter.ts +12 -0
- package/src/features/ota/OtaOrchestrator.ts +209 -62
- package/src/features/ota/OtaTypes.ts +37 -39
- package/src/features/ota/useOtaUpdate.ts +11 -2
- package/src/public/ScaleBunFacade.ts +127 -3
|
@@ -90,6 +90,11 @@ async function deliverOtaEvents(params) {
|
|
|
90
90
|
kind: 'ota_event',
|
|
91
91
|
type: e.type,
|
|
92
92
|
bundleId: e.bundleId,
|
|
93
|
+
// Without this the backend stored a null releaseId on every row it ingested,
|
|
94
|
+
// while serving the release id on every check — so the delivery funnel could
|
|
95
|
+
// only ever be grouped by bundle, and a bundle re-promoted under a second
|
|
96
|
+
// release merged the two into one indistinguishable series.
|
|
97
|
+
releaseId: e.releaseId,
|
|
93
98
|
installationId: params.installationId,
|
|
94
99
|
// OTA bundles are compiled per platform, so this genuinely is ios|android. Narrowed via
|
|
95
100
|
// resolveMobileOS so a non-mobile RN target is skipped rather than served an Android bundle.
|
|
@@ -127,7 +132,6 @@ async function deliverOtaEvents(params) {
|
|
|
127
132
|
/** Boot-guard configuration */
|
|
128
133
|
|
|
129
134
|
const DEFAULT_HEALTHY_AFTER_MS = 10_000;
|
|
130
|
-
const DEFAULT_MAX_REVERT_ATTEMPTS = 2;
|
|
131
135
|
class OtaOrchestrator {
|
|
132
136
|
enabled = false;
|
|
133
137
|
currentBundle = null;
|
|
@@ -204,22 +208,35 @@ class OtaOrchestrator {
|
|
|
204
208
|
this.signatureConfig = config?.signature;
|
|
205
209
|
__DEV__ && _internalLogger.logger.debug(`[OTA] Orchestrator initialized (RN ${this.environment.rnVersionString ?? 'unknown'}` + `${this.environment.bridgeless ? ', bridgeless' : ''}` + `${this.environment.hermes ? `, Hermes HBC v${this.environment.hermesBytecodeVersion ?? '?'}` : ''})`);
|
|
206
210
|
|
|
211
|
+
// ONE read of the slot state, shared by both boot-time consumers.
|
|
212
|
+
//
|
|
213
|
+
// `getSlotState()` is CONSUME-ON-READ for the revert record: both native
|
|
214
|
+
// implementations delete it as they serialise, so that a rollback is
|
|
215
|
+
// reported exactly once instead of on every launch forever. Calling it
|
|
216
|
+
// twice therefore means the second caller never sees the revert — which is
|
|
217
|
+
// precisely what happened, since hydration ran first and swallowed it. It
|
|
218
|
+
// is also a blocking synchronous bridge call, so one read is cheaper.
|
|
219
|
+
const slotState = this.readSlotState();
|
|
220
|
+
|
|
207
221
|
// Rehydrate which bundle we are running from the native slot state.
|
|
208
222
|
// Without this `currentBundle` stays null for the whole process after a
|
|
209
223
|
// restart, so every check reported no current bundle and the backend had
|
|
210
224
|
// no way to know what the device was actually on.
|
|
211
|
-
this.hydrateCurrentBundleFromSlots();
|
|
225
|
+
this.hydrateCurrentBundleFromSlots(slotState);
|
|
212
226
|
|
|
213
227
|
// Warm the device-country cache (edge Worker lookup) so checks can carry
|
|
214
228
|
// a country when the API itself sits behind no geo-stamping CDN.
|
|
215
229
|
// Fire-and-forget and failure-soft — a check without a country is valid.
|
|
216
230
|
void (0, _geoCountry.prefetchDeviceCountry)();
|
|
217
231
|
|
|
232
|
+
// Check if the boot guard fired on this launch (native reverted before JS
|
|
233
|
+
// loaded). BEFORE the identity check, because both read the install record
|
|
234
|
+
// and the identity check retires it — a revert must get its chance to name
|
|
235
|
+
// the bundle that failed while the record still describes it.
|
|
236
|
+
this.checkBootGuardRecovery(slotState);
|
|
237
|
+
|
|
218
238
|
// Prove the bundle we installed is the bundle that loaded.
|
|
219
239
|
this.verifyRunningBundleIdentity();
|
|
220
|
-
|
|
221
|
-
// Check if the boot guard fired on this launch (native reverted before JS loaded)
|
|
222
|
-
this.checkBootGuardRecovery();
|
|
223
240
|
});
|
|
224
241
|
}
|
|
225
242
|
|
|
@@ -227,10 +244,20 @@ class OtaOrchestrator {
|
|
|
227
244
|
* Read the active slot back into `currentBundle` so the next check reports
|
|
228
245
|
* what this device is genuinely running.
|
|
229
246
|
*/
|
|
230
|
-
|
|
231
|
-
|
|
247
|
+
/**
|
|
248
|
+
* Parse the native slot state once. Returns null when the module is absent or
|
|
249
|
+
* the payload is unreadable — every caller treats that as "factory bundle".
|
|
250
|
+
*/
|
|
251
|
+
readSlotState() {
|
|
252
|
+
if (!_NativeScaleBunOta.default) return null;
|
|
253
|
+
try {
|
|
254
|
+
return JSON.parse(_NativeScaleBunOta.default.getSlotState());
|
|
255
|
+
} catch {
|
|
256
|
+
return null;
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
hydrateCurrentBundleFromSlots(state) {
|
|
232
260
|
try {
|
|
233
|
-
const state = JSON.parse(_NativeScaleBunOta.default.getSlotState());
|
|
234
261
|
const current = state?.current;
|
|
235
262
|
if (!current?.sha256) return;
|
|
236
263
|
|
|
@@ -245,6 +272,7 @@ class OtaOrchestrator {
|
|
|
245
272
|
this.currentBundle = {
|
|
246
273
|
id: record.bundleId,
|
|
247
274
|
version: record.version,
|
|
275
|
+
releaseId: record.releaseId ?? undefined,
|
|
248
276
|
sha256: record.sha256
|
|
249
277
|
};
|
|
250
278
|
__DEV__ && _internalLogger.logger.debug(`[OTA] Running bundle v${record.version} (${record.bundleId})`);
|
|
@@ -281,37 +309,42 @@ class OtaOrchestrator {
|
|
|
281
309
|
verifyRunningBundleIdentity() {
|
|
282
310
|
if (!this.currentBundle) return;
|
|
283
311
|
const running = readRunningBundleMarker();
|
|
284
|
-
const
|
|
312
|
+
const record = this.readInstallRecord();
|
|
313
|
+
|
|
314
|
+
// No record at all — installed by an SDK that predates install records, or
|
|
315
|
+
// local storage was cleared. NOTHING can be concluded here and nothing is
|
|
316
|
+
// reported: the marker is a random per-publish token, never the bundle id,
|
|
317
|
+
// so comparing the two would flag a false mismatch on every healthy launch.
|
|
318
|
+
if (!record) return;
|
|
285
319
|
|
|
286
|
-
//
|
|
287
|
-
|
|
320
|
+
// The record describes a bundle that is no longer the active one (a revert,
|
|
321
|
+
// or a bundle staged by another path). It cannot verify this launch, and
|
|
322
|
+
// keeping it would make the next launch mis-report what is running.
|
|
323
|
+
if (record.sha256 !== this.currentBundle.sha256) {
|
|
288
324
|
this.clearInstallExpectation();
|
|
289
325
|
return;
|
|
290
326
|
}
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
// Deliberately NOT cleared: the condition is still true on the next boot
|
|
303
|
-
// and should keep reporting until the integration is fixed. Clearing here
|
|
304
|
-
// would make a permanently broken install look like a one-off.
|
|
327
|
+
|
|
328
|
+
// Already proven on an earlier launch. The token is retired once verified
|
|
329
|
+
// while the REST of the record stays — it is also the sha256 -> bundleId map
|
|
330
|
+
// that `hydrateCurrentBundleFromSlots` reads to report what this device is
|
|
331
|
+
// running. Wiping the whole record here is what made every launch after the
|
|
332
|
+
// first send `currentBundleId: undefined`, which the server reads as "not on
|
|
333
|
+
// this bundle" and answers by serving the same bundle again, forever.
|
|
334
|
+
if (!record.identityToken) return;
|
|
335
|
+
if (running === record.identityToken) {
|
|
336
|
+
__DEV__ && _internalLogger.logger.debug('[OTA] Install verified — running bundle matches what was installed.');
|
|
337
|
+
this.retireIdentityToken(record);
|
|
305
338
|
return;
|
|
306
339
|
}
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
340
|
+
_internalLogger.logger.error(`[OTA] INSTALL DID NOT TAKE EFFECT — bundle ${this.currentBundle.id} was installed and ` + `carries a known identity marker, but the running bundle reports ` + `${running ?? 'no marker at all'}. The app is executing different code than the slot ` + 'manager believes. Check that the host app resolves the OTA bundle path at launch ' + '(see the ScaleBunOta integration for your React Native version).');
|
|
341
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('APPLY_FAILED', this.currentBundle.id, {
|
|
342
|
+
releaseId: this.currentBundle.releaseId,
|
|
343
|
+
error: `install_not_effective — expected ${record.identityToken}, running ${running ?? 'none'}`
|
|
344
|
+
});
|
|
345
|
+
// Deliberately NOT retired: the condition is still true on the next boot and
|
|
346
|
+
// should keep reporting until the integration is fixed. Retiring the token
|
|
347
|
+
// here would make a permanently broken install look like a one-off.
|
|
315
348
|
}
|
|
316
349
|
|
|
317
350
|
// ── Install expectation ────────────────────────────────────────────────────
|
|
@@ -325,6 +358,11 @@ class OtaOrchestrator {
|
|
|
325
358
|
this.storage().set(OtaOrchestrator.INSTALL_EXPECTATION_KEY, JSON.stringify({
|
|
326
359
|
bundleId: bundle.id,
|
|
327
360
|
version: bundle.version,
|
|
361
|
+
// Carried so telemetry emitted on a LATER launch (a boot-guard
|
|
362
|
+
// rollback, an ineffective install) can still be attributed to the
|
|
363
|
+
// release, not merely the bundle. The check response is long gone by
|
|
364
|
+
// then; this record is the only thing that remembers.
|
|
365
|
+
releaseId: bundle.releaseId ?? null,
|
|
328
366
|
// The join key back to the native slot, which records sha256 and
|
|
329
367
|
// nothing else identifying.
|
|
330
368
|
sha256: bundle.sha256,
|
|
@@ -344,12 +382,28 @@ class OtaOrchestrator {
|
|
|
344
382
|
return null;
|
|
345
383
|
}
|
|
346
384
|
}
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Drop the identity token once the install has been proven, keeping the rest
|
|
388
|
+
* of the record.
|
|
389
|
+
*
|
|
390
|
+
* The record does two jobs: it proves an install took effect (once), and it
|
|
391
|
+
* maps the native slot's sha256 back to a bundle id (for the life of that
|
|
392
|
+
* bundle). Only the first job is finished after a successful verification, so
|
|
393
|
+
* only the token is retired.
|
|
394
|
+
*/
|
|
395
|
+
retireIdentityToken(record) {
|
|
396
|
+
try {
|
|
397
|
+
this.storage().set(OtaOrchestrator.INSTALL_EXPECTATION_KEY, JSON.stringify({
|
|
398
|
+
bundleId: record.bundleId,
|
|
399
|
+
version: record.version,
|
|
400
|
+
releaseId: record.releaseId ?? null,
|
|
401
|
+
sha256: record.sha256,
|
|
402
|
+
identityToken: null
|
|
403
|
+
}));
|
|
404
|
+
} catch {
|
|
405
|
+
/* non-fatal */
|
|
406
|
+
}
|
|
353
407
|
}
|
|
354
408
|
clearInstallExpectation() {
|
|
355
409
|
try {
|
|
@@ -368,17 +422,43 @@ class OtaOrchestrator {
|
|
|
368
422
|
* If getSlotState() shows bootMarkerPresent=false but we have a 'previous' slot
|
|
369
423
|
* and no 'current' OTA bundle, the native layer already reverted.
|
|
370
424
|
*/
|
|
371
|
-
checkBootGuardRecovery() {
|
|
372
|
-
if (!_NativeScaleBunOta.default) return;
|
|
425
|
+
checkBootGuardRecovery(state) {
|
|
373
426
|
try {
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
427
|
+
if (!state?.bootGuardReverted) return;
|
|
428
|
+
|
|
429
|
+
// WHICH bundle was rolled back, and it has to come from the install
|
|
430
|
+
// record. The obvious source — `state.previous` — is wrong twice over:
|
|
431
|
+
// slot meta.json carries only `{sha256, installedAt}` so it has no bundle
|
|
432
|
+
// id to read, and `revert()` deletes the previous slot as its last step,
|
|
433
|
+
// so by the time this runs there is no previous meta at all. The event
|
|
434
|
+
// therefore reported `bundleId: 'unknown'` on every rollback, and the
|
|
435
|
+
// backend drops any ota_event whose bundleId does not resolve to a bundle
|
|
436
|
+
// the app owns — so the crash-guard's own rollback signal never arrived.
|
|
437
|
+
//
|
|
438
|
+
// Native now stamps the sha256 of the bundle it reverted AWAY FROM into
|
|
439
|
+
// the revert record; the install record maps that back to a bundle id.
|
|
440
|
+
const record = this.readInstallRecord();
|
|
441
|
+
const revertedSha = state.bootGuardRevertedSha256;
|
|
442
|
+
const matchesRecord = !!record && (!revertedSha || record.sha256 === revertedSha);
|
|
443
|
+
|
|
444
|
+
// Report the reason native actually determined — a hash mismatch and a
|
|
445
|
+
// crash loop are different incidents and were being collapsed into one.
|
|
446
|
+
const reason = state.bootGuardRevertReason || 'boot_crash_guard';
|
|
447
|
+
if (matchesRecord && record) {
|
|
448
|
+
_internalLogger.logger.warn(`[OTA] Boot guard fired — reverted away from bundle ${record.bundleId} ` + `(v${record.version}); reason: ${reason}`);
|
|
449
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('AUTO_ROLLBACK', record.bundleId, {
|
|
450
|
+
releaseId: record.releaseId ?? undefined,
|
|
451
|
+
version: record.version,
|
|
452
|
+
reason
|
|
380
453
|
});
|
|
454
|
+
// The record describes a bundle this device is no longer running.
|
|
455
|
+
this.clearInstallExpectation();
|
|
456
|
+
return;
|
|
381
457
|
}
|
|
458
|
+
|
|
459
|
+
// No usable record (older SDK, cleared storage). Say so rather than
|
|
460
|
+
// emitting an event the server is obliged to discard.
|
|
461
|
+
_internalLogger.logger.warn(`[OTA] Boot guard fired (reason: ${reason}) but the rolled-back bundle could not be ` + 'identified locally — no install record. The rollback is not reported to the server.');
|
|
382
462
|
} catch {
|
|
383
463
|
// Slot state parsing failed — non-fatal
|
|
384
464
|
}
|
|
@@ -479,6 +559,22 @@ class OtaOrchestrator {
|
|
|
479
559
|
};
|
|
480
560
|
}
|
|
481
561
|
__DEV__ && _internalLogger.logger.debug('[OTA] Sync started…');
|
|
562
|
+
|
|
563
|
+
// The funnel's denominator, for devices already on an OTA bundle. Emitted
|
|
564
|
+
// before the request, so a check that fails outright still counts as a
|
|
565
|
+
// check — the only CHECK rows before this came from a server-side geo
|
|
566
|
+
// side-effect that is skipped whenever the request carries no country.
|
|
567
|
+
//
|
|
568
|
+
// Only when a current bundle is known: every ota_event must name a bundle
|
|
569
|
+
// the app owns or the server drops it, and a device still on the binary's
|
|
570
|
+
// factory bundle has no such id to give. Those devices are counted
|
|
571
|
+
// server-side when they are offered something.
|
|
572
|
+
if (this.currentBundle?.id) {
|
|
573
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('CHECK', this.currentBundle.id, {
|
|
574
|
+
releaseId: this.currentBundle.releaseId,
|
|
575
|
+
version: this.currentBundle.version
|
|
576
|
+
});
|
|
577
|
+
}
|
|
482
578
|
const checkRes = await this.checkForUpdate(params);
|
|
483
579
|
if (checkRes.action === 'NONE') {
|
|
484
580
|
__DEV__ && _internalLogger.logger.debug('[OTA] App is up to date');
|
|
@@ -492,7 +588,9 @@ class OtaOrchestrator {
|
|
|
492
588
|
// Handle server-initiated rollback (Sprint 4)
|
|
493
589
|
if (checkRes.action === 'ROLLBACK') {
|
|
494
590
|
_internalLogger.logger.warn('[OTA] Server requested ROLLBACK — reverting to previous bundle');
|
|
495
|
-
_OtaEventEmitter.otaEventEmitter.emitSimple('MANUAL_ROLLBACK', this.currentBundle?.id ?? 'unknown'
|
|
591
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('MANUAL_ROLLBACK', this.currentBundle?.id ?? 'unknown', {
|
|
592
|
+
releaseId: this.currentBundle?.releaseId
|
|
593
|
+
});
|
|
496
594
|
const reverted = await _NativeScaleBunOta.default.revertToPrevious();
|
|
497
595
|
if (reverted) {
|
|
498
596
|
this.currentBundle = null;
|
|
@@ -517,6 +615,15 @@ class OtaOrchestrator {
|
|
|
517
615
|
const bundle = checkRes.bundle;
|
|
518
616
|
let patchUsed = false;
|
|
519
617
|
|
|
618
|
+
// The offer itself. Everything downstream (download, install, activation)
|
|
619
|
+
// is a conversion against this, so without it the top of the funnel was
|
|
620
|
+
// unmeasurable and a rollout that never reached devices looked identical
|
|
621
|
+
// to one whose devices all declined to download.
|
|
622
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('OFFERED', bundle.id, {
|
|
623
|
+
releaseId: bundle.releaseId,
|
|
624
|
+
version: bundle.version
|
|
625
|
+
});
|
|
626
|
+
|
|
520
627
|
// ── VERIFY AUTHENTICITY (OTA-03) ─────────────────────────────────────
|
|
521
628
|
// Before anything touches the disk. SHA-256 proves the bytes arrived
|
|
522
629
|
// intact; only the signature proves they came from you. Checking after
|
|
@@ -524,6 +631,7 @@ class OtaOrchestrator {
|
|
|
524
631
|
const signatureOutcome = await (0, _signature.verifyBundleSignature)(bundle.sha256, bundle.signature, this.signatureConfig);
|
|
525
632
|
if (!signatureOutcome.ok) {
|
|
526
633
|
_OtaEventEmitter.otaEventEmitter.emitSimple('APPLY_FAILED', bundle.id, {
|
|
634
|
+
releaseId: bundle.releaseId,
|
|
527
635
|
error: `Signature check failed: ${signatureOutcome.reason}`,
|
|
528
636
|
version: bundle.version
|
|
529
637
|
});
|
|
@@ -536,6 +644,7 @@ class OtaOrchestrator {
|
|
|
536
644
|
|
|
537
645
|
// ── DOWNLOAD ─────────────────────────────────────────────────────────
|
|
538
646
|
_OtaEventEmitter.otaEventEmitter.emitSimple('DOWNLOAD_STARTED', bundle.id, {
|
|
647
|
+
releaseId: bundle.releaseId,
|
|
539
648
|
version: bundle.version
|
|
540
649
|
});
|
|
541
650
|
const downloadStart = Date.now();
|
|
@@ -634,6 +743,7 @@ class OtaOrchestrator {
|
|
|
634
743
|
postProgress(0, 'FAILED');
|
|
635
744
|
_internalLogger.logger.error('[OTA] Staging bundle failed after retries');
|
|
636
745
|
_OtaEventEmitter.otaEventEmitter.emitSimple('APPLY_FAILED', bundle.id, {
|
|
746
|
+
releaseId: bundle.releaseId,
|
|
637
747
|
error: 'Staging failed — SHA-256 mismatch or download error',
|
|
638
748
|
version: bundle.version
|
|
639
749
|
});
|
|
@@ -646,6 +756,7 @@ class OtaOrchestrator {
|
|
|
646
756
|
postProgress(bundle.size, 'COMPLETED');
|
|
647
757
|
const downloadDuration = Date.now() - downloadStart;
|
|
648
758
|
_OtaEventEmitter.otaEventEmitter.emitSimple('DOWNLOAD_COMPLETE', bundle.id, {
|
|
759
|
+
releaseId: bundle.releaseId,
|
|
649
760
|
version: bundle.version,
|
|
650
761
|
durationMs: downloadDuration,
|
|
651
762
|
patchUsed
|
|
@@ -657,6 +768,7 @@ class OtaOrchestrator {
|
|
|
657
768
|
if (!applied) {
|
|
658
769
|
_internalLogger.logger.error('[OTA] Applying update failed');
|
|
659
770
|
_OtaEventEmitter.otaEventEmitter.emitSimple('APPLY_FAILED', bundle.id, {
|
|
771
|
+
releaseId: bundle.releaseId,
|
|
660
772
|
error: 'Atomic slot swap failed',
|
|
661
773
|
version: bundle.version
|
|
662
774
|
});
|
|
@@ -680,6 +792,7 @@ class OtaOrchestrator {
|
|
|
680
792
|
// it is skipped when there is no marker to compare.
|
|
681
793
|
this.recordInstallExpectation(bundle);
|
|
682
794
|
_OtaEventEmitter.otaEventEmitter.emitSimple('INSTALLED', bundle.id, {
|
|
795
|
+
releaseId: bundle.releaseId,
|
|
683
796
|
version: bundle.version
|
|
684
797
|
});
|
|
685
798
|
__DEV__ && _internalLogger.logger.debug(`[OTA] Update v${bundle.version} installed successfully!`);
|
|
@@ -752,6 +865,19 @@ class OtaOrchestrator {
|
|
|
752
865
|
_NativeScaleBunOta.default?.markHealthy();
|
|
753
866
|
__DEV__ && _internalLogger.logger.info('[OTA] Boot guard cleared — bundle marked healthy ✓');
|
|
754
867
|
this.healthyTimer = null;
|
|
868
|
+
|
|
869
|
+
// The honest activation signal. INSTALLED is emitted optimistically,
|
|
870
|
+
// BEFORE the bundle has ever executed, so counting it as adoption
|
|
871
|
+
// credits bundles that were installed and then crash-reverted. This
|
|
872
|
+
// fires only once the bundle has actually booted and survived.
|
|
873
|
+
const running = this.currentBundle;
|
|
874
|
+
if (running?.id) {
|
|
875
|
+
_OtaEventEmitter.otaEventEmitter.emitSimple('BOOT_SUCCESS', running.id, {
|
|
876
|
+
releaseId: running.releaseId,
|
|
877
|
+
version: running.version,
|
|
878
|
+
durationMs: healthyMs
|
|
879
|
+
});
|
|
880
|
+
}
|
|
755
881
|
});
|
|
756
882
|
}, healthyMs);
|
|
757
883
|
} catch {
|
|
@@ -66,7 +66,13 @@ function useOtaUpdate(options) {
|
|
|
66
66
|
setIsSyncing(true);
|
|
67
67
|
setDownloadProgress(0);
|
|
68
68
|
try {
|
|
69
|
-
|
|
69
|
+
// Read through the ref, not the closed-over `options`. The dependency list
|
|
70
|
+
// below cannot name the targeting fields (`attributes` and `segmentIds` are
|
|
71
|
+
// fresh object/array identities on every render, so listing them would
|
|
72
|
+
// rebuild this callback each time), which left a host that changed
|
|
73
|
+
// `channelName` or `lifecycleStage` syncing against the values captured on
|
|
74
|
+
// first render. The ref is assigned on every render, so it is always current.
|
|
75
|
+
const result = await _OtaOrchestrator.otaOrchestrator.sync(optionsRef.current);
|
|
70
76
|
setSyncResult(result);
|
|
71
77
|
|
|
72
78
|
// Handle mandatory update blocking
|
|
@@ -77,7 +83,10 @@ function useOtaUpdate(options) {
|
|
|
77
83
|
} finally {
|
|
78
84
|
setIsSyncing(false);
|
|
79
85
|
}
|
|
80
|
-
|
|
86
|
+
// Empty: everything this reads comes from `optionsRef`, so the callback has a
|
|
87
|
+
// stable identity and never needs rebuilding. A host can safely pass it to a
|
|
88
|
+
// memoised child or an effect dependency list.
|
|
89
|
+
}, []);
|
|
81
90
|
const restart = (0, _react.useCallback)(() => {
|
|
82
91
|
setMandatoryUpdatePending(false);
|
|
83
92
|
_OtaOrchestrator.otaOrchestrator.restart();
|
|
@@ -259,6 +259,11 @@ class ScaleBunFacade {
|
|
|
259
259
|
_internalLogger.logger.warn('[ScaleBun] A signing key is pinned but no signature verifier is available. ' + 'Signature checking is fail-closed: updates will be REJECTED until one exists. ' + 'Install the optional peers `@noble/ed25519` + `@noble/hashes` (no further ' + 'code needed), or supply `ota.verifySignature`.');
|
|
260
260
|
}
|
|
261
261
|
}
|
|
262
|
+
// `healthyAfterMs` is the field BootGuardConfig actually declares.
|
|
263
|
+
// This passed `healthyTimeoutMs`, which nothing reads, so a host that
|
|
264
|
+
// tuned the boot-guard window silently got the 10s default instead.
|
|
265
|
+
// Both spellings are accepted so the older one keeps working.
|
|
266
|
+
const healthyAfterMs = typeof ota.healthyAfterMs === 'number' ? ota.healthyAfterMs : typeof ota.healthyTimeoutMs === 'number' ? ota.healthyTimeoutMs : undefined;
|
|
262
267
|
otaOrchestrator.init({
|
|
263
268
|
...(signingRequested ? {
|
|
264
269
|
signature: {
|
|
@@ -268,15 +273,123 @@ class ScaleBunFacade {
|
|
|
268
273
|
verifier
|
|
269
274
|
}
|
|
270
275
|
} : {}),
|
|
271
|
-
...(
|
|
272
|
-
|
|
276
|
+
...(healthyAfterMs !== undefined ? {
|
|
277
|
+
healthyAfterMs
|
|
273
278
|
} : {})
|
|
274
279
|
});
|
|
275
280
|
_internalLogger.logger.info('[ScaleBun] OTA enabled from init config.');
|
|
281
|
+
|
|
282
|
+
// Run the checks the config asked for. Until this existed, `ota.enabled`
|
|
283
|
+
// initialised the orchestrator and then never checked anything: the
|
|
284
|
+
// documented `checkOnForeground` and `channelOverride` options were read
|
|
285
|
+
// by no code at all, and an app following the documented config received
|
|
286
|
+
// updates only if it ALSO drove `useOtaUpdate` or the CodePush shim by
|
|
287
|
+
// hand. Nothing logged, because "no update available" and "never asked"
|
|
288
|
+
// look identical from the outside.
|
|
289
|
+
this._startOtaChecks(ota);
|
|
276
290
|
} catch (err) {
|
|
277
291
|
_internalLogger.logger.warn(`[ScaleBun] OTA init failed: ${err?.message ?? err}`);
|
|
278
292
|
}
|
|
279
293
|
}
|
|
294
|
+
|
|
295
|
+
/** Guards against overlapping config-driven OTA checks. */
|
|
296
|
+
_otaCheckInFlight = false;
|
|
297
|
+
/** Wall clock of the last config-driven check, for the foreground floor. */
|
|
298
|
+
_otaLastCheckAt = 0;
|
|
299
|
+
_otaForegroundListener = null;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Minimum gap between config-driven checks.
|
|
303
|
+
*
|
|
304
|
+
* A foreground transition is cheap to trigger — app switchers, permission
|
|
305
|
+
* dialogs and share sheets all produce one — so an unthrottled check would
|
|
306
|
+
* put a request on the hot path every time the user glanced away. Ten
|
|
307
|
+
* minutes is well below any realistic release cadence and well above that
|
|
308
|
+
* noise. A host that wants a check on demand calls `useOtaUpdate().sync()`,
|
|
309
|
+
* which is never throttled.
|
|
310
|
+
*/
|
|
311
|
+
static OTA_MIN_CHECK_INTERVAL_MS = 10 * 60 * 1000;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Drive OTA checks from init config: once at startup, then on each
|
|
315
|
+
* foreground when `checkOnForeground` is on (the schema default).
|
|
316
|
+
*
|
|
317
|
+
* `appVersion` is resolved from the native bridge rather than asked of the
|
|
318
|
+
* integrator, because it gates the server's `targetAppVersion` semver check
|
|
319
|
+
* — sending a wrong or invented value is worse than sending none, and there
|
|
320
|
+
* is no honest default. If it cannot be resolved, the check is skipped with
|
|
321
|
+
* a warning instead of guessing.
|
|
322
|
+
*/
|
|
323
|
+
_startOtaChecks(ota) {
|
|
324
|
+
// Never in a debug build. `ScaleBunOtaModule.getJSBundleFile()` returns null
|
|
325
|
+
// there on purpose so Metro keeps ownership of the bundle — so a bundle
|
|
326
|
+
// downloaded in dev is installed into a slot that will never be loaded, and
|
|
327
|
+
// the identity check on the next launch then correctly observes that the
|
|
328
|
+
// running code is not what was installed and reports APPLY_FAILED. Checking
|
|
329
|
+
// at all in dev buys nothing and manufactures that false alarm. A developer
|
|
330
|
+
// testing the OTA path drives `useOtaUpdate().sync()` explicitly.
|
|
331
|
+
if (__DEV__) {
|
|
332
|
+
_internalLogger.logger.info('[ScaleBun] OTA checks are skipped in debug builds (Metro owns the bundle).');
|
|
333
|
+
return;
|
|
334
|
+
}
|
|
335
|
+
const runCheck = async trigger => {
|
|
336
|
+
if (this._otaCheckInFlight) return;
|
|
337
|
+
if (trigger === 'foreground' && Date.now() - this._otaLastCheckAt < ScaleBunFacade.OTA_MIN_CHECK_INTERVAL_MS) {
|
|
338
|
+
return;
|
|
339
|
+
}
|
|
340
|
+
const clientKey = this._clientKey;
|
|
341
|
+
const apiUrl = this._apiBaseUrl;
|
|
342
|
+
if (!clientKey || !apiUrl) return;
|
|
343
|
+
this._otaCheckInFlight = true;
|
|
344
|
+
try {
|
|
345
|
+
const info = await _bridgeAdapter.bridgeAdapter.getDeviceInfo();
|
|
346
|
+
const appVersion = info?.appVersion;
|
|
347
|
+
if (!appVersion) {
|
|
348
|
+
_internalLogger.logger.warn('[ScaleBun] OTA check skipped — the app version could not be read from the ' + 'native bridge. Rebuild the native app, or drive checks yourself with ' + 'useOtaUpdate({ appVersion }).');
|
|
349
|
+
return;
|
|
350
|
+
}
|
|
351
|
+
this._otaLastCheckAt = Date.now();
|
|
352
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
353
|
+
const {
|
|
354
|
+
otaOrchestrator
|
|
355
|
+
} = require('../features/ota/OtaOrchestrator');
|
|
356
|
+
await otaOrchestrator.sync({
|
|
357
|
+
apiUrl,
|
|
358
|
+
clientKey,
|
|
359
|
+
appVersion,
|
|
360
|
+
// The documented option, finally connected. Omitted means the
|
|
361
|
+
// server's `default` channel, exactly as before.
|
|
362
|
+
channelName: typeof ota.channelOverride === 'string' ? ota.channelOverride : undefined
|
|
363
|
+
// Never forced from config: the release's own installMode
|
|
364
|
+
// decides when the app restarts, and yanking the screen out
|
|
365
|
+
// from under a user is not a decision this switch should make.
|
|
366
|
+
});
|
|
367
|
+
} catch (err) {
|
|
368
|
+
_internalLogger.logger.warn(`[ScaleBun] OTA check failed: ${err?.message ?? err}`);
|
|
369
|
+
} finally {
|
|
370
|
+
this._otaCheckInFlight = false;
|
|
371
|
+
}
|
|
372
|
+
};
|
|
373
|
+
void runCheck('startup');
|
|
374
|
+
if (ota.checkOnForeground === false) return;
|
|
375
|
+
if (this._otaForegroundListener) return; // idempotent across repeated init()
|
|
376
|
+
try {
|
|
377
|
+
// Through `appLifecycle`, not a second AppState subscription: the SDK
|
|
378
|
+
// already owns one and fanning out from it keeps every consumer on the
|
|
379
|
+
// same transition sequence.
|
|
380
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
381
|
+
const {
|
|
382
|
+
appLifecycle
|
|
383
|
+
} = require('../core/lifecycle/appLifecycle');
|
|
384
|
+
this._otaForegroundListener = state => {
|
|
385
|
+
if (state === 'active') void runCheck('foreground');
|
|
386
|
+
};
|
|
387
|
+
appLifecycle.addListener(this._otaForegroundListener);
|
|
388
|
+
} catch {
|
|
389
|
+
// Lifecycle unavailable (tests, exotic hosts) — the startup check stands.
|
|
390
|
+
this._otaForegroundListener = null;
|
|
391
|
+
}
|
|
392
|
+
}
|
|
280
393
|
_autoEnableDebug(debugConfig) {
|
|
281
394
|
try {
|
|
282
395
|
const dbgConfig = (0, _debug.buildDebugConfigFromInitConfig)(debugConfig);
|