@anfenn/dync 1.0.33 → 1.1.1

package/README.md

@@ -45,7 +45,7 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
         ```
 
 - Sync some or all tables with any backend in 2 ways:
-    - Option 1: Map remote api CRUD urls to a local collection:
+    - Option 1: Map remote api CRUD urls to a local table:
 
         ```ts
         const db = new Dync({
@@ -58,6 +58,8 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
                     update: (id, changes) => fetch(`/api/items/${id}`),
                     remove: (id) => fetch(`/api/items/${id}`),
                     list: (since) => fetch(`/api/items?since=${since}`),
+                    // Optional: Delay calling this endpoint during a pull if slow changing data, to reduce server load
+                    listExtraIntervalMs: 7 * 24 * 60 * 60 * 1000, // 1 week
                 },
             },
         });

package/dist/index.cjs

@@ -169,7 +169,7 @@ var SYNC_STATE_KEY = "sync_state";
 var DEFAULT_STATE = {
   firstLoadDone: false,
   pendingChanges: [],
-  lastPulled: {}
+  newestServerUpdatedAt: {}
 };
 var StateManager = class {
   persistedState;
@@ -339,7 +339,8 @@ function clonePersistedState(state) {
       before: cloneRecord(change.before),
       after: cloneRecord(change.after)
     })),
-    lastPulled: { ...state.lastPulled },
+    newestServerUpdatedAt: { ...state.newestServerUpdatedAt },
+    lastPulledAt: state.lastPulledAt ? { ...state.lastPulledAt } : void 0,
     conflicts: cloneConflicts(state.conflicts)
   };
 }
@@ -738,12 +739,25 @@ async function pullAll(ctx) {
   const changedTables = [];
   for (const [tableName, api] of Object.entries(ctx.syncApis)) {
     try {
-      const lastPulled = ctx.state.getState().lastPulled[tableName];
-      const since = lastPulled ? new Date(lastPulled) : /* @__PURE__ */ new Date(0);
+      const now = Date.now();
+      if (beforeListExtraInterval(api, tableName, ctx, now)) {
+        continue;
+      }
+      const newestServerUpdatedAt = ctx.state.getState().newestServerUpdatedAt[tableName];
+      const since = newestServerUpdatedAt ? new Date(newestServerUpdatedAt) : /* @__PURE__ */ new Date(0);
       ctx.logger.debug(`[dync] pull:start tableName=${tableName} since=${since.toISOString()}`);
       const serverData = await api.list(since);
       const changed = await processPullData(tableName, serverData, since, ctx);
       if (changed) changedTables.push(tableName);
+      if (hasListExtraInterval(api)) {
+        await ctx.state.setState((syncState) => ({
+          ...syncState,
+          lastPulledAt: {
+            ...syncState.lastPulledAt,
+            [tableName]: now
+          }
+        }));
+      }
     } catch (err) {
       firstSyncError = firstSyncError ?? err;
       ctx.logger.error(`[dync] pull:error tableName=${tableName}`, err);
@@ -751,6 +765,22 @@ async function pullAll(ctx) {
   }
   return { error: firstSyncError, changedTables };
 }
+function hasListExtraInterval(api) {
+  return Number.isFinite(api.listExtraIntervalMs) && api.listExtraIntervalMs > 0;
+}
+function beforeListExtraInterval(api, tableName, ctx, now) {
+  if (!hasListExtraInterval(api)) {
+    return false;
+  }
+  const lastPulledAt = ctx.state.getState().lastPulledAt?.[tableName] ?? 0;
+  if (now - lastPulledAt < api.listExtraIntervalMs) {
+    ctx.logger.debug(
+      `[dync] pull:skip-interval tableName=${tableName} lastPulledAt=${new Date(lastPulledAt).toISOString()} nextAllowed=${new Date(lastPulledAt + api.listExtraIntervalMs).toISOString()}`
+    );
+    return true;
+  }
+  return false;
+}
 async function handleRemoteItemUpdate(table, tableName, localItem, remote, ctx) {
   const pendingChange = ctx.state.getState().pendingChanges.find((p) => p.tableName === tableName && p.localId === localItem._localId);
   const conflictStrategy = ctx.conflictResolutionStrategy;
@@ -807,8 +837,8 @@ async function pullAllBatch(ctx) {
   try {
     const sinceMap = {};
     for (const tableName of ctx.batchSync.syncTables) {
-      const lastPulled = ctx.state.getState().lastPulled[tableName];
-      sinceMap[tableName] = lastPulled ? new Date(lastPulled) : /* @__PURE__ */ new Date(0);
+      const newestServerUpdatedAt = ctx.state.getState().newestServerUpdatedAt[tableName];
+      sinceMap[tableName] = newestServerUpdatedAt ? new Date(newestServerUpdatedAt) : /* @__PURE__ */ new Date(0);
     }
     ctx.logger.debug(`[dync] pull:batch:start tables=${[...ctx.batchSync.syncTables].join(",")}`, sinceMap);
     const serverDataByTable = await ctx.batchSync.pull(sinceMap);
@@ -870,8 +900,8 @@ async function processPullData(tableName, serverData, since, ctx) {
     }
     await ctx.state.setState((syncState) => ({
       ...syncState,
-      lastPulled: {
-        ...syncState.lastPulled,
+      newestServerUpdatedAt: {
+        ...syncState.newestServerUpdatedAt,
         [tableName]: newest.toISOString()
       }
     }));
@@ -1153,7 +1183,7 @@ async function startFirstLoad(ctx) {
   ctx.logger.debug("[dync] First load completed");
 }
 async function processBatchInChunks(ctx, tableName, batch, isEmptyTable, isFirstBatch) {
-  let newest = new Date(ctx.state.getState().lastPulled[tableName] || 0);
+  let newest = new Date(ctx.state.getState().newestServerUpdatedAt[tableName] || 0);
   return ctx.withTransaction("rw", [tableName, DYNC_STATE_TABLE], async (tables) => {
     const txTable = tables[tableName];
     let tableIsEmpty = isEmptyTable;
@@ -1188,8 +1218,8 @@ async function processBatchInChunks(ctx, tableName, batch, isEmptyTable, isFirst
     }
     await ctx.state.setState((syncState) => ({
       ...syncState,
-      lastPulled: {
-        ...syncState.lastPulled,
+      newestServerUpdatedAt: {
+        ...syncState.newestServerUpdatedAt,
         [tableName]: newest.toISOString()
       }
     }));
@@ -1363,7 +1393,7 @@ var DyncBase = class {
     this.adapter = storageAdapter;
     this.name = databaseName;
     this.syncOptions = {
-      syncInterval: DEFAULT_SYNC_INTERVAL_MILLIS,
+      syncIntervalMs: DEFAULT_SYNC_INTERVAL_MILLIS,
       logger: DEFAULT_LOGGER,
       minLogLevel: DEFAULT_MIN_LOG_LEVEL,
       missingRemoteRecordDuringUpdateStrategy: DEFAULT_MISSING_REMOTE_RECORD_STRATEGY,
@@ -1614,7 +1644,8 @@ var DyncBase = class {
     }
     return pullAll({
       ...baseContext,
-      syncApis: this.syncApis
+      syncApis: this.syncApis,
+      syncIntervalMs: this.syncOptions.syncIntervalMs
     });
   }
   async pushAll() {
@@ -1649,7 +1680,7 @@ var DyncBase = class {
     while (this.syncTimerStarted) {
       this.sleepAbortController = new AbortController();
       await this.syncOnce();
-      await sleep(this.syncOptions.syncInterval, this.sleepAbortController.signal);
+      await sleep(this.syncOptions.syncIntervalMs, this.sleepAbortController.signal);
     }
     this.syncStatus = "disabled";
     this.disableSyncPromiseResolver?.();