@vue-skuilder/db 0.2.17 → 0.2.19

package/dist/impl/static/index.d.cts

@@ -1,9 +1,9 @@
-import { U as UserDBInterface, C as CourseDBInterface, b as CoursesDBInterface, c as ClassroomDBInterface, A as AdminDBInterface, a as UserDBReader, d as CourseInfo, S as StudySessionItem, D as DataLayerResult, e as ContentNavigationStrategyData, f as ContentNavigator, R as ReplanHints, G as GeneratorResult } from '../../contentSource-Brz42x7n.cjs';
-import { D as DataLayerProvider } from '../../dataLayerProvider-CpwpT1rM.cjs';
+import { U as UserDBInterface, C as CourseDBInterface, b as CoursesDBInterface, c as ClassroomDBInterface, A as AdminDBInterface, a as UserDBReader, d as CourseInfo, S as StudySessionItem, D as DataLayerResult, e as ContentNavigationStrategyData, f as ContentNavigator, R as ReplanHints, G as GeneratorResult } from '../../contentSource-D-LQYFyx.cjs';
+import { D as DataLayerProvider } from '../../dataLayerProvider-Dd2UcCif.cjs';
 import { S as StaticCourseManifest } from '../../types-BFUa1pa3.cjs';
 import { CourseConfig, CourseElo, DataShape } from '@vue-skuilder/common';
 import { S as SkuilderCourseData, Q as QualifiedCardID, T as TagStub, a as Tag } from '../../types-legacy-4tlwHnXo.cjs';
-import { S as SyncStrategy, A as AccountCreationResult, a as AuthenticationResult } from '../../SyncStrategy-CyATpyLQ.cjs';
+import { S as SyncStrategy, A as AccountCreationResult, a as AuthenticationResult } from '../../SyncStrategy-BJMZq3WO.cjs';
 import 'moment';
 
 interface SkuilderManifest {

package/dist/impl/static/index.d.ts

@@ -1,9 +1,9 @@
-import { U as UserDBInterface, C as CourseDBInterface, b as CoursesDBInterface, c as ClassroomDBInterface, A as AdminDBInterface, a as UserDBReader, d as CourseInfo, S as StudySessionItem, D as DataLayerResult, e as ContentNavigationStrategyData, f as ContentNavigator, R as ReplanHints, G as GeneratorResult } from '../../contentSource-B1p-vdz7.js';
-import { D as DataLayerProvider } from '../../dataLayerProvider-BWayUIoK.js';
+import { U as UserDBInterface, C as CourseDBInterface, b as CoursesDBInterface, c as ClassroomDBInterface, A as AdminDBInterface, a as UserDBReader, d as CourseInfo, S as StudySessionItem, D as DataLayerResult, e as ContentNavigationStrategyData, f as ContentNavigator, R as ReplanHints, G as GeneratorResult } from '../../contentSource-BDRX_YYJ.js';
+import { D as DataLayerProvider } from '../../dataLayerProvider-Dpshuql4.js';
 import { S as StaticCourseManifest } from '../../types-CHgpWQAY.js';
 import { CourseConfig, CourseElo, DataShape } from '@vue-skuilder/common';
 import { S as SkuilderCourseData, Q as QualifiedCardID, T as TagStub, a as Tag } from '../../types-legacy-4tlwHnXo.js';
-import { S as SyncStrategy, A as AccountCreationResult, a as AuthenticationResult } from '../../SyncStrategy-CyATpyLQ.js';
+import { S as SyncStrategy, A as AccountCreationResult, a as AuthenticationResult } from '../../SyncStrategy-BJMZq3WO.js';
 import 'moment';
 
 interface SkuilderManifest {

package/dist/impl/static/index.js

@@ -5391,6 +5391,19 @@ var init_couch = __esm({
 });
 
 // src/impl/common/BaseUserDB.ts
+function withTimeout(p, ms, label) {
+  let timer;
+  return Promise.race([
+    p,
+    new Promise((_resolve, reject) => {
+      timer = setTimeout(() => reject(new Error(`${label} timed out after ${ms}ms`)), ms);
+    })
+  ]).finally(() => {
+    if (timer !== void 0) {
+      clearTimeout(timer);
+    }
+  });
+}
 function accomodateGuest() {
   logger.log("[funnel] accomodateGuest() called");
   if (typeof localStorage === "undefined") {
@@ -5564,7 +5577,7 @@ async function dropUserFromClassroom(user, classID) {
 async function getUserClassrooms(user) {
   return getOrCreateClassroomRegistrationsDoc(user);
 }
-var import_common12, import_moment6, log3, BaseUser, userCoursesDoc, userClassroomsDoc;
+var import_common12, import_moment6, log3, HYDRATION_TIMEOUT_MS, BaseUser, userCoursesDoc, userClassroomsDoc;
 var init_BaseUserDB = __esm({
   "src/impl/common/BaseUserDB.ts"() {
     "use strict";
@@ -5581,6 +5594,7 @@ var init_BaseUserDB = __esm({
     log3 = (s) => {
       logger.info(s);
     };
+    HYDRATION_TIMEOUT_MS = 15e3;
     BaseUser = class _BaseUser {
       static _instance;
       static _initialized = false;
@@ -5609,6 +5623,49 @@ var init_BaseUserDB = __esm({
       writeDB;
       // Database to use for write operations (local-first approach)
       updateQueue;
+      _hydration = { state: "not-required" };
+      /** In-flight hydration, so concurrent callers can wait for a real answer. */
+      _hydrationPromise = null;
+      /**
+       * How far the local mirror can be trusted, RIGHT NOW. See
+       * {@link UserHydrationStatus}.
+       *
+       * This is a snapshot, and during login it can legitimately read
+       * `hydrating` — prefer awaitHydration() anywhere a decision hangs on the
+       * answer.
+       */
+      hydrationStatus() {
+        return { ...this._hydration };
+      }
+      /**
+       * The hydration status once it has settled — never `hydrating`.
+       *
+       * Resolves immediately unless a pull is in flight. Exists for callers that
+       * must decide something (a route guard, a first-run branch) and would
+       * otherwise sample `hydrating` and guess. Since init() is awaited by both
+       * app startup and login(), that only happens when something navigates
+       * concurrently with a login still in progress — a window that stretches to
+       * HYDRATION_TIMEOUT_MS on a slow connection.
+       */
+      async awaitHydration() {
+        try {
+          await this._hydrationPromise;
+        } catch {
+        }
+        return this.hydrationStatus();
+      }
+      /**
+       * Whether a missing document may be treated as genuinely absent, allowing
+       * callers to create it with defaults.
+       *
+       * False only when hydration failed or is still running: a 404 then may just
+       * mean "not pulled down yet", and materializing a default would both lie to
+       * the user and, once live sync starts, push a rev-1 document that loses to
+       * the real one — silently discarding it.
+       */
+      canMaterializeDefaults() {
+        return this._hydration.state !== "failed" && this._hydration.state !== "hydrating";
+      }
       async createAccount(username, password) {
         if (!this.syncStrategy.canCreateAccount()) {
           throw new Error("Account creation not supported by current sync strategy");
@@ -5726,6 +5783,11 @@ Currently logged-in as ${this._username}.`
         } catch (e) {
           const err = e;
           if (err.status === 404) {
+            if (!this.canMaterializeDefaults()) {
+              throw new Error(
+                `Cannot read course registrations for ${this._username}: the local mirror is unavailable (hydration state '${this._hydration.state}'). Refusing to create an empty registration doc \u2014 that would report an existing user as unregistered, and then lose to their real document once sync resumes.`
+              );
+            }
             await this.localDB.put({
               _id: _BaseUser.DOC_IDS.COURSE_REGISTRATIONS,
               courses: [],
@@ -5968,6 +6030,11 @@ Currently logged-in as ${this._username}.`
         } catch (e) {
           const err = e;
           if (err.name && err.name === "not_found") {
+            if (!this.canMaterializeDefaults()) {
+              throw new Error(
+                `Cannot read config for ${this._username}: the local mirror is unavailable (hydration state '${this._hydration.state}'). Refusing to write a default config over what may be an existing one.`
+              );
+            }
             await this.localDB.put(defaultConfig);
             return this.getConfig();
           } else {
@@ -6041,7 +6108,10 @@ Currently logged-in as ${this._username}.`
           _BaseUser._initialized = true;
           return;
         }
+        this.syncStrategy.stopSync?.();
         this.setDBandQ();
+        this._hydrationPromise = this.hydrateLocalMirror();
+        await this._hydrationPromise;
         this.syncStrategy.startSync(this.localDB, this.remoteDB);
         this.applyDesignDocs().catch((error) => {
           log3(`Error in applyDesignDocs background task: ${error}`);
@@ -6057,6 +6127,85 @@ Currently logged-in as ${this._username}.`
         });
         _BaseUser._initialized = true;
       }
+      /**
+       * Pull this account's documents into the local mirror, if that hasn't
+       * happened on this device before.
+       *
+       * Runs between setDBandQ() and startSync() — after the handles exist, before
+       * anything can observe an empty local DB or replicate one upward.
+       *
+       * Never throws: a failure is recorded as `failed` state and reported through
+       * hydrationStatus(), because throwing here would abort init() and leave
+       * BaseUser._initialized false forever (BaseUser.instance() polls it with no
+       * ceiling). Callers decide what a failure means for them.
+       */
+      async hydrateLocalMirror() {
+        if (this.localDB.name === this.remoteDB.name || !this.syncStrategy.hydrate) {
+          this._hydration = { state: "not-required" };
+          return;
+        }
+        if (await this.hasHydrationMarker()) {
+          this._hydration = { state: "stale" };
+          return;
+        }
+        this._hydration = { state: "hydrating" };
+        const start = Date.now();
+        try {
+          const { docsWritten } = await withTimeout(
+            this.syncStrategy.hydrate(this.localDB, this.remoteDB),
+            HYDRATION_TIMEOUT_MS,
+            `Hydration of local mirror for ${this._username}`
+          );
+          await this.writeHydrationMarker();
+          this._hydration = {
+            state: "hydrated",
+            docsWritten,
+            durationMs: Date.now() - start
+          };
+          log3(
+            `Hydrated local mirror for ${this._username}: ${docsWritten} docs in ${this._hydration.durationMs}ms`
+          );
+        } catch (e) {
+          this.syncStrategy.stopSync?.();
+          this._hydration = {
+            state: "failed",
+            durationMs: Date.now() - start,
+            error: e instanceof Error ? e.message : String(e)
+          };
+          logger.error(`Failed to hydrate local mirror for ${this._username}:`, e);
+        }
+      }
+      /**
+       * Has a full pull completed on this device for the CURRENT account?
+       *
+       * The marker is a `_local/` document, which never replicates — so its
+       * presence describes this device's mirror and cannot arrive from elsewhere.
+       */
+      async hasHydrationMarker() {
+        try {
+          const marker = await this.localDB.get(HYDRATION_MARKER_ID);
+          return marker.username === this._username;
+        } catch {
+          return false;
+        }
+      }
+      async writeHydrationMarker() {
+        try {
+          let existingRev;
+          try {
+            existingRev = (await this.localDB.get(HYDRATION_MARKER_ID))._rev;
+          } catch {
+          }
+          await this.localDB.put({
+            _id: HYDRATION_MARKER_ID,
+            _rev: existingRev,
+            username: this._username,
+            hydratedAt: (/* @__PURE__ */ new Date()).toISOString()
+          });
+        } catch (e) {
+          logger.warn(`Could not write hydration marker for ${this._username}: ${e}`);
+        }
+      }
       static designDocs = [
         {
           _id: "_design/reviewCards",
@@ -6393,6 +6542,11 @@ Currently logged-in as ${this._username}.`
         } catch (e) {
           const err = e;
           if (err.status === 404) {
+            if (!this.canMaterializeDefaults()) {
+              throw new Error(
+                `Cannot read strategy state '${strategyKey}' for ${this._username}: the local mirror is unavailable (hydration state '${this._hydration.state}').`
+              );
+            }
             return null;
           }
           throw e;
@@ -6568,6 +6722,15 @@ var init_userOutcome = __esm({
   }
 });
 
+// src/core/types/hydration.ts
+var HYDRATION_MARKER_ID;
+var init_hydration = __esm({
+  "src/core/types/hydration.ts"() {
+    "use strict";
+    HYDRATION_MARKER_ID = "_local/hydration";
+  }
+});
+
 // src/core/bulkImport/cardProcessor.ts
 var import_common16;
 var init_cardProcessor = __esm({
@@ -6937,6 +7100,7 @@ var init_core = __esm({
     init_user();
     init_strategyState();
     init_userOutcome();
+    init_hydration();
     init_Loggable();
     init_util();
     init_navigators();