DHFPROD-7303: add primary key to default selected properties

Author: ryanjdew

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/entities/entity-search-lib.sjs

@@ -93,6 +93,8 @@ function buildAllMetadata(parentPropertyName, entityModel, entityName) {
     const isStructuredProperty = property.datatype != "array" && property["$ref"];
     const isStructuredArrayProperty = property.datatype == "array" && (property["items"] && property["items"]["$ref"]);
 
+    const isPrimaryKey = propertyName === entityType.primaryKey;
+
     const propertyMetadata = {};
     const propertyMetadataObject = {};
 
@@ -132,7 +134,12 @@ function buildAllMetadata(parentPropertyName, entityModel, entityName) {
       granularPropertyMetadata = Object.assign({},granularPropertyMetadata, metaData["granularPropertyMetadata"]);
     }
     granularPropertyMetadata[propertyMetadataObject["propertyPath"]] = propertyMetadataObject;
-    allPropertiesMetadata.push(propertyMetadata);
+    // Ensure the primary key property goes first in the array so it is selected by default
+    if (isPrimaryKey) {
+      allPropertiesMetadata.unshift(propertyMetadata);
+    } else {
+      allPropertiesMetadata.push(propertyMetadata);
+    }
   }
 
   const allMetadata = {};

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/entitySearch/searchResultFacetsTest.sjs

@@ -6,13 +6,24 @@ function datahubSourceNameAndTypeFacetsTest() {
   const options = hent.dumpSearchOptions(fn.doc("/entities/Customer.entity.json").toObject(), true);
   const searchResults = fn.head(search.search('', options));
 
-  return[
+  return [
     test.assertEqual("testSourceForCustomer", xs.string(fn.head(searchResults.xpath("/*:facet[@name = 'sourceName']/*:facet-value[1]/text()")))),
     test.assertEqual("testSourceForCustomerXML", xs.string(fn.head(searchResults.xpath("/*:facet[@name = 'sourceName']/*:facet-value[2]/text()")))),
     test.assertEqual("testSourceType", xs.string(fn.head(searchResults.xpath("/*:facet[@name = 'sourceType']/*:facet-value[1]/text()")))),
     test.assertEqual("testSourceTypeXML", xs.string(fn.head(searchResults.xpath("/*:facet[@name = 'sourceType']/*:facet-value[2]/text()"))))
   ];
 }
 
+function selectedPropertiesTransformTest() {
+  const searchResultsTransform = require('/marklogic.rest.transform/hubEntitySearchTransform/assets/transform.sjs');
+  const transformedResults = searchResultsTransform.transform({}, { entityName: 'Customer'}, xdmp.toJSON({ results: []}));
+
+  return[
+    test.assertTrue(transformedResults.selectedPropertyDefinitions && transformedResults.selectedPropertyDefinitions.length >= 1, `There should be at least one selected property. Results: ${xdmp.toJsonString(transformedResults)}`),
+    test.assertEqual("customerId", transformedResults.selectedPropertyDefinitions[0].propertyLabel, `The first selected property should be the primary key. selectedPropertiesDefinition[0]: ${xdmp.toJsonString(transformedResults.selectedPropertyDefinitions[0])}`)
+  ];
+}
+
 []
-    .concat(datahubSourceNameAndTypeFacetsTest());
+    .concat(datahubSourceNameAndTypeFacetsTest())
+    .concat(selectedPropertiesTransformTest());

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/entitySearch/test-data/entities/Customer.entity.json

@@ -11,9 +11,6 @@
       ],
       "primaryKey": "customerId",
       "properties": {
-        "customerId": {
-          "datatype": "integer"
-        },
         "name": {
           "datatype": "string",
           "collation": "http://marklogic.com/collation/codepoint"
@@ -41,6 +38,10 @@
         },
         "customerSince": {
           "datatype": "date"
+        },
+        "customerId": {
+          "datatype": "integer",
+          "description": "This is supposed to be last to test that the primary key is always included"
         }
       }
     },