dexie-cloud-addon 4.1.0-alpha.20 → 4.1.0-alpha.23

package/dist/modern/db/entities/PersistedSyncState.d.ts

@@ -1,5 +1,6 @@
 export interface PersistedSyncState {
     serverRevision?: any;
+    yServerRevision?: string;
     latestRevisions: {
         [tableName: string]: number;
     };

package/dist/modern/dexie-cloud-addon.js

@@ -8,7 +8,7 @@
  *
  * ==========================================================================
  *
- * Version 4.1.0-alpha.20, Wed Oct 23 2024
+ * Version 4.1.0-alpha.23, Wed Nov 27 2024
  *
  * https://dexie.org
  *
@@ -17,7 +17,7 @@
  */
 
 import Dexie, { PropModification, cmp, DexieYProvider, RangeSet, liveQuery } from 'dexie';
-import { firstValueFrom, from as from$1, filter as filter$1, Observable as Observable$1, BehaviorSubject, Subject, fromEvent, of, merge, switchMap as switchMap$1, tap as tap$1, mergeMap as mergeMap$1, Subscription as Subscription$1, throwError, combineLatest, map as map$1, share, timer as timer$1 } from 'rxjs';
+import { firstValueFrom, from as from$1, filter as filter$1, Observable as Observable$1, BehaviorSubject, Subject, fromEvent, of, merge, switchMap as switchMap$1, tap as tap$1, mergeMap as mergeMap$1, Subscription as Subscription$1, throwError, combineLatest, map as map$1, share, timer as timer$1, startWith as startWith$1 } from 'rxjs';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -979,13 +979,20 @@ const writeAny = (encoder, data) => {
 function encodeYMessage(msg) {
     const encoder = new Encoder();
     writeVarString(encoder, msg.type);
-    writeVarString(encoder, msg.table);
-    writeVarString(encoder, msg.prop);
+    if ('table' in msg)
+        writeVarString(encoder, msg.table);
+    if ('prop' in msg)
+        writeVarString(encoder, msg.prop);
     switch (msg.type) {
         case 'u-ack':
         case 'u-reject':
             writeBigUint64(encoder, BigInt(msg.i));
             break;
+        case 'outdated-server-rev':
+            break;
+        case 'y-complete-sync-done':
+            writeVarString(encoder, msg.yServerRev);
+            break;
         default:
             writeAny(encoder, msg.k);
             switch (msg.type) {
@@ -1329,6 +1336,12 @@ const readAny = decoder => readAnyLookupTable[127 - readUint8(decoder)](decoder)
 function decodeYMessage(a) {
     const decoder = new Decoder(a);
     const type = readVarString(decoder);
+    if (type === 'outdated-server-rev') {
+        return { type };
+    }
+    if (type === 'y-complete-sync-done') {
+        return { type, yServerRev: readVarString(decoder) };
+    }
     const table = readVarString(decoder);
     const prop = readVarString(decoder);
     switch (type) {
@@ -3414,10 +3427,10 @@ function formatAsPem(str) {
 }
 
 // Emulate true-private property db. Why? So it's not stored in DB.
-const wm$1 = new WeakMap();
+const wm$2 = new WeakMap();
 class AuthPersistedContext {
     constructor(db, userLogin) {
-        wm$1.set(this, db);
+        wm$2.set(this, db);
         Object.assign(this, userLogin);
     }
     static load(db, userId) {
@@ -3434,7 +3447,7 @@ class AuthPersistedContext {
     }
     save() {
         return __awaiter(this, void 0, void 0, function* () {
-            const db = wm$1.get(this);
+            const db = wm$2.get(this);
             db.table("$logins").put(this);
         });
     }
@@ -4715,6 +4728,7 @@ function syncWithServer(changes, y, syncState, baseRevs, db, databaseUrl, schema
             lastPull: syncState
                 ? {
                     serverRevision: syncState.serverRevision,
+                    yServerRevision: syncState.yServerRevision,
                     realms: syncState.realms,
                     inviteRealms: syncState.inviteRealms,
                 }
@@ -5060,12 +5074,14 @@ function getUpdatesTable(db, table, ydocProp) {
 function applyYServerMessages(yMessages, db) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
-        const result = {};
+        const receivedUntils = {};
+        let resyncNeeded = false;
+        let yServerRevision;
         for (const m of yMessages) {
             switch (m.type) {
                 case 'u-s': {
                     const utbl = getUpdatesTable(db, m.table, m.prop);
-                    result[utbl.name] = yield utbl.add({
+                    receivedUntils[utbl.name] = yield utbl.add({
                         k: m.k,
                         u: m.u,
                     });
@@ -5094,13 +5110,13 @@ function applyYServerMessages(yMessages, db) {
                     // and destroy it's open document if there is one.
                     const primaryKey = (_a = (yield utbl.get(m.i))) === null || _a === void 0 ? void 0 : _a.k;
                     if (primaryKey != null) {
-                        yield db.transaction('rw', utbl, tx => {
+                        yield db.transaction('rw', utbl, (tx) => {
                             // @ts-ignore
                             tx.idbtrans._rejecting_y_ypdate = true; // Inform ydoc triggers that we delete because of a rejection and not GC
                             return utbl
                                 .where('i')
                                 .aboveOrEqual(m.i)
-                                .filter(u => cmp(u.k, primaryKey) === 0 && ((u.f || 0) & 1) === 1)
+                                .filter((u) => cmp(u.k, primaryKey) === 0 && ((u.f || 0) & 1) === 1)
                                 .delete();
                         });
                         // Destroy active doc
@@ -5117,13 +5133,24 @@ function applyYServerMessages(yMessages, db) {
                     }
                     break;
                 }
+                case 'y-complete-sync-done': {
+                    yServerRevision = m.yServerRev;
+                    break;
+                }
+                case 'outdated-server-rev':
+                    resyncNeeded = true;
+                    break;
             }
         }
-        return result;
+        return {
+            receivedUntils,
+            resyncNeeded,
+            yServerRevision
+        };
     });
 }
 
-function updateYSyncStates(lastUpdateIdsBeforeSync, receivedUntilsAfterSync, db, serverRevision) {
+function updateYSyncStates(lastUpdateIdsBeforeSync, receivedUntilsAfterSync, db) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c, _d, _e;
         // We want to update unsentFrom for each yTable to the value specified in first argument
@@ -5172,14 +5199,12 @@ function updateYSyncStates(lastUpdateIdsBeforeSync, receivedUntilsAfterSync, db,
                     yield db.table(yTable).add({
                         i: DEXIE_CLOUD_SYNCER_ID,
                         unsentFrom,
-                        receivedUntil,
-                        serverRev: serverRevision,
+                        receivedUntil
                     });
                 }
                 else {
                     state.unsentFrom = Math.max(unsentFrom, state.unsentFrom || 1);
                     state.receivedUntil = Math.max(receivedUntil, state.receivedUntil || 0);
-                    state.serverRev = serverRevision;
                     yield db.table(yTable).put(state);
                 }
             }));
@@ -5515,6 +5540,7 @@ function _sync(db_1, options_1, schema_1) {
             newSyncState.realms = res.realms;
             newSyncState.inviteRealms = res.inviteRealms;
             newSyncState.serverRevision = res.serverRevision;
+            newSyncState.yServerRevision = res.serverRevision;
             newSyncState.timestamp = new Date();
             delete newSyncState.error;
             const filteredChanges = filterServerChangesThroughAddedClientChanges(res.changes, addedClientChanges);
@@ -5526,11 +5552,17 @@ function _sync(db_1, options_1, schema_1) {
                 //
                 // apply yMessages
                 //
-                const receivedUntils = yield applyYServerMessages(res.yMessages, db);
+                const { receivedUntils, resyncNeeded, yServerRevision } = yield applyYServerMessages(res.yMessages, db);
+                if (yServerRevision) {
+                    newSyncState.yServerRevision = yServerRevision;
+                }
                 //
                 // update Y SyncStates
                 //
-                yield updateYSyncStates(lastUpdateIds, receivedUntils, db, res.serverRevision);
+                yield updateYSyncStates(lastUpdateIds, receivedUntils, db);
+                if (resyncNeeded) {
+                    newSyncState.yDownloadedRealms = {}; // Will trigger a full download of Y-documents below...
+                }
             }
             //
             // Update regular syncState
@@ -5823,7 +5855,7 @@ function MessagesFromServerConsumer(db) {
     };
 }
 
-const wm = new WeakMap();
+const wm$1 = new WeakMap();
 const DEXIE_CLOUD_SCHEMA = {
     members: '@id, [userId+realmId], [email+realmId], realmId',
     roles: '[realmId+name]',
@@ -5837,7 +5869,7 @@ let static_counter = 0;
 function DexieCloudDB(dx) {
     if ('vip' in dx)
         dx = dx['vip']; // Avoid race condition. Always map to a vipped dexie that don't block during db.on.ready().
-    let db = wm.get(dx.cloud);
+    let db = wm$1.get(dx.cloud);
     if (!db) {
         const localSyncEvent = new Subject();
         let syncStateChangedEvent = new BroadcastedAndLocalEvent(`syncstatechanged-${dx.name}`);
@@ -5925,7 +5957,7 @@ function DexieCloudDB(dx) {
         Object.assign(db, helperMethods);
         db.messageConsumer = MessagesFromServerConsumer(db);
         db.messageProducer = new Subject();
-        wm.set(dx.cloud, db);
+        wm$1.set(dx.cloud, db);
     }
     return db;
 }
@@ -6785,9 +6817,7 @@ function createYClientUpdateObservable(db) {
     // If messageProducer emits empty array, nothing is emitted
     // but if messageProducer emits array of messages, they are
     // emitted one by one.
-    mergeMap$1((messages) => messages), tap$1((message) => {
-        console.debug('dexie-cloud emitting y-c', message);
-    }));
+    mergeMap$1((messages) => messages));
 }
 
 function getAwarenessLibrary(db) {
@@ -6800,6 +6830,23 @@ function getAwarenessLibrary(db) {
 const awarenessWeakMap = new WeakMap();
 const getDocAwareness = (doc) => awarenessWeakMap.get(doc);
 
+const wm = new WeakMap();
+/** A property (package-private) on Y.Doc that is used
+ * to signal that the server wants us to send a 'doc-open' message
+ * to the server for this document.
+ *
+ * @param doc
+ * @returns
+ */
+function getOpenDocSignal(doc) {
+    let signal = wm.get(doc);
+    if (!signal) {
+        signal = new Subject();
+        wm.set(doc, signal);
+    }
+    return signal;
+}
+
 const SERVER_PING_TIMEOUT = 20000;
 const CLIENT_PING_INTERVAL = 30000;
 const FAIL_RETRY_WAIT_TIME = 60000;
@@ -6962,9 +7009,6 @@ class WSConnection extends Subscription$1 {
                     if (msg.type === 'error') {
                         throw new Error(`Error message from dexie-cloud: ${msg.error}`);
                     }
-                    else if (msg.type === 'rev') {
-                        this.rev = msg.rev; // No meaning but seems reasonable.
-                    }
                     else if (msg.type === 'aware') {
                         const docCache = DexieYProvider.getDocCache(this.db.dx);
                         const doc = docCache.find(msg.table, msg.k, msg.prop);
@@ -6979,7 +7023,19 @@ class WSConnection extends Subscription$1 {
                     else if (msg.type === 'u-ack' || msg.type === 'u-reject' || msg.type === 'u-s' || msg.type === 'in-sync') {
                         applyYServerMessages([msg], this.db);
                     }
+                    else if (msg.type === 'doc-open') {
+                        const docCache = DexieYProvider.getDocCache(this.db.dx);
+                        const doc = docCache.find(msg.table, msg.k, msg.prop);
+                        if (doc) {
+                            getOpenDocSignal(doc).next(); // Make yHandler reopen the document on server.
+                        }
+                    }
+                    else if (msg.type === 'outdated-server-rev' || msg.type === 'y-complete-sync-done') {
+                        // Won't happen but need this for typing.
+                        throw new Error('Outdated server revision or y-complete-sync-done not expected over WebSocket - only in sync using fetch()');
+                    }
                     else if (msg.type !== 'pong') {
+                        // Forward the request to our subscriber, wich is in messageFromServerQueue.ts (via connectWebSocket's subscribe() at the end!)
                         this.subscriber.next(msg);
                     }
                 }
@@ -7016,6 +7072,10 @@ class WSConnection extends Subscription$1 {
                         }
                         console.debug('dexie-cloud WebSocket send', msg.type, msg);
                         if (msg.type === 'ready') {
+                            // Ok, we are certain to have stored everything up until revision msg.rev.
+                            // Update this.rev in case of reconnect - remember where we were and don't just start over!
+                            this.rev = msg.rev;
+                            // ... and then send along the request to the server so it would also be updated!
                             (_a = this.ws) === null || _a === void 0 ? void 0 : _a.send(TSON.stringify(msg));
                         }
                         else {
@@ -7923,14 +7983,14 @@ function createYHandler(db) {
             return; // The table that holds the doc is not marked for sync - leave it to dexie. No syncing, no awareness.
         }
         let awareness;
-        Object.defineProperty(provider, "awareness", {
+        Object.defineProperty(provider, 'awareness', {
             get() {
                 if (awareness)
                     return awareness;
                 awareness = createAwareness(db, doc, provider);
                 awarenessWeakMap.set(doc, awareness);
                 return awareness;
-            }
+            },
         });
     };
 }
@@ -7938,6 +7998,7 @@ function createAwareness(db, doc, provider) {
     const { parentTable, parentId, parentProp, updatesTable } = doc.meta;
     const awap = getAwarenessLibrary(db);
     const awareness = new awap.Awareness(doc);
+    const reopenDocSignal = getOpenDocSignal(doc);
     awareness.on('update', ({ added, updated, removed }, origin) => {
         // Send the update
         const changedClients = added.concat(updated).concat(removed);
@@ -7953,7 +8014,7 @@ function createAwareness(db, doc, provider) {
             });
             if (provider.destroyed) {
                 // We're called from awareness.on('destroy') that did
-                // removeAwarenessStates. 
+                // removeAwarenessStates.
                 // It's time to also send the doc-close message that dexie-cloud understands
                 // and uses to stop subscribing for updates and awareness updates and brings
                 // down the cached information in memory on the WS connection for this.
@@ -7961,7 +8022,7 @@ function createAwareness(db, doc, provider) {
                     type: 'doc-close',
                     table: parentTable,
                     prop: parentProp,
-                    k: doc.meta.parentId
+                    k: doc.meta.parentId,
                 });
             }
         }
@@ -7977,16 +8038,21 @@ function createAwareness(db, doc, provider) {
             return;
         let connected = false;
         let currentFlowId = 1;
-        const subscription = db.cloud.webSocketStatus.subscribe((wsStatus) => {
+        const subscription = combineLatest([
+            db.cloud.webSocketStatus, // Wake up when webSocket status changes
+            reopenDocSignal.pipe(startWith$1(null)), // Wake up when reopenDocSignal emits
+        ]).subscribe(([wsStatus]) => {
             if (provider.destroyed)
                 return;
             // Keep "connected" state in a variable so we can check it after async operations
             connected = wsStatus === 'connected';
             // We are or got connected. Open the document on the server.
             const user = db.cloud.currentUser.value;
-            if (wsStatus === "connected" && user.isLoggedIn && !isEagerSyncDisabled(db)) {
+            if (wsStatus === 'connected' &&
+                user.isLoggedIn &&
+                !isEagerSyncDisabled(db)) {
                 ++currentFlowId;
-                openDocumentOnServer().catch(error => {
+                openDocumentOnServer().catch((error) => {
                     console.warn(`Error catched in createYHandler.ts: ${error}`);
                 });
             }
@@ -8005,27 +8071,35 @@ function createAwareness(db, doc, provider) {
          * case no state vector is sent (then the server already knows us by
          * revision)
          *
-         * When server gets the doc-open message, it will authorized us for
+         * When server gets the doc-open message, it will authorize us for
          * whether we are allowed to read / write to this document, and then
          * keep the cached information in memory on the WS connection for this
          * particular document, as well as subscribe to updates and awareness updates
          * from other clients on the document.
          */
-        function openDocumentOnServer(wsStatus) {
+        function openDocumentOnServer() {
             return __awaiter(this, void 0, void 0, function* () {
                 const myFlow = currentFlowId; // So we can abort when a new flow is started
                 const yTbl = db.table(updatesTable);
-                const syncState = yield yTbl.get(DEXIE_CLOUD_SYNCER_ID);
+                const syncStateTbl = db.$syncState;
+                const [receivedUntil, yServerRev] = yield db.transaction('r', syncStateTbl, yTbl, () => __awaiter(this, void 0, void 0, function* () {
+                    const syncState = yield yTbl.get(DEXIE_CLOUD_SYNCER_ID);
+                    const persistedSyncState = yield syncStateTbl.get('syncState');
+                    return [
+                        (syncState === null || syncState === void 0 ? void 0 : syncState.receivedUntil) || 0,
+                        (persistedSyncState === null || persistedSyncState === void 0 ? void 0 : persistedSyncState.yServerRevision) ||
+                            (persistedSyncState === null || persistedSyncState === void 0 ? void 0 : persistedSyncState.serverRevision),
+                    ];
+                }));
                 // After every await, check if we still should be working on this task.
                 if (provider.destroyed || currentFlowId !== myFlow || !connected)
                     return;
-                const receivedUntil = (syncState === null || syncState === void 0 ? void 0 : syncState.receivedUntil) || 0;
                 const docOpenMsg = {
                     type: 'doc-open',
                     table: parentTable,
                     prop: parentProp,
                     k: parentId,
-                    serverRev: syncState === null || syncState === void 0 ? void 0 : syncState.serverRev,
+                    serverRev: yServerRev,
                 };
                 const serverUpdatesSinceLastSync = yield yTbl
                     .where('i')
@@ -8097,7 +8171,7 @@ function dexieCloud(dexie) {
     const syncComplete = new Subject();
     dexie.cloud = {
         // @ts-ignore
-        version: "4.1.0-alpha.20",
+        version: "4.1.0-alpha.23",
         options: Object.assign({}, DEFAULT_OPTIONS),
         schema: null,
         get currentUserId() {
@@ -8399,7 +8473,7 @@ function dexieCloud(dexie) {
     }
 }
 // @ts-ignore
-dexieCloud.version = "4.1.0-alpha.20";
+dexieCloud.version = "4.1.0-alpha.23";
 Dexie.Cloud = dexieCloud;
 
 const ydocTriggers = {};