@salesforce/lds-runtime-mobile 1.249.0 → 1.250.0

package/dist/main.js

@@ -4378,7 +4378,7 @@ function rootQuery(recordNodes, input) {
     if (fails.length > 0) {
         return failure(fails);
     }
-    return success({ type: 'root', connections });
+    return success({ type: 'root', connections, queryKeys: input.queryKeys });
 }
 /**
  * Given a connection array of LuvioSelectionCustomFieldNode
@@ -4598,11 +4598,11 @@ class StoreEvalPreconditioner {
         // require at least this top level record present to resolve relationship lookups
         const recordSelections = findRecordSelections(ast);
         let metadata = {};
+        const queryKeys = recordSelections.map((rs) => connectionKeyBuilder(rs, variables));
         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
+            let sqlResult = await sqliteStore.query(`select key, metadata from lds_data where key in (${queryKeys
                 .map(() => '?')
-                .join(',')})`, keys);
+                .join(',')})`, queryKeys);
             metadata = sqlResult.rows.reduce((metadata, row) => {
                 metadata[row[0]] = JSON.parse(row[1]);
                 return metadata;
@@ -4654,6 +4654,7 @@ class StoreEvalPreconditioner {
                 draftFunctions,
                 connectionKeyBuilder,
                 metadata,
+                queryKeys,
             });
             if (astTransformResult.isSuccess === false) {
                 for (const error of astTransformResult.error) {
@@ -4725,6 +4726,11 @@ async function evaluateSqlite(query, eventEmitter, store) {
     eventEmitter({ type: 'graphql-db-read', sql, bindings, duration: Date.now() - start });
     const data = JSON.parse(rawValue);
     const seenRecords = createSeenRecords$1(data);
+    if (query.queryKeys) {
+        for (const queryKey of query.queryKeys) {
+            seenRecords.add(queryKey);
+        }
+    }
     return { data, seenRecords };
 }
 const wrapStartEndEvents = (storeEval) => {
@@ -6948,6 +6954,20 @@ function buildQueryTypeStringKey(args) {
     return `${keyPrefix}::${schemaName}::${queryTypeName}[${serializeOperationNode(operationNode, variables, fragmentMap)}]`;
 }
 
+/**
+ * @description Spec compliant way to retrieve the correct Operation from the Document that Luvio should operate on. https://spec.graphql.org/June2018/#sec-Named-Operation-Definitions
+ * @param document
+ * @param operationName
+ * @returns The Operation in the GraphQL document we should use for the current call.
+ */
+function getOperationFromDocument(document, operationName) {
+    const operations = document.definitions.filter((def) => def.kind === 'OperationDefinition');
+    if (operationName) {
+        return operations.find((def) => def.name !== undefined && def.name.value === operationName);
+    }
+    return operations[0]; // If a named operation is not provided, we return the first one
+}
+
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
  * All rights reserved.
@@ -9553,9 +9573,9 @@ function extendExistingRecordType(schema, type, objectInfo, objectInfoMap) {
     const existingFields = keys$4(type.getFields());
     const missingFields = values$2(objectInfo.fields).filter((field) => {
         return (existingFields.includes(field.apiName) === false ||
-            (field.relationshipName !== null && field.referenceToInfos.length > 1));
+            (field.relationshipName !== null && field.referenceToInfos.length > 0));
     });
-    const { fields, polymorphicFieldTypeNames } = makeRecordField(missingFields, objectInfoMap, parentRelationshipFields, 'Cached');
+    const { fields, polymorphicFieldTypeNames } = makeRecordField(missingFields, objectInfoMap, parentRelationshipFields, 'Cached', existingFields);
     const { apiName, childRelationships } = objectInfo;
     // handles child relationship
     const { spanningRecordConnections, typedScalars: spanningConnectionTypedScalars } = makeSpanningRecordConnections(schema, childRelationships, objectInfoMap, parentRelationshipFields, existingFields);
@@ -9630,7 +9650,7 @@ function makeSpanningRecordConnections(schema, childRelationships, objectInfoMap
  * @param recordTypeInSchema
  * @returns
  */
-function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRelationships, recordTypeInSchema) {
+function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRelationships, recordTypeInSchema, existingFields = []) {
     const polymorphicFieldTypeNames = new Set();
     let fields = ``;
     for (const field of values$2(fieldRepresentations)) {
@@ -9647,7 +9667,8 @@ function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRela
             // Only add the relationship if there is relevant objectinfos for it,
             // otherwise we'd be defining types we cannot satisfy and aren't referenced in
             // the query.
-            if (objectInfoMap[relation.apiName] !== undefined) {
+            if (objectInfoMap[relation.apiName] !== undefined &&
+                existingFields.includes(field.relationshipName) === false) {
                 existingParentRelationships.add(field.relationshipName);
                 fields += `${field.relationshipName}: ${relation.apiName}\n`;
             }
@@ -9720,6 +9741,8 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
     // this is only wrapped in a try to execute the event after the result was returned
     try {
         eventEmitter({ type: 'graphql-eval-start' });
+        const operationNode = getOperationFromDocument(config.query);
+        let topLevelQueries = [];
         // assume that 'config.query' has required injected fields.
         const modifiedAST = visit(config.query, {
             Field: {
@@ -9749,6 +9772,25 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
                     };
                 },
             },
+            Directive: {
+                enter(node, _key, _parent, _path, ancester) {
+                    if (node.name.value === 'category' && node.arguments !== undefined) {
+                        for (let i = 0, len = node.arguments.length; i < len; i++) {
+                            const argument = node.arguments[i];
+                            if (isStringValueNode(argument.value) &&
+                                argument.value.value === 'recordQuery') {
+                                const parentNode = ancester[ancester.length - 1];
+                                if (isFieldNode(parentNode)) {
+                                    topLevelQueries.push({
+                                        argumentNodes: parentNode.arguments || [],
+                                        recordName: parentNode.name.value,
+                                    });
+                                }
+                            }
+                        }
+                    }
+                },
+            },
         });
         eventEmitter({ type: 'graphql-preconditions-met' });
         // create the resolver request context, runtime values and functions for
@@ -9767,7 +9809,18 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
             rootValue: {},
         }));
         eventEmitter({ type: 'graphql-evaluated' });
-        return { result, seenRecordIds: [...contextValue.seenRecordIds] };
+        // add record key to seen ids
+        const seenRecordIds = [...contextValue.seenRecordIds].map((id) => `UiApi::RecordRepresentation:${id}`);
+        // if we have all the data to build the top level query
+        // add it to the seen ids
+        if (operationNode !== undefined && topLevelQueries.length > 0) {
+            topLevelQueries.forEach((query) => {
+                const { recordName, argumentNodes } = query;
+                const queryString = buildKeyStringForRecordQuery(operationNode, config.variables || {}, argumentNodes, recordName);
+                seenRecordIds.push(queryString);
+            });
+        }
+        return { result, seenRecordIds };
     }
     finally {
         eventEmitter({ type: 'graphql-eval-end' });
@@ -13147,14 +13200,12 @@ function isLocalEvalSnapshot(snapshot) {
     return 'rebuildWithLocalEval' in snapshot;
 }
 function createSeenRecords(ids, currentSnapshot) {
-    let seenRecords = ids
-        .map((id) => `UiApi::RecordRepresentation:${id}`)
-        .reduce((acc, curr) => (acc.add(curr), acc), new StoreKeySet());
+    let seenRecords = ids.reduce((acc, curr) => (acc.add(curr), acc), new StoreKeySet());
     if (currentSnapshot.state !== 'Error') {
         currentSnapshot.seenRecords.forEach((record) => {
             let keyString = typeof record !== 'string' ? serializeStructuredKey(record) : record;
-            if (keyString !== 'UiApi::GraphQLRepresentation__uiapi' &&
-                keyString !== 'UiApi::GraphQLRepresentation__uiapi__query' &&
+            if (keyString !== 'UiApi::uiapi::Query[uiapi]__uiapi' &&
+                keyString !== 'UiApi::uiapi::Query[uiapi]__uiapi__query' &&
                 seenRecords.has(record) === false) {
                 seenRecords.add(record);
             }
@@ -17508,4 +17559,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.249.0-11c3e1ed5
+// version: 1.250.0-9df9bc3d1

package/package.json

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

package/sfdc/main.js

@@ -4378,7 +4378,7 @@ function rootQuery(recordNodes, input) {
     if (fails.length > 0) {
         return failure(fails);
     }
-    return success({ type: 'root', connections });
+    return success({ type: 'root', connections, queryKeys: input.queryKeys });
 }
 /**
  * Given a connection array of LuvioSelectionCustomFieldNode
@@ -4598,11 +4598,11 @@ class StoreEvalPreconditioner {
         // require at least this top level record present to resolve relationship lookups
         const recordSelections = findRecordSelections(ast);
         let metadata = {};
+        const queryKeys = recordSelections.map((rs) => connectionKeyBuilder(rs, variables));
         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
+            let sqlResult = await sqliteStore.query(`select key, metadata from lds_data where key in (${queryKeys
                 .map(() => '?')
-                .join(',')})`, keys);
+                .join(',')})`, queryKeys);
             metadata = sqlResult.rows.reduce((metadata, row) => {
                 metadata[row[0]] = JSON.parse(row[1]);
                 return metadata;
@@ -4654,6 +4654,7 @@ class StoreEvalPreconditioner {
                 draftFunctions,
                 connectionKeyBuilder,
                 metadata,
+                queryKeys,
             });
             if (astTransformResult.isSuccess === false) {
                 for (const error of astTransformResult.error) {
@@ -4725,6 +4726,11 @@ async function evaluateSqlite(query, eventEmitter, store) {
     eventEmitter({ type: 'graphql-db-read', sql, bindings, duration: Date.now() - start });
     const data = JSON.parse(rawValue);
     const seenRecords = createSeenRecords$1(data);
+    if (query.queryKeys) {
+        for (const queryKey of query.queryKeys) {
+            seenRecords.add(queryKey);
+        }
+    }
     return { data, seenRecords };
 }
 const wrapStartEndEvents = (storeEval) => {
@@ -6948,6 +6954,20 @@ function buildQueryTypeStringKey(args) {
     return `${keyPrefix}::${schemaName}::${queryTypeName}[${serializeOperationNode(operationNode, variables, fragmentMap)}]`;
 }
 
+/**
+ * @description Spec compliant way to retrieve the correct Operation from the Document that Luvio should operate on. https://spec.graphql.org/June2018/#sec-Named-Operation-Definitions
+ * @param document
+ * @param operationName
+ * @returns The Operation in the GraphQL document we should use for the current call.
+ */
+function getOperationFromDocument(document, operationName) {
+    const operations = document.definitions.filter((def) => def.kind === 'OperationDefinition');
+    if (operationName) {
+        return operations.find((def) => def.name !== undefined && def.name.value === operationName);
+    }
+    return operations[0]; // If a named operation is not provided, we return the first one
+}
+
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
  * All rights reserved.
@@ -9553,9 +9573,9 @@ function extendExistingRecordType(schema, type, objectInfo, objectInfoMap) {
     const existingFields = keys$4(type.getFields());
     const missingFields = values$2(objectInfo.fields).filter((field) => {
         return (existingFields.includes(field.apiName) === false ||
-            (field.relationshipName !== null && field.referenceToInfos.length > 1));
+            (field.relationshipName !== null && field.referenceToInfos.length > 0));
     });
-    const { fields, polymorphicFieldTypeNames } = makeRecordField(missingFields, objectInfoMap, parentRelationshipFields, 'Cached');
+    const { fields, polymorphicFieldTypeNames } = makeRecordField(missingFields, objectInfoMap, parentRelationshipFields, 'Cached', existingFields);
     const { apiName, childRelationships } = objectInfo;
     // handles child relationship
     const { spanningRecordConnections, typedScalars: spanningConnectionTypedScalars } = makeSpanningRecordConnections(schema, childRelationships, objectInfoMap, parentRelationshipFields, existingFields);
@@ -9630,7 +9650,7 @@ function makeSpanningRecordConnections(schema, childRelationships, objectInfoMap
  * @param recordTypeInSchema
  * @returns
  */
-function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRelationships, recordTypeInSchema) {
+function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRelationships, recordTypeInSchema, existingFields = []) {
     const polymorphicFieldTypeNames = new Set();
     let fields = ``;
     for (const field of values$2(fieldRepresentations)) {
@@ -9647,7 +9667,8 @@ function makeRecordField(fieldRepresentations, objectInfoMap, existingParentRela
             // Only add the relationship if there is relevant objectinfos for it,
             // otherwise we'd be defining types we cannot satisfy and aren't referenced in
             // the query.
-            if (objectInfoMap[relation.apiName] !== undefined) {
+            if (objectInfoMap[relation.apiName] !== undefined &&
+                existingFields.includes(field.relationshipName) === false) {
                 existingParentRelationships.add(field.relationshipName);
                 fields += `${field.relationshipName}: ${relation.apiName}\n`;
             }
@@ -9720,6 +9741,8 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
     // this is only wrapped in a try to execute the event after the result was returned
     try {
         eventEmitter({ type: 'graphql-eval-start' });
+        const operationNode = getOperationFromDocument(config.query);
+        let topLevelQueries = [];
         // assume that 'config.query' has required injected fields.
         const modifiedAST = visit(config.query, {
             Field: {
@@ -9749,6 +9772,25 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
                     };
                 },
             },
+            Directive: {
+                enter(node, _key, _parent, _path, ancester) {
+                    if (node.name.value === 'category' && node.arguments !== undefined) {
+                        for (let i = 0, len = node.arguments.length; i < len; i++) {
+                            const argument = node.arguments[i];
+                            if (isStringValueNode(argument.value) &&
+                                argument.value.value === 'recordQuery') {
+                                const parentNode = ancester[ancester.length - 1];
+                                if (isFieldNode(parentNode)) {
+                                    topLevelQueries.push({
+                                        argumentNodes: parentNode.arguments || [],
+                                        recordName: parentNode.name.value,
+                                    });
+                                }
+                            }
+                        }
+                    }
+                },
+            },
         });
         eventEmitter({ type: 'graphql-preconditions-met' });
         // create the resolver request context, runtime values and functions for
@@ -9767,7 +9809,18 @@ async function evaluate(config, observers, settings, objectInfos, store, snapsho
             rootValue: {},
         }));
         eventEmitter({ type: 'graphql-evaluated' });
-        return { result, seenRecordIds: [...contextValue.seenRecordIds] };
+        // add record key to seen ids
+        const seenRecordIds = [...contextValue.seenRecordIds].map((id) => `UiApi::RecordRepresentation:${id}`);
+        // if we have all the data to build the top level query
+        // add it to the seen ids
+        if (operationNode !== undefined && topLevelQueries.length > 0) {
+            topLevelQueries.forEach((query) => {
+                const { recordName, argumentNodes } = query;
+                const queryString = buildKeyStringForRecordQuery(operationNode, config.variables || {}, argumentNodes, recordName);
+                seenRecordIds.push(queryString);
+            });
+        }
+        return { result, seenRecordIds };
     }
     finally {
         eventEmitter({ type: 'graphql-eval-end' });
@@ -13147,14 +13200,12 @@ function isLocalEvalSnapshot(snapshot) {
     return 'rebuildWithLocalEval' in snapshot;
 }
 function createSeenRecords(ids, currentSnapshot) {
-    let seenRecords = ids
-        .map((id) => `UiApi::RecordRepresentation:${id}`)
-        .reduce((acc, curr) => (acc.add(curr), acc), new StoreKeySet());
+    let seenRecords = ids.reduce((acc, curr) => (acc.add(curr), acc), new StoreKeySet());
     if (currentSnapshot.state !== 'Error') {
         currentSnapshot.seenRecords.forEach((record) => {
             let keyString = typeof record !== 'string' ? serializeStructuredKey(record) : record;
-            if (keyString !== 'UiApi::GraphQLRepresentation__uiapi' &&
-                keyString !== 'UiApi::GraphQLRepresentation__uiapi__query' &&
+            if (keyString !== 'UiApi::uiapi::Query[uiapi]__uiapi' &&
+                keyString !== 'UiApi::uiapi::Query[uiapi]__uiapi__query' &&
                 seenRecords.has(record) === false) {
                 seenRecords.add(record);
             }
@@ -17508,4 +17559,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.249.0-11c3e1ed5
+// version: 1.250.0-9df9bc3d1