@salesforce/lds-runtime-mobile 1.142.1 → 1.144.0

package/dist/main.js

@@ -27,6 +27,9 @@ import shortTimeFormat from '@salesforce/i18n/dateTime.shortTimeFormat';
 import shortDateTimeFormat from '@salesforce/i18n/dateTime.shortDateTimeFormat';
 import { getDateTimeFormat, getDateTimeISO8601Parser, getNumberFormat } from 'lightning/i18nService';
 import formattingOptions from 'lightning/i18nCldrOptions';
+import eagerEvalValidAt from '@salesforce/gate/lds.eagerEvalValidAt';
+import eagerEvalStaleWhileRevalidate from '@salesforce/gate/lds.eagerEvalStaleWhileRevalidate';
+import eagerEvalDefaultCachePolicy from '@salesforce/gate/lds.eagerEvalDefaultCachePolicy';
 
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -877,7 +880,7 @@ async function reviveOrCreateContext(adapterId, durableStore, durableStoreErrorH
     }
     return contextReturn();
 }
-function isUnfulfilledSnapshot(cachedSnapshotResult) {
+function isUnfulfilledSnapshot$1(cachedSnapshotResult) {
     if (cachedSnapshotResult === undefined) {
         return false;
     }
@@ -1161,7 +1164,7 @@ function makeDurable(environment, { durableStore, instrumentation }) {
             const snapshot = buildCachedSnapshot(injectedBuildSnapshotContext, injectedStoreLookup, luvio);
             // if the adapter attempted to do an L1 lookup and it was unfulfilled
             // then we can attempt an L2 lookup
-            if (isUnfulfilledSnapshot(snapshot)) {
+            if (isUnfulfilledSnapshot$1(snapshot)) {
                 const start = Date.now();
                 emitDurableEnvironmentAdapterEvent({ type: 'l2-revive-start' }, adapterRequestContext.eventObservers);
                 const revivedSnapshot = reviveSnapshot(environment, durableStore, snapshot, durableStoreErrorHandler, () => injectedStoreLookup(snapshot.select, snapshot.refresh)).then((result) => {
@@ -4661,6 +4664,10 @@ var DraftQueueEventType;
      * Triggered after an action had been added to the queue
      */
     DraftQueueEventType["ActionAdded"] = "added";
+    /**
+     * Triggered when starting to upload and process an action
+     */
+    DraftQueueEventType["ActionUploading"] = "uploading";
     /**
      * Triggered once an action failed
      */
@@ -5212,6 +5219,10 @@ class DurableDraftQueue {
         if (this.state === DraftQueueState.Waiting) {
             this.state = DraftQueueState.Started;
         }
+        this.notifyChangedListeners({
+            type: DraftQueueEventType.ActionUploading,
+            action: { ...action, status: DraftActionStatus.Uploading },
+        });
         return this.handle(action);
     }
     async handleServerError(action, error) {
@@ -5972,6 +5983,7 @@ var DraftActionOperationType;
 var DraftQueueOperationType;
 (function (DraftQueueOperationType) {
     DraftQueueOperationType["ItemAdded"] = "added";
+    DraftQueueOperationType["ItemUploading"] = "uploading";
     DraftQueueOperationType["ItemDeleted"] = "deleted";
     DraftQueueOperationType["ItemCompleted"] = "completed";
     DraftQueueOperationType["ItemFailed"] = "failed";
@@ -6022,29 +6034,29 @@ function toQueueState(queue) {
 class DraftManager {
     constructor(draftQueue) {
         this.listeners = [];
-        this.draftQueue = draftQueue;
-        draftQueue.registerOnChangedListener((event) => {
-            if (this.shouldEmitDraftEvent(event)) {
-                return this.callListeners(event);
-            }
-            return Promise.resolve();
-        });
-    }
-    shouldEmitDraftEvent(event) {
-        const { type } = event;
-        return [
+        this.draftEventsShouldBeEmitted = [
             DraftQueueEventType.ActionAdded,
+            DraftQueueEventType.ActionUploading,
             DraftQueueEventType.ActionCompleted,
             DraftQueueEventType.ActionDeleted,
             DraftQueueEventType.ActionFailed,
             DraftQueueEventType.ActionUpdated,
             DraftQueueEventType.QueueStateChanged,
-        ].includes(type);
+        ];
+        this.draftQueue = draftQueue;
+        draftQueue.registerOnChangedListener((event) => {
+            if (this.draftEventsShouldBeEmitted.includes(event.type)) {
+                return this.callListeners(event);
+            }
+            return Promise.resolve();
+        });
     }
     draftQueueEventTypeToOperationType(type) {
         switch (type) {
             case DraftQueueEventType.ActionAdded:
                 return DraftQueueOperationType.ItemAdded;
+            case DraftQueueEventType.ActionUploading:
+                return DraftQueueOperationType.ItemUploading;
             case DraftQueueEventType.ActionCompleted:
                 return DraftQueueOperationType.ItemCompleted;
             case DraftQueueEventType.ActionDeleted:
@@ -12533,6 +12545,7 @@ function draftAwareGraphQLAdapterFactory(userId, objectInfoService, store, luvio
                 query: injectedAST,
             },
             luvio,
+            gqlEval: true,
         }, buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy));
         if (isErrorSnapshotThatShouldGetReturnedToCaller(nonEvaluatedSnapshot)) {
             return nonEvaluatedSnapshot;
@@ -14229,6 +14242,7 @@ const DRAFT_QUEUE_STATE_ERROR = 'draft-queue-state-error';
 const DRAFT_QUEUE_STATE_WAITING = 'draft-queue-state-waiting';
 const DRAFT_QUEUE_STATE_STOPPED = 'draft-queue-state-stopped';
 const DRAFT_QUEUE_ACTION_ADDED = 'draft-queue-action-added';
+const DRAFT_QUEUE_ACTION_UPLOADING = 'draft-queue-action-uploading';
 const DRAFT_QUEUE_ACTION_COMPLETED = 'draft-queue-action-completed';
 const DRAFT_QUEUE_ACTION_DELETED = 'draft-queue-action-deleted';
 const DRAFT_QUEUE_ACTION_UPDATED = 'draft-queue-action-updated';
@@ -14283,6 +14297,9 @@ function reportDraftActionEvent(state) {
         case 'added':
             ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_ADDED);
             break;
+        case 'uploading':
+            ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_UPLOADING);
+            break;
         case 'completed':
             ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_COMPLETED);
             break;
@@ -14402,6 +14419,9 @@ function instrumentDraftQueue(queue) {
             case DraftQueueEventType.ActionAdded:
                 reportDraftActionEvent('added');
                 break;
+            case DraftQueueEventType.ActionUploading:
+                reportDraftActionEvent('uploading');
+                break;
             case DraftQueueEventType.ActionCompleted:
                 reportDraftActionEvent('completed');
                 break;
@@ -15114,8 +15134,17 @@ function formatDisplayValue(value, datatype) {
     }
 }
 
-//TODO: [W-12734162] - rebuild non-evaluated snapshot when graph rebuild is triggered. The dependency work on luvio needs to be done.
+function isUnfulfilledSnapshot(cachedSnapshotResult) {
+    if (cachedSnapshotResult === undefined) {
+        return false;
+    }
+    if ('then' in cachedSnapshotResult) {
+        return false;
+    }
+    return cachedSnapshotResult.state === 'Unfulfilled';
+}
 function makeEnvironmentGraphqlAware(environment) {
+    //TODO: [W-12734162] - rebuild non-evaluated snapshot when graph rebuild is triggered. The dependency work on luvio needs to be done.
     const rebuildSnapshot = function (snapshot, onRebuild) {
         if (isStoreEvalSnapshot(snapshot)) {
             snapshot.rebuildWithStoreEval(snapshot).then((rebuilt) => {
@@ -15131,8 +15160,64 @@ function makeEnvironmentGraphqlAware(environment) {
         }
         return environment.rebuildSnapshot(snapshot, onRebuild);
     };
+    const applyCachePolicy = function (luvio, adapterRequestContext, buildSnapshotContext, buildCachedSnapshot, buildNetworkSnapshot) {
+        // Early exit for non-evaluating adapters
+        let graphqlBuildSnapshotContext = buildSnapshotContext;
+        if (graphqlBuildSnapshotContext.gqlEval !== true) {
+            return environment.applyCachePolicy(luvio, adapterRequestContext, buildSnapshotContext, buildCachedSnapshot, buildNetworkSnapshot);
+        }
+        var localBuildCachedSnapshot = buildCachedSnapshot;
+        const hoistUnfulfilledToStale = (context, storeLookup, luvio) => {
+            const upstream = buildCachedSnapshot(context, storeLookup, luvio);
+            if (upstream === undefined)
+                return upstream;
+            if (isUnfulfilledSnapshot(upstream)) {
+                return {
+                    ...upstream,
+                    data: upstream.data || {},
+                    state: 'Stale',
+                };
+            }
+            else if ('then' in upstream) {
+                return upstream.then((snapshot) => {
+                    if (snapshot === undefined)
+                        return snapshot;
+                    if (isUnfulfilledSnapshot(snapshot)) {
+                        return {
+                            ...snapshot,
+                            data: snapshot.data || {},
+                            state: 'Stale',
+                        };
+                    }
+                    return snapshot;
+                });
+            }
+            return upstream;
+        };
+        const { cachePolicy } = adapterRequestContext;
+        if (eagerEvalValidAt.isOpen({ fallback: false }) &&
+            cachePolicy &&
+            cachePolicy.type === 'valid-at' &&
+            cachePolicy.timestamp === 0 &&
+            cachePolicy.basePolicy &&
+            cachePolicy.basePolicy.type === 'stale-while-revalidate') {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        if (eagerEvalStaleWhileRevalidate.isOpen({ fallback: false }) &&
+            cachePolicy &&
+            cachePolicy.type === 'stale-while-revalidate' &&
+            cachePolicy.staleDurationSeconds === Number.MAX_SAFE_INTEGER) {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        if (eagerEvalDefaultCachePolicy.isOpen({ fallback: false }) && cachePolicy === undefined) {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        return environment.applyCachePolicy(luvio, adapterRequestContext, buildSnapshotContext, localBuildCachedSnapshot, buildNetworkSnapshot);
+    };
     return create(environment, {
         rebuildSnapshot: { value: rebuildSnapshot },
+        applyCachePolicy: { value: applyCachePolicy },
+        setDefaultCachePolicy: { value: environment.setDefaultCachePolicy.bind(environment) },
     });
 }
 
@@ -15885,4 +15970,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.142.1-d514db71e
+// version: 1.144.0-ac4b15ad8

package/dist/types/instrumentation/metrics.d.ts

@@ -6,7 +6,7 @@ export declare function reportGraphqlSqlEvalPreconditionError(err: unknown): voi
 export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
 export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
 export declare function reportGraphqlAdapterError(errorCode: string): void;
-export declare function reportDraftActionEvent(state: 'added' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
+export declare function reportDraftActionEvent(state: 'added' | 'uploading' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
 export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
 export declare function reportDraftAwareContentDocumentVersionSynthesizeError(err: unknown): void;
 export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.142.1",
+    "version": "1.144.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",

package/sfdc/main.js

@@ -27,6 +27,9 @@ import shortTimeFormat from '@salesforce/i18n/dateTime.shortTimeFormat';
 import shortDateTimeFormat from '@salesforce/i18n/dateTime.shortDateTimeFormat';
 import { getDateTimeFormat, getDateTimeISO8601Parser, getNumberFormat } from 'lightning/i18nService';
 import formattingOptions from 'lightning/i18nCldrOptions';
+import eagerEvalValidAt from '@salesforce/gate/lds.eagerEvalValidAt';
+import eagerEvalStaleWhileRevalidate from '@salesforce/gate/lds.eagerEvalStaleWhileRevalidate';
+import eagerEvalDefaultCachePolicy from '@salesforce/gate/lds.eagerEvalDefaultCachePolicy';
 
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -877,7 +880,7 @@ async function reviveOrCreateContext(adapterId, durableStore, durableStoreErrorH
     }
     return contextReturn();
 }
-function isUnfulfilledSnapshot(cachedSnapshotResult) {
+function isUnfulfilledSnapshot$1(cachedSnapshotResult) {
     if (cachedSnapshotResult === undefined) {
         return false;
     }
@@ -1161,7 +1164,7 @@ function makeDurable(environment, { durableStore, instrumentation }) {
             const snapshot = buildCachedSnapshot(injectedBuildSnapshotContext, injectedStoreLookup, luvio);
             // if the adapter attempted to do an L1 lookup and it was unfulfilled
             // then we can attempt an L2 lookup
-            if (isUnfulfilledSnapshot(snapshot)) {
+            if (isUnfulfilledSnapshot$1(snapshot)) {
                 const start = Date.now();
                 emitDurableEnvironmentAdapterEvent({ type: 'l2-revive-start' }, adapterRequestContext.eventObservers);
                 const revivedSnapshot = reviveSnapshot(environment, durableStore, snapshot, durableStoreErrorHandler, () => injectedStoreLookup(snapshot.select, snapshot.refresh)).then((result) => {
@@ -4661,6 +4664,10 @@ var DraftQueueEventType;
      * Triggered after an action had been added to the queue
      */
     DraftQueueEventType["ActionAdded"] = "added";
+    /**
+     * Triggered when starting to upload and process an action
+     */
+    DraftQueueEventType["ActionUploading"] = "uploading";
     /**
      * Triggered once an action failed
      */
@@ -5212,6 +5219,10 @@ class DurableDraftQueue {
         if (this.state === DraftQueueState.Waiting) {
             this.state = DraftQueueState.Started;
         }
+        this.notifyChangedListeners({
+            type: DraftQueueEventType.ActionUploading,
+            action: { ...action, status: DraftActionStatus.Uploading },
+        });
         return this.handle(action);
     }
     async handleServerError(action, error) {
@@ -5972,6 +5983,7 @@ var DraftActionOperationType;
 var DraftQueueOperationType;
 (function (DraftQueueOperationType) {
     DraftQueueOperationType["ItemAdded"] = "added";
+    DraftQueueOperationType["ItemUploading"] = "uploading";
     DraftQueueOperationType["ItemDeleted"] = "deleted";
     DraftQueueOperationType["ItemCompleted"] = "completed";
     DraftQueueOperationType["ItemFailed"] = "failed";
@@ -6022,29 +6034,29 @@ function toQueueState(queue) {
 class DraftManager {
     constructor(draftQueue) {
         this.listeners = [];
-        this.draftQueue = draftQueue;
-        draftQueue.registerOnChangedListener((event) => {
-            if (this.shouldEmitDraftEvent(event)) {
-                return this.callListeners(event);
-            }
-            return Promise.resolve();
-        });
-    }
-    shouldEmitDraftEvent(event) {
-        const { type } = event;
-        return [
+        this.draftEventsShouldBeEmitted = [
             DraftQueueEventType.ActionAdded,
+            DraftQueueEventType.ActionUploading,
             DraftQueueEventType.ActionCompleted,
             DraftQueueEventType.ActionDeleted,
             DraftQueueEventType.ActionFailed,
             DraftQueueEventType.ActionUpdated,
             DraftQueueEventType.QueueStateChanged,
-        ].includes(type);
+        ];
+        this.draftQueue = draftQueue;
+        draftQueue.registerOnChangedListener((event) => {
+            if (this.draftEventsShouldBeEmitted.includes(event.type)) {
+                return this.callListeners(event);
+            }
+            return Promise.resolve();
+        });
     }
     draftQueueEventTypeToOperationType(type) {
         switch (type) {
             case DraftQueueEventType.ActionAdded:
                 return DraftQueueOperationType.ItemAdded;
+            case DraftQueueEventType.ActionUploading:
+                return DraftQueueOperationType.ItemUploading;
             case DraftQueueEventType.ActionCompleted:
                 return DraftQueueOperationType.ItemCompleted;
             case DraftQueueEventType.ActionDeleted:
@@ -12533,6 +12545,7 @@ function draftAwareGraphQLAdapterFactory(userId, objectInfoService, store, luvio
                 query: injectedAST,
             },
             luvio,
+            gqlEval: true,
         }, buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy));
         if (isErrorSnapshotThatShouldGetReturnedToCaller(nonEvaluatedSnapshot)) {
             return nonEvaluatedSnapshot;
@@ -14229,6 +14242,7 @@ const DRAFT_QUEUE_STATE_ERROR = 'draft-queue-state-error';
 const DRAFT_QUEUE_STATE_WAITING = 'draft-queue-state-waiting';
 const DRAFT_QUEUE_STATE_STOPPED = 'draft-queue-state-stopped';
 const DRAFT_QUEUE_ACTION_ADDED = 'draft-queue-action-added';
+const DRAFT_QUEUE_ACTION_UPLOADING = 'draft-queue-action-uploading';
 const DRAFT_QUEUE_ACTION_COMPLETED = 'draft-queue-action-completed';
 const DRAFT_QUEUE_ACTION_DELETED = 'draft-queue-action-deleted';
 const DRAFT_QUEUE_ACTION_UPDATED = 'draft-queue-action-updated';
@@ -14283,6 +14297,9 @@ function reportDraftActionEvent(state) {
         case 'added':
             ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_ADDED);
             break;
+        case 'uploading':
+            ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_UPLOADING);
+            break;
         case 'completed':
             ldsMobileInstrumentation.incrementCounter(DRAFT_QUEUE_ACTION_COMPLETED);
             break;
@@ -14402,6 +14419,9 @@ function instrumentDraftQueue(queue) {
             case DraftQueueEventType.ActionAdded:
                 reportDraftActionEvent('added');
                 break;
+            case DraftQueueEventType.ActionUploading:
+                reportDraftActionEvent('uploading');
+                break;
             case DraftQueueEventType.ActionCompleted:
                 reportDraftActionEvent('completed');
                 break;
@@ -15114,8 +15134,17 @@ function formatDisplayValue(value, datatype) {
     }
 }
 
-//TODO: [W-12734162] - rebuild non-evaluated snapshot when graph rebuild is triggered. The dependency work on luvio needs to be done.
+function isUnfulfilledSnapshot(cachedSnapshotResult) {
+    if (cachedSnapshotResult === undefined) {
+        return false;
+    }
+    if ('then' in cachedSnapshotResult) {
+        return false;
+    }
+    return cachedSnapshotResult.state === 'Unfulfilled';
+}
 function makeEnvironmentGraphqlAware(environment) {
+    //TODO: [W-12734162] - rebuild non-evaluated snapshot when graph rebuild is triggered. The dependency work on luvio needs to be done.
     const rebuildSnapshot = function (snapshot, onRebuild) {
         if (isStoreEvalSnapshot(snapshot)) {
             snapshot.rebuildWithStoreEval(snapshot).then((rebuilt) => {
@@ -15131,8 +15160,64 @@ function makeEnvironmentGraphqlAware(environment) {
         }
         return environment.rebuildSnapshot(snapshot, onRebuild);
     };
+    const applyCachePolicy = function (luvio, adapterRequestContext, buildSnapshotContext, buildCachedSnapshot, buildNetworkSnapshot) {
+        // Early exit for non-evaluating adapters
+        let graphqlBuildSnapshotContext = buildSnapshotContext;
+        if (graphqlBuildSnapshotContext.gqlEval !== true) {
+            return environment.applyCachePolicy(luvio, adapterRequestContext, buildSnapshotContext, buildCachedSnapshot, buildNetworkSnapshot);
+        }
+        var localBuildCachedSnapshot = buildCachedSnapshot;
+        const hoistUnfulfilledToStale = (context, storeLookup, luvio) => {
+            const upstream = buildCachedSnapshot(context, storeLookup, luvio);
+            if (upstream === undefined)
+                return upstream;
+            if (isUnfulfilledSnapshot(upstream)) {
+                return {
+                    ...upstream,
+                    data: upstream.data || {},
+                    state: 'Stale',
+                };
+            }
+            else if ('then' in upstream) {
+                return upstream.then((snapshot) => {
+                    if (snapshot === undefined)
+                        return snapshot;
+                    if (isUnfulfilledSnapshot(snapshot)) {
+                        return {
+                            ...snapshot,
+                            data: snapshot.data || {},
+                            state: 'Stale',
+                        };
+                    }
+                    return snapshot;
+                });
+            }
+            return upstream;
+        };
+        const { cachePolicy } = adapterRequestContext;
+        if (eagerEvalValidAt.isOpen({ fallback: false }) &&
+            cachePolicy &&
+            cachePolicy.type === 'valid-at' &&
+            cachePolicy.timestamp === 0 &&
+            cachePolicy.basePolicy &&
+            cachePolicy.basePolicy.type === 'stale-while-revalidate') {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        if (eagerEvalStaleWhileRevalidate.isOpen({ fallback: false }) &&
+            cachePolicy &&
+            cachePolicy.type === 'stale-while-revalidate' &&
+            cachePolicy.staleDurationSeconds === Number.MAX_SAFE_INTEGER) {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        if (eagerEvalDefaultCachePolicy.isOpen({ fallback: false }) && cachePolicy === undefined) {
+            localBuildCachedSnapshot = hoistUnfulfilledToStale;
+        }
+        return environment.applyCachePolicy(luvio, adapterRequestContext, buildSnapshotContext, localBuildCachedSnapshot, buildNetworkSnapshot);
+    };
     return create(environment, {
         rebuildSnapshot: { value: rebuildSnapshot },
+        applyCachePolicy: { value: applyCachePolicy },
+        setDefaultCachePolicy: { value: environment.setDefaultCachePolicy.bind(environment) },
     });
 }
 
@@ -15885,4 +15970,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.142.1-d514db71e
+// version: 1.144.0-ac4b15ad8

package/sfdc/types/instrumentation/metrics.d.ts

@@ -6,7 +6,7 @@ export declare function reportGraphqlSqlEvalPreconditionError(err: unknown): voi
 export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
 export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
 export declare function reportGraphqlAdapterError(errorCode: string): void;
-export declare function reportDraftActionEvent(state: 'added' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
+export declare function reportDraftActionEvent(state: 'added' | 'uploading' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
 export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
 export declare function reportDraftAwareContentDocumentVersionSynthesizeError(err: unknown): void;
 export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;