DHFPROD-3581: Search within a specific facet of string datatype

Author: rahulvudutala

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/data-services/searchFacetValues/searchFacetValues.api

@@ -0,0 +1,29 @@
+{
+  "functionName": "getFacetValues",
+  "params": [
+    {
+      "name": "entityName",
+      "datatype": "string"
+    },
+    {
+      "name": "facetName",
+      "datatype": "string"
+    },
+    {
+      "name": "indexType",
+      "datatype": "string"
+    },
+    {
+      "name": "searchStr",
+      "datatype": "string"
+    },
+    {
+      "name": "limit",
+      "datatype": "int"
+    }
+  ],
+  "return": {
+    "datatype": "jsonDocument",
+    "$javaClass": "com.fasterxml.jackson.databind.JsonNode"
+  }
+}

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/data-services/searchFacetValues/searchFacetValues.sjs

@@ -0,0 +1,31 @@
+'use strict';
+
+var entityName;
+var facetName;
+var indexType;
+var searchStr;
+var limit;
+
+var query;
+
+if(indexType === 'elementRangeIndex') {
+  query = cts.elementReference(facetName);
+} else if(indexType === 'fieldRangeIndex') {
+  query = cts.fieldReference(facetName);
+} else if(indexType === 'collection') {
+  query = cts.collectionReference();
+} else {
+  query = cts.pathReference("//*:instance/" + entityName + "/" + facetName);
+}
+
+var facetValues = cts.valueMatch(query, searchStr + "*",
+    ["item-order", "ascending", "limit=" + limit]).toArray().map(String);
+
+if (facetValues.length < limit) {
+  var moreFacetValues = cts.valueMatch(query, "?*" + searchStr + "*",
+      ["item-order", "ascending", "limit=" + limit]).toArray().map(String);
+  facetValues = Array.from(
+      [...new Set([...facetValues, ...moreFacetValues])]).slice(0, limit);
+}
+
+facetValues;

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/data-services/searchFacetValues/service.json

@@ -0,0 +1,4 @@
+{
+  "endpointDirectory": "/data-hub/5/data-services/searchFacetValues/",
+  "$javaClass": "com.marklogic.hub.dataservices.FacetValuesSearch"
+}

marklogic-data-hub/src/test/java/com/marklogic/bootstrap/Installer.java

@@ -1,10 +1,16 @@
 package com.marklogic.bootstrap;
 
 
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
 import com.marklogic.hub.ApplicationConfig;
 import com.marklogic.hub.HubTestBase;
 import com.marklogic.mgmt.api.API;
 import com.marklogic.mgmt.api.security.User;
+
+import org.apache.commons.io.FileUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.SpringApplication;
@@ -40,6 +46,14 @@ public void bootstrapHub() {
         }
 
         if (!isInstalled) {
+            try {
+                Path srcDir = Paths.get("src", "test", "ml-config", "databases","final-database.json");
+                Path dstDir = Paths.get(adminHubConfig.getUserDatabaseDir().toString(), "test-final-database.json");
+                FileUtils.copyFile(srcDir.toAbsolutePath().toFile(), dstDir.toAbsolutePath().toFile());
+            } catch (IOException ioe) {
+                ioe.printStackTrace();
+            }
+
             dataHub.install();
 
             User dataHubDeveloper = new User(new API(adminHubConfig.getManageClient()), "test-data-hub-developer");

marklogic-data-hub/src/test/ml-config/databases/final-database.json

@@ -18,6 +18,23 @@
       "collation" : "http://marklogic.com/collation//S1",
       "range-value-positions" : false,
       "invalid-values" : "reject"
+    },
+    {
+      "scalar-type" : "string",
+      "namespace-uri" : "",
+      "localname" : "searchStrCityFacet",
+      "collation" : "http://marklogic.com/collation/",
+      "range-value-positions" : false,
+      "invalid-values" : "reject"
+    }
+  ],
+  "range-path-index": [
+    {
+      "scalar-type": "string",
+      "path-expression": "//*:instance/SearchFacetsEntity/searchStrNameFacet",
+      "collation": "http://marklogic.com/collation/",
+      "range-value-positions": false,
+      "invalid-values": "reject"
     }
   ]
 }

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/searchFacetValues/searchStringFacetValuesTest.sjs

@@ -0,0 +1,62 @@
+const test = require("/test/test-helper.xqy");
+
+function invokeService(entityName, facetName, indexType, searchStr, limit) {
+  return fn.head(xdmp.invoke(
+      "/data-hub/5/data-services/searchFacetValues/searchFacetValues.sjs",
+      {
+        "entityName": entityName,
+        "facetName": facetName,
+        "indexType": indexType,
+        "searchStr": searchStr,
+        "limit": limit
+      }
+  ));
+}
+
+function testSearchOnRangePathIndexes() {
+  const result = invokeService("SearchFacetsEntity", "searchStrNameFacet",
+      "rangeIndex", "name", 10);
+  return [
+    test.assertEqual(3, result.length),
+    test.assertTrue(result.includes("firstName1")),
+    test.assertTrue(result.includes("firstName2")),
+    test.assertTrue(result.includes("firstName3"))
+  ];
+}
+
+function testSearchOnRangeElementIndexes() {
+  const result = invokeService("", "searchStrCityFacet", "elementRangeIndex",
+      "ra", 10);
+  return [
+    test.assertEqual(2, result.length),
+    test.assertTrue(result.includes("ranchi")),
+    test.assertTrue(result.includes("Raleigh"))
+  ];
+}
+
+function testSearchOnRangeFieldIndexes() {
+  const result = invokeService("", "datahubCreatedInFlow", "fieldRangeIndex",
+      "flow", 10);
+  return [
+    test.assertEqual(3, result.length),
+    test.assertTrue(result.includes("my-flow-1")),
+    test.assertTrue(result.includes("my-flow-2")),
+    test.assertTrue(result.includes("my-flow-3"))
+  ];
+}
+
+function testSearchOnCollectionNames() {
+  const result = invokeService("", "", "collection", "doc", 10);
+  return [
+    test.assertEqual(3, result.length),
+    test.assertTrue(result.includes("doc1")),
+    test.assertTrue(result.includes("doc2")),
+    test.assertTrue(result.includes("doc3"))
+  ];
+}
+
+[]
+.concat(testSearchOnRangePathIndexes())
+.concat(testSearchOnRangeElementIndexes())
+.concat(testSearchOnRangeFieldIndexes())
+.concat(testSearchOnCollectionNames());

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/searchFacetValues/suiteSetup.sjs

@@ -0,0 +1,61 @@
+declareUpdate();
+
+xdmp.documentInsert("/exp/doc1",
+    {
+      "envelope": {
+        "instance": {
+          "SearchFacetsEntity": {
+            "searchStrNameFacet": "firstName1",
+            "searchStrCityFacet": "Reims"
+          }
+        }
+      }
+    },
+    {
+      permissions: xdmp.defaultPermissions(),
+      collections: "doc1",
+      metadata: {
+        "datahubCreatedInFlow": "my-flow-1",
+        "datahubCreatedByStep": "my-step-1"
+      }
+    });
+
+xdmp.documentInsert("/exp/doc2",
+    {
+      "envelope": {
+        "instance": {
+          "SearchFacetsEntity": {
+            "searchStrNameFacet": "firstName2",
+            "searchStrCityFacet": "Raleigh"
+          }
+        }
+      }
+    },
+    {
+      permissions: xdmp.defaultPermissions(),
+      collections: "doc2",
+      metadata: {
+        "datahubCreatedInFlow": "my-flow-2",
+        "datahubCreatedByStep": "my-step-2"
+      }
+    });
+
+xdmp.documentInsert("/exp/doc3",
+    {
+      "envelope": {
+        "instance": {
+          "SearchFacetsEntity": {
+            "searchStrNameFacet": "firstName3",
+            "searchStrCityFacet": "ranchi"
+          }
+        }
+      }
+    },
+    {
+      permissions: xdmp.defaultPermissions(),
+      collections: "doc3",
+      metadata: {
+        "datahubCreatedInFlow": "my-flow-3",
+        "datahubCreatedByStep": "my-step-3"
+      }
+    });

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/searchFacetValues/suiteTeardown.sjs

@@ -0,0 +1,5 @@
+declareUpdate();
+
+xdmp.collectionDelete("doc1");
+xdmp.collectionDelete("doc2");
+xdmp.collectionDelete("doc3");