dexie-cloud-addon 4.1.0-alpha.10 → 4.1.0-alpha.13

package/dist/umd/service-worker.js

@@ -8,7 +8,7 @@
  *
  * ==========================================================================
  *
- * Version 4.1.0-alpha.10, Wed Oct 16 2024
+ * Version 4.1.0-alpha.13, Thu Oct 17 2024
  *
  * https://dexie.org
  *
@@ -4755,6 +4755,7 @@
     }
 
     function applyYServerMessages(yMessages, db) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const result = {};
             for (const m of yMessages) {
@@ -4786,7 +4787,24 @@
                         // See my question in https://discuss.yjs.dev/t/generate-an-inverse-update/2765
                         console.debug(`Y update rejected. Deleting it.`);
                         const utbl = getUpdatesTable(db, m.table, m.prop);
-                        yield utbl.delete(m.i);
+                        // Delete the rejected update and all local updates since (avoid holes in the CRDT)
+                        // 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 => {
+                                // @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 => Dexie.cmp(u.k, primaryKey) === 0 && ((u.f || 0) & 1) === 1)
+                                    .delete();
+                            });
+                            // Destroy active doc
+                            const activeDoc = Dexie.DexieYProvider.getDocCache(db.dx).find(m.table, primaryKey, m.prop);
+                            if (activeDoc)
+                                activeDoc.destroy(); // Destroy the document so that editors don't continue to work on it
+                        }
                         break;
                     }
                     case 'in-sync': {
@@ -6306,8 +6324,7 @@
                                 outstandingTransactions.next(outstandingTransactions.value);
                             };
                             const txComplete = () => {
-                                if (tx.mutationsAdded &&
-                                    !isEagerSyncDisabled(db)) {
+                                if (tx.mutationsAdded && !isEagerSyncDisabled(db)) {
                                     triggerSync(db, 'push');
                                 }
                                 removeTransaction();
@@ -6389,26 +6406,107 @@
                                     : mutateAndLog(req);
                             } }));
                         function mutateAndLog(req) {
+                            var _a, _b;
                             const trans = req.trans;
-                            trans.mutationsAdded = true;
+                            const unsyncedProps = (_b = (_a = db.cloud.options) === null || _a === void 0 ? void 0 : _a.unsyncedProperties) === null || _b === void 0 ? void 0 : _b[tableName];
                             const { txid, currentUser: { userId }, } = trans;
                             const { type } = req;
                             const opNo = ++trans.opCount;
+                            function stripChangeSpec(changeSpec) {
+                                if (!unsyncedProps)
+                                    return changeSpec;
+                                let rv = changeSpec;
+                                for (const keyPath of Object.keys(changeSpec)) {
+                                    if (unsyncedProps.some((p) => keyPath === p || keyPath.startsWith(p + '.'))) {
+                                        if (rv === changeSpec)
+                                            rv = Object.assign({}, changeSpec); // clone on demand
+                                        delete rv[keyPath];
+                                    }
+                                }
+                                return rv;
+                            }
                             return table.mutate(req).then((res) => {
+                                var _a;
                                 const { numFailures: hasFailures, failures } = res;
                                 let keys = type === 'delete' ? req.keys : res.results;
                                 let values = 'values' in req ? req.values : [];
-                                let updates = 'updates' in req && req.updates;
+                                let changeSpec = 'changeSpec' in req ? req.changeSpec : undefined;
+                                let updates = 'updates' in req ? req.updates : undefined;
                                 if (hasFailures) {
                                     keys = keys.filter((_, idx) => !failures[idx]);
                                     values = values.filter((_, idx) => !failures[idx]);
                                 }
+                                if (unsyncedProps) {
+                                    // Filter out unsynced properties
+                                    values = values.map((value) => {
+                                        const newValue = Object.assign({}, value);
+                                        for (const prop of unsyncedProps) {
+                                            delete newValue[prop];
+                                        }
+                                        return newValue;
+                                    });
+                                    if (changeSpec) {
+                                        // modify operation with criteria and changeSpec.
+                                        // We must strip out unsynced properties from changeSpec.
+                                        // We deal with criteria later.
+                                        changeSpec = stripChangeSpec(changeSpec);
+                                        if (Object.keys(changeSpec).length === 0) {
+                                            // Nothing to change on server
+                                            return res;
+                                        }
+                                    }
+                                    if (updates) {
+                                        let strippedChangeSpecs = updates.changeSpecs.map(stripChangeSpec);
+                                        let newUpdates = {
+                                            keys: [],
+                                            changeSpecs: [],
+                                        };
+                                        const validKeys = new Dexie.RangeSet();
+                                        let anyChangeSpecBecameEmpty = false;
+                                        for (let i = 0, l = strippedChangeSpecs.length; i < l; ++i) {
+                                            if (Object.keys(strippedChangeSpecs[i]).length > 0) {
+                                                newUpdates.keys.push(updates.keys[i]);
+                                                newUpdates.changeSpecs.push(strippedChangeSpecs[i]);
+                                                validKeys.addKey(updates.keys[i]);
+                                            }
+                                            else {
+                                                anyChangeSpecBecameEmpty = true;
+                                            }
+                                        }
+                                        updates = newUpdates;
+                                        if (anyChangeSpecBecameEmpty) {
+                                            // Some keys were stripped. We must also strip them from keys and values
+                                            let newKeys = [];
+                                            let newValues = [];
+                                            for (let i = 0, l = keys.length; i < l; ++i) {
+                                                if (validKeys.hasKey(keys[i])) {
+                                                    newKeys.push(keys[i]);
+                                                    newValues.push(values[i]);
+                                                }
+                                            }
+                                            keys = newKeys;
+                                            values = newValues;
+                                        }
+                                    }
+                                }
                                 const ts = Date.now();
                                 // Canonicalize req.criteria.index to null if it's on the primary key.
-                                const criteria = 'criteria' in req && req.criteria
+                                let criteria = 'criteria' in req && req.criteria
                                     ? Object.assign(Object.assign({}, req.criteria), { index: req.criteria.index === schema.primaryKey.keyPath // Use null to inform server that criteria is on primary key
                                             ? null // This will disable the server from trying to log consistent operations where it shouldnt.
                                             : req.criteria.index }) : undefined;
+                                if (unsyncedProps && (criteria === null || criteria === void 0 ? void 0 : criteria.index)) {
+                                    const keyPaths = (_a = schema.indexes.find((idx) => idx.name === criteria.index)) === null || _a === void 0 ? void 0 : _a.keyPath;
+                                    const involvedProps = keyPaths
+                                        ? typeof keyPaths === 'string'
+                                            ? [keyPaths]
+                                            : keyPaths
+                                        : [];
+                                    if (involvedProps.some((p) => unsyncedProps === null || unsyncedProps === void 0 ? void 0 : unsyncedProps.includes(p))) {
+                                        // Don't log criteria on unsynced properties as the server could not test them.
+                                        criteria = undefined;
+                                    }
+                                }
                                 const mut = req.type === 'delete'
                                     ? {
                                         type: 'delete',
@@ -6429,7 +6527,7 @@
                                             userId,
                                             values,
                                         }
-                                        : criteria && req.changeSpec
+                                        : criteria && changeSpec
                                             ? {
                                                 // Common changeSpec for all keys
                                                 type: 'modify',
@@ -6437,30 +6535,41 @@
                                                 opNo,
                                                 keys,
                                                 criteria,
-                                                changeSpec: req.changeSpec,
+                                                changeSpec,
                                                 txid,
                                                 userId,
                                             }
-                                            : updates
+                                            : changeSpec
                                                 ? {
-                                                    // One changeSpec per key
+                                                    // In case criteria involved an unsynced property, we go for keys instead.
                                                     type: 'update',
                                                     ts,
                                                     opNo,
-                                                    keys: updates.keys,
-                                                    changeSpecs: updates.changeSpecs,
-                                                    txid,
-                                                    userId,
-                                                }
-                                                : {
-                                                    type: 'upsert',
-                                                    ts,
-                                                    opNo,
                                                     keys,
-                                                    values,
+                                                    changeSpecs: keys.map(() => changeSpec),
                                                     txid,
                                                     userId,
-                                                };
+                                                }
+                                                : updates
+                                                    ? {
+                                                        // One changeSpec per key
+                                                        type: 'update',
+                                                        ts,
+                                                        opNo,
+                                                        keys: updates.keys,
+                                                        changeSpecs: updates.changeSpecs,
+                                                        txid,
+                                                        userId,
+                                                    }
+                                                    : {
+                                                        type: 'upsert',
+                                                        ts,
+                                                        opNo,
+                                                        keys,
+                                                        values,
+                                                        txid,
+                                                        userId,
+                                                    };
                                 if ('isAdditionalChunk' in req && req.isAdditionalChunk) {
                                     mut.isAdditionalChunk = true;
                                 }
@@ -7807,125 +7916,137 @@
     function createYHandler(db) {
         return (provider) => {
             var _a;
-            const awap = getAwarenessLibrary(db);
             const doc = provider.doc;
-            const { parentTable, parentId, parentProp, updatesTable } = doc.meta;
+            const { parentTable } = doc.meta || {};
             if (!((_a = db.cloud.schema) === null || _a === void 0 ? void 0 : _a[parentTable].markedForSync)) {
                 return; // The table that holds the doc is not marked for sync - leave it to dexie. No syncing, no awareness.
             }
-            let awareness = new awap.Awareness(doc);
-            awarenessWeakMap.set(doc, awareness);
-            provider.awareness = awareness;
-            awareness.on('update', ({ added, updated, removed }, origin) => {
-                // Send the update
-                const changedClients = added.concat(updated).concat(removed);
-                const user = db.cloud.currentUser.value;
-                if (origin !== 'server' && user.isLoggedIn && !isEagerSyncDisabled(db)) {
-                    const update = awap.encodeAwarenessUpdate(awareness, changedClients);
+            let awareness;
+            Object.defineProperty(provider, "awareness", {
+                get() {
+                    if (awareness)
+                        return awareness;
+                    awarenessWeakMap.set(doc, awareness);
+                    awareness = createAwareness(db, doc, provider);
+                    return awareness;
+                }
+            });
+        };
+    }
+    function createAwareness(db, doc, provider) {
+        const { parentTable, parentId, parentProp, updatesTable } = doc.meta;
+        const awap = getAwarenessLibrary(db);
+        const awareness = new awap.Awareness(doc);
+        awareness.on('update', ({ added, updated, removed }, origin) => {
+            // Send the update
+            const changedClients = added.concat(updated).concat(removed);
+            const user = db.cloud.currentUser.value;
+            if (origin !== 'server' && user.isLoggedIn && !isEagerSyncDisabled(db)) {
+                const update = awap.encodeAwarenessUpdate(awareness, changedClients);
+                db.messageProducer.next({
+                    type: 'aware',
+                    table: parentTable,
+                    prop: parentProp,
+                    k: doc.meta.parentId,
+                    u: update,
+                });
+                if (provider.destroyed) {
+                    // We're called from awareness.on('destroy') that did
+                    // 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.
                     db.messageProducer.next({
-                        type: 'aware',
+                        type: 'doc-close',
                         table: parentTable,
                         prop: parentProp,
-                        k: doc.meta.parentId,
-                        u: update,
+                        k: doc.meta.parentId
                     });
-                    if (provider.destroyed) {
-                        // We're called from awareness.on('destroy') that did
-                        // 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.
-                        db.messageProducer.next({
-                            type: 'doc-close',
-                            table: parentTable,
-                            prop: parentProp,
-                            k: doc.meta.parentId
-                        });
-                    }
                 }
-            });
-            awareness.on('destroy', () => {
-                // Signal to server that this provider is destroyed (the update event will be triggered, which
-                // in turn will trigger db.messageProducer that will send the message to the server if WS is connected)
-                awap.removeAwarenessStates(awareness, [doc.clientID], 'provider destroyed');
-            });
-            // Now wait til document is loaded and then open the document on the server
-            provider.on('load', () => __awaiter(this, void 0, void 0, function* () {
+            }
+        });
+        awareness.on('destroy', () => {
+            // Signal to server that this provider is destroyed (the update event will be triggered, which
+            // in turn will trigger db.messageProducer that will send the message to the server if WS is connected)
+            awap.removeAwarenessStates(awareness, [doc.clientID], 'provider destroyed');
+        });
+        // Open the document on the server
+        (() => __awaiter(this, void 0, void 0, function* () {
+            if (provider.destroyed)
+                return;
+            let connected = false;
+            let currentFlowId = 1;
+            const subscription = db.cloud.webSocketStatus.subscribe((wsStatus) => {
                 if (provider.destroyed)
                     return;
-                let connected = false;
-                let currentFlowId = 1;
-                const subscription = db.cloud.webSocketStatus.subscribe((wsStatus) => {
-                    if (provider.destroyed)
+                // 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)) {
+                    ++currentFlowId;
+                    openDocumentOnServer().catch(error => {
+                        console.warn(`Error catched in createYHandler.ts: ${error}`);
+                    });
+                }
+            });
+            // Wait until WebSocket is connected
+            provider.addCleanupHandler(subscription);
+            /** Sends an 'doc-open' message to server whenever websocket becomes
+             * connected, or if it is already connected.
+             * The flow is aborted in case websocket is disconnected while querying
+             * information required to compute the state vector. Flow is also
+             * aborted in case document or provider has been destroyed during
+             * the async parts of the task.
+             *
+             * The state vector is only computed from the updates that have occured
+             * after the last full sync - which could very often be zero - in which
+             * 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
+             * 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) {
+                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);
+                    // After every await, check if we still should be working on this task.
+                    if (provider.destroyed || currentFlowId !== myFlow || !connected)
                         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)) {
-                        ++currentFlowId;
-                        openDocumentOnServer().catch(error => {
-                            console.warn(`Error catched in createYHandler.ts: ${error}`);
-                        });
+                    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,
+                    };
+                    const serverUpdatesSinceLastSync = yield yTbl
+                        .where('i')
+                        .between(receivedUntil, Infinity, false)
+                        .filter((update) => Dexie.cmp(update.k, parentId) === 0 && // Only updates for this document
+                        ((update.f || 0) & 1) === 0 // Don't include local changes
+                    )
+                        .toArray();
+                    // After every await, check if we still should be working on this task.
+                    if (provider.destroyed || currentFlowId !== myFlow || !connected)
+                        return;
+                    if (serverUpdatesSinceLastSync.length > 0) {
+                        const Y = $Y(db); // Get the Yjs library from Dexie constructor options
+                        const mergedUpdate = Y.mergeUpdatesV2(serverUpdatesSinceLastSync.map((update) => update.u));
+                        const stateVector = Y.encodeStateVectorFromUpdateV2(mergedUpdate);
+                        docOpenMsg.sv = stateVector;
                     }
+                    db.messageProducer.next(docOpenMsg);
                 });
-                // Wait until WebSocket is connected
-                provider.addCleanupHandler(subscription);
-                /** Sends an 'doc-open' message to server whenever websocket becomes
-                 * connected, or if it is already connected.
-                 * The flow is aborted in case websocket is disconnected while querying
-                 * information required to compute the state vector. Flow is also
-                 * aborted in case document or provider has been destroyed during
-                 * the async parts of the task.
-                 *
-                 * The state vector is only computed from the updates that have occured
-                 * after the last full sync - which could very often be zero - in which
-                 * 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
-                 * 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) {
-                    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);
-                        // 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,
-                        };
-                        const serverUpdatesSinceLastSync = yield yTbl
-                            .where('i')
-                            .between(receivedUntil, Infinity, false)
-                            .filter((update) => Dexie.cmp(update.k, parentId) === 0 && // Only updates for this document
-                            ((update.f || 0) & 1) === 0 // Don't include local changes
-                        )
-                            .toArray();
-                        // After every await, check if we still should be working on this task.
-                        if (provider.destroyed || currentFlowId !== myFlow || !connected)
-                            return;
-                        if (serverUpdatesSinceLastSync.length > 0) {
-                            const Y = $Y(db); // Get the Yjs library from Dexie constructor options
-                            const mergedUpdate = Y.mergeUpdatesV2(serverUpdatesSinceLastSync.map((update) => update.u));
-                            const stateVector = Y.encodeStateVectorFromUpdateV2(mergedUpdate);
-                            docOpenMsg.sv = stateVector;
-                        }
-                        db.messageProducer.next(docOpenMsg);
-                    });
-                }
-            }));
-        };
+            }
+        }))();
+        return awareness;
     }
 
     const DEFAULT_OPTIONS = {
@@ -7968,7 +8089,7 @@
         const syncComplete = new rxjs.Subject();
         dexie.cloud = {
             // @ts-ignore
-            version: "4.1.0-alpha.10",
+            version: "4.1.0-alpha.13",
             options: Object.assign({}, DEFAULT_OPTIONS),
             schema: null,
             get currentUserId() {
@@ -8270,7 +8391,7 @@
         }
     }
     // @ts-ignore
-    dexieCloud.version = "4.1.0-alpha.10";
+    dexieCloud.version = "4.1.0-alpha.13";
     Dexie.Cloud = dexieCloud;
 
     // In case the SW lives for a while, let it reuse already opened connections: