DHFPROD-7956: Clear model info from HC config when deletes are published

Author: ryanjdew

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

@@ -237,6 +237,26 @@ function deleteDraftModel(entityName) {
   writeDraftModel(entityName, model)
 }
 
+function cleanupModelsFromHubCentralConfig(retainEntityNames) {
+  const hubCentralConfigURI = "/config/hubCentral.json";
+  const hubCentralConfig = fn.head(hubUtils.invokeFunction(() => cts.doc(hubCentralConfigURI), config.FINALDATABASE));
+  if (hubCentralConfig) {
+    const hubCentralConfigObj = hubCentralConfig.toObject();
+    if (hubCentralConfigObj.modeling && hubCentralConfigObj.modeling.entities) {
+      let changesMade = false;
+      for (let entityName of Object.keys(hubCentralConfigObj.modeling.entities)) {
+        if (!retainEntityNames.includes(entityName)) {
+          changesMade = true;
+          delete hubCentralConfigObj.modeling.entities[entityName];
+        }
+      }
+      if (changesMade) {
+        hubUtils.writeDocument(hubCentralConfigURI, hubCentralConfigObj, xdmp.nodePermissions(hubCentralConfig), xdmp.nodeCollections(hubCentralConfig), config.FINALDATABASE);
+      }
+    }
+  }
+}
+
 function deleteModel(entityName) {
   const uri = getModelUri(entityName);
   [...new Set([config.STAGINGDATABASE, config.FINALDATABASE])].forEach(db => {
@@ -448,6 +468,12 @@ function writeModelToDatabases(entityName, model, databases, isDraft = false) {
   });
 }
 
+function getEntityNames() {
+  return hubUtils.invokeFunction(() => cts.search(cts.collectionQuery(consts.ENTITY_MODEL_COLLECTION)), config.FINALDATABASE)
+    .toArray()
+    .map(entityNode => entityNode.toObject().info.title);
+}
+
 function publishDraftModels() {
   hubUtils.hubTrace(consts.TRACE_ENTITY,`publishing in database: ${xdmp.databaseName(xdmp.database())}`);
   const draftModels = hubUtils.invokeFunction(() => cts.search(cts.collectionQuery(consts.DRAFT_ENTITY_MODEL_COLLECTION)), xdmp.databaseName(xdmp.database()));
@@ -505,6 +531,7 @@ function publishDraftModels() {
       xdmp.invokeFunction(deleteDraftsOperation, {database, update: "true", commit: "auto"});
     }
   });
+  cleanupModelsFromHubCentralConfig(getEntityNames());
 }
 
 function getModelPermissions() {

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/models/drafts/clearModelFromHubCentralConfig.sjs

@@ -0,0 +1,74 @@
+declareUpdate();
+
+const config = require("/com.marklogic.hub/config.sjs");
+const entityLib = require("/data-hub/5/impl/entity-lib.sjs");
+const hubUtils = require("/data-hub/5/impl/hub-utils.sjs");
+const test = require("/test/test-helper.xqy");
+
+const hubCentralConfig = {
+  "modeling": {
+    "entities": {
+      "Customer": { x: 10, y: 15 },
+      "Test": { x: 10, y: 15 }
+    }
+  }
+};
+
+const model = {
+  "info": {
+    "title": "Customer",
+    "version": "0.0.1",
+    "baseUri": "http://example.org/"
+  },
+  "definitions": {
+    "Customer": {
+      "properties": {
+        "customerId": {"datatype": "integer"},
+        "age": {"datatype": "integer"}
+      }
+    }
+  }
+};
+
+const modelUri = "Customer";
+
+const assertions = [];
+
+xdmp.invokeFunction(function() {
+  declareUpdate();
+  entityLib.writeDraftModel(modelUri, model);
+  hubUtils.writeDocument("/config/hubCentral.json", hubCentralConfig, [xdmp.permission("data-hub-common", "read"),xdmp.permission("data-hub-common-writer", "update")], [], config.FINALDATABASE);
+});
+
+xdmp.invokeFunction(function() {
+  const hubCentralConfig = cts.doc("/config/hubCentral.json")
+  const draftModel = entityLib.findDraftModelByEntityName(modelUri)
+  assertions.push(test.assertTrue(fn.exists(hubCentralConfig.xpath("/modeling/entities/Customer"))))
+  assertions.push(test.assertEqual(draftModel.info.title, modelUri))
+  assertions.push(test.assertTrue(draftModel.info.isDraft))
+  assertions.push(test.assertFalse(draftModel.info.isDraftDeleted))
+  assertions.push(test.assertEqual("integer", draftModel.definitions[modelUri].properties["age"].datatype))
+});
+
+xdmp.invokeFunction(function() {
+  declareUpdate();
+  entityLib.deleteDraftModel(modelUri)
+
+  const deletedModel = entityLib.findDraftModelByEntityName(modelUri)
+  assertions.push(test.assertEqual(deletedModel.info.title, modelUri))
+  assertions.push(test.assertTrue(deletedModel.info.isDraft))
+  assertions.push(test.assertTrue(deletedModel.info.isDraftDeleted))
+});
+
+xdmp.invokeFunction(function() {
+  declareUpdate();
+  entityLib.publishDraftModels()
+});
+
+xdmp.invokeFunction(function() {
+  const hubCentralConfig = cts.doc("/config/hubCentral.json")
+  assertions.push(test.assertTrue(fn.empty(hubCentralConfig.xpath("/modeling/entities/Customer"))))
+  assertions.push(test.assertTrue(fn.exists(hubCentralConfig.xpath("/modeling/entities/Test"))))
+});
+
+assertions;

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/models/drafts/setup.sjs

@@ -0,0 +1,8 @@
+xquery version "1.0-ml";
+import module namespace hub-test = "http://marklogic.com/data-hub/test" at "/test/data-hub-test-helper.xqy";
+hub-test:reset-hub();
+
+xquery version "1.0-ml";
+import module namespace hub-test = "http://marklogic.com/data-hub/test" at "/test/data-hub-test-helper.xqy";
+import module namespace test = "http://marklogic.com/test" at "/test/test-helper.xqy";
+hub-test:load-artifacts($test:__CALLER_FILE__)

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/data-services/models/drafts/setup.xqy

@@ -0,0 +1,12 @@
+{
+  "info": {
+    "title": "Test",
+    "version": "0.0.1",
+    "baseUri": "http://example.org/"
+  },
+  "definitions": {
+    "Test": {
+      "properties": {}
+    }
+  }
+}