@salesforce/lds-worker-api 1.246.0 → 1.248.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -916,36 +916,47 @@ var DraftQueueOperationType;
 
 var EvictStatus;
 (function (EvictStatus) {
-    EvictStatus["InProgress"] = "InProgress";
+    EvictStatus["Started"] = "Started";
+    EvictStatus["Running"] = "Running";
+    EvictStatus["Evicted"] = "Evicted";
     EvictStatus["Succeeded"] = "Succeeded";
     EvictStatus["Error"] = "Error";
-    EvictStatus["Cancelled"] = "Cancelled";
+    EvictStatus["Canceled"] = "Canceled";
 })(EvictStatus || (EvictStatus = {}));
 const MessagingDurableSegmentName = 'MESSAGING';
 const DEFAULT_MAX_ENTRIES_PER_OPERATION = 500;
+const EVICTION_IN_PROGESS_MESSAGE = `Cache eviction in progress. Can't start another until it is finished or canceled.`;
 /**
- * Keep tracking of ongoing eviction id to a flag to trigger eviction cancellation.
- * false in the begining, set to true when cancelEviction is called.
+ * Only one eviction is allowed at a time. running status is return when evictCacheRecordsByIds or
+ * evictExpiredCacheEntries is called if there's already an eviction in progress.
  */
-const evictionCancellationFlag = new Map();
+var currentEvictionId = '';
+var cancelCurrentEviction = false;
 /**
  * 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 evictId, call cancelEviction with it to abort the eviction.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * The record will not be purged if the record has draft.
  */
 function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
-    const evictionId = uuidv4();
-    evictionCancellationFlag.set(evictionId, false);
+    // Send error back if an eviction is going on.
+    if (currentEvictionId) {
+        return {
+            status: EvictStatus.Running,
+            message: EVICTION_IN_PROGESS_MESSAGE,
+        };
+    }
+    currentEvictionId = uuidv4();
+    cancelCurrentEviction = false;
     const evictAChunk = () => {
         evictChunksOfRecord(recordIds).then(onEvicted);
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
     evictAChunk();
-    return evictionId;
+    return { status: EvictStatus.Started };
 }
 /**
  * Purging the db entries which passed expired time by specified days
@@ -953,49 +964,53 @@ function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
  * @param expiredByDays
  * @param onProgressUpdate
  *
- * @returns an evictId, call cancelEviction with it to abort the eviction.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * 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);
+    // Send error back if an eviction is going on.
+    if (currentEvictionId) {
+        return {
+            status: EvictStatus.Running,
+            message: EVICTION_IN_PROGESS_MESSAGE,
+        };
+    }
+    currentEvictionId = uuidv4();
+    cancelCurrentEviction = false;
     const overdueExpirationTimeStamp = Date.now() - expiredByDays * 24 * 3600 * 1000;
     const evictAChunk = () => {
         evictChunkOfOverdueEntries(overdueExpirationTimeStamp).then(onEvicted);
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
     evictAChunk();
-    return evictionId;
+    return { status: EvictStatus.Started };
 }
 /**
- * Cancel the eviction by specified id.
- * Signal to cancel the eviction if the eviction is going on.
- * @param evictionId
+ * Signal to stop current eviction if there's an active eviction going on.
  */
-function cancelEviction(evictionId) {
-    if (evictionCancellationFlag.has(evictionId)) {
-        evictionCancellationFlag.set(evictionId, true);
+function stopEviction() {
+    if (currentEvictionId) {
+        cancelCurrentEviction = 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) {
+function getOnEvictedCallback(onProgressUpdate, evictAChunk) {
     return (progress) => {
         onProgressUpdate(progress);
         const { status } = progress;
         if (status === EvictStatus.Succeeded || status === EvictStatus.Error) {
-            evictionCancellationFlag.delete(evictionId);
+            currentEvictionId = '';
         }
-        if (status === EvictStatus.InProgress) {
-            if (evictionCancellationFlag.get(evictionId)) {
-                evictionCancellationFlag.delete(evictionId);
-                onProgressUpdate({ status: EvictStatus.Cancelled });
+        if (status === EvictStatus.Evicted) {
+            if (cancelCurrentEviction) {
+                currentEvictionId = '';
+                onProgressUpdate({ status: EvictStatus.Canceled });
             }
             else {
                 evictAChunk();
@@ -1032,7 +1047,7 @@ function evictChunksOfRecord(ids) {
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                 }
                 resolve({
-                    status: EvictStatus.InProgress,
+                    status: EvictStatus.Evicted,
                     evictedEntries,
                     skippedEntries,
                 });
@@ -1085,7 +1100,7 @@ function evictChunkOfOverdueEntries(overdueExpirationTimestamp) {
                     // broadcast entries evicted
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                     resolve({
-                        status: EvictStatus.InProgress,
+                        status: EvictStatus.Evicted,
                         evictedEntries,
                         skippedEntries: [],
                     });
@@ -1119,5 +1134,5 @@ if (process.env.NODE_ENV !== 'production') {
     });
 }
 
-export { cancelEviction, createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
-// version: 1.246.0-8357100fc
+export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
+// version: 1.248.0-1f7f01112

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

@@ -1,11 +1,20 @@
 declare enum EvictStatus {
-    InProgress = "InProgress",
+    Started = "Started",
+    Running = "Running",
+    Evicted = "Evicted",
     Succeeded = "Succeeded",
     Error = "Error",
-    Cancelled = "Cancelled"
+    Canceled = "Canceled"
 }
-interface EvictInProgress {
-    status: EvictStatus.InProgress;
+interface EvictStarted {
+    status: EvictStatus.Started;
+}
+interface EvictRunning {
+    status: EvictStatus.Running;
+    message: string;
+}
+interface BatchEvicted {
+    status: EvictStatus.Evicted;
     skippedEntries?: string[];
     evictedEntries?: string[];
 }
@@ -17,35 +26,33 @@ interface EvictError {
     message: string;
 }
 interface EvictCancelled {
-    status: EvictStatus.Cancelled;
+    status: EvictStatus.Canceled;
 }
-export type EvictProgress = EvictInProgress | EvictSucceeded | EvictError | EvictCancelled;
+export type EvictProgress = BatchEvicted | EvictSucceeded | EvictError | EvictCancelled;
 export type ProgressUpdateCallback = (progess: EvictProgress) => void;
 /**
  * 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 evictId, call cancelEviction with it to abort the eviction.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * The record will not be purged if the record has draft.
  */
-export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): string;
+export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
 /**
  * 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.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * 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;
+export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
 /**
- * Cancel the eviction by specified id.
- * Signal to cancel the eviction if the eviction is going on.
- * @param evictionId
+ * Signal to stop current eviction if there's an active eviction going on.
  */
-export declare function cancelEviction(evictionId: string): void;
+export declare function stopEviction(): void;
 export {};

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, evictExpiredCacheEntries, cancelEviction } from './cachePurging';
-export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, cancelEviction, };
+import { evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction } from './cachePurging';
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, };