@salesforce/lds-runtime-mobile 1.152.3 → 1.153.0

package/dist/main.js

@@ -14,6 +14,7 @@
 import { withRegistration, register } from '@salesforce/lds-default-luvio';
 import { setupInstrumentation, instrumentAdapter as instrumentAdapter$1, instrumentLuvio, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation } from '@salesforce/lds-instrumentation';
 import { HttpStatusCode, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from '@luvio/engine';
+import excludeStaleRecordsGate from '@salesforce/gate/lds.graphqlEvalExcludeStaleRecords';
 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';
@@ -2125,9 +2126,13 @@ const recordSuffix = 'edges';
 const pathPrefix = '$';
 const recordsCTE = 'recordsCTE';
 const MultiPickListValueSeparator$1 = ';';
+const recordCTESQL = excludeStaleRecordsGate.isOpen({ fallback: false })
+    ? `WITH ${recordsCTE} AS NOT materialized ` +
+        `(select data, metadata from lds_data where key like 'UiApi::RecordRepresentation:%')`
+    : `WITH ${recordsCTE} AS NOT materialized ` +
+        `(select data from lds_data where key like 'UiApi::RecordRepresentation:%')`;
 function cteSql() {
-    return (`WITH ${recordsCTE} AS NOT materialized ` +
-        `(select data from lds_data where key like 'UiApi::RecordRepresentation:%')`);
+    return recordCTESQL;
 }
 function computeSql(rootQuery) {
     const fields = rootQuery.connections.map((connection) => {
@@ -2404,6 +2409,14 @@ function expressionToSql(expression, targetDataType, operator) {
             if (expression.subfield === 'displayValue' && targetDataType === 'Boolean') {
                 return { sql: 'null', bindings: [] };
             }
+            // metadata extract is somewhat different than a data extract
+            if (expression.metadata === true) {
+                let sql = `json_extract("${expression.jsonAlias}".metadata, '${pathPrefix}.${expression.field}')`;
+                if (targetDataType !== undefined) {
+                    sql = coerceToTargetDataType(sql, targetDataType);
+                }
+                return { sql, bindings: [] };
+            }
             let path = extractPath(expression.field, expression.subfield);
             // For multiple picklist includes/excluding filtering, we need to prefix and suffix the field value with ';'
             // to make the match safe.
@@ -4040,6 +4053,39 @@ function recordQuery(selection, apiName, alias, predicates, input) {
     const draftsField = { type: FieldType.Scalar, extract, path: 'node._drafts' };
     const idExtract = { type: ValueType.Extract, jsonAlias: alias, field: 'Id' };
     const idField = { type: FieldType.Scalar, extract: idExtract, path: 'node.Id' };
+    // When the exclude stale records gate is open, inject an additional predicate
+    // to limit the search to records that either have drafts associated to them or
+    // were ingested at least as recently as the query.
+    if (excludeStaleRecordsGate.isOpen({ fallback: false })) {
+        const key = input.connectionKeyBuilder(selection, input.config.variables);
+        const queryMetadata = input.metadata[key];
+        // If there is no metadata for this query or it somehow lacks a timestamp
+        // skip adding the additional predicates
+        if (queryMetadata !== undefined && queryMetadata.ingestionTimestamp !== undefined) {
+            const timestamp = queryMetadata.ingestionTimestamp;
+            const timestampCheck = {
+                type: PredicateType$1.comparison,
+                left: {
+                    type: ValueType.Extract,
+                    jsonAlias: alias,
+                    field: 'ingestionTimestamp',
+                    metadata: true,
+                },
+                operator: ComparisonOperator.gte,
+                right: { type: ValueType.IntLiteral, value: timestamp },
+            };
+            const isDraft = {
+                type: PredicateType$1.nullComparison,
+                left: { type: ValueType.Extract, jsonAlias: alias, field: 'drafts' },
+                operator: NullComparisonOperator.isNot,
+            };
+            predicates.push({
+                type: PredicateType$1.compound,
+                operator: CompoundOperator.or,
+                children: [timestampCheck, isDraft],
+            });
+        }
+    }
     return queryContainer(internalFields, alias, apiName, predicates).map((result) => {
         const { fields, predicates } = result;
         const allFields = removeDuplicateFields(fields.concat(...[draftsField, idField]));
@@ -4310,12 +4356,24 @@ class StoreEvalPreconditioner {
      * Missing object info records triggers the objectInfoService (same instance shared with Drafts code), to
      * use the getObjectInfos adapter to efficiently fetch the necessary records.
      */
-    async createRootQuery(config, objectInfoService, userId, draftFunctions) {
+    async createRootQuery(config, objectInfoService, userId, draftFunctions, connectionKeyBuilder, sqliteStore) {
         const { query: ast, variables } = config;
         swapVariableArguments(ast, variables);
         // Parse out top-level record queries types we know we will need, since spanning fields will
         // require at least this top level record present to resolve relationship lookups
-        const topLevelNeededRecords = findRecordSelections(ast).map((selection) => selection.name);
+        const recordSelections = findRecordSelections(ast);
+        let metadata = {};
+        if (excludeStaleRecordsGate.isOpen({ fallback: false })) {
+            const keys = recordSelections.map((rs) => connectionKeyBuilder(rs, variables));
+            let sqlResult = await sqliteStore.query(`select key, metadata from lds_data where key in (${keys
+                .map(() => '?')
+                .join(',')})`, keys);
+            metadata = sqlResult.rows.reduce((metadata, row) => {
+                metadata[row[0]] = JSON.parse(row[1]);
+                return metadata;
+            }, {});
+        }
+        const topLevelNeededRecords = recordSelections.map((selection) => selection.name);
         // Seed the initial list of things to fetch
         const neededObjectInfos = new Set(topLevelNeededRecords);
         // Seed the list of things we've _tried_ to fetch.  As we iterate and
@@ -4355,9 +4413,12 @@ class StoreEvalPreconditioner {
             };
             // Attempt to parse the AST given what we know already...
             astTransformResult = transform(ast, {
+                config,
                 userId,
                 objectInfoMap,
                 draftFunctions,
+                connectionKeyBuilder,
+                metadata,
             });
             if (astTransformResult.isSuccess === false) {
                 for (const error of astTransformResult.error) {
@@ -4432,10 +4493,10 @@ async function evaluateSqlite(query, eventEmitter, store) {
     return { data, seenRecords };
 }
 const wrapStartEndEvents = (storeEval) => {
-    return async (config, nonEvaluatedSnapshotOrPromise, observers) => {
+    return async (config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder) => {
         const eventEmitter = createCustomAdapterEventEmitter(GRAPHQL_EVAL_NAMESPACE$1, observers);
         eventEmitter({ type: 'graphql-eval-start' });
-        const snapshot = await storeEval(config, nonEvaluatedSnapshotOrPromise, observers);
+        const snapshot = await storeEval(config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder);
         eventEmitter({ type: 'graphql-eval-end' });
         return snapshot;
     };
@@ -4448,7 +4509,7 @@ function sqliteStoreEvalFactory(userId, sqliteStore, objectInfoService, draftFun
     const preconditioner = new StoreEvalPreconditioner();
     return makeStoreEval(preconditioner, objectInfoService, userId, async () => {
         return undefined;
-    }, (query, _context, eventEmitter) => evaluateSqlite(query, eventEmitter, sqliteStore), draftFunctions);
+    }, (query, _context, eventEmitter) => evaluateSqlite(query, eventEmitter, sqliteStore), draftFunctions, sqliteStore);
 }
 async function noopStoreEval(_config, nonEvaluatedSnapshotOrPromise, _observers) {
     return nonEvaluatedSnapshotOrPromise;
@@ -4467,8 +4528,8 @@ function isErrorSnapshotThatShouldGetReturnedToCaller$1(snapshot) {
 function generateUniqueRecordId$1() {
     return `${GRAPHQL_ROOT_KEY$1}${Date.now() + Math.random().toFixed(5).split('.')[1]}`;
 }
-function makeStoreEval(preconditioner, objectInfoService, userId, contextProvider, queryEvaluator, draftFunctions) {
-    const storeEval = async (config, nonEvaluatedSnapshotOrPromise, observers) => {
+function makeStoreEval(preconditioner, objectInfoService, userId, contextProvider, queryEvaluator, draftFunctions, sqliteStore) {
+    const storeEval = async (config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder) => {
         const eventEmitter = createCustomAdapterEventEmitter(GRAPHQL_EVAL_NAMESPACE$1, observers);
         // the non-eval'ed input could either be a snapshot or promise of one so
         // await it here to normalize the input to a snapshot
@@ -4497,7 +4558,7 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
             context = await contextProvider();
             // Ensures ObjectInfo metadata is available for the request.  Sourcing records from L1/L2/Network
             // is delegated to the getObjectInfo adapter via objectInfoService
-            rootQuery = await preconditioner.createRootQuery(config, objectInfoService, userId, draftFunctions);
+            rootQuery = await preconditioner.createRootQuery(config, objectInfoService, userId, draftFunctions, connectionKeyBuilder, sqliteStore);
         }
         catch (error) {
             eventEmitter({
@@ -4528,7 +4589,7 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
         try {
             const { data, seenRecords } = await queryEvaluator(rootQuery, context, eventEmitter);
             const rebuildWithStoreEval = ((originalSnapshot) => {
-                return storeEval(config, originalSnapshot, observers);
+                return storeEval(config, originalSnapshot, observers, connectionKeyBuilder);
             });
             const recordId = generateUniqueRecordId$1();
             // if the non-eval'ed snapshot was an error then we return a synthetic
@@ -15706,4 +15767,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.152.3-537a957a0
+// version: 1.153.0-8e8a8177b

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.152.3",
+    "version": "1.153.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",
@@ -57,17 +57,17 @@
         {
             "path": "./dist/main.js",
             "maxSize": {
-                "none": "667 kB",
-                "min": "273 kB",
-                "compressed": "105 kB"
+                "none": "675 kB",
+                "min": "275 kB",
+                "compressed": "110 kB"
             }
         },
         {
             "path": "./sfdc/main.js",
             "maxSize": {
-                "none": "667 kB",
-                "min": "273 kB",
-                "compressed": "105 kB"
+                "none": "675 kB",
+                "min": "275 kB",
+                "compressed": "110 kB"
             }
         }
     ],

package/sfdc/main.js

@@ -14,6 +14,7 @@
 import { withRegistration, register } from 'native/ldsEngineMobile';
 import { setupInstrumentation, instrumentAdapter as instrumentAdapter$1, instrumentLuvio, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation } from 'force/ldsInstrumentation';
 import { HttpStatusCode, StoreKeySet, serializeStructuredKey, Reader, deepFreeze, emitAdapterEvent, createCustomAdapterEventEmitter, StoreKeyMap, isFileReference, Environment, Luvio, InMemoryStore } from 'force/luvioEngine';
+import excludeStaleRecordsGate from '@salesforce/gate/lds.graphqlEvalExcludeStaleRecords';
 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';
@@ -2125,9 +2126,13 @@ const recordSuffix = 'edges';
 const pathPrefix = '$';
 const recordsCTE = 'recordsCTE';
 const MultiPickListValueSeparator$1 = ';';
+const recordCTESQL = excludeStaleRecordsGate.isOpen({ fallback: false })
+    ? `WITH ${recordsCTE} AS NOT materialized ` +
+        `(select data, metadata from lds_data where key like 'UiApi::RecordRepresentation:%')`
+    : `WITH ${recordsCTE} AS NOT materialized ` +
+        `(select data from lds_data where key like 'UiApi::RecordRepresentation:%')`;
 function cteSql() {
-    return (`WITH ${recordsCTE} AS NOT materialized ` +
-        `(select data from lds_data where key like 'UiApi::RecordRepresentation:%')`);
+    return recordCTESQL;
 }
 function computeSql(rootQuery) {
     const fields = rootQuery.connections.map((connection) => {
@@ -2404,6 +2409,14 @@ function expressionToSql(expression, targetDataType, operator) {
             if (expression.subfield === 'displayValue' && targetDataType === 'Boolean') {
                 return { sql: 'null', bindings: [] };
             }
+            // metadata extract is somewhat different than a data extract
+            if (expression.metadata === true) {
+                let sql = `json_extract("${expression.jsonAlias}".metadata, '${pathPrefix}.${expression.field}')`;
+                if (targetDataType !== undefined) {
+                    sql = coerceToTargetDataType(sql, targetDataType);
+                }
+                return { sql, bindings: [] };
+            }
             let path = extractPath(expression.field, expression.subfield);
             // For multiple picklist includes/excluding filtering, we need to prefix and suffix the field value with ';'
             // to make the match safe.
@@ -4040,6 +4053,39 @@ function recordQuery(selection, apiName, alias, predicates, input) {
     const draftsField = { type: FieldType.Scalar, extract, path: 'node._drafts' };
     const idExtract = { type: ValueType.Extract, jsonAlias: alias, field: 'Id' };
     const idField = { type: FieldType.Scalar, extract: idExtract, path: 'node.Id' };
+    // When the exclude stale records gate is open, inject an additional predicate
+    // to limit the search to records that either have drafts associated to them or
+    // were ingested at least as recently as the query.
+    if (excludeStaleRecordsGate.isOpen({ fallback: false })) {
+        const key = input.connectionKeyBuilder(selection, input.config.variables);
+        const queryMetadata = input.metadata[key];
+        // If there is no metadata for this query or it somehow lacks a timestamp
+        // skip adding the additional predicates
+        if (queryMetadata !== undefined && queryMetadata.ingestionTimestamp !== undefined) {
+            const timestamp = queryMetadata.ingestionTimestamp;
+            const timestampCheck = {
+                type: PredicateType$1.comparison,
+                left: {
+                    type: ValueType.Extract,
+                    jsonAlias: alias,
+                    field: 'ingestionTimestamp',
+                    metadata: true,
+                },
+                operator: ComparisonOperator.gte,
+                right: { type: ValueType.IntLiteral, value: timestamp },
+            };
+            const isDraft = {
+                type: PredicateType$1.nullComparison,
+                left: { type: ValueType.Extract, jsonAlias: alias, field: 'drafts' },
+                operator: NullComparisonOperator.isNot,
+            };
+            predicates.push({
+                type: PredicateType$1.compound,
+                operator: CompoundOperator.or,
+                children: [timestampCheck, isDraft],
+            });
+        }
+    }
     return queryContainer(internalFields, alias, apiName, predicates).map((result) => {
         const { fields, predicates } = result;
         const allFields = removeDuplicateFields(fields.concat(...[draftsField, idField]));
@@ -4310,12 +4356,24 @@ class StoreEvalPreconditioner {
      * Missing object info records triggers the objectInfoService (same instance shared with Drafts code), to
      * use the getObjectInfos adapter to efficiently fetch the necessary records.
      */
-    async createRootQuery(config, objectInfoService, userId, draftFunctions) {
+    async createRootQuery(config, objectInfoService, userId, draftFunctions, connectionKeyBuilder, sqliteStore) {
         const { query: ast, variables } = config;
         swapVariableArguments(ast, variables);
         // Parse out top-level record queries types we know we will need, since spanning fields will
         // require at least this top level record present to resolve relationship lookups
-        const topLevelNeededRecords = findRecordSelections(ast).map((selection) => selection.name);
+        const recordSelections = findRecordSelections(ast);
+        let metadata = {};
+        if (excludeStaleRecordsGate.isOpen({ fallback: false })) {
+            const keys = recordSelections.map((rs) => connectionKeyBuilder(rs, variables));
+            let sqlResult = await sqliteStore.query(`select key, metadata from lds_data where key in (${keys
+                .map(() => '?')
+                .join(',')})`, keys);
+            metadata = sqlResult.rows.reduce((metadata, row) => {
+                metadata[row[0]] = JSON.parse(row[1]);
+                return metadata;
+            }, {});
+        }
+        const topLevelNeededRecords = recordSelections.map((selection) => selection.name);
         // Seed the initial list of things to fetch
         const neededObjectInfos = new Set(topLevelNeededRecords);
         // Seed the list of things we've _tried_ to fetch.  As we iterate and
@@ -4355,9 +4413,12 @@ class StoreEvalPreconditioner {
             };
             // Attempt to parse the AST given what we know already...
             astTransformResult = transform(ast, {
+                config,
                 userId,
                 objectInfoMap,
                 draftFunctions,
+                connectionKeyBuilder,
+                metadata,
             });
             if (astTransformResult.isSuccess === false) {
                 for (const error of astTransformResult.error) {
@@ -4432,10 +4493,10 @@ async function evaluateSqlite(query, eventEmitter, store) {
     return { data, seenRecords };
 }
 const wrapStartEndEvents = (storeEval) => {
-    return async (config, nonEvaluatedSnapshotOrPromise, observers) => {
+    return async (config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder) => {
         const eventEmitter = createCustomAdapterEventEmitter(GRAPHQL_EVAL_NAMESPACE$1, observers);
         eventEmitter({ type: 'graphql-eval-start' });
-        const snapshot = await storeEval(config, nonEvaluatedSnapshotOrPromise, observers);
+        const snapshot = await storeEval(config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder);
         eventEmitter({ type: 'graphql-eval-end' });
         return snapshot;
     };
@@ -4448,7 +4509,7 @@ function sqliteStoreEvalFactory(userId, sqliteStore, objectInfoService, draftFun
     const preconditioner = new StoreEvalPreconditioner();
     return makeStoreEval(preconditioner, objectInfoService, userId, async () => {
         return undefined;
-    }, (query, _context, eventEmitter) => evaluateSqlite(query, eventEmitter, sqliteStore), draftFunctions);
+    }, (query, _context, eventEmitter) => evaluateSqlite(query, eventEmitter, sqliteStore), draftFunctions, sqliteStore);
 }
 async function noopStoreEval(_config, nonEvaluatedSnapshotOrPromise, _observers) {
     return nonEvaluatedSnapshotOrPromise;
@@ -4467,8 +4528,8 @@ function isErrorSnapshotThatShouldGetReturnedToCaller$1(snapshot) {
 function generateUniqueRecordId$1() {
     return `${GRAPHQL_ROOT_KEY$1}${Date.now() + Math.random().toFixed(5).split('.')[1]}`;
 }
-function makeStoreEval(preconditioner, objectInfoService, userId, contextProvider, queryEvaluator, draftFunctions) {
-    const storeEval = async (config, nonEvaluatedSnapshotOrPromise, observers) => {
+function makeStoreEval(preconditioner, objectInfoService, userId, contextProvider, queryEvaluator, draftFunctions, sqliteStore) {
+    const storeEval = async (config, nonEvaluatedSnapshotOrPromise, observers, connectionKeyBuilder) => {
         const eventEmitter = createCustomAdapterEventEmitter(GRAPHQL_EVAL_NAMESPACE$1, observers);
         // the non-eval'ed input could either be a snapshot or promise of one so
         // await it here to normalize the input to a snapshot
@@ -4497,7 +4558,7 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
             context = await contextProvider();
             // Ensures ObjectInfo metadata is available for the request.  Sourcing records from L1/L2/Network
             // is delegated to the getObjectInfo adapter via objectInfoService
-            rootQuery = await preconditioner.createRootQuery(config, objectInfoService, userId, draftFunctions);
+            rootQuery = await preconditioner.createRootQuery(config, objectInfoService, userId, draftFunctions, connectionKeyBuilder, sqliteStore);
         }
         catch (error) {
             eventEmitter({
@@ -4528,7 +4589,7 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
         try {
             const { data, seenRecords } = await queryEvaluator(rootQuery, context, eventEmitter);
             const rebuildWithStoreEval = ((originalSnapshot) => {
-                return storeEval(config, originalSnapshot, observers);
+                return storeEval(config, originalSnapshot, observers, connectionKeyBuilder);
             });
             const recordId = generateUniqueRecordId$1();
             // if the non-eval'ed snapshot was an error then we return a synthetic
@@ -15706,4 +15767,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.152.3-537a957a0
+// version: 1.153.0-8e8a8177b