@jcbuisson/express-x-client 3.1.12 → 3.1.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcbuisson/express-x-client",
-  "version": "3.1.12",
+  "version": "3.1.14",
   "type": "module",
   "description": "Client library for ExpressX framework",
   "main": "src/client.mts",

package/src/client.mts

@@ -205,9 +205,9 @@ export function offlinePlugin(app) {
 
       app.service(modelName).on('updateWithMeta', async ([value, meta]) => {
          console.log(`${modelName} EVENT updateWithMeta`, value);
-         // value may be undefined when the server's UPDATE RETURNING yielded 0 rows
+         // value may be undefined when the server's update yielded 0 rows
          // (concurrent delete race: record was removed between the sync's findMany
-         // snapshot and the actual UPDATE).  Guard to avoid a TypeError crash that
+         // snapshot and the actual update). Guard to avoid a TypeError crash that
          // would prevent db.metadata.put(meta) from running.
          if (value?.uid) await db.values.put(value);
          await db.metadata.put(meta);
@@ -215,12 +215,12 @@ export function offlinePlugin(app) {
 
       app.service(modelName).on('deleteWithMeta', async ([value, meta]) => {
          console.log(`${modelName} EVENT deleteWithMeta`, value)
-         // value may be undefined when the server's DELETE RETURNING yielded 0 rows
-         // (double-delete race).  Guard before accessing .uid.
+         // value may be undefined when the server's delete yielded 0 rows
+         // (double-delete race).
          if (value?.uid) await db.values.delete(value.uid)
          // delete, not put: synchronize() step 2 also deletes idbMetadata for the same
-         // uid.  If the pub/sub handler fires AFTER step 2, put() would re-create the
-         // metadata row as a permanent orphan.  delete() is idempotent regardless of order.
+         // uid. If the pub/sub handler fires AFTER step 2, put() would re-create the
+         // metadata row as a permanent orphan. delete() is idempotent regardless of order.
          await db.metadata.delete(meta.uid)
       });
 
@@ -233,10 +233,11 @@ export function offlinePlugin(app) {
          // optimistic update
          const now = new Date()
          await db.values.add({ uid, ...data })
-         await db.metadata.add({ uid, created_at: now })
+         await db.metadata.add({ uid, created_at: now, __dirty__: true })
          // execute on server, asynchronously, if connection is active
          if (app.isConnected) {
             app.service(modelName).createWithMeta(uid, data, now)
+            .then(result => applyCreateAcknowledgement(uid, now, result))
             .catch(async err => {
                console.log(`*** err sync ${modelName} create`, err)
                // rollback
@@ -247,16 +248,49 @@ export function offlinePlugin(app) {
          return await db.values.get(uid)
       }
 
+      async function applyCreateAcknowledgement(uid, requestCreatedAt, result) {
+         const currentMetadata = await db.metadata.get(uid)
+         if (!currentMetadata || !sameTimestamp(currentMetadata.created_at, requestCreatedAt)) return
+         const [value, meta] = Array.isArray(result) ? result : []
+         if (value?.uid) await db.values.put(value)
+         if (meta?.uid)
+            await db.metadata.put({ ...meta, __dirty__: false })
+         else
+            await db.metadata.update(uid, { __dirty__: false })
+      }
+
+      async function applyUpdateAcknowledgement(uid, requestUpdatedAt, result) {
+         const currentMetadata = await db.metadata.get(uid)
+         if (!currentMetadata || !sameTimestamp(currentMetadata.updated_at, requestUpdatedAt)) return
+         const [value, meta] = Array.isArray(result) ? result : []
+         if (value?.uid) await db.values.put(value)
+         if (meta?.uid)
+            await db.metadata.put({ ...meta, __dirty__: false })
+         else
+            await db.metadata.update(uid, { __dirty__: false })
+      }
+
+      async function applyDeleteAcknowledgement(uid, requestDeletedAt, result) {
+         const currentMetadata = await db.metadata.get(uid)
+         if (!currentMetadata || !sameTimestamp(currentMetadata.deleted_at, requestDeletedAt)) return
+         const [, meta] = Array.isArray(result) ? result : []
+         if (meta?.uid)
+            await db.metadata.put({ ...meta, __dirty__: false })
+         else
+            await db.metadata.update(uid, { __dirty__: false })
+      }
+
       const update = async (uid: string, data: object) => {
          const previousValue = { ...(await db.values.get(uid)) }
          const previousMetadata = { ...(await db.metadata.get(uid)) }
          // optimistic update of cache
          const now = new Date()
          await db.values.update(uid, data)
-         await db.metadata.update(uid, { updated_at: now })
+         await db.metadata.update(uid, { updated_at: now, __dirty__: true })
          // execute on server, asynchronously, if connection is active
          if (app.isConnected) {
             app.service(modelName).updateWithMeta(uid, data, now)
+            .then(result => applyUpdateAcknowledgement(uid, now, result))
             .catch(async err => {
                console.log(`*** err sync ${modelName} update`, err)
                // rollback
@@ -266,7 +300,10 @@ export function offlinePlugin(app) {
                // Restoring the full previousMetadata snapshot would overwrite any
                // deleted_at that remove() set while the socket round-trip was in flight,
                // silently un-deleting the record.
-               await db.metadata.update(uid, { updated_at: previousMetadata.updated_at ?? null })
+               await db.metadata.update(uid, {
+                  updated_at: previousMetadata.updated_at ?? null,
+                  __dirty__: previousMetadata.__dirty__ ?? false,
+               })
             })
          }
          return await db.values.get(uid)
@@ -276,15 +313,16 @@ export function offlinePlugin(app) {
          const deleted_at = new Date()
          // optimistic delete in cache
          await db.values.update(uid, { __deleted__: true })
-         await db.metadata.update(uid, { deleted_at })
+         await db.metadata.update(uid, { deleted_at, __dirty__: true })
          // and in database, if connected
          if (app.isConnected) {
             app.service(modelName).deleteWithMeta(uid, deleted_at)
+            .then(result => applyDeleteAcknowledgement(uid, deleted_at, result))
             .catch(async err => {
                console.log(`*** err sync ${modelName} remove`, err)
                // rollback
                await db.values.update(uid, { __deleted__: null })
-               await db.metadata.update(uid, { deleted_at: null })
+               await db.metadata.update(uid, { deleted_at: null, __dirty__: false })
             })
          }
       }
@@ -439,6 +477,12 @@ export function offlinePlugin(app) {
                clientMetadataDict[value.uid] = {}
             }
          }
+         const dirtyMetadataList = await idbMetadata.filter(metadata => metadata.__dirty__).toArray()
+         for (const metadata of dirtyMetadataList) {
+            if (metadata.uid in clientMetadataDict) continue
+            const value = await idbValues.get(metadata.uid)
+            if (value || metadata.deleted_at) clientMetadataDict[metadata.uid] = metadata
+         }
 
          // call sync service on `where` perimeter
          const { addClient, updateClient, deleteClient, addDatabase, updateDatabase } =
@@ -458,7 +502,7 @@ export function offlinePlugin(app) {
                   // add() would throw ConstraintError and abort the entire transaction,
                   // silently dropping every other addClient record in the batch.
                   await idbValues.put(value)
-                  await idbMetadata.put(metaData)
+                  await idbMetadata.put({ ...metaData, __dirty__: false })
                }
             })
          }
@@ -476,7 +520,7 @@ export function offlinePlugin(app) {
             const value = { ...elt }
             delete value.__deleted__
             await idbValues.put(value)
-            await idbMetadata.put({ uid: elt.uid, ...serverMeta })
+            await idbMetadata.put({ uid: elt.uid, ...serverMeta, __dirty__: false })
          }
 
          // 4- create elements of `addDatabase` with full data from cache
@@ -491,7 +535,10 @@ export function offlinePlugin(app) {
             delete fullValue.uid
             delete fullValue.__deleted__
             try {
-               await app.service(modelName).createWithMeta(elt.uid, fullValue, elt.created_at)
+               const result = await app.service(modelName).createWithMeta(elt.uid, fullValue, elt.created_at)
+               const serverMeta = Array.isArray(result) ? result[1] : null
+               if (serverMeta?.uid) await idbMetadata.put({ ...serverMeta, __dirty__: false })
+               else await idbMetadata.update(elt.uid, { __dirty__: false })
             } catch(err) {
                console.log("*** err sync user addDatabase", err, elt.uid, fullValue, elt.created_at)
                // rollback
@@ -508,7 +555,10 @@ export function offlinePlugin(app) {
             delete fullValue.uid
             delete fullValue.__deleted__
             try {
-               await app.service(modelName).updateWithMeta(elt.uid, fullValue, elt.updated_at)
+               const result = await app.service(modelName).updateWithMeta(elt.uid, fullValue, elt.updated_at)
+               const serverMeta = Array.isArray(result) ? result[1] : null
+               if (serverMeta?.uid) await idbMetadata.put({ ...serverMeta, __dirty__: false })
+               else await idbMetadata.update(elt.uid, { __dirty__: false })
             } catch(err) {
                console.log("*** err sync user updateDatabase", err)
                // Leave client's local version intact; it will be retried on the next sync.
@@ -609,6 +659,11 @@ function stringifyWithSortedKeys(obj, space = null) {
 }
 // console.log('stringifyWithSortedKeys({ age: 30, name: "Alice", data: { city: "Paris", color: "red" }})', stringifyWithSortedKeys({ age: 30, name: "Alice", data: { city: "Paris", color: "red" } }))
 
+function sameTimestamp(a, b) {
+   if (!a || !b) return a === b
+   return new Date(a).getTime() === new Date(b).getTime()
+}
+
 export class Mutex {
    constructor() {
       this.locked = false;