@salesforce/lds-worker-api 1.253.0 → 1.257.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -33,11 +33,13 @@ import * as unstableLightningRelatedListApi from 'lightning/unstable_uiRelatedLi
 import * as lightningGraphQLApi from 'lightning/uiGraphQLApi';
 import { createContentDocumentAndVersion, createContentVersion } from 'force/ldsAdaptersUiapi';
 import * as gqlApi from 'force/ldsAdaptersGraphql';
-import { getRuntime, reportGraphqlQueryParseError } from 'native/ldsRuntimeMobile';
+import { getRuntime, reportGraphqlQueryParseError, O11Y_NAMESPACE_LDS_MOBILE } from 'native/ldsRuntimeMobile';
 export { registerReportObserver } from 'native/ldsRuntimeMobile';
 import { HttpStatusCode } from 'force/luvioEngine';
 import { API_NAMESPACE, RECORD_REPRESENTATION_NAME, keyBuilderRecord } from 'force/ldsAdaptersUiapi';
 import { withDefaultLuvio } from 'native/ldsEngineMobile';
+import { getInstrumentation } from 'o11y/client';
+import { evictCacheRecordsByIdsSchema, evictExpiredEntriesSchema } from 'o11y_schema/sf_lds';
 
 const { create, keys } = Object;
 const { stringify, parse } = JSON;
@@ -778,15 +780,7 @@ function removeEventHandler(session, handler) {
     }
 }
 
-var EvictStatus;
-(function (EvictStatus) {
-    EvictStatus["Started"] = "Started";
-    EvictStatus["Running"] = "Running";
-    EvictStatus["Evicted"] = "Evicted";
-    EvictStatus["Succeeded"] = "Succeeded";
-    EvictStatus["Error"] = "Error";
-    EvictStatus["Canceled"] = "Canceled";
-})(EvictStatus || (EvictStatus = {}));
+const ldsMobileInstrumentation = getInstrumentation(O11Y_NAMESPACE_LDS_MOBILE);
 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.`;
@@ -809,18 +803,27 @@ function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
     // Send error back if an eviction is going on.
     if (activeEvictionInProgress) {
         return {
-            status: EvictStatus.Running,
+            status: 'Running',
             message: EVICTION_IN_PROGESS_MESSAGE,
         };
     }
     activeEvictionInProgress = true;
     cancelCurrentEviction = false;
+    const o11yActivity = ldsMobileInstrumentation.startActivity('evictCacheRecordsByIds');
+    const stat = {
+        idCount: recordIds.length,
+        evictedCount: 0,
+        skippedCount: 0,
+    };
     const evictAChunk = () => {
-        evictChunksOfRecord(recordIds).then(onEvicted);
+        evictChunksOfRecord(recordIds).then((progress) => {
+            handleInstrumentation(o11yActivity, stat, progress);
+            onEvicted(progress);
+        });
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
+    const onEvicted = getOnEvictedCallback(o11yActivity, onProgressUpdate, evictAChunk, stat);
     evictAChunk();
-    return { status: EvictStatus.Started };
+    return { status: 'Started' };
 }
 /**
  * Purging the db entries which passed expired time by specified days
@@ -836,19 +839,28 @@ function evictExpiredCacheEntries(expiredByDays, onProgressUpdate) {
     // Send error back if an eviction is going on.
     if (activeEvictionInProgress) {
         return {
-            status: EvictStatus.Running,
+            status: 'Running',
             message: EVICTION_IN_PROGESS_MESSAGE,
         };
     }
     activeEvictionInProgress = true;
     cancelCurrentEviction = false;
+    const stat = {
+        expiredInDays: expiredByDays,
+        evictedCount: 0,
+        skippedCount: 0,
+    };
+    const o11yActivity = ldsMobileInstrumentation.startActivity('evictExpiredCacheEntries');
     const overdueExpirationTimeStamp = Date.now() - expiredByDays * 24 * 3600 * 1000;
     const evictAChunk = () => {
-        evictChunkOfOverdueEntries(overdueExpirationTimeStamp).then(onEvicted);
+        evictChunkOfOverdueEntries(overdueExpirationTimeStamp).then((progress) => {
+            handleInstrumentation(o11yActivity, stat, progress);
+            onEvicted(progress);
+        });
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
+    const onEvicted = getOnEvictedCallback(o11yActivity, onProgressUpdate, evictAChunk, stat);
     evictAChunk();
-    return { status: EvictStatus.Started };
+    return { status: 'Started' };
 }
 /**
  * Signal to stop current eviction if there's an active eviction going on.
@@ -864,17 +876,19 @@ function stopEviction() {
  * @param evictAChunk
  * @returns a callback to call when a chunk of records or entries are removed.
  */
-function getOnEvictedCallback(onProgressUpdate, evictAChunk) {
+function getOnEvictedCallback(o11yActivity, onProgressUpdate, evictAChunk, stat) {
     return (progress) => {
         onProgressUpdate(progress);
         const { status } = progress;
-        if (status === EvictStatus.Succeeded || status === EvictStatus.Error) {
+        if (status === 'Succeeded' || status === 'Error') {
             activeEvictionInProgress = false;
         }
-        if (status === EvictStatus.Evicted) {
+        if (status === 'Evicted') {
             if (cancelCurrentEviction) {
                 activeEvictionInProgress = false;
-                onProgressUpdate({ status: EvictStatus.Canceled });
+                const canceledProgress = { status: 'Canceled' };
+                onProgressUpdate(canceledProgress);
+                handleInstrumentation(o11yActivity, stat, canceledProgress);
             }
             else {
                 evictAChunk();
@@ -890,7 +904,7 @@ function getOnEvictedCallback(onProgressUpdate, evictAChunk) {
 function evictChunksOfRecord(ids) {
     const chunk = ids.splice(0, DEFAULT_MAX_ENTRIES_PER_OPERATION);
     if (chunk.length === 0) {
-        return Promise.resolve({ status: EvictStatus.Succeeded });
+        return Promise.resolve({ status: 'Succeeded' });
     }
     return new Promise((resolve) => {
         // evict the chunk
@@ -911,22 +925,22 @@ function evictChunksOfRecord(ids) {
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                 }
                 resolve({
-                    status: EvictStatus.Evicted,
+                    status: 'Evicted',
                     evictedEntries,
                     skippedEntries,
                 });
             })
                 .catch((reason) => {
                 resolve({
-                    status: EvictStatus.Error,
-                    message: JSON.stringify(reason),
+                    status: 'Error',
+                    message: reason.toString(),
                 });
             });
         }
         catch (reason) {
             resolve({
-                status: EvictStatus.Error,
-                message: JSON.stringify(reason),
+                status: 'Error',
+                message: reason.toString(),
             });
         }
     });
@@ -965,30 +979,50 @@ function evictChunkOfOverdueEntries(overdueExpirationTimestamp) {
                     // broadcast entries evicted
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                     resolve({
-                        status: EvictStatus.Evicted,
+                        status: 'Evicted',
                         evictedEntries,
                         skippedEntries: [],
                     });
                 }
                 else {
-                    resolve({ status: EvictStatus.Succeeded });
+                    resolve({ status: 'Succeeded' });
                 }
             })
                 .catch((reason) => {
                 resolve({
-                    status: EvictStatus.Error,
-                    message: JSON.stringify(reason),
+                    status: 'Error',
+                    message: reason.toString(),
                 });
             });
         }
         catch (reason) {
             resolve({
-                status: EvictStatus.Error,
-                message: JSON.stringify(reason),
+                status: 'Error',
+                message: reason.toString(),
             });
         }
     });
 }
+function handleInstrumentation(activity, stat, progress) {
+    const status = progress.status;
+    if (status === 'Evicted') {
+        const evicted = progress;
+        stat.evictedCount += evicted.evictedEntries.length;
+        stat.skippedCount += evicted.skippedEntries.length;
+        return;
+    }
+    const schema = 'idCount' in stat ? evictCacheRecordsByIdsSchema : evictExpiredEntriesSchema;
+    const userData = {
+        ...stat,
+        isCanceled: status === 'Canceled',
+    };
+    if (status === 'Error') {
+        activity.error(progress.message, schema, userData);
+    }
+    else if (status === 'Succeeded' || status === 'Canceled') {
+        activity.stop(schema, userData);
+    }
+}
 
 if (process.env.NODE_ENV !== 'production') {
     // eslint-disable-next-line no-undef
@@ -1000,4 +1034,4 @@ if (process.env.NODE_ENV !== 'production') {
 }
 
 export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
-// version: 1.253.0-5f7477b3b
+// version: 1.257.0-236dcdea5

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

@@ -1,32 +1,24 @@
-declare enum EvictStatus {
-    Started = "Started",
-    Running = "Running",
-    Evicted = "Evicted",
-    Succeeded = "Succeeded",
-    Error = "Error",
-    Canceled = "Canceled"
-}
 interface EvictStarted {
-    status: EvictStatus.Started;
+    status: 'Started';
 }
 interface EvictRunning {
-    status: EvictStatus.Running;
+    status: 'Running';
     message: string;
 }
 interface BatchEvicted {
-    status: EvictStatus.Evicted;
-    skippedEntries?: string[];
-    evictedEntries?: string[];
+    status: 'Evicted';
+    skippedEntries: string[];
+    evictedEntries: string[];
 }
 interface EvictSucceeded {
-    status: EvictStatus.Succeeded;
+    status: 'Succeeded';
 }
 interface EvictError {
-    status: EvictStatus.Error;
+    status: 'Error';
     message: string;
 }
 interface EvictCancelled {
-    status: EvictStatus.Canceled;
+    status: 'Canceled';
 }
 export type EvictProgress = BatchEvicted | EvictSucceeded | EvictError | EvictCancelled;
 export type ProgressUpdateCallback = (progess: EvictProgress) => void;