one 2.21.0 → 2.21.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/dist/cjs/Root.cjs +6 -1
- package/dist/cjs/Root.native.cjs +6 -1
- package/dist/cjs/Root.native.js +6 -1
- package/dist/cjs/Root.native.js.map +1 -1
- package/dist/cjs/router/warmState.cjs +16 -0
- package/dist/cjs/router/warmState.native.cjs +16 -0
- package/dist/cjs/router/warmState.native.js +16 -0
- package/dist/cjs/router/warmState.native.js.map +1 -1
- package/dist/esm/Root.mjs +7 -2
- package/dist/esm/Root.mjs.map +1 -1
- package/dist/esm/Root.native.js +7 -2
- package/dist/esm/Root.native.js.map +1 -1
- package/dist/esm/router/warmState.mjs +16 -1
- package/dist/esm/router/warmState.mjs.map +1 -1
- package/dist/esm/router/warmState.native.js +16 -1
- package/dist/esm/router/warmState.native.js.map +1 -1
- package/package.json +13 -13
- package/src/Root.tsx +8 -1
- package/src/router/warmState.test.ts +34 -0
- package/src/router/warmState.ts +23 -0
- package/types/Root.d.ts.map +1 -1
- package/types/router/warmState.d.ts +2 -0
- package/types/router/warmState.d.ts.map +1 -1
package/src/Root.tsx
CHANGED
|
@@ -28,6 +28,7 @@ import {
|
|
|
28
28
|
isWarmRouteApplied,
|
|
29
29
|
isWarmStateEnabled,
|
|
30
30
|
reconcileNativeColdDeepLink,
|
|
31
|
+
settleWarmLaunch,
|
|
31
32
|
} from './router/warmState'
|
|
32
33
|
import {
|
|
33
34
|
attachWarmStateLifecycle,
|
|
@@ -154,7 +155,10 @@ export function Root(props: RootProps) {
|
|
|
154
155
|
|
|
155
156
|
useEffect(() => {
|
|
156
157
|
if (!isWarmStateEnabled()) return
|
|
158
|
+
// a launch still running after a few seconds, or one the user left, did not crash
|
|
159
|
+
const settle = setTimeout(settleWarmLaunch, 5000)
|
|
157
160
|
const detach = attachWarmStateLifecycle(() => {
|
|
161
|
+
settleWarmLaunch()
|
|
158
162
|
flushWarmState()
|
|
159
163
|
})
|
|
160
164
|
const currentHref = store.routeInfo?.unstable_globalHref || store.routeInfo?.pathname
|
|
@@ -171,7 +175,10 @@ export function Root(props: RootProps) {
|
|
|
171
175
|
setIsHoldingWarmReconcile(false)
|
|
172
176
|
})
|
|
173
177
|
}
|
|
174
|
-
return
|
|
178
|
+
return () => {
|
|
179
|
+
clearTimeout(settle)
|
|
180
|
+
detach()
|
|
181
|
+
}
|
|
175
182
|
}, [])
|
|
176
183
|
|
|
177
184
|
// One.Updates counts a launch as good once react native shows its first
|
|
@@ -20,6 +20,7 @@ import {
|
|
|
20
20
|
reconcileNativeColdDeepLink,
|
|
21
21
|
registerWarmStateSource,
|
|
22
22
|
scheduleWarmStatePersist,
|
|
23
|
+
settleWarmLaunch,
|
|
23
24
|
trackRestoredLaunch,
|
|
24
25
|
waitForWarmRoutePreload,
|
|
25
26
|
type WarmNavigationSnapshot,
|
|
@@ -624,6 +625,39 @@ describe('warmState', () => {
|
|
|
624
625
|
expect(consumeWarmRouteApplied()).toBe(true)
|
|
625
626
|
})
|
|
626
627
|
|
|
628
|
+
it('starts fresh after a launch that loaded saved state and never settled', () => {
|
|
629
|
+
const saved = JSON.stringify({
|
|
630
|
+
v: 1,
|
|
631
|
+
schemaVersion: 2,
|
|
632
|
+
updatedAt: nowMs,
|
|
633
|
+
pathname: '/inbox',
|
|
634
|
+
state: { index: 0, routes: [{ name: 'inbox' }] },
|
|
635
|
+
sources: {},
|
|
636
|
+
})
|
|
637
|
+
// relaunch keeps storage and drops everything held in memory
|
|
638
|
+
const relaunch = () => {
|
|
639
|
+
const kept = new Map(storage.raw)
|
|
640
|
+
clearWarmState({ keepConfig: true })
|
|
641
|
+
for (const [key, value] of kept) storage.raw.set(key, value)
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
storage.raw.set(WARM_STATE_STORAGE_KEY, saved)
|
|
645
|
+
expect(getHydratedWarmState()?.pathname).toBe('/inbox')
|
|
646
|
+
settleWarmLaunch()
|
|
647
|
+
relaunch()
|
|
648
|
+
expect(getHydratedWarmState()?.pathname).toBe('/inbox')
|
|
649
|
+
|
|
650
|
+
// this launch dies before settling, so the next one opens without saved state
|
|
651
|
+
relaunch()
|
|
652
|
+
expect(getHydratedWarmState()).toBeNull()
|
|
653
|
+
expect(storage.raw.has(WARM_STATE_STORAGE_KEY)).toBe(false)
|
|
654
|
+
|
|
655
|
+
// state saved during the fresh launch restores again afterwards
|
|
656
|
+
storage.raw.set(WARM_STATE_STORAGE_KEY, saved)
|
|
657
|
+
relaunch()
|
|
658
|
+
expect(getHydratedWarmState()?.pathname).toBe('/inbox')
|
|
659
|
+
})
|
|
660
|
+
|
|
627
661
|
it('lets a route restore export skip or redirect using the saved params', async () => {
|
|
628
662
|
const seen: unknown[] = []
|
|
629
663
|
const files: Record<string, any> = {
|
package/src/router/warmState.ts
CHANGED
|
@@ -86,6 +86,9 @@ let restoredLaunch = false
|
|
|
86
86
|
let restoredState: OneRouter.ResultState | undefined
|
|
87
87
|
let restoredPathname: string | undefined
|
|
88
88
|
let warmInitialRouteConsumed = false
|
|
89
|
+
// set while a native launch that loaded saved state has not yet settled
|
|
90
|
+
const RESTORE_GUARD_KEY = `${WARM_STATE_STORAGE_KEY}restoring`
|
|
91
|
+
let restoreGuardSet = false
|
|
89
92
|
|
|
90
93
|
let latestNavState: unknown
|
|
91
94
|
let latestPathname: string | undefined
|
|
@@ -233,6 +236,14 @@ function ensureLoadedEnvelope(): WarmStateEnvelope | null {
|
|
|
233
236
|
const raw = safeReadStorage(WARM_STATE_STORAGE_KEY)
|
|
234
237
|
if (!raw) return null
|
|
235
238
|
|
|
239
|
+
// a launch that loaded saved state and died before settling would die the
|
|
240
|
+
// same way on every relaunch, so the next one starts fresh
|
|
241
|
+
if (isNativeRuntime() && safeReadStorage(RESTORE_GUARD_KEY)) {
|
|
242
|
+
safeRemoveStorage(WARM_STATE_STORAGE_KEY)
|
|
243
|
+
safeRemoveStorage(RESTORE_GUARD_KEY)
|
|
244
|
+
return null
|
|
245
|
+
}
|
|
246
|
+
|
|
236
247
|
const parsed = parseWarmEnvelope(raw, {
|
|
237
248
|
schemaVersion: config.schemaVersion,
|
|
238
249
|
maxAgeMs: config.maxAgeMs,
|
|
@@ -246,9 +257,19 @@ function ensureLoadedEnvelope(): WarmStateEnvelope | null {
|
|
|
246
257
|
}
|
|
247
258
|
|
|
248
259
|
hydratedEnvelope = parsed
|
|
260
|
+
if (isNativeRuntime()) {
|
|
261
|
+
restoreGuardSet = safeWriteStorage(RESTORE_GUARD_KEY, '1')
|
|
262
|
+
}
|
|
249
263
|
return hydratedEnvelope
|
|
250
264
|
}
|
|
251
265
|
|
|
266
|
+
/** mark the launch healthy so its saved state restores on the next launch. */
|
|
267
|
+
export function settleWarmLaunch(): void {
|
|
268
|
+
if (!restoreGuardSet) return
|
|
269
|
+
restoreGuardSet = false
|
|
270
|
+
safeRemoveStorage(RESTORE_GUARD_KEY)
|
|
271
|
+
}
|
|
272
|
+
|
|
252
273
|
export function getHydratedWarmState(): WarmStateEnvelope | null {
|
|
253
274
|
if (!isWarmStateEnabled()) return null
|
|
254
275
|
return ensureLoadedEnvelope()
|
|
@@ -617,6 +638,8 @@ export function flushWarmState(): boolean {
|
|
|
617
638
|
/** clear persisted warm snapshot and reset cached boot state. */
|
|
618
639
|
export function clearWarmState(options?: { keepConfig?: boolean }): void {
|
|
619
640
|
safeRemoveStorage(WARM_STATE_STORAGE_KEY)
|
|
641
|
+
safeRemoveStorage(RESTORE_GUARD_KEY)
|
|
642
|
+
restoreGuardSet = false
|
|
620
643
|
loadedFromStorage = false
|
|
621
644
|
hydratedEnvelope = null
|
|
622
645
|
hydratedSourceKeys.clear()
|
package/types/Root.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Root.d.ts","sourceRoot":"","sources":["../src/Root.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,wBAAwB,EAAE,MAAM,0BAA0B,CAAA;AAG1F,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,SAAS,EAOf,MAAM,OAAO,CAAA;AAMd,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;
|
|
1
|
+
{"version":3,"file":"Root.d.ts","sourceRoot":"","sources":["../src/Root.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,wBAAwB,EAAE,MAAM,0BAA0B,CAAA;AAG1F,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,SAAS,EAOf,MAAM,OAAO,CAAA;AAMd,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAqBzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAOlD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAcvC,KAAK,SAAS,GAAG,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG;IAC7C,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,mBAAmB,CAAA;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;IAC/B,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAA;IACjB,OAAO,CAAC,EAAE,gBAAgB,CAAA;CAC3B,CAAA;AAED,KAAK,UAAU,GAAG;IAChB,OAAO,EAAE,GAAG,CAAC,YAAY,CAAA;IACzB,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,OAAO,CAAC,EAAE,iBAAiB,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAA;IACpD,wBAAwB,CAAC,EAAE,wBAAwB,GAAG;QACpD,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,OAAO,CAAA;YACb,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM,CAAA;gBACf,UAAU,EAAE,MAAM,CAAA;gBAClB,IAAI,EAAE,MAAM,CAAA;gBACZ,IAAI,EAAE,MAAM,CAAA;gBACZ,MAAM,EAAE,MAAM,CAAA;gBACd,YAAY,EAAE,MAAM,CAAA;aACrB,CAAA;SACF,CAAA;KACF,CAAA;CACF,CAAA;AAKD,wBAAgB,IAAI,CAAC,KAAK,EAAE,SAAS,sCAqOpC"}
|
|
@@ -24,6 +24,8 @@ export declare function shouldRestoreWarmRoute(): boolean;
|
|
|
24
24
|
* hydrate synchronously on warm launch before first render.
|
|
25
25
|
*/
|
|
26
26
|
export declare function registerWarmStateSource<T>(key: string, source: WarmStateSource<T>): () => void;
|
|
27
|
+
/** mark the launch healthy so its saved state restores on the next launch. */
|
|
28
|
+
export declare function settleWarmLaunch(): void;
|
|
27
29
|
export declare function getHydratedWarmState(): WarmStateEnvelope | null;
|
|
28
30
|
export declare function isWarmRoutePreloadPending(): boolean;
|
|
29
31
|
export declare function waitForWarmRoutePreload(timeoutMs?: number): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"warmState.d.ts","sourceRoot":"","sources":["../../src/router/warmState.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAGxC,OAAO,EASL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAEtB,KAAK,gBAAgB,EACtB,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EACL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAE1B,YAAY,EACV,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,mBAAmB,CAAA;AAE1B,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,OAAO,IAAI;IACzC,WAAW,EAAE,MAAM,CAAC,CAAA;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAA;CAC1C,CAAA;
|
|
1
|
+
{"version":3,"file":"warmState.d.ts","sourceRoot":"","sources":["../../src/router/warmState.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAGxC,OAAO,EASL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAEtB,KAAK,gBAAgB,EACtB,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EACL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAE1B,YAAY,EACV,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,mBAAmB,CAAA;AAE1B,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,OAAO,IAAI;IACzC,WAAW,EAAE,MAAM,CAAC,CAAA;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAA;CAC1C,CAAA;AAkHD,wEAAwE;AACxE,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,gBAAgB,GAAG;IAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAA;CAAE,GAC7E,IAAI,CAkBN;AAED,qEAAqE;AACrE,wBAAgB,2BAA2B,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAMnE;AAED,wBAAgB,kBAAkB,IAAI,OAAO,CAE5C;AAED,wBAAgB,sBAAsB,IAAI,OAAO,CAIhD;AAeD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,GACzB,MAAM,IAAI,CAQZ;AAqCD,8EAA8E;AAC9E,wBAAgB,gBAAgB,IAAI,IAAI,CAIvC;AAED,wBAAgB,oBAAoB,IAAI,iBAAiB,GAAG,IAAI,CAG/D;AA2CD,wBAAgB,yBAAyB,IAAI,OAAO,CAEnD;AAED,wBAAsB,uBAAuB,CAAC,SAAS,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAc5E;AAED,wBAAgB,sBAAsB,CAAC,OAAO,CAAC,EAAE;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAC/C,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAA;CAClB,GAAG,iBAAiB,GAAG,IAAI,CAqD3B;AAiDD,gFAAgF;AAChF,wBAAgB,iCAAiC,CAC/C,SAAS,EAAE,SAAS,GAAG,IAAI,EAC3B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,SAAS,CAAC,WAAW,GAAG,SAAS,CAsGnC;AAED,sFAAsF;AACtF,sFAAsF;AACtF,wBAAgB,6BAA6B,CAAC,eAAe,CAAC,EAAE,GAAG,GAAG,OAAO,CAG5E;AAED,wBAAgB,wBAAwB,CAAC,eAAe,CAAC,EAAE,GAAG,GAAG,OAAO,CAKvE;AAED,wBAAgB,kBAAkB,IAAI,OAAO,CAE5C;AAED,wBAAgB,gBAAgB,IAAI,OAAO,CAE1C;AAID,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAItE;AAED,wBAAgB,uBAAuB,IAAI,OAAO,CAIjD;AAsBD,2FAA2F;AAC3F,wBAAgB,wBAAwB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAkBpF;AAED,uFAAuF;AACvF,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,CAwBvE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CASlD;AAED;;;GAGG;AACH,wBAAsB,2BAA2B,CAAC,OAAO,EAAE;IACzD,aAAa,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAC3C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAA;CAC7C,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAkCzB"}
|