on-zero 0.6.2 → 0.6.3

package/src/helpers/recoverZeroClient.test.ts

@@ -4,6 +4,7 @@ import { UpdateNeededReasonType } from '@rocicorp/zero'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
 
 import {
+  classifyZeroRecoveryLog,
   composeRecoveryLogSink,
   makeZeroRecovery,
   resetRecoveryStateForTests,
@@ -131,6 +132,38 @@ describe('zero recovery', () => {
     expect(reload).toHaveBeenCalledTimes(1)
   })
 
+  test('logSink recovers on native sqlite finalized-statement local-store loss', async () => {
+    const { deps, deleteLocalState, reload } = setup()
+    const sqliteError = new Error('This statement has been finalized')
+    sqliteError.name = 'SqliteError'
+    const sink = composeRecoveryLogSink(deps)
+    sink.log('error', { bgIntervalProcess: 'Heartbeat' }, 'Error running.', sqliteError)
+    await flush()
+    expect(deleteLocalState).toHaveBeenCalledTimes(1)
+    expect(reload).toHaveBeenCalledTimes(1)
+  })
+
+  test('logSink recovers on repeated store-closed local-store loss', async () => {
+    const nowSpy = vi.spyOn(Date, 'now')
+    const { deps, deleteLocalState, reload } = setup()
+    try {
+      const sink = composeRecoveryLogSink(deps)
+      nowSpy.mockReturnValue(10_000)
+      sink.log('error', undefined, 'Failed to connect.', new Error('Store is closed'))
+      await flush()
+      expect(deleteLocalState).not.toHaveBeenCalled()
+      expect(reload).not.toHaveBeenCalled()
+
+      nowSpy.mockReturnValue(13_000)
+      sink.log('error', undefined, 'Failed to connect.', new Error('Store is closed'))
+      await flush()
+      expect(deleteLocalState).toHaveBeenCalledTimes(1)
+      expect(reload).toHaveBeenCalledTimes(1)
+    } finally {
+      nowSpy.mockRestore()
+    }
+  })
+
   test('logSink with no consumer preserves console output and still watches', async () => {
     const { deps, deleteLocalState, reload } = setup()
     const infoSpy = vi.spyOn(console, 'info').mockImplementation(() => {})
@@ -170,6 +203,39 @@ describe('zero recovery', () => {
     expect(reload).not.toHaveBeenCalled()
   })
 
+  test('recovery log classification is narrow', () => {
+    const sqliteError = new Error('This statement has been finalized')
+    sqliteError.name = 'SqliteError'
+    expect(
+      classifyZeroRecoveryLog('error', ['Error running.', sqliteError]),
+    ).toMatchObject({
+      reason: 'sqlite-statement-finalized',
+      dropLocalState: true,
+    })
+    expect(
+      classifyZeroRecoveryLog('error', [
+        { name: 'SqliteError', message: 'database is locked' },
+      ]),
+    ).toBeUndefined()
+    expect(
+      classifyZeroRecoveryLog('warn', ['Expected IndexedDB not found']),
+    ).toBeUndefined()
+    expect(classifyZeroRecoveryLog('error', ['Store is closed'], 10_000)).toBeUndefined()
+    expect(classifyZeroRecoveryLog('error', ['Store is closed'], 11_000)).toBeUndefined()
+    expect(classifyZeroRecoveryLog('error', ['Store is closed'], 14_000)).toMatchObject({
+      reason: 'store-closed-repeat',
+      dropLocalState: true,
+    })
+    resetRecoveryStateForTests()
+    expect(
+      classifyZeroRecoveryLog(
+        'error',
+        ['Mutator "send" error on server', 'Store is closed'],
+        20_000,
+      ),
+    ).toBeUndefined()
+  })
+
   // a host with a `window` shim but no real `location` — the sootsim tenant
   // render-worker, which hides `location` for isolation. the DEFAULT reload
   // path (no injected `deps.reload`) must still drop stale IDB and not throw

package/src/helpers/recoverZeroClient.ts

@@ -10,6 +10,23 @@ const RECOVER_GUARD_MS = 60_000
 // the fatal local-store-loss signature Zero logs when the IndexedDB it expects
 // is gone (evicted, or deleted by another tab).
 const LOCAL_STORE_LOST = 'Expected IndexedDB not found'
+const SQLITE_ERROR_NAME = 'SqliteError'
+const SQLITE_STATEMENT_FINALIZED = 'This statement has been finalized'
+const STORE_CLOSED = 'Store is closed'
+const STORE_CLOSED_REPEAT_MIN_MS = 2_000
+const STORE_CLOSED_REPEAT_MAX_MS = 60_000
+
+export type ZeroRecoveryLogReason =
+  | 'indexeddb-not-found'
+  | 'sqlite-statement-finalized'
+  | 'store-closed-repeat'
+
+export type ZeroRecoveryLogClassification = {
+  reason: ZeroRecoveryLogReason
+  reasonKey: string
+  message: string
+  dropLocalState: boolean
+}
 
 export type ZeroRecoveryDeps = {
   // delete THIS client's local persistent state (its own scoped IDB). pass the
@@ -38,15 +55,22 @@ const pendingDeletes: Array<Promise<unknown>> = []
 function recoveryGuardOpen(reasonKey: string): boolean {
   try {
     const key = `on-zero-recover-${reasonKey}`
-    const last = Number(window.sessionStorage.getItem(key) || 0)
-    if (Date.now() - last < RECOVER_GUARD_MS) return false
-    window.sessionStorage.setItem(key, String(Date.now()))
+    const rawLast = window.sessionStorage.getItem(key)
+    const now = Date.now()
+    const last = rawLast ? Number(rawLast) : 0
+    if (last > 0 && now - last < RECOVER_GUARD_MS) return false
+    window.sessionStorage.setItem(key, String(now))
   } catch {
     // no sessionStorage (private mode) — fall back to the in-memory latch.
   }
   return true
 }
 
+// "Store is closed" is noisy during intentional instance replacement. One log is
+// teardown noise; repeated logs seconds apart mean a live client is stuck using a
+// closed local store and needs fresh local state.
+let lastStoreClosedAtMs = 0
+
 function recover(
   deps: ZeroRecoveryDeps,
   reasonKey: string,
@@ -137,6 +161,66 @@ function logToConsole(
   console[method](...(prefix ? [prefix] : []), ...args)
 }
 
+function logArgText(arg: unknown): string {
+  if (typeof arg === 'string') return arg
+  if (arg instanceof Error) return `${arg.name} ${arg.message} ${arg.stack || ''}`
+  if (arg && typeof arg === 'object') {
+    const message = 'message' in arg ? (arg as { message?: unknown }).message : undefined
+    const name = 'name' in arg ? (arg as { name?: unknown }).name : undefined
+    if (typeof message === 'string')
+      return `${typeof name === 'string' ? name : ''} ${message}`
+  }
+  return ''
+}
+
+function isBenignStoreClosedLog(text: string): boolean {
+  if (/Mutator\s+".*"\s+error on server/i.test(text)) return true
+  if (/Mutator\s+".*"\s+app error on client/i.test(text)) return true
+  return false
+}
+
+export function classifyZeroRecoveryLog(
+  level: LogLevel | string,
+  args: readonly unknown[],
+  nowMs = Date.now(),
+): ZeroRecoveryLogClassification | undefined {
+  if (level !== 'error') return undefined
+  const text = args.map(logArgText).join(' ')
+  if (text.includes(LOCAL_STORE_LOST)) {
+    return {
+      reason: 'indexeddb-not-found',
+      reasonKey: 'local-store',
+      message: 'local store lost',
+      dropLocalState: true,
+    }
+  }
+  if (text.includes(SQLITE_ERROR_NAME) && text.includes(SQLITE_STATEMENT_FINALIZED)) {
+    return {
+      reason: 'sqlite-statement-finalized',
+      reasonKey: 'sqlite-statement-finalized',
+      message: 'sqlite statement finalized',
+      dropLocalState: true,
+    }
+  }
+  if (text.includes(STORE_CLOSED) && !isBenignStoreClosedLog(text)) {
+    const prevMs = lastStoreClosedAtMs
+    lastStoreClosedAtMs = nowMs
+    if (
+      prevMs > 0 &&
+      nowMs - prevMs >= STORE_CLOSED_REPEAT_MIN_MS &&
+      nowMs - prevMs <= STORE_CLOSED_REPEAT_MAX_MS
+    ) {
+      return {
+        reason: 'store-closed-repeat',
+        reasonKey: 'store-closed-repeat',
+        message: 'local store closed repeatedly',
+        dropLocalState: true,
+      }
+    }
+  }
+  return undefined
+}
+
 // watch error-level logs for the local-store-lost signature (the one fatal Zero
 // surfaces only through the log, not the structured callbacks) and trigger the
 // same recovery. forwards to the consumer sink, or to the console when there is
@@ -151,18 +235,9 @@ export function composeRecoveryLogSink(
     log(level: LogLevel, context: Context | undefined, ...args: unknown[]): void {
       if (consumerLogSink) consumerLogSink.log(level, context, ...args)
       else logToConsole(level, context, ...args)
-      if (level !== 'error') return
-      const text = args
-        .map((arg) =>
-          typeof arg === 'string'
-            ? arg
-            : arg && typeof arg === 'object' && 'message' in arg
-              ? String((arg as { message: unknown }).message)
-              : '',
-        )
-        .join(' ')
-      if (text.includes(LOCAL_STORE_LOST)) {
-        recover(deps, 'local-store', 'local store lost', true)
+      const recovery = classifyZeroRecoveryLog(level, args)
+      if (recovery) {
+        recover(deps, recovery.reasonKey, recovery.message, recovery.dropLocalState)
       }
     },
     // call through the consumer sink so a class-based sink keeps its `this`,
@@ -176,4 +251,5 @@ export function composeRecoveryLogSink(
 export function resetRecoveryStateForTests() {
   reloadScheduled = false
   pendingDeletes.length = 0
+  lastStoreClosedAtMs = 0
 }

package/src/index.ts

@@ -42,7 +42,10 @@ export {
   type ZeroClientErrorInfo,
 } from './helpers/showZeroClientError'
 export {
+  classifyZeroRecoveryLog,
   makeZeroRecovery,
   composeRecoveryLogSink,
+  type ZeroRecoveryLogClassification,
+  type ZeroRecoveryLogReason,
   type ZeroRecoveryDeps,
 } from './helpers/recoverZeroClient'

package/types/helpers/recoverZeroClient.d.ts

@@ -1,7 +1,14 @@
 import type { Emitter } from '@take-out/helpers';
 import type { ZeroEvent } from '../types';
 import type { UpdateNeededReason } from '@rocicorp/zero';
-import type { LogSink } from '@rocicorp/logger';
+import type { LogLevel, LogSink } from '@rocicorp/logger';
+export type ZeroRecoveryLogReason = 'indexeddb-not-found' | 'sqlite-statement-finalized' | 'store-closed-repeat';
+export type ZeroRecoveryLogClassification = {
+    reason: ZeroRecoveryLogReason;
+    reasonKey: string;
+    message: string;
+    dropLocalState: boolean;
+};
 export type ZeroRecoveryDeps = {
     deleteLocalState: () => Promise<unknown>;
     zeroEvents: Emitter<ZeroEvent | null>;
@@ -12,6 +19,7 @@ export declare function makeZeroRecovery(deps: ZeroRecoveryDeps): {
     onUpdateNeeded(reason: UpdateNeededReason): void;
     onClientStateNotFound(): void;
 };
+export declare function classifyZeroRecoveryLog(level: LogLevel | string, args: readonly unknown[], nowMs?: number): ZeroRecoveryLogClassification | undefined;
 export declare function composeRecoveryLogSink(deps: ZeroRecoveryDeps, consumerLogSink?: LogSink): LogSink;
 export declare function resetRecoveryStateForTests(): void;
 //# sourceMappingURL=recoverZeroClient.d.ts.map

package/types/helpers/recoverZeroClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recoverZeroClient.d.ts","sourceRoot":"","sources":["../../src/helpers/recoverZeroClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,KAAK,EAAqB,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAUlE,MAAM,MAAM,gBAAgB,GAAG;IAI7B,gBAAgB,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;IAExC,UAAU,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IAGrC,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;CACpB,CAAA;AAsED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,gBAAgB;2BAE5B,kBAAkB;;EAsB5C;AAyBD,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,gBAAgB,EACtB,eAAe,CAAC,EAAE,OAAO,GACxB,OAAO,CAwBT;AAID,wBAAgB,0BAA0B,SAGzC"}
+{"version":3,"file":"recoverZeroClient.d.ts","sourceRoot":"","sources":["../../src/helpers/recoverZeroClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,KAAK,EAAW,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAelE,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,GACrB,4BAA4B,GAC5B,qBAAqB,CAAA;AAEzB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,qBAAqB,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAI7B,gBAAgB,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;IAExC,UAAU,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IAGrC,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;CACpB,CAAA;AA6ED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,gBAAgB;2BAE5B,kBAAkB;;EAsB5C;AAsCD,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,QAAQ,GAAG,MAAM,EACxB,IAAI,EAAE,SAAS,OAAO,EAAE,EACxB,KAAK,SAAa,GACjB,6BAA6B,GAAG,SAAS,CAoC3C;AAOD,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,gBAAgB,EACtB,eAAe,CAAC,EAAE,OAAO,GACxB,OAAO,CAeT;AAID,wBAAgB,0BAA0B,SAIzC"}

package/types/index.d.ts

@@ -21,5 +21,5 @@ export { defineQuery, defineQueries } from '@rocicorp/zero';
 export type * from './types';
 export { clearZeroClientData, type ClearZeroClientDataOptions, } from './helpers/clearZeroClientData';
 export { showZeroClientErrorOnce, resetShownZeroClientError, type ShowZeroClientErrorOptions, type ZeroClientErrorInfo, } from './helpers/showZeroClientError';
-export { makeZeroRecovery, composeRecoveryLogSink, type ZeroRecoveryDeps, } from './helpers/recoverZeroClient';
+export { classifyZeroRecoveryLog, makeZeroRecovery, composeRecoveryLogSink, type ZeroRecoveryLogClassification, type ZeroRecoveryLogReason, type ZeroRecoveryDeps, } from './helpers/recoverZeroClient';
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAErD,OAAO,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAA;AAC3B,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,OAAO,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAA;AACzD,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,eAAe,CAAA;AAC7B,cAAc,OAAO,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAM3D,mBAAmB,SAAS,CAAA;AAE5B,OAAO,EACL,mBAAmB,EACnB,KAAK,0BAA0B,GAChC,MAAM,+BAA+B,CAAA;AACtC,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,GACzB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,KAAK,gBAAgB,GACtB,MAAM,6BAA6B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAErD,OAAO,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAA;AAC3B,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,OAAO,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAA;AACzD,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,eAAe,CAAA;AAC7B,cAAc,OAAO,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAM3D,mBAAmB,SAAS,CAAA;AAE5B,OAAO,EACL,mBAAmB,EACnB,KAAK,0BAA0B,GAChC,MAAM,+BAA+B,CAAA;AACtC,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,GACzB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,GACtB,MAAM,6BAA6B,CAAA"}