@salesforce/lds-worker-api 1.245.0 → 1.246.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -925,30 +925,76 @@ const MessagingDurableSegmentName = 'MESSAGING';
 const DEFAULT_MAX_ENTRIES_PER_OPERATION = 500;
 /**
  * Keep tracking of ongoing eviction id to a flag to trigger eviction cancellation.
- * false in the begining, set to false when cancelEviction is called.
+ * false in the begining, set to true when cancelEviction is called.
  */
-const inProgressEvictions = new Map();
+const evictionCancellationFlag = new Map();
 /**
  * Purging records specified by an array of record id from durable store
  * @param recordIds record id array
  * @onProgressUpdate call back to report evict progress
  *
- * @returns a function to cancel the eviction
+ * @returns evictId, call cancelEviction with it to abort the eviction.
  *
  * The record will not be purged if the record has draft.
  */
 function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
     const evictionId = uuidv4();
-    inProgressEvictions.set(evictionId, false);
-    const onEvicted = (progress) => {
+    evictionCancellationFlag.set(evictionId, false);
+    const evictAChunk = () => {
+        evictChunksOfRecord(recordIds).then(onEvicted);
+    };
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    evictAChunk();
+    return evictionId;
+}
+/**
+ * Purging the db entries which passed expired time by specified days
+ * from durable store.
+ * @param expiredByDays
+ * @param onProgressUpdate
+ *
+ * @returns an evictId, call cancelEviction with it to abort the eviction.
+ *
+ * Important: records with draft, objectInfo entries will not be purged even expired by the specified days.
+ */
+function evictExpiredCacheEntries(expiredByDays, onProgressUpdate) {
+    const evictionId = uuidv4();
+    evictionCancellationFlag.set(evictionId, false);
+    const overdueExpirationTimeStamp = Date.now() - expiredByDays * 24 * 3600 * 1000;
+    const evictAChunk = () => {
+        evictChunkOfOverdueEntries(overdueExpirationTimeStamp).then(onEvicted);
+    };
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    evictAChunk();
+    return evictionId;
+}
+/**
+ * Cancel the eviction by specified id.
+ * Signal to cancel the eviction if the eviction is going on.
+ * @param evictionId
+ */
+function cancelEviction(evictionId) {
+    if (evictionCancellationFlag.has(evictionId)) {
+        evictionCancellationFlag.set(evictionId, true);
+    }
+}
+/**
+ * Get a callback function when a chunk of records or entries are removed.
+ * @param onProgressUpdate
+ * @param evictionId
+ * @param evictAChunk
+ * @returns a callback to call when a chunk of records or entries are removed.
+ */
+function getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk) {
+    return (progress) => {
         onProgressUpdate(progress);
         const { status } = progress;
         if (status === EvictStatus.Succeeded || status === EvictStatus.Error) {
-            inProgressEvictions.delete(evictionId);
+            evictionCancellationFlag.delete(evictionId);
         }
         if (status === EvictStatus.InProgress) {
-            if (inProgressEvictions.get(evictionId)) {
-                inProgressEvictions.delete(evictionId);
+            if (evictionCancellationFlag.get(evictionId)) {
+                evictionCancellationFlag.delete(evictionId);
                 onProgressUpdate({ status: EvictStatus.Cancelled });
             }
             else {
@@ -956,18 +1002,6 @@ function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
             }
         }
     };
-    const evictAChunk = () => {
-        evictChunksOfRecord(recordIds).then(onEvicted);
-    };
-    evictAChunk();
-    return evictionId;
-}
-/**
- * Cancel the eviction by specified id.
- * @param evictionId
- */
-function cancelEviction(evictionId) {
-    inProgressEvictions.set(evictionId, true);
 }
 /**
  * pull a chunk of record id, evict status back in a promise.
@@ -993,8 +1027,10 @@ function evictChunksOfRecord(ids) {
                 .then((result) => {
                 const evictedEntries = result.rows.map((row) => row[0]);
                 const skippedEntries = params.filter((entryKey) => evictedEntries.indexOf(entryKey) === -1);
-                // broadcast entries evicted
-                nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
+                // broadcast entries evicted if some entries are removed
+                if (evictedEntries.length > 0) {
+                    nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
+                }
                 resolve({
                     status: EvictStatus.InProgress,
                     evictedEntries,
@@ -1016,6 +1052,63 @@ function evictChunksOfRecord(ids) {
         }
     });
 }
+/**
+ * Evict chunk of overdue entries from db.
+ * @param overdueExpirationTimestamp
+ * @returns
+ */
+function evictChunkOfOverdueEntries(overdueExpirationTimestamp) {
+    return new Promise((resolve) => {
+        // evict the chunk
+        const { nimbusSqliteStore } = getRuntime();
+        try {
+            nimbusSqliteStore
+                .query(`DELETE FROM lds_data 
+                        WHERE key IN (
+                        SELECT key
+                        FROM lds_data
+                        WHERE key NOT LIKE 'UiApi::ObjectInfoRepresentation:%' 
+                            AND 
+                            (
+                                key NOT LIKE 'UiApi::RecordRepresentation:%' 
+                                OR  
+                                key LIKE 'UiApi::RecordRepresentation:%' AND 
+                                JSON_EXTRACT(data, '$.drafts') IS NULL AND
+                                JSON_EXTRACT(metadata, '$.expirationTimestamp') < ${overdueExpirationTimestamp}
+                            )
+                        LIMIT ${DEFAULT_MAX_ENTRIES_PER_OPERATION}
+                        )
+                    RETURNING key`, [])
+                .then((result) => {
+                const evictedEntries = result.rows.map((row) => row[0]);
+                if (evictedEntries.length > 0) {
+                    // broadcast entries evicted
+                    nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
+                    resolve({
+                        status: EvictStatus.InProgress,
+                        evictedEntries,
+                        skippedEntries: [],
+                    });
+                }
+                else {
+                    resolve({ status: EvictStatus.Succeeded });
+                }
+            })
+                .catch((reason) => {
+                resolve({
+                    status: EvictStatus.Error,
+                    message: JSON.stringify(reason),
+                });
+            });
+        }
+        catch (reason) {
+            resolve({
+                status: EvictStatus.Error,
+                message: JSON.stringify(reason),
+            });
+        }
+    });
+}
 
 if (process.env.NODE_ENV !== 'production') {
     // eslint-disable-next-line no-undef
@@ -1026,5 +1119,5 @@ if (process.env.NODE_ENV !== 'production') {
     });
 }
 
-export { cancelEviction, createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
-// version: 1.245.0-0ea124370
+export { cancelEviction, createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
+// version: 1.246.0-8357100fc

package/dist/sfdc/es/types/cachePurging.d.ts

@@ -26,13 +26,25 @@ export type ProgressUpdateCallback = (progess: EvictProgress) => void;
  * @param recordIds record id array
  * @onProgressUpdate call back to report evict progress
  *
- * @returns a function to cancel the eviction
+ * @returns evictId, call cancelEviction with it to abort the eviction.
  *
  * The record will not be purged if the record has draft.
  */
 export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): string;
+/**
+ * Purging the db entries which passed expired time by specified days
+ * from durable store.
+ * @param expiredByDays
+ * @param onProgressUpdate
+ *
+ * @returns an evictId, call cancelEviction with it to abort the eviction.
+ *
+ * Important: records with draft, objectInfo entries will not be purged even expired by the specified days.
+ */
+export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): string;
 /**
  * Cancel the eviction by specified id.
+ * Signal to cancel the eviction if the eviction is going on.
  * @param evictionId
  */
 export declare function cancelEviction(evictionId: string): void;

package/dist/sfdc/es/types/main.d.ts

@@ -5,5 +5,5 @@ import { draftQueue, draftManager } from './draftQueueImplementation';
 import { setUiApiRecordTTL, setMetadataTTL } from './ttl';
 import { registerReportObserver } from '@salesforce/lds-runtime-mobile';
 import { createPrimingSession } from './primingApi';
-import { evictCacheRecordsByIds, cancelEviction } from './cachePurging';
-export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, cancelEviction, };
+import { evictCacheRecordsByIds, evictExpiredCacheEntries, cancelEviction } from './cachePurging';
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, cancelEviction, };