DHFPROD-8136: Passing extra interceptors to flow if needed.

Author: Aniela Amy

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

@@ -137,6 +137,9 @@ class Flow {
     ));
   }
 
+  runFlow(flowName, jobId, contentArray, options, stepNumber) {
+    runFlow(flowName, jobId, contentArray, options, stepNumber, null);
+  }
   /**
    * It's unlikely that this actually runs a "flow", unless the flow consists of one step and only one transaction is
    * needed to run the step. More likely, this is really "process a batch of items for a step".
@@ -149,8 +152,9 @@ class Flow {
    * @param options Unfortunately this is not consistently defined; depending on the client, it's either the runtime
    * options provided by the user, or it's the already-combined options
    * @param stepNumber The number of the step within the given flow to run
+   * @param interceptors Additional interceptors to run. Used with the merge REST endpoint
    */
-  runFlow(flowName, jobId, contentArray, options, stepNumber) {
+  runFlow(flowName, jobId, contentArray, options, stepNumber, interceptors = []) {
     contentArray = contentArray || [];
     const theFlow = this.getFlow(flowName);
     if(!theFlow) {
@@ -177,10 +181,10 @@ class Flow {
       throw Error('Step '+stepNumber+' for the flow: '+flowName+' could not be found.');
     }
     const stepDefinition = this.stepDefinition.getStepDefinitionByNameAndType(flowStep.stepDefinitionName, flowStep.stepDefinitionType);
-
     const stepExecutionContext = new StepExecutionContext(theFlow, stepNumber, stepDefinition, jobId, options);
     const combinedOptions = stepExecutionContext.combinedOptions;
-
+    // add any additional interceptors
+    stepExecutionContext.flowStep.interceptors = (stepExecutionContext.flowStep.interceptors || []).concat(interceptors);
     const batchItems = contentArray.map(contentObject => contentObject.uri);
 
     let outputContentArray;

marklogic-data-hub/src/main/resources/ml-modules/services/mlSmMerge.sjs

@@ -40,8 +40,8 @@ function post(context, params, input) {
   let stepDetails = datahub.flow.stepDefinition.getStepDefinitionByNameAndType(stepRef.stepDefinitionName, stepRef.stepDefinitionType) || {};
   // build combined options
   let flowOptions = flow.options || {};
-  let stepRefOptions = stepRef.options || {};
-  let stepDetailsOptions = stepDetails.options || {};
+  let stepRefOptions = stepRef.options || stepRef;
+  let stepDetailsOptions = stepDetails.options || stepDetails;
   let combinedOptions = Object.assign({}, stepDetailsOptions, flowOptions, stepRefOptions, inputOptions, params);
   let sourceDatabase = combinedOptions.sourceDatabase || config.FINALDATABASE;
 
@@ -52,7 +52,8 @@ function post(context, params, input) {
   let uris = hubUtils.normalizeToArray(params.uri);
   let query = cts.documentQuery(uris);
   let content = hubUtils.queryToContentDescriptorArray(query, combinedOptions, sourceDatabase);
-  let results = datahub.flow.runFlow(flowName, jobId, content, combinedOptions, stepNumber);
+  let results = datahub.flow.runFlow(flowName, jobId, content, combinedOptions, stepNumber, stepRef.interceptors);
+
   return {
     'success': results.errorCount === 0,
     'errors': results.errors,

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/post.sjs

@@ -11,7 +11,8 @@ const validResults = mlSmMergeRest.POST(context, validMergeParams, emptyDocument
 
 assertions.push(
   test.assertTrue(validResults.success,"Merge should be successful"),
-  test.assertEqual(2, validResults.mergedURIs.length)
+  test.assertEqual(2, validResults.mergedURIs.length),
+  test.assertTrue(validResults.mergedDocument.value.envelope.headers.interceptorCalled, "Interceptor should be called on merge.")
 );
 
 const invalidMergeParams = { flowName: "CurateCustomerJSON", step: "1", uri: ["/content/customer1.json", "/content/customer2.json"] };

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/test-data/content/customer1.json

@@ -1,5 +1,6 @@
 {
   "envelope": {
+    "headers": {},
     "instance": {
       "info": {
         "title": "Customer",

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/test-data/content/customer2.json

@@ -0,0 +1,14 @@
+{
+  "envelope": {
+    "headers": {},
+    "instance": {
+      "info": {
+        "title": "Customer",
+        "version": "0.0.1"
+      },
+      "Customer": {
+        "customerId": 1
+      }
+    }
+  }
+}

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/test-data/mergeInterceptor.sjs

@@ -0,0 +1,12 @@
+'use strict';
+
+var contentArray;
+var options;
+
+contentArray.forEach(content => {
+  if (content.value.root instanceof ObjectNode) {
+    const contentValue = content.value.toObject();
+    contentValue.envelope.headers.interceptorCalled =  true;
+    content.value = contentValue;
+  }
+});

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/test-data/steps/merging/mergeCustomers.step.json

@@ -17,5 +17,12 @@
   "lastUpdatedLocation": {},
   "mergeStrategies": [],
   "mergeRules": [],
-  "targetCollections": {}
+  "targetCollections": {},
+  "interceptors" : [
+    {
+      "path": "/test/suites/data-hub/5/smart-mastering/rest/mlSmMerge/test-data/mergeInterceptor.sjs",
+      "vars": {},
+      "when": "beforeContentPersisted"
+    }
+  ]
 }