@glance-apps/sync 1.5.1 → 1.5.2

package/CHANGELOG.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.2] - 2026-06-19
+
+### Fixed
+
+- **Key verifier no longer fails with a cryptic `get row failed: 400`.** The
+  verifier's single-row GET (`GET /sync/{app}/__glance_keycheck`) is scoped by
+  `accountId`, which GLANCEvault requires as a query param on every row-scoped
+  endpoint. When the verifier ran with an `accountId` that was empty or
+  whitespace — e.g. fired during reconstruction before the account id was
+  populated — the request went out as `?accountId=` (or `?accountId=+++`), which
+  the server correctly rejects with `400 {"error":"accountId is required"}`,
+  aborting enable. The default `createVaultClient` now validates `accountId` on
+  every row-scoped call (`batch`, `list`, single-row GET, `DELETE`, `device`) and
+  throws a clear, typed, retryable `ACCOUNT_ID_REQUIRED` instead of putting a
+  malformed `accountId` on the wire — so the next cycle (once the id is loaded)
+  succeeds. `createDbSyncEngine` also rejects an empty/whitespace `accountId` at
+  construction (a whitespace-only id previously passed the plain falsy check).
+  The verifier path surfaces `ACCOUNT_ID_REQUIRED` (and `PASSPHRASE_REQUIRED`)
+  with their own code rather than mislabeling them `VERIFIER_UNSUPPORTED`. The
+  verifier GET correctly carries `?accountId=...` (like the working `list` call)
+  and, on a fresh account, 404 → writes the verifier via `batch` with
+  `accountId` + `insertOnly: true`.
+
+### Added
+
+- `ACCOUNT_ID_REQUIRED` standardized on the `SyncErrorCode` type.
+
 ## [1.5.1] - 2026-06-19
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glance-apps/sync",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "license": "MIT",
   "type": "module",
   "main": "src/index.js",

package/src/dbEngine.js

@@ -92,7 +92,13 @@ export const createDbSyncEngine = (config) => {
   if (!storageKeyPrefix) throw new Error('createDbSyncEngine: storageKeyPrefix is required');
   if (!config.vaultClient && !vaultUrl)   throw new Error('createDbSyncEngine: vaultUrl is required');
   if (!config.vaultClient && !vaultToken) throw new Error('createDbSyncEngine: vaultToken is required');
-  if (!accountId)        throw new Error('createDbSyncEngine: accountId is required');
+  if (typeof accountId !== 'string' || accountId.trim() === '') {
+    // Reject empty/whitespace too: a whitespace-only id passes a plain falsy
+    // check but serialises to `?accountId=+++`, which the server trims to empty
+    // and rejects with a cryptic 400 on every row-scoped call (incl. the key
+    // verifier's single-row GET).
+    throw new Error('createDbSyncEngine: accountId is required');
+  }
   if (typeof getLocalEntity    !== 'function') throw new Error('createDbSyncEngine: getLocalEntity is required');
   if (typeof applyRemoteEntity !== 'function') throw new Error('createDbSyncEngine: applyRemoteEntity is required');
   if (typeof applyRemoteDelete !== 'function') throw new Error('createDbSyncEngine: applyRemoteDelete is required');
@@ -242,7 +248,14 @@ export const createDbSyncEngine = (config) => {
   // skipped would still push poison rows. Pausing sync with a clear reason is
   // the correct degradation. (config.allowUnverified is an explicit operator
   // escape hatch, off by default, that downgrades this to a logged warning.)
+  // Client-readiness failures (no passphrase yet, or accountId not populated)
+  // are NOT a server problem: re-throw them as-is so they surface with their own
+  // typed, retryable code instead of being mislabeled "update your server".
+  const isClientNotReady = (err) =>
+    err && (err.code === 'ACCOUNT_ID_REQUIRED' || err.code === 'PASSPHRASE_REQUIRED');
+
   const verifierUnsupported = (cause) => {
+    if (isClientNotReady(cause)) throw cause;
     if (allowUnverified) {
       // eslint-disable-next-line no-console
       console.warn(`[${appId}] db sync proceeding UNVERIFIED: the server cannot host the key verifier (${KEYCHECK_ENTITY_ID}).`, cause);

package/src/vaultClient.js

@@ -73,12 +73,27 @@ export function createVaultClient({ vaultUrl, vaultToken, fetchImpl } = {}) {
     return res.json();
   };
 
+  // accountId scopes every row-scoped endpoint (batch, list, single-row GET,
+  // DELETE, device). The server has no default and rejects a missing/empty value
+  // with a cryptic 400 {"error":"accountId is required"}. Validate it here so a
+  // caller that fires before the account id is populated (e.g. the key verifier
+  // running during reconstruction) fails with a clear, typed, retryable error
+  // and we never put a malformed `?accountId=` on the wire.
+  const requireAccountId = (accountId, context) => {
+    if (typeof accountId !== 'string' || accountId.trim() === '') {
+      const err = new Error(`${context}: accountId is required but was missing or empty.`);
+      err.code = 'ACCOUNT_ID_REQUIRED';
+      throw err;
+    }
+  };
+
   return {
     /**
      * Upserts a batch of rows. Each row is { entityId, envelope, createdAt }.
      * @returns {Promise<{ written: number, maxSeq: number }>}
      */
     async batch(app, { accountId, rows }) {
+      requireAccountId(accountId, 'batch upsert');
       const res = await request('POST', `/sync/${encodeURIComponent(app)}/batch`, {
         body: { accountId, rows },
       });
@@ -90,6 +105,7 @@ export function createVaultClient({ vaultUrl, vaultToken, fetchImpl } = {}) {
      * @returns {Promise<{ rows: Array, hasMore: boolean }>}
      */
     async list(app, { accountId, since }) {
+      requireAccountId(accountId, 'list');
       const res = await request('GET', `/sync/${encodeURIComponent(app)}/list`, {
         query: { accountId, since: String(since) },
       });
@@ -100,6 +116,7 @@ export function createVaultClient({ vaultUrl, vaultToken, fetchImpl } = {}) {
      * Fetches a single row by entityId. Returns null on 404.
      */
     async getRow(app, entityId, accountId) {
+      requireAccountId(accountId, 'get row');
       const res = await request('GET', `/sync/${encodeURIComponent(app)}/${encodeURIComponent(entityId)}`, {
         query: { accountId },
       });
@@ -112,6 +129,7 @@ export function createVaultClient({ vaultUrl, vaultToken, fetchImpl } = {}) {
      * the new seq for the tombstone).
      */
     async deleteRow(app, entityId, accountId) {
+      requireAccountId(accountId, 'delete row');
       const res = await request('DELETE', `/sync/${encodeURIComponent(app)}/${encodeURIComponent(entityId)}`, {
         query: { accountId },
       });
@@ -125,6 +143,7 @@ export function createVaultClient({ vaultUrl, vaultToken, fetchImpl } = {}) {
      * @returns {Promise<{ updated: boolean }>}
      */
     async device(app, { accountId, deviceId, lastSeenSeq }) {
+      requireAccountId(accountId, 'device cursor');
       const res = await request('POST', `/sync/${encodeURIComponent(app)}/device`, {
         body: { accountId, deviceId, lastSeenSeq },
       });

package/types/index.d.ts

@@ -24,7 +24,10 @@ export type SyncErrorCode =
   | 'ROW_DECRYPT_FAILED'
   // DB transport: the server can't host the key verifier (doesn't support the
   // reserved __glance_keycheck id or the single-row endpoint).
-  | 'VERIFIER_UNSUPPORTED';
+  | 'VERIFIER_UNSUPPORTED'
+  // DB transport: a row-scoped call (incl. the key verifier) was made before the
+  // accountId was populated — retryable once the account id is available.
+  | 'ACCOUNT_ID_REQUIRED';
 
 export type SyncStatus = 'idle' | 'uploading' | 'downloading' | 'success' | 'error';