Skip to content

Commit

Permalink
Add parse methods for the Template XContent
Browse files Browse the repository at this point in the history 
Signed-off-by: Daniel Widdis <[email protected]>
  • Loading branch information
@dbwiddis
dbwiddis committed Sep 21, 2023
1 parent 8332103 commit c253068
Show file tree
Hide file tree
Showing 5 changed files with 347 additions and 31 deletions.
197 changes: 172 additions & 25 deletions src/main/java/org/opensearch/flowframework/template/Template.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,53 +11,111 @@
import org.opensearch.Version;
import org.opensearch.core.xcontent.ToXContentObject;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;
import org.opensearch.flowframework.workflow.Workflow;

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;

/**
* The Template is the central data structure which configures workflows. This object is used to parse JSON communicated via REST API.
*/
public class Template implements ToXContentObject {

private static final String WORKFLOWS_FIELD = "workflows";
private static final String USER_INPUTS_FIELD = "user_inputs";
private static final String COMPATIBILITY_FIELD = "compatibility";
private static final String TEMPLATE_FIELD = "template";
private static final String VERSION_FIELD = "version";
private static final String OPERATIONS_FIELD = "operations";
private static final String USE_CASE_FIELD = "use_case";
private static final String DESCRIPTION_FIELD = "description";
private static final String NAME_FIELD = "name";
// TODO: Some of thse are placeholders based on the template design
// Current code is only using user inputs and workflows
private String name = null;
private String description = null;
private String useCase = null;
private String[] operations = null; // probably an ENUM actually
private Version templateVersion = null;
private Version[] compatibilityVersion = null;
private Map<String, String> userInputs = new HashMap<>();
private Map<String, Workflow> workflows = new HashMap<>();
// Change as needed to match defined template
private final String name;
private final String description;
private final String useCase; // probably an ENUM actually
private final String[] operations; // probably an ENUM actually
private final Version templateVersion;
private final Version[] compatibilityVersion;
private final Map<String, String> userInputs;
private final Map<String, Workflow> workflows;

/**
* Instantiate the object representing a use case template
*
* @param name The template's name
* @param description A description of the template's use case
* @param useCase A string defining the internal use case type
* @param operations Expected operations of this template. Should match defined workflows.
* @param templateVersion The version of this template
* @param compatibilityVersion OpenSearch version compatibility of this template
* @param userInputs Optional user inputs to apply globally
* @param workflows Workflow graph definitions corresponding to the defined operations.
*/
public Template(
String name,
String description,
String useCase,
String[] operations,
Version templateVersion,
Version[] compatibilityVersion,
Map<String, String> userInputs,
Map<String, Workflow> workflows
) {
this.name = name;
this.description = description;
this.useCase = useCase;
this.operations = operations;
this.templateVersion = templateVersion;
this.compatibilityVersion = compatibilityVersion;
this.userInputs = userInputs;
this.workflows = workflows;
}

@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
XContentBuilder xContentBuilder = builder.startObject();
xContentBuilder.field("name", this.name);
xContentBuilder.field("description", this.description);
xContentBuilder.field("use_case", this.useCase);
xContentBuilder.field("operations", this.operations);

xContentBuilder.startObject("version");
xContentBuilder.field("template", this.templateVersion);
xContentBuilder.startArray("compatibility");
for (Version v : this.compatibilityVersion) {
xContentBuilder.value(v);
xContentBuilder.field(NAME_FIELD, this.name);
xContentBuilder.field(DESCRIPTION_FIELD, this.description);
xContentBuilder.field(USE_CASE_FIELD, this.useCase);
xContentBuilder.startArray(OPERATIONS_FIELD);
for (String op : this.operations) {
xContentBuilder.value(op);
}
xContentBuilder.endArray();
xContentBuilder.endObject();

xContentBuilder.startObject("user_inputs");
for (Entry<String, String> e : userInputs.entrySet()) {
xContentBuilder.field(e.getKey(), e.getValue());
if (this.templateVersion != null || this.compatibilityVersion.length > 0) {
xContentBuilder.startObject(VERSION_FIELD);
if (this.templateVersion != null) {
xContentBuilder.field(TEMPLATE_FIELD, this.templateVersion);
}
if (this.compatibilityVersion.length > 0) {
xContentBuilder.startArray(COMPATIBILITY_FIELD);
for (Version v : this.compatibilityVersion) {
xContentBuilder.value(v);
}
xContentBuilder.endArray();
}
xContentBuilder.endObject();
}

if (!this.userInputs.isEmpty()) {
xContentBuilder.startObject(USER_INPUTS_FIELD);
for (Entry<String, String> e : userInputs.entrySet()) {
xContentBuilder.field(e.getKey(), e.getValue());
}
xContentBuilder.endObject();
}
xContentBuilder.endObject();

xContentBuilder.startObject("workflows");
xContentBuilder.startObject(WORKFLOWS_FIELD);
for (Entry<String, Workflow> e : workflows.entrySet()) {
xContentBuilder.field(e.getKey(), e.getValue(), params);
}
Expand All @@ -66,4 +124,93 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
return xContentBuilder.endObject();
}

/**
* Parse raw json content into a workflow node instance.
*
* @param parser json based content parser
* @throws IOException if content can't be parsed correctly
*/
public static Template parse(XContentParser parser) throws IOException {
String name = null;
String description = "";
String useCase = "";
String[] operations = new String[0];
Version templateVersion = null;
Version[] compatibilityVersion = new Version[0];
Map<String, String> userInputs = new HashMap<>();
Map<String, Workflow> workflows = new HashMap<>();

ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String fieldName = parser.currentName();
parser.nextToken();
switch (fieldName) {
case NAME_FIELD:
name = parser.text();
break;
case DESCRIPTION_FIELD:
description = parser.text();
break;
case USE_CASE_FIELD:
useCase = parser.text();
break;
case OPERATIONS_FIELD:
ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
List<String> operationsList = new ArrayList<>();
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
operationsList.add(parser.text());
}
operations = operationsList.toArray(new String[0]);
break;
case VERSION_FIELD:
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String versionFieldName = parser.currentName();
parser.nextToken();
switch (versionFieldName) {
case TEMPLATE_FIELD:
templateVersion = Version.fromString(parser.text());
break;
case COMPATIBILITY_FIELD:
ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
List<Version> compatibilityList = new ArrayList<>();
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
compatibilityList.add(Version.fromString(parser.text()));
}
compatibilityVersion = compatibilityList.toArray(new Version[0]);
break;
default:
throw new IOException("Unable to parse field [" + fieldName + "] in a version object.");
}

}
break;
case USER_INPUTS_FIELD:
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String inputFieldName = parser.currentName();
parser.nextToken();
userInputs.put(inputFieldName, parser.text());
}
break;
case WORKFLOWS_FIELD:
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String workflowFieldName = parser.currentName();
parser.nextToken();
workflows.put(workflowFieldName, Workflow.parse(parser));
}
break;

default:
throw new IOException("Unable to parse field [" + fieldName + "] in a template object.");
}
}
if (name == null) {
throw new IOException("An template object requires a name.");
}

return new Template(name, description, useCase, operations, templateVersion, compatibilityVersion, userInputs, workflows);
}

}
35 changes: 35 additions & 0 deletions src/main/java/org/opensearch/flowframework/template/WorkflowEdge.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@

import org.opensearch.core.xcontent.ToXContentFragment;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;

import java.io.IOException;
import java.util.Objects;

import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;

/**
* This represents an edge between process nodes (steps) in a workflow graph in the {@link Template}.
*/
Expand Down Expand Up @@ -43,6 +46,38 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
return xContentBuilder.endObject();
}

/**
* Parse raw json content into a workflow edge instance.
*
* @param parser json based content parser
* @throws IOException if content can't be parsed correctly
*/
public static WorkflowEdge parse(XContentParser parser) throws IOException {
String source = null;
String destination = null;

ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String fieldName = parser.currentName();
parser.nextToken();
switch (fieldName) {
case SOURCE_FIELD:
source = parser.text();
break;
case DEST_FIELD:
destination = parser.text();
break;
default:
throw new IOException("Unable to parse field [" + fieldName + "] in an edge object.");
}
}
if (source == null || destination == null) {
throw new IOException("An edge object requires both a source and dest field.");
}

return new WorkflowEdge(source, destination);
}

/**
* Gets the source node id.
*
Expand Down
63 changes: 60 additions & 3 deletions src/main/java/org/opensearch/flowframework/template/WorkflowNode.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@

import org.opensearch.core.xcontent.ToXContentFragment;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;

/**
* This represents a process node (step) in a workflow graph in the {@link Template}.
* It will have a one-to-one correspondence with a {@link ProcessNode},
Expand All @@ -28,9 +31,22 @@ public class WorkflowNode implements ToXContentFragment {
private static final String TYPE_FIELD = "type";
private static final String ID_FIELD = "id";

private String id = null; // unique id
private String type = null; // maps to a WorkflowStep
private Map<String, String> inputs = new HashMap<>(); // maps to WorkflowData
private final String id; // unique id
private final String type; // maps to a WorkflowStep
private final Map<String, String> inputs; // maps to WorkflowData

/**
* Create this node with the id and type, and any user input.
*
* @param id A unique string identifying this node
* @param type The type of {@link WorkflowStep} to create for the corresponding {@link ProcessNode}
* @param inputs Optional input to populate params in {@link WorkflowData}
*/
public WorkflowNode(String id, String type, Map<String, String> inputs) {
this.id = id;
this.type = type;
this.inputs = inputs;
}

@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
Expand All @@ -46,4 +62,45 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws

return xContentBuilder.endObject();
}

/**
* Parse raw json content into a workflow node instance.
*
* @param parser json based content parser
* @throws IOException if content can't be parsed correctly
*/
public static WorkflowNode parse(XContentParser parser) throws IOException {
String id = null;
String type = null;
Map<String, String> inputs = new HashMap<>();

ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String fieldName = parser.currentName();
parser.nextToken();
switch (fieldName) {
case ID_FIELD:
id = parser.text();
break;
case TYPE_FIELD:
type = parser.text();
break;
case INPUTS_FIELD:
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String inputFieldName = parser.currentName();
parser.nextToken();
inputs.put(inputFieldName, parser.text());
}
break;
default:
throw new IOException("Unable to parse field [" + fieldName + "] in a node object.");
}
}
if (id == null || type == null) {
throw new IOException("An node object requires both an id and type field.");
}

return new WorkflowNode(id, type, inputs);
}
}
Loading

0 comments on commit c253068

Please sign in to comment.