Skip to content

Commit

Permalink
Refactoring of WorkItemNodeInstance for extensibility (#1461)
Browse files Browse the repository at this point in the history 
* Introduced setWorkItemParameters/updateVariablesFromResult methods on WorkItemNodeInstance to allow inheriting classes to change the parameter mapping behaviour and removed the unnecessary type casting

* Changed private methods processOutputs of RuleSetNodeInstance.java to protected for extendability
  • Loading branch information
@SimonRinguette @mswiderski
SimonRinguette authored and mswiderski committed Mar 21, 2019
1 parent 5dfd109 commit 442526f
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 75 deletions.
2 changes: 1 addition & 1 deletion jbpm-flow/src/main/java/org/jbpm/workflow/instance/node/RuleSetNodeInstance.java
View file
Expand Up @@ -274,7 +274,7 @@ public void retractFacts() {
factHandles.clear();
}

private void processOutputs(Map<String, Object> objects) {
protected void processOutputs(Map<String, Object> objects) {
RuleSetNode ruleSetNode = getRuleSetNode();
if (ruleSetNode != null) {
for (Iterator<DataAssociation> iterator = ruleSetNode.getOutAssociations().iterator(); iterator.hasNext(); ) {
Expand Down
163 changes: 89 additions & 74 deletions jbpm-flow/src/main/java/org/jbpm/workflow/instance/node/WorkItemNodeInstance.java
View file
Expand Up @@ -88,7 +88,7 @@ public class WorkItemNodeInstance extends StateBasedNodeInstance implements Even
private Map<String, List<ContextInstance>> subContextInstances = new HashMap<String, List<ContextInstance>>();

private long workItemId = -1;
private transient WorkItem workItem;
protected transient WorkItem workItem;

private long exceptionHandlingProcessInstanceId = -1;

Expand Down Expand Up @@ -138,9 +138,9 @@ public void internalTrigger(final NodeInstance from, String type) {
addWorkItemListener();
}
String deploymentId = (String) getProcessInstance().getKnowledgeRuntime().getEnvironment().get(EnvironmentName.DEPLOYMENT_ID);
((WorkItem) workItem).setDeploymentId(deploymentId);
((WorkItem) workItem).setNodeInstanceId(this.getId());
((WorkItem) workItem).setNodeId(getNodeId());
workItem.setDeploymentId(deploymentId);
workItem.setNodeInstanceId(this.getId());
workItem.setNodeId(getNodeId());
if (isInversionOfControl()) {
((ProcessInstance) getProcessInstance()).getKnowledgeRuntime()
.update(((ProcessInstance) getProcessInstance()).getKnowledgeRuntime().getFactHandle(this), this);
Expand Down Expand Up @@ -175,14 +175,24 @@ public void internalTrigger(final NodeInstance from, String type) {
protected WorkItem createWorkItem(WorkItemNode workItemNode) {
Work work = workItemNode.getWork();
workItem = new WorkItemImpl();
((WorkItem) workItem).setName(work.getName());
((WorkItem) workItem).setProcessInstanceId(getProcessInstance().getId());
((WorkItem) workItem).setParameters(new HashMap<String, Object>(work.getParameters()));
workItem.setName(work.getName());
workItem.setProcessInstanceId(getProcessInstance().getId());
workItem.setParameters(new HashMap<String, Object>(work.getParameters()));
// if there are any dynamic parameters add them
if (dynamicParameters != null) {
((WorkItem) workItem).getParameters().putAll(dynamicParameters);
workItem.getParameters().putAll(dynamicParameters);
}

setWorkItemParameters(workItemNode);
return workItem;
}

protected void setWorkItemParameters(WorkItemNode workItemNode) {
setWorkItemParametersFromDataAssociations(workItemNode);
setWorkItemParametersFromStringReplacement(workItemNode);
}

protected void setWorkItemParametersFromDataAssociations(WorkItemNode workItemNode) {
for (Iterator<DataAssociation> iterator = workItemNode.getInAssociations().iterator(); iterator.hasNext();) {
DataAssociation association = iterator.next();
if (association.getTransformation() != null) {
Expand All @@ -191,7 +201,7 @@ protected WorkItem createWorkItem(WorkItemNode workItemNode) {
if (transformer != null) {
Object parameterValue = transformer.transform(transformation.getCompiledExpression(), getSourceParameters(association));
if (parameterValue != null) {
((WorkItem) workItem).setParameter(association.getTarget(), parameterValue);
workItem.setParameter(association.getTarget(), parameterValue);
}
}
} else if (association.getAssignments() == null || association.getAssignments().isEmpty()) {
Expand All @@ -204,12 +214,12 @@ protected WorkItem createWorkItem(WorkItemNode workItemNode) {
parameterValue = MVELSafeHelper.getEvaluator().eval(association.getSources().get(0), new NodeInstanceResolverFactory(this));
} catch (Throwable t) {
logger.error("Could not find variable scope for variable {}", association.getSources().get(0));
logger.error("when trying to execute Work Item {}", work.getName());
logger.error("when trying to execute Work Item {}", workItemNode.getWork().getName());
logger.error("Continuing without setting parameter.");
}
}
if (parameterValue != null) {
((WorkItem) workItem).setParameter(association.getTarget(), parameterValue);
workItem.setParameter(association.getTarget(), parameterValue);
}
} else {
for (Iterator<Assignment> it = association.getAssignments().iterator(); it.hasNext();) {
Expand All @@ -218,6 +228,9 @@ protected WorkItem createWorkItem(WorkItemNode workItemNode) {
}
}

}

protected void setWorkItemParametersFromStringReplacement(WorkItemNode workItemNode) {
for (Map.Entry<String, Object> entry : workItem.getParameters().entrySet()) {
if (entry.getValue() instanceof String) {
String s = (String) entry.getValue();
Expand All @@ -238,7 +251,7 @@ protected WorkItem createWorkItem(WorkItemNode workItemNode) {
replacements.put(paramName, variableValueString);
} catch (Throwable t) {
logger.error("Could not find variable scope for variable {}", paramName);
logger.error("when trying to replace variable in string for Work Item {}", work.getName());
logger.error("when trying to replace variable in string for Work Item {}", workItemNode.getWork().getName());
logger.error("Continuing without setting parameter.");
}
}
Expand All @@ -248,11 +261,10 @@ protected WorkItem createWorkItem(WorkItemNode workItemNode) {
for (Map.Entry<String, String> replacement : replacements.entrySet()) {
s = s.replace("#{" + replacement.getKey() + "}", replacement.getValue());
}
((WorkItem) workItem).setParameter(entry.getKey(), s);
workItem.setParameter(entry.getKey(), s);

}
}
return workItem;
}

private void handleAssignment(Assignment assignment) {
Expand All @@ -271,66 +283,7 @@ public void triggerCompleted(WorkItem workItem) {
WorkItemNode workItemNode = getWorkItemNode();

if (workItemNode != null && workItem.getState() == WorkItem.COMPLETED) {
validateWorkItemResultVariable(getProcessInstance().getProcessName(), workItemNode.getOutAssociations(), workItem);
for (Iterator<DataAssociation> iterator = getWorkItemNode().getOutAssociations().iterator(); iterator.hasNext();) {
DataAssociation association = iterator.next();
if (association.getTransformation() != null) {
Transformation transformation = association.getTransformation();
DataTransformer transformer = DataTransformerRegistry.get().find(transformation.getLanguage());
if (transformer != null) {
Object parameterValue = transformer.transform(transformation.getCompiledExpression(), workItem.getResults());
VariableScopeInstance variableScopeInstance = (VariableScopeInstance) resolveContextInstance(VariableScope.VARIABLE_SCOPE, association.getTarget());
if (variableScopeInstance != null && parameterValue != null) {

variableScopeInstance.getVariableScope().validateVariable(getProcessInstance().getProcessName(), association.getTarget(), parameterValue);

variableScopeInstance.setVariable(association.getTarget(), parameterValue);
} else {
logger.warn("Could not find variable scope for variable {}", association.getTarget());
logger.warn("when trying to complete Work Item {}", workItem.getName());
logger.warn("Continuing without setting variable.");
}
if (parameterValue != null) {
((WorkItem) workItem).setParameter(association.getTarget(), parameterValue);
}
}
} else if (association.getAssignments() == null || association.getAssignments().isEmpty()) {
VariableScopeInstance variableScopeInstance = (VariableScopeInstance) resolveContextInstance(VariableScope.VARIABLE_SCOPE, association.getTarget());
if (variableScopeInstance != null) {
Object value = workItem.getResult(association.getSources().get(0));
if (value == null) {
try {
value = MVELSafeHelper.getEvaluator().eval(association.getSources().get(0), new WorkItemResolverFactory(workItem));
} catch (Throwable t) {
// do nothing
}
}
Variable varDef = variableScopeInstance.getVariableScope().findVariable(association.getTarget());
DataType dataType = varDef.getType();
// exclude java.lang.Object as it is considered unknown type
if (!dataType.getStringType().endsWith("java.lang.Object") &&
!dataType.getStringType().endsWith("Object") && value instanceof String) {
value = dataType.readValue((String) value);
} else {
variableScopeInstance.getVariableScope().validateVariable(getProcessInstance().getProcessName(), association.getTarget(), value);
}
variableScopeInstance.setVariable(association.getTarget(), value);
} else {
logger.warn("Could not find variable scope for variable {}", association.getTarget());
logger.warn("when trying to complete Work Item {}", workItem.getName());
logger.warn("Continuing without setting variable.");
}

} else {
try {
for (Iterator<Assignment> it = association.getAssignments().iterator(); it.hasNext();) {
handleAssignment(it.next());
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
updateVariablesFromResult(workItem, workItemNode);
}
// handle dynamic nodes
if (getNode() == null) {
Expand All @@ -346,6 +299,68 @@ public void triggerCompleted(WorkItem workItem) {
}
}

protected void updateVariablesFromResult(WorkItem workItem, WorkItemNode workItemNode) {
validateWorkItemResultVariable(getProcessInstance().getProcessName(), workItemNode.getOutAssociations(), workItem);
for (Iterator<DataAssociation> iterator = getWorkItemNode().getOutAssociations().iterator(); iterator.hasNext();) {
DataAssociation association = iterator.next();
if (association.getTransformation() != null) {
Transformation transformation = association.getTransformation();
DataTransformer transformer = DataTransformerRegistry.get().find(transformation.getLanguage());
if (transformer != null) {
Object parameterValue = transformer.transform(transformation.getCompiledExpression(), workItem.getResults());
VariableScopeInstance variableScopeInstance = (VariableScopeInstance) resolveContextInstance(VariableScope.VARIABLE_SCOPE, association.getTarget());
if (variableScopeInstance != null && parameterValue != null) {

variableScopeInstance.getVariableScope().validateVariable(getProcessInstance().getProcessName(), association.getTarget(), parameterValue);

variableScopeInstance.setVariable(association.getTarget(), parameterValue);
} else {
logger.warn("Could not find variable scope for variable {}", association.getTarget());
logger.warn("when trying to complete Work Item {}", workItem.getName());
logger.warn("Continuing without setting variable.");
}
if (parameterValue != null) {
workItem.setParameter(association.getTarget(), parameterValue);
}
}
} else if (association.getAssignments() == null || association.getAssignments().isEmpty()) {
VariableScopeInstance variableScopeInstance = (VariableScopeInstance) resolveContextInstance(VariableScope.VARIABLE_SCOPE, association.getTarget());
if (variableScopeInstance != null) {
Object value = workItem.getResult(association.getSources().get(0));
if (value == null) {
try {
value = MVELSafeHelper.getEvaluator().eval(association.getSources().get(0), new WorkItemResolverFactory(workItem));
} catch (Throwable t) {
// do nothing
}
}
Variable varDef = variableScopeInstance.getVariableScope().findVariable(association.getTarget());
DataType dataType = varDef.getType();
// exclude java.lang.Object as it is considered unknown type
if (!dataType.getStringType().endsWith("java.lang.Object") &&
!dataType.getStringType().endsWith("Object") && value instanceof String) {
value = dataType.readValue((String) value);
} else {
variableScopeInstance.getVariableScope().validateVariable(getProcessInstance().getProcessName(), association.getTarget(), value);
}
variableScopeInstance.setVariable(association.getTarget(), value);
} else {
logger.warn("Could not find variable scope for variable {}", association.getTarget());
logger.warn("when trying to complete Work Item {}", workItem.getName());
logger.warn("Continuing without setting variable.");
}

} else {
try {
for (Iterator<Assignment> it = association.getAssignments().iterator(); it.hasNext();) {
handleAssignment(it.next());
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
}
public void cancel() {
WorkItem workItem = getWorkItem();
if (workItem != null &&
Expand Down

0 comments on commit 442526f

Please sign in to comment.