Feature/#49 node factories with common configs

.gitignore

@@ -1,24 +1,13 @@
 # Generated files #
 ###################
-node_modules
-node
-target-grunt
-.sass-cache
-.grunt
-C:
 .project
 .classpath
 .settings
 generated
 
 # Compiled source #
 ###################
-# *.com
 *.class
-*.dll
-*.exe
-*.o
-*.so
 
 # Packages #
 ############
@@ -39,8 +28,6 @@ generated
 # Logs and databases #
 ######################
 *.log
-*.sql
-*.sqlite
 
 # OS generated files #
 ######################

handler/api/src/main/java/io/knotx/fragments/handler/api/actionlog/ActionLogLevel.java

@@ -22,7 +22,7 @@
 public enum ActionLogLevel {
   INFO("info"), ERROR("error");
 
-  public static final String CONFIG_KEY_NAME = "logLevel";
+
   private final String level;
 
   ActionLogLevel(String level) {

handler/api/src/main/java/io/knotx/fragments/handler/api/actionlog/ActionLogger.java

@@ -15,15 +15,13 @@
  */
 package io.knotx.fragments.handler.api.actionlog;
 
-import static io.knotx.fragments.handler.api.actionlog.ActionLogLevel.CONFIG_KEY_NAME;
 import static io.knotx.fragments.handler.api.actionlog.ActionLogLevel.INFO;
 
+import io.vertx.core.json.JsonObject;
 import java.time.Instant;
 import java.util.Objects;
 import java.util.function.Function;
 
-import io.vertx.core.json.JsonObject;
-
 public class ActionLogger {
 
   private final ActionLogLevel actionLogLevel;
@@ -34,10 +32,6 @@ private ActionLogger(String alias, ActionLogLevel actionLogLevel) {
     this.builder = new ActionLogBuilder(alias);
   }
 
-  public static ActionLogger create(String alias, JsonObject config) {
-    return ActionLogger.create(alias, config.getString(CONFIG_KEY_NAME));
-  }
-
   public static ActionLogger create(String alias, ActionLogLevel actionLogLevel) {
     return new ActionLogger(alias, actionLogLevel);
   }

handler/core/docs/asciidoc/dataobjects.adoc

@@ -1,15 +1,34 @@
 = Cheatsheets
 
-[[ActionNodeConfigOptions]]
-== ActionNodeConfigOptions
+[[ActionFactoryOptions]]
+== ActionFactoryOptions
+
+
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[config]]`@config`|`Json object`|+++
+Sets <code>Action</code> configuration that is passed to Action.
++++
+|[[doAction]]`@doAction`|`String`|+++
+Sets the name of the base <code>Action</code> that will be triggered while creating current <code>Action</code>. In not set (<code>null</code>), given action will have no base actions.
++++
+|[[factory]]`@factory`|`String`|+++
+Sets <code>Action</code> factory name.
++++
+|===
+
+[[ActionNodeConfig]]
+== ActionNodeConfig
 
 ++++
- Action node configuration model. It is model for link JSON object.
+ Action node configuration model. It is model for  JSON object.
 
  <pre>
  node {
    factory = action
-   config { //represented by ActionNodeConfigOptions
+   config { //represented by ActionNodeConfig
      ...
    }
  }
@@ -27,74 +46,73 @@ Sets link name. The specified Action is executed
 +++
 |===
 
-[[ActionOptions]]
-== ActionOptions
+[[ActionNodeFactoryConfig]]
+== ActionNodeFactoryConfig
 
+++++
+ Action Node factory config model.
+++++
+'''
 
 [cols=">25%,25%,50%"]
 [frame="topbot"]
 |===
 ^|Name | Type ^| Description
-|[[config]]`@config`|`Json object`|+++
-Sets <code>Action</code> configuration that is passed to Action.
+|[[actions]]`@actions`|`link:dataobjects.html#ActionFactoryOptions[ActionFactoryOptions]`|+++
+The dictionary maps action name to action factory options.
 +++
-|[[doAction]]`@doAction`|`String`|+++
-Sets the name of the base <code>Action</code> that will be triggered while creating current <code>Action</code>. In not set (<code>null</code>), given action will have no base actions.
+|===
+
+[[DefaultTaskFactoryConfig]]
+== DefaultTaskFactoryConfig
+
+++++
+ Default Task Factory config model.
+++++
+'''
+
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[logLevel]]`@logLevel`|`String`|+++
+The global node log level.
 +++
-|[[factory]]`@factory`|`String`|+++
-Sets <code>Action</code> factory name.
+|[[nodeFactories]]`@nodeFactories`|`Array of link:dataobjects.html#NodeFactoryOptions[NodeFactoryOptions]`|+++
+The array/list of graph node factory options defines node factories taking part in the creation
+ of graph.
++++
+|[[taskNameKey]]`@taskNameKey`|`String`|+++
+The fragment's configuration key specifies a task assigned to a fragment by the task name.
++++
+|[[tasks]]`@tasks`|`link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
+The dictionary that maps a task name to a directed acyclic graph (DAG) of nodes.
 +++
 |===
 
 [[FragmentsHandlerOptions]]
 == FragmentsHandlerOptions
 
+++++
+ Fragments Handler options model.
+++++
+'''
 
 [cols=">25%,25%,50%"]
 [frame="topbot"]
 |===
 ^|Name | Type ^| Description
-|[[actions]]`@actions`|`link:dataobjects.html#ActionOptions[ActionOptions]`|+++
-Sets named actions with their factory configuration.
-+++
-|[[logLevel]]`@logLevel`|`String`|-
-|[[taskKey]]`@taskKey`|`String`|-
-|[[tasks]]`@tasks`|`link:dataobjects.html#TaskOptions[TaskOptions]`|+++
-Sets <code>Task</code> list, which are named, directed graphs of <code>Actions</code>.
+|[[taskFactories]]`@taskFactories`|`Array of link:dataobjects.html#TaskFactoryOptions[TaskFactoryOptions]`|+++
+The array/list of task factory options defines factories taking part in the creation of tasks. First
+ items on the list have the highest priority.
 +++
 |===
 
 [[GraphNodeOptions]]
 == GraphNodeOptions
 
 ++++
- It is link processing configuration. Task is graph of nodes (in
- fact it is tree structure). It defines link and outgoing directed graph edges,
- called <code>Transitions</code>.
-
- It represents JSON configuration:
- <pre>
- {
-   node = {
-     factory = action
-     config {
-       action = a
-     }
-   }
-   onTransitions {
-     _success {
-       node = {
-         factory = action
-         config {
-           action = b
-         }
-       }
-     }
-   }
- }
- </pre>
-
- Please note that Transitions define next graph nodes.
+ Graph node options model.
 ++++
 '''
 
@@ -103,20 +121,51 @@ Sets <code>Task</code> list, which are named, directed graphs of <code>Actions</
 |===
 ^|Name | Type ^| Description
 |[[action]]`@action`|`String`|+++
-
+Sets a node factory name to <code>ActionNodeFactory.NAME</code> and configures the action.
 +++
 |[[actions]]`@actions`|`Array of link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
-
+Sets a node factory name to <code>SubtasksNodeFactory.NAME</code> and configures subgraphs.
 +++
-|[[composite]]`@composite`|`Boolean`|-
 |[[node]]`@node`|`link:dataobjects.html#NodeOptions[NodeOptions]`|+++
-Sets node options defining node factory and its configuration.
+Node options define a node factory and its configuration.
 +++
 |[[onTransitions]]`@onTransitions`|`link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
-Sets outgoing graph node edges, called <code>Transitions</code>. Transition is String, <code>onTransitions</code> map links Transition with next graph node.
+The outgoing graph node edges, called transitions. A transition is named graph edge that
+ defines the next graph node in fragment's processing.
 +++
 |[[subtasks]]`@subtasks`|`Array of link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
+Sets a node factory name to <code>SubtasksNodeFactory.NAME</code> and configures subgraphs.
++++
+|===
+
+[[LogLevelConfig]]
+== LogLevelConfig
+
+
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[logLevel]]`@logLevel`|`String`|-
+|===
+
+[[NodeFactoryOptions]]
+== NodeFactoryOptions
+
+++++
+ Node Factory options model.
+++++
+'''
 
+[cols=">25%,25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[config]]`@config`|`Json object`|+++
+The JSON object that contains node factory configuration entries.
++++
+|[[factory]]`@factory`|`String`|+++
+The node factory name that identifies <code>NodeFactory</code> implementation.
 +++
 |===
 
@@ -140,20 +189,11 @@ Sets node factory name
 +++
 |===
 
-[[SubtasksNodeConfigOptions]]
-== SubtasksNodeConfigOptions
+[[SubtasksNodeConfig]]
+== SubtasksNodeConfig
 
 ++++
- Subtask node configuration. It is model for link JSON object.
-
- <pre>
- node {
-   factory = subtasks
-   config { //represented by SubtasksNodeConfigOptions
-     ...
-   }
- }
- </pre>
+ Subtask Node configuration.
 ++++
 '''
 
@@ -162,16 +202,16 @@ Sets node factory name
 |===
 ^|Name | Type ^| Description
 |[[subtasks]]`@subtasks`|`Array of link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
-Sets list of link that represents link
- that will be executed in parallel.
+The array/list of subgraphs/subtasks that can be executed in parallel.
 +++
 |===
 
-[[TaskOptions]]
-== TaskOptions
+[[TaskFactoryOptions]]
+== TaskFactoryOptions
 
 ++++
- Task options.
+ Task Factory options model. It specifies task factory by its name and provides task factory
+ config.
 ++++
 '''
 
@@ -180,13 +220,10 @@ Sets list of link that represents link
 |===
 ^|Name | Type ^| Description
 |[[config]]`@config`|`Json object`|+++
-Gets task provider factory configuration.
+The JSON object that contains task factory configuration entries.
 +++
 |[[factory]]`@factory`|`String`|+++
-Sets task provider factory name
-+++
-|[[graph]]`@graph`|`link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
-Sets task graph.
+The task factory name that identifies <code>TaskFactory</code> implementation.
 +++
 |===
 

handler/core/handler/common/customTask.conf

@@ -0,0 +1,27 @@
+tasks {
+  success-task {
+    graph {
+      action = success-action
+    }
+  }
+}
+
+nodeFactories = [
+  {
+    factory = action
+    config {
+      actions {
+        success-action {
+          factory = test-action
+          config {
+            transition = _success
+            body = "custom"
+          }
+        }
+      }
+    }
+  }
+  {
+    factory = subtasks
+  }
+]