fixed #271 - allow plugins to know entity name

paxtonhare · paxtonhare · commit b80463661ca2 · 2016-09-23T09:08:30.000-04:00
WARNING!!!!: This is a breaking change. Make sure you delete the .tmp directory from your data hub project directory.  Also, any previously run jobs will no longer render correctly in the Jobs tab.
diff --git a/marklogic-data-hub/src/main/java/com/marklogic/hub/FlowManager.java b/marklogic-data-hub/src/main/java/com/marklogic/hub/FlowManager.java
@@ -150,9 +150,9 @@ private JobParameters buildJobParameters(Flow flow, int batchSize) {
         JobParametersBuilder jpb = new JobParametersBuilder();
         jpb.addLong("chunk", Integer.toUnsignedLong(batchSize));
         jpb.addString("uid", UUID.randomUUID().toString());
-        jpb.addString("jobType", flow.getType().toString());
-        jpb.addString("entityName", flow.getEntityName());
-        jpb.addString("flowName", flow.getName());
+        jpb.addString("flowType", flow.getType().toString());
+        jpb.addString("entity", flow.getEntityName());
+        jpb.addString("flow", flow.getName());
         return jpb.toJobParameters();
     }
 
diff --git a/marklogic-data-hub/src/main/resources/ml-modules/root/com.marklogic.hub/mlcp-flow-transform.xqy b/marklogic-data-hub/src/main/resources/ml-modules/root/com.marklogic.hub/mlcp-flow-transform.xqy
@@ -23,22 +23,25 @@ declare function mlcpFlow:transform(
   let $uri := map:get($content, "uri")
   return
     perf:log('mlcp-flow-transform(' || $uri || ')', function() {
-      let $paramNodes := xdmp:unquote(map:get($context, 'transform_param'))/node()/*
-      let $paramMap := map:new()
-      let $_ := $paramNodes ! map:put($paramMap, fn:local-name(.), ./string())
+      let $params := map:new((
+        for $pair in map:get($context, 'transform_param') ! fn:tokenize(., ",")
+        let $parts := fn:tokenize($pair, "=")
+        return
+          map:entry($parts[1], $parts[2])
+      ))
 
       let $flow := flow:get-flow(
-        map:get($paramMap, 'entity-name'),
-        map:get($paramMap, 'flow-name'),
-        map:get($paramMap, 'flow-type'))
+        map:get($params, 'entity'),
+        map:get($params, 'flow'),
+        map:get($params, 'flowType'))
 
       let $_ :=
         if ($flow) then ()
         else
-          fn:error(xs:QName("MISSING_FLOW"), "The specified flow " || map:get($paramMap, "flow-name") || " is missing.")
+          fn:error(xs:QName("MISSING_FLOW"), "The specified flow " || map:get($params, "flow") || " is missing.")
 
       let $envelope := try {
-        flow:run-plugins($flow, $uri, map:get($content, "value"), $paramMap)
+        flow:run-plugins($flow, $uri, map:get($content, "value"), $params)
       }
       catch($ex) {
         xdmp:log(xdmp:describe($ex, (), ())),
diff --git a/marklogic-data-hub/src/main/resources/ml-modules/services/flow.xqy b/marklogic-data-hub/src/main/resources/ml-modules/services/flow.xqy
@@ -78,7 +78,12 @@ declare %rapi:transaction-mode("update") function post(
   perf:log('/v1/resources/flow:post', function() {
     let $flow as element(hub:flow) := $input/hub:flow
     let $identifier := map:get($params, "identifier")
-    let $_ := flow:run-flow($flow, $identifier, map:map())
+    let $options := map:new((
+      map:entry("entity", $flow/hub:entity/fn:data()),
+      map:entry("flow", $flow/hub:name/fn:data()),
+      map:entry("flowType", $flow/hub:type/fn:data())
+    ))
+    let $_ := flow:run-flow($flow, $identifier, $options)
     return
       document { () }
   })
diff --git a/marklogic-data-hub/src/main/resources/ml-modules/transforms/run-flow.xqy b/marklogic-data-hub/src/main/resources/ml-modules/transforms/run-flow.xqy
@@ -20,11 +20,13 @@ declare function runFlow:transform(
   ) as document-node()
 {
   perf:log('/transforms/run-flow:transform', function() {
-    let $entity-name := map:get($params, 'entity-name')
-    let $flow-name := map:get($params, 'flow-name')
+    let $entity-name := map:get($params, 'entity')
+    let $flow-name := map:get($params, 'flow')
+    let $flow-type := "input"
+    let $_ := map:put($params, "flowType", $flow-type)
 
     let $uri := map:get($context, 'uri')
-    let $flow := flow:get-flow($entity-name, $flow-name, "input")
+    let $flow := flow:get-flow($entity-name, $flow-name, $flow-type)
     let $_ :=
       if ($flow) then ()
       else
diff --git a/marklogic-data-hub/src/test/java/com/marklogic/hub/DataHubInstallTest.java b/marklogic-data-hub/src/test/java/com/marklogic/hub/DataHubInstallTest.java
@@ -30,8 +30,10 @@ public static void setup() throws IOException {
         dataHub.initProject();
         dataHub.install(new StatusListener() {
             @Override
-            public void onStatusChange(int percentComplete, String message) {
-            }
+            public void onStatusChange(int percentComplete, String message) {}
+
+            @Override
+            public void onError() {}
         });
     }
 
@@ -40,8 +42,10 @@ public static void teardown() throws IOException {
         dataHub = new DataHub(getHubConfig(projectPath.toString()));
         dataHub.uninstall(new StatusListener() {
             @Override
-            public void onStatusChange(int percentComplete, String message) {
-            }
+            public void onStatusChange(int percentComplete, String message) {}
+
+            @Override
+            public void onError() {}
         });
         FileUtils.deleteDirectory(projectPath);
     }
diff --git a/marklogic-data-hub/src/test/java/com/marklogic/hub/HubTestBase.java b/marklogic-data-hub/src/test/java/com/marklogic/hub/HubTestBase.java
@@ -15,26 +15,8 @@
  */
 package com.marklogic.hub;
 
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
-
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import javax.xml.parsers.ParserConfigurationException;
-
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.FilenameUtils;
-import org.apache.commons.io.IOUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.w3c.dom.Document;
-import org.xml.sax.SAXException;
-
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.DatabaseClientFactory;
 import com.marklogic.client.DatabaseClientFactory.Authentication;
@@ -44,11 +26,23 @@
 import com.marklogic.client.eval.EvalResult;
 import com.marklogic.client.eval.EvalResultIterator;
 import com.marklogic.client.eval.ServerEvaluationCall;
-import com.marklogic.client.io.DOMHandle;
-import com.marklogic.client.io.DocumentMetadataHandle;
-import com.marklogic.client.io.Format;
-import com.marklogic.client.io.InputStreamHandle;
-import com.marklogic.client.io.StringHandle;
+import com.marklogic.client.io.*;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.FilenameUtils;
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+import org.xml.sax.SAXException;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
 
 public class HubTestBase {
     static final private Logger logger = LoggerFactory.getLogger(HubTestBase.class);
@@ -173,14 +167,19 @@ protected static void installHub() throws IOException {
             @Override
             public void onStatusChange(int percentComplete, String message) {
             }
+
+            @Override
+            public void onError() {}
         });
     }
 
     protected static void uninstallHub() throws IOException {
         new DataHub(getHubConfig()).uninstall(new StatusListener() {
             @Override
-            public void onStatusChange(int percentComplete, String message) {
-            }
+            public void onStatusChange(int percentComplete, String message) {}
+
+            @Override
+            public void onError() {}
         });
         FileUtils.deleteDirectory(new File(PROJECT_PATH));
     }
diff --git a/quick-start/src/main/java/com/marklogic/quickstart/service/FlowManagerService.java b/quick-start/src/main/java/com/marklogic/quickstart/service/FlowManagerService.java
@@ -25,16 +25,12 @@
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.stereotype.Service;
-import org.w3c.dom.Document;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-import org.xml.sax.SAXException;
 
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
-import java.io.*;
-import java.nio.charset.StandardCharsets;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
@@ -139,43 +135,20 @@ protected ConfigurableApplicationContext buildApplicationContext(JobStatusListen
         return ctx;
     }
 
-    private JobParameters buildJobParameters(JsonNode json) throws ParserConfigurationException, IOException, SAXException {
+    private JobParameters buildJobParameters(JsonNode json) throws ParserConfigurationException, IOException {
         JobParametersBuilder jpb = new JobParametersBuilder();
         jpb.addString("mlcpOptions", json.toString());
         jpb.addString("uid", UUID.randomUUID().toString());
 
         // convert the transform params into job params to be stored in ML for later reference
         JsonNode tp = json.get("transform_param");
         if (tp != null) {
-            String transformParams = tp.textValue();
-            transformParams = transformParams.replace("\"", "");
-            logger.info("transformParams: " + transformParams);
-            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
-            DocumentBuilder builder = factory.newDocumentBuilder();
-            ByteArrayInputStream bis = new ByteArrayInputStream(transformParams.getBytes(StandardCharsets.UTF_8));
-            Document doc = builder.parse(bis);
-            bis.close();
-
-            NodeList nodes = doc.getElementsByTagName("params");
-            if (nodes.getLength() == 1) {
-                Node params = nodes.item(0);
-                NodeList childNodes = params.getChildNodes();
-                for (int i = 0; i < childNodes.getLength(); i++) {
-                    Node child = childNodes.item(i);
-                    if (child.getNodeType() == Node.ELEMENT_NODE) {
-                        String name = child.getNodeName();
-                        switch (name) {
-                            case "entity-name":
-                                jpb.addString("entityName", child.getTextContent());
-                                break;
-                            case "flow-name":
-                                jpb.addString("flowName", child.getTextContent());
-                                break;
-                            case "flow-type":
-                                jpb.addString("flowType", child.getTextContent());
-                        }
-                    }
-                }
+            String transformParams = tp.textValue().replace("\"", "");
+            String[] pairs = transformParams.split(",");
+
+            for (String pair : pairs) {
+                String[] tokens = pair.split("=");
+                jpb.addString(tokens[0], tokens[1]);
             }
         }
         return jpb.toJobParameters();
diff --git a/quick-start/src/main/ui/app/jobs/job.model.ts b/quick-start/src/main/ui/app/jobs/job.model.ts
@@ -2,14 +2,14 @@ export class Job {
   uid: string;
   jobId: string;
   jobName: string;
-  jobType: string;
+  flowType: string;
   startTime: string;
   endTime: string;
   lastUpdated: string;
   status: string;
 
-  entityName: string;
-  flowName: string;
+  entity: string;
+  flow: string;
   jobOutput: string;
   mlcpOptions: string;
 }
diff --git a/quick-start/src/main/ui/app/jobs/jobs.tpl.html b/quick-start/src/main/ui/app/jobs/jobs.tpl.html
@@ -19,8 +19,8 @@ <h1>Jobs</h1>
       <tr *ngFor="let job of jobs" [ngClass]="{'error' : job.status === 'FAILED' }">
         <td><i class="mdi" [ngClass]="getIconClass(job.jobName)"></i> {{job.jobName}}</td>
         <td>{{job.jobId}}</td>
-        <td>{{job.entityName}}</td>
-        <td>{{job.flowName}}</td>
+        <td>{{job.entity}}</td>
+        <td>{{job.flow}}</td>
         <td>{{job.status}}</td>
         <td>{{job.startTime | amTimeAgo}}</td>
         <td><span *ngIf="job.endTime">{{getDuration(job)}} seconds</span></td>
diff --git a/quick-start/src/main/ui/app/mlcp-ui/mlcp-ui.html b/quick-start/src/main/ui/app/mlcp-ui/mlcp-ui.html
@@ -23,16 +23,16 @@ <h3 (click)="toggleSection(group.category)"><i class="fa fa-caret-right" [ngClas
               tooltipPlacement="right"
               *ngIf="setting.type === 'boolean'"
               [ngModel]="setting.value"
-              (change)="updateSetting(setting, $event.checked)">
+              (change)="updateSetting(setting, $event)">
               {{setting.label}}
             </mdl-switch>
             <mdl-textfield floating-label type="text"
               [tooltip]="setting.description"
               tooltipPlacement="innerRight"
-              [placeholder]="setting.label"
+              [label]="setting.label"
               name="{{setting.field}}" *ngIf="isText(setting.type)"
               [ngModel]="setting.value"
-              (change)="updateSetting(setting, $event.target.value)"
+              (input)="updateSetting(setting, $event.target.value)"
               [disabled]="setting.readOnly"></mdl-textfield>
             <app-custom-select
               [id]="setting.field"
diff --git a/quick-start/src/main/ui/app/mlcp-ui/mlcp-ui.ts b/quick-start/src/main/ui/app/mlcp-ui/mlcp-ui.ts
@@ -392,7 +392,7 @@ export class MlcpUiComponent {
             field: 'transform_param',
             type: 'string',
             description: 'Optional extra data to pass through to a custom transformation function. Ignored if -transform_module is not specified.\nDefault: no namespace. For details, see Transforming Content During Ingestion.',
-            value: '<params><entity-name>' + entityName + '</entity-name><flow-name>' + flowName + '</flow-name><flow-type>input</flow-type></params>',
+            value: `entity=${entityName},flow=${flowName},flowType=input`,
             readOnly: true,
           },
         ],
diff --git a/quick-start/src/main/ui/app/settings/settings.tpl.html b/quick-start/src/main/ui/app/settings/settings.tpl.html
@@ -4,13 +4,13 @@ <h1>Data Hub Settings</h1>
   <div class="debug-status">
     <mdl-switch
       mdl-tooltip="Enables or Disables Debug Logging for Hub HTTP Requests to MarkLogic."
-      class="primary-color" [ngModel]="debugEnabled()" (change)="toggleDebug($event.checked)">Debugging</mdl-switch>
+      class="primary-color" [ngModel]="debugEnabled()" (change)="toggleDebug($event)">Debugging</mdl-switch>
   </div>
 
   <div class="trace-status">
     <mdl-switch
       mdl-tooltip="Enables or Disable Trace Logging for Flows"
-      class="primary-color" [ngModel]="traceEnabled()" (change)="toggleTrace($event.checked)">Tracing</mdl-switch>
+      class="primary-color" [ngModel]="traceEnabled()" (change)="toggleTrace($event)">Tracing</mdl-switch>
   </div>
 
   <div>
