#92 Provide task metadata to event consumer. Expose in debug script.

handler/core/build.gradle.kts

@@ -41,6 +41,7 @@ dependencies {
     implementation(group = "org.apache.commons", name = "commons-lang3")
     implementation(group = "com.google.guava", name = "guava")
 
+    testImplementation("io.knotx:knotx-junit5:${project.version}")
     testImplementation(group = "org.mockito", name = "mockito-core")
     testImplementation(group = "org.mockito", name = "mockito-junit-jupiter")
     testImplementation(group = "io.vertx", name = "vertx-web-client")

handler/core/docs/asciidoc/dataobjects.adoc

@@ -106,6 +106,22 @@ The factory name.
 +++
 |===
 
+[[FragmentExecutionLog]]
+== FragmentExecutionLog
+
+
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[finishTime]]`@finishTime`|`Number (long)`|-
+|[[fragmentId]]`@fragmentId`|`String`|-
+|[[graph]]`@graph`|`Json object`|-
+|[[startTime]]`@startTime`|`Number (long)`|-
+|[[status]]`@status`|`link:enums.html#Status[Status]`|-
+|[[type]]`@type`|`String`|-
+|===
+
 [[FragmentsHandlerOptions]]
 == FragmentsHandlerOptions
 
@@ -208,6 +224,18 @@ Sets node factory name
 +++
 |===
 
+[[OperationMetadata]]
+== OperationMetadata
+
+
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[data]]`@data`|`Json object`|-
+|[[factory]]`@factory`|`String`|-
+|===
+
 [[SubtasksNodeConfig]]
 == SubtasksNodeConfig
 

handler/core/src/main/java/io/knotx/fragments/engine/NodeMetadata.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.knotx.fragments.engine;
+
+import io.knotx.fragments.engine.api.node.NodeType;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+public class NodeMetadata {
+
+  private String nodeId;
+  private String label;
+  private NodeType type;
+  private Map<String, String> transitions;
+  private List<String> nestedNodes;
+  private OperationMetadata operation;
+
+  public static NodeMetadata single(String nodeId, String label, Map<String, String> transitions,
+      OperationMetadata operation) {
+    return new NodeMetadata(nodeId, label, NodeType.SINGLE, transitions, Collections.emptyList(),
+        operation);
+  }
+
+  public static NodeMetadata composite(String nodeId, String label, Map<String, String> transitions,
+      List<String> nestedNodes, OperationMetadata operation) {
+    return new NodeMetadata(nodeId, label, NodeType.COMPOSITE, transitions, nestedNodes, operation);
+  }
+
+  private NodeMetadata(String nodeId, String label, NodeType type, Map<String, String> transitions,
+      List<String> nestedNodes, OperationMetadata operation) {
+    this.nodeId = nodeId;
+    this.label = label;
+    this.type = type;
+    this.transitions = transitions;
+    this.nestedNodes = nestedNodes;
+    this.operation = operation;
+  }
+
+  public String getNodeId() {
+    return nodeId;
+  }
+
+  public String getLabel() {
+    return label;
+  }
+
+  public NodeType getType() {
+    return type;
+  }
+
+  /**
+   * @return transition name to node id map
+   */
+  public Map<String, String> getTransitions() {
+    return transitions;
+  }
+
+  /**
+   * @return list of composite nodes identifiers
+   */
+  public List<String> getNestedNodes() {
+    return nestedNodes;
+  }
+
+  public OperationMetadata getOperation() {
+    return operation;
+  }
+
+  @Override
+  public String toString() {
+    return "NodeMetadata{" +
+        "nodeId='" + nodeId + '\'' +
+        ", label='" + label + '\'' +
+        ", type=" + type +
+        ", transitions=" + transitions +
+        ", nestedNodes=" + nestedNodes +
+        ", operation=" + operation +
+        '}';
+  }
+}

handler/core/src/main/java/io/knotx/fragments/engine/OperationMetadata.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.knotx.fragments.engine;
+
+import io.vertx.codegen.annotations.DataObject;
+import io.vertx.core.json.JsonObject;
+
+@DataObject(generateConverter = true)
+public class OperationMetadata {
+
+  private String factory;
+
+  private JsonObject data;
+
+  public OperationMetadata() {
+    // empty
+  }
+
+  public OperationMetadata(JsonObject obj) {
+    OperationMetadataConverter.fromJson(obj, this);
+  }
+
+  public JsonObject toJson() {
+    JsonObject json = new JsonObject();
+    OperationMetadataConverter.toJson(this, json);
+    return json;
+  }
+
+  public String getFactory() {
+    return factory;
+  }
+
+  public OperationMetadata setFactory(String factory) {
+    this.factory = factory;
+    return this;
+  }
+
+  public JsonObject getData() {
+    return data;
+  }
+
+  public OperationMetadata setData(JsonObject data) {
+    this.data = data;
+    return this;
+  }
+
+  @Override
+  public String toString() {
+    return "OperationMetadata{" +
+        "factory='" + factory + '\'' +
+        ", data=" + data +
+        '}';
+  }
+}

handler/core/src/main/java/io/knotx/fragments/engine/TaskMetadata.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.knotx.fragments.engine;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class TaskMetadata {
+
+  private String taskName;
+  private String rootNodeId;
+  private Map<String, NodeMetadata> nodesMetadata;
+
+  private TaskMetadata(String taskName, String rootNodeId,
+      Map<String, NodeMetadata> nodesMetadata) {
+    this.taskName = taskName;
+    this.rootNodeId = rootNodeId;
+    this.nodesMetadata = nodesMetadata;
+  }
+
+  public static TaskMetadata create(String taskName, String rootNodeId,
+      Map<String, NodeMetadata> nodesMetadata) {
+    return new TaskMetadata(taskName, rootNodeId, nodesMetadata);
+  }
+
+  public static TaskMetadata noMetadata(String taskName, String rootNodeId) {
+    return new TaskMetadata(taskName, rootNodeId, new HashMap<>());
+  }
+
+  public static TaskMetadata notDefined() {
+    return noMetadata("_NOT_DEFINED", "");
+  }
+
+  public String getTaskName() {
+    return taskName;
+  }
+
+  public String getRootNodeId() {
+    return rootNodeId;
+  }
+
+  public Map<String, NodeMetadata> getNodesMetadata() {
+    return nodesMetadata;
+  }
+
+  @Override
+  public String toString() {
+    return "TaskMetadata{" +
+        "taskName='" + taskName + '\'' +
+        ", rootNodeId='" + rootNodeId + '\'' +
+        ", nodesMetadata=" + nodesMetadata +
+        '}';
+  }
+}

handler/core/src/main/java/io/knotx/fragments/engine/TaskWithMetadata.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.knotx.fragments.engine;
+
+import io.knotx.fragments.engine.api.Task;
+
+public class TaskWithMetadata {
+
+  private final Task task;
+  private final TaskMetadata taskMetadata;
+
+  public TaskWithMetadata(Task task, TaskMetadata taskMetadata) {
+    this.task = task;
+    this.taskMetadata = taskMetadata;
+  }
+
+  public Task getTask() {
+    return task;
+  }
+
+  public TaskMetadata getTaskMetadata() {
+    return taskMetadata;
+  }
+
+}