@salesforce/lds-runtime-mobile 1.142.0 → 1.143.0

package/dist/main.js

@@ -13,7 +13,7 @@
  */
 import { withRegistration, register } from '@salesforce/lds-default-luvio';
 import { setupInstrumentation, instrumentAdapter as instrumentAdapter$1, instrumentLuvio, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation } from '@salesforce/lds-instrumentation';
-import { HttpStatusCode, buildStaleWhileRevalidateImplementation, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from '@luvio/engine';
+import { HttpStatusCode, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from '@luvio/engine';
 import { parseAndVisit, Kind, visit, execute, buildSchema, isObjectType, defaultFieldResolver } from '@luvio/graphql-parser';
 import { getRecordId18, keyBuilderQuickActionExecutionRepresentation, ingestQuickActionExecutionRepresentation, keyBuilderContentDocumentCompositeRepresentation, getResponseCacheKeysContentDocumentCompositeRepresentation, keyBuilderFromTypeContentDocumentCompositeRepresentation, ingestContentDocumentCompositeRepresentation, keyBuilderRecord, getTypeCacheKeysRecord, keyBuilderFromTypeRecordRepresentation, ingestRecord, RecordRepresentationRepresentationType, ObjectInfoRepresentationType, getRecordAdapterFactory, getObjectInfoAdapterFactory, getObjectInfosAdapterFactory, UiApiNamespace, RecordRepresentationType, RecordRepresentationTTL, RecordRepresentationVersion } from '@salesforce/lds-adapters-uiapi';
 import caseSensitiveUserId from '@salesforce/user/Id';
@@ -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.,
@@ -758,7 +761,7 @@ class DurableTTLStore {
     }
 }
 
-function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler) {
+function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, additionalDurableStoreOperations = []) {
     const durableRecords = create$5(null);
     const evictedRecords = create$5(null);
     const { records, metadata: storeMetadata, visitedIds, refreshedIds, } = store.fallbackStringKeyInMemoryStore;
@@ -785,7 +788,7 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
             };
         }
     }
-    const durableStoreOperations = [];
+    const durableStoreOperations = additionalDurableStoreOperations;
     // publishes
     const recordKeys = keys$6(durableRecords);
     if (recordKeys.length > 0) {
@@ -877,7 +880,7 @@ async function reviveOrCreateContext(adapterId, durableStore, durableStoreErrorH
     }
     return contextReturn();
 }
-function isUnfulfilledSnapshot(cachedSnapshotResult) {
+function isUnfulfilledSnapshot$1(cachedSnapshotResult) {
     if (cachedSnapshotResult === undefined) {
         return false;
     }
@@ -888,7 +891,8 @@ function isUnfulfilledSnapshot(cachedSnapshotResult) {
 }
 /**
  * Configures the environment to persist data into a durable store and attempt to resolve
- * data from the persistent store before hitting the network.
+ * data from the persistent store before hitting the network.  Sets the default
+ * cache policy to stale-while-revalidate with infinite staleDuration.
  *
  * @param environment The base environment
  * @param durableStore A DurableStore implementation
@@ -1028,12 +1032,12 @@ function makeDurable(environment, { durableStore, instrumentation }) {
         // call the base storeBroadcast
         return publishChangesToDurableStore();
     };
-    const publishChangesToDurableStore = function () {
+    const publishChangesToDurableStore = function (additionalDurableStoreOperations) {
         validateNotDisposed();
         if (ingestStagingStore === null) {
             return Promise.resolve();
         }
-        const promise = flushInMemoryStoreValuesToDurableStore(ingestStagingStore, durableStore, durableStoreErrorHandler);
+        const promise = flushInMemoryStoreValuesToDurableStore(ingestStagingStore, durableStore, durableStoreErrorHandler, additionalDurableStoreOperations);
         ingestStagingStore = null;
         return promise;
     };
@@ -1160,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) => {
@@ -1313,10 +1317,11 @@ function makeDurable(environment, { durableStore, instrumentation }) {
             return entries;
         });
     };
-    environment.defaultCachePolicy = {
+    // set the default cache policy of the base environment
+    environment.setDefaultCachePolicy({
         type: 'stale-while-revalidate',
-        implementation: buildStaleWhileRevalidateImplementation(Number.MAX_SAFE_INTEGER),
-    };
+        staleDurationSeconds: Number.MAX_SAFE_INTEGER,
+    });
     return create$5(environment, {
         publishStoreMetadata: { value: publishStoreMetadata },
         storeIngest: { value: storeIngest },
@@ -12531,6 +12536,7 @@ function draftAwareGraphQLAdapterFactory(userId, objectInfoService, store, luvio
                 query: injectedAST,
             },
             luvio,
+            gqlEval: true,
         }, buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy));
         if (isErrorSnapshotThatShouldGetReturnedToCaller(nonEvaluatedSnapshot)) {
             return nonEvaluatedSnapshot;
@@ -15112,8 +15118,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) => {
@@ -15129,8 +15144,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) },
     });
 }
 
@@ -15883,4 +15954,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.142.0-7730e2a14
+// version: 1.143.0-a6d2a998d

package/package.json

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

package/sfdc/main.js

@@ -13,7 +13,7 @@
  */
 import { withRegistration, register } from 'native/ldsEngineMobile';
 import { setupInstrumentation, instrumentAdapter as instrumentAdapter$1, instrumentLuvio, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation } from 'force/ldsInstrumentation';
-import { HttpStatusCode, buildStaleWhileRevalidateImplementation, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from 'force/luvioEngine';
+import { HttpStatusCode, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from 'force/luvioEngine';
 import { parseAndVisit, Kind, visit, execute, buildSchema, isObjectType, defaultFieldResolver } from 'force/ldsGraphqlParser';
 import { getRecordId18, keyBuilderQuickActionExecutionRepresentation, ingestQuickActionExecutionRepresentation, keyBuilderContentDocumentCompositeRepresentation, getResponseCacheKeysContentDocumentCompositeRepresentation, keyBuilderFromTypeContentDocumentCompositeRepresentation, ingestContentDocumentCompositeRepresentation, keyBuilderRecord, getTypeCacheKeysRecord, keyBuilderFromTypeRecordRepresentation, ingestRecord, RecordRepresentationRepresentationType, ObjectInfoRepresentationType, getRecordAdapterFactory, getObjectInfoAdapterFactory, getObjectInfosAdapterFactory, UiApiNamespace, RecordRepresentationType, RecordRepresentationTTL, RecordRepresentationVersion } from 'force/ldsAdaptersUiapi';
 import caseSensitiveUserId from '@salesforce/user/Id';
@@ -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.,
@@ -758,7 +761,7 @@ class DurableTTLStore {
     }
 }
 
-function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler) {
+function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, additionalDurableStoreOperations = []) {
     const durableRecords = create$5(null);
     const evictedRecords = create$5(null);
     const { records, metadata: storeMetadata, visitedIds, refreshedIds, } = store.fallbackStringKeyInMemoryStore;
@@ -785,7 +788,7 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
             };
         }
     }
-    const durableStoreOperations = [];
+    const durableStoreOperations = additionalDurableStoreOperations;
     // publishes
     const recordKeys = keys$6(durableRecords);
     if (recordKeys.length > 0) {
@@ -877,7 +880,7 @@ async function reviveOrCreateContext(adapterId, durableStore, durableStoreErrorH
     }
     return contextReturn();
 }
-function isUnfulfilledSnapshot(cachedSnapshotResult) {
+function isUnfulfilledSnapshot$1(cachedSnapshotResult) {
     if (cachedSnapshotResult === undefined) {
         return false;
     }
@@ -888,7 +891,8 @@ function isUnfulfilledSnapshot(cachedSnapshotResult) {
 }
 /**
  * Configures the environment to persist data into a durable store and attempt to resolve
- * data from the persistent store before hitting the network.
+ * data from the persistent store before hitting the network.  Sets the default
+ * cache policy to stale-while-revalidate with infinite staleDuration.
  *
  * @param environment The base environment
  * @param durableStore A DurableStore implementation
@@ -1028,12 +1032,12 @@ function makeDurable(environment, { durableStore, instrumentation }) {
         // call the base storeBroadcast
         return publishChangesToDurableStore();
     };
-    const publishChangesToDurableStore = function () {
+    const publishChangesToDurableStore = function (additionalDurableStoreOperations) {
         validateNotDisposed();
         if (ingestStagingStore === null) {
             return Promise.resolve();
         }
-        const promise = flushInMemoryStoreValuesToDurableStore(ingestStagingStore, durableStore, durableStoreErrorHandler);
+        const promise = flushInMemoryStoreValuesToDurableStore(ingestStagingStore, durableStore, durableStoreErrorHandler, additionalDurableStoreOperations);
         ingestStagingStore = null;
         return promise;
     };
@@ -1160,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) => {
@@ -1313,10 +1317,11 @@ function makeDurable(environment, { durableStore, instrumentation }) {
             return entries;
         });
     };
-    environment.defaultCachePolicy = {
+    // set the default cache policy of the base environment
+    environment.setDefaultCachePolicy({
         type: 'stale-while-revalidate',
-        implementation: buildStaleWhileRevalidateImplementation(Number.MAX_SAFE_INTEGER),
-    };
+        staleDurationSeconds: Number.MAX_SAFE_INTEGER,
+    });
     return create$5(environment, {
         publishStoreMetadata: { value: publishStoreMetadata },
         storeIngest: { value: storeIngest },
@@ -12531,6 +12536,7 @@ function draftAwareGraphQLAdapterFactory(userId, objectInfoService, store, luvio
                 query: injectedAST,
             },
             luvio,
+            gqlEval: true,
         }, buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy));
         if (isErrorSnapshotThatShouldGetReturnedToCaller(nonEvaluatedSnapshot)) {
             return nonEvaluatedSnapshot;
@@ -15112,8 +15118,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) => {
@@ -15129,8 +15144,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) },
     });
 }
 
@@ -15883,4 +15954,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.142.0-7730e2a14
+// version: 1.143.0-a6d2a998d