Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1032 from X-Ultra/dev_script_task
Browse files Browse the repository at this point in the history
Add new system task type Lambda
  • Loading branch information
kishorebanala committed Mar 7, 2019
2 parents 2b9b2d2 + d6edbd6 commit 6ebf348
Show file tree
Hide file tree
Showing 10 changed files with 403 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public enum TaskType {
WAIT(true),
USER_DEFINED(false),
HTTP(true),
LAMBDA(true),
EXCLUSIVE_JOIN(true);

/**
Expand All @@ -34,6 +35,7 @@ public enum TaskType {
public static final String TASK_TYPE_USER_DEFINED = "USER_DEFINED";
public static final String TASK_TYPE_SIMPLE = "SIMPLE";
public static final String TASK_TYPE_HTTP = "HTTP";
public static final String TASK_TYPE_LAMBDA= "LAMBDA";
public static final String TASK_TYPE_EXLCUSIVE_JOIN = "EXCLUSIVE_JOIN";

private boolean isSystemTask;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ public static boolean isSystemTask(String name) {
@ProtoField(id = 8)
private String caseExpression;

@ProtoField(id = 22)
private String scriptExpression;

@ProtoMessage(wrapper = true)
public static class WorkflowTaskList {
public List<WorkflowTask> getTasks() {
Expand Down Expand Up @@ -356,6 +359,15 @@ public void setCaseExpression(String caseExpression) {
this.caseExpression = caseExpression;
}


public String getScriptExpression() {
return scriptExpression;
}

public void setScriptExpression(String expression) {
this.scriptExpression = expression;
}


/**
* @return the subWorkflow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,38 +28,13 @@
import com.netflix.conductor.core.events.EventQueueProvider;
import com.netflix.conductor.core.events.queue.dyno.DynoEventQueueProvider;
import com.netflix.conductor.core.execution.ParametersUtils;
import com.netflix.conductor.core.execution.mapper.DecisionTaskMapper;
import com.netflix.conductor.core.execution.mapper.DynamicTaskMapper;
import com.netflix.conductor.core.execution.mapper.EventTaskMapper;
import com.netflix.conductor.core.execution.mapper.ExclusiveJoinTaskMapper;
import com.netflix.conductor.core.execution.mapper.ForkJoinDynamicTaskMapper;
import com.netflix.conductor.core.execution.mapper.ForkJoinTaskMapper;
import com.netflix.conductor.core.execution.mapper.HTTPTaskMapper;
import com.netflix.conductor.core.execution.mapper.JoinTaskMapper;
import com.netflix.conductor.core.execution.mapper.SimpleTaskMapper;
import com.netflix.conductor.core.execution.mapper.SubWorkflowTaskMapper;
import com.netflix.conductor.core.execution.mapper.TaskMapper;
import com.netflix.conductor.core.execution.mapper.UserDefinedTaskMapper;
import com.netflix.conductor.core.execution.mapper.WaitTaskMapper;
import com.netflix.conductor.core.execution.tasks.Event;
import com.netflix.conductor.core.execution.tasks.SubWorkflow;
import com.netflix.conductor.core.execution.tasks.SystemTaskWorkerCoordinator;
import com.netflix.conductor.core.execution.tasks.Wait;
import com.netflix.conductor.core.execution.mapper.*;
import com.netflix.conductor.core.execution.tasks.*;
import com.netflix.conductor.core.utils.JsonUtils;
import com.netflix.conductor.dao.MetadataDAO;
import com.netflix.conductor.dao.QueueDAO;

import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_DECISION;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_DYNAMIC;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_EVENT;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_FORK_JOIN;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_FORK_JOIN_DYNAMIC;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_HTTP;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_JOIN;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_SIMPLE;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_SUB_WORKFLOW;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_USER_DEFINED;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_WAIT;
import static com.netflix.conductor.common.metadata.workflow.TaskType.*;
import static com.netflix.conductor.core.events.EventQueues.EVENT_QUEUE_PROVIDERS_QUALIFIER;
import static com.netflix.conductor.common.metadata.workflow.TaskType.TASK_TYPE_EXLCUSIVE_JOIN;
/**
Expand All @@ -79,6 +54,7 @@ protected void configure() {
bind(SubWorkflow.class).asEagerSingleton();
bind(Wait.class).asEagerSingleton();
bind(Event.class).asEagerSingleton();
bind(Lambda.class).asEagerSingleton();
}

@Provides
Expand Down Expand Up @@ -189,6 +165,14 @@ public TaskMapper getSimpleTaskMapper(ParametersUtils parametersUtils) {
public TaskMapper getHTTPTaskMapper(ParametersUtils parametersUtils, MetadataDAO metadataDAO) {
return new HTTPTaskMapper(parametersUtils, metadataDAO);
}

@ProvidesIntoMap
@StringMapKey(TASK_TYPE_LAMBDA)
@Singleton
@Named(TASK_MAPPERS_QUALIFIER)
public TaskMapper getLambdaTaskMapper(ParametersUtils parametersUtils) {
return new LambdaTaskMapper(parametersUtils);
}

@ProvidesIntoMap
@StringMapKey(TASK_TYPE_EXLCUSIVE_JOIN)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/**
* Copyright 2018 Netflix, Inc.
* <p>
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 com.netflix.conductor.core.execution.mapper;

import com.netflix.conductor.common.metadata.tasks.Task;
import com.netflix.conductor.common.metadata.workflow.TaskType;
import com.netflix.conductor.common.metadata.workflow.WorkflowDef;
import com.netflix.conductor.common.metadata.workflow.WorkflowTask;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.core.execution.ParametersUtils;
import com.netflix.conductor.core.execution.SystemTaskType;
import com.netflix.conductor.core.execution.tasks.Lambda;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
* @author x-ultra
*/
public class LambdaTaskMapper implements TaskMapper {

public static final Logger logger = LoggerFactory.getLogger(LambdaTaskMapper.class);
private ParametersUtils parametersUtils;

public LambdaTaskMapper(ParametersUtils parametersUtils) {
this.parametersUtils = parametersUtils;
}


@Override
public List<Task> getMappedTasks(TaskMapperContext taskMapperContext) {

logger.debug("TaskMapperContext {} in LambdaTaskMapper", taskMapperContext);

WorkflowTask taskToSchedule = taskMapperContext.getTaskToSchedule();
Workflow workflowInstance = taskMapperContext.getWorkflowInstance();
String taskId = taskMapperContext.getTaskId();

Map<String, Object> taskInput = parametersUtils.getTaskInputV2(taskMapperContext.getTaskToSchedule().getInputParameters(), workflowInstance, taskId, null);

Task task = new Task();
task.setTaskType(Lambda.TASK_NAME);
task.setTaskDefName(taskMapperContext.getTaskToSchedule().getName());
task.setReferenceTaskName(taskMapperContext.getTaskToSchedule().getTaskReferenceName());
task.setWorkflowInstanceId(workflowInstance.getWorkflowId());
task.setWorkflowType(workflowInstance.getWorkflowName());
task.setCorrelationId(workflowInstance.getCorrelationId());
task.setScheduledTime(System.currentTimeMillis());
task.setInputData(taskInput);
task.setTaskId(taskId);
task.setStatus(Task.Status.IN_PROGRESS);
task.setWorkflowTask(taskToSchedule);
return Arrays.asList(task);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
package com.netflix.conductor.core.execution.tasks;

import com.netflix.conductor.common.metadata.tasks.Task;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.core.events.ScriptEvaluator;
import com.netflix.conductor.core.execution.WorkflowExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.inject.Singleton;
import javax.script.ScriptException;
import java.util.Map;


/**
* @author X-Ultra
* Task that enables execute Lambda script at workflow execution, For example,
* <pre>
...
{
"tasks": [
{
"name": "LAMBDA",
"taskReferenceName": "lambda_test",
"type": "LAMBDA",
"inputParameters": {
"input": "${workflow.input}",
"scriptExpression": "if ($.input.a==1){return {testvalue: true}} else{return {testvalue: false} }"
}
}
]
}
...
* </pre>
* then to use task output, e.g. <code>script_test.output.testvalue</code>
*/
public class Lambda extends WorkflowSystemTask {

private static final Logger logger = LoggerFactory.getLogger(Lambda.class);
private static final String QUERY_EXPRESSION_PARAMETER = "scriptExpression";
public static final String TASK_NAME = "LAMBDA";

public Lambda() {
super(TASK_NAME);
logger.info(TASK_NAME + " task initialized...");
}

@Override
public void start(Workflow workflow, Task task, WorkflowExecutor executor) {


}


@Override
public boolean execute(Workflow workflow, Task task, WorkflowExecutor executor) {
Map<String, Object> taskInput = task.getInputData();
Map<String, Object> taskOutput = task.getOutputData();

String scriptExpression = (String) taskInput.get(QUERY_EXPRESSION_PARAMETER);

if(scriptExpression == null) {
task.setReasonForIncompletion("Missing '" + QUERY_EXPRESSION_PARAMETER + "' in input parameters");
task.setStatus(Task.Status.FAILED);
return true;
}

String scriptExpressionBuilder = "function scriptFun(){" +
scriptExpression +
"} scriptFun();";

logger.info("scriptExpressionBuilder: {}" , scriptExpressionBuilder);

try {
Object returnValue = null;
returnValue = ScriptEvaluator.eval(scriptExpressionBuilder, taskInput);
taskOutput.put("result", returnValue);
task.setStatus(Task.Status.COMPLETED);
} catch (ScriptException e) {
logger.error("Failed to execute Lambda: {}", scriptExpression, e);
task.setStatus(Task.Status.FAILED);
task.setReasonForIncompletion(e.getMessage());
taskOutput.put("error", e.getCause() != null ? e.getCause().getMessage() : e.getMessage());
}

return true;

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,7 @@
import com.netflix.conductor.common.metadata.workflow.WorkflowDef;
import com.netflix.conductor.common.metadata.workflow.WorkflowTask;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.core.execution.mapper.DecisionTaskMapper;
import com.netflix.conductor.core.execution.mapper.DynamicTaskMapper;
import com.netflix.conductor.core.execution.mapper.EventTaskMapper;
import com.netflix.conductor.core.execution.mapper.ForkJoinDynamicTaskMapper;
import com.netflix.conductor.core.execution.mapper.ForkJoinTaskMapper;
import com.netflix.conductor.core.execution.mapper.HTTPTaskMapper;
import com.netflix.conductor.core.execution.mapper.JoinTaskMapper;
import com.netflix.conductor.core.execution.mapper.SimpleTaskMapper;
import com.netflix.conductor.core.execution.mapper.SubWorkflowTaskMapper;
import com.netflix.conductor.core.execution.mapper.TaskMapper;
import com.netflix.conductor.core.execution.mapper.UserDefinedTaskMapper;
import com.netflix.conductor.core.execution.mapper.WaitTaskMapper;
import com.netflix.conductor.core.execution.mapper.*;
import com.netflix.conductor.core.execution.tasks.Wait;
import com.netflix.conductor.core.execution.tasks.WorkflowSystemTask;
import com.netflix.conductor.core.metadata.MetadataMapperService;
Expand Down Expand Up @@ -113,6 +102,7 @@ public void init() {
taskMappers.put("EVENT", new EventTaskMapper(parametersUtils));
taskMappers.put("WAIT", new WaitTaskMapper(parametersUtils));
taskMappers.put("HTTP", new HTTPTaskMapper(parametersUtils, metadataDAO));
taskMappers.put("LAMBDA", new LambdaTaskMapper(parametersUtils));

deciderService = new DeciderService(parametersUtils, queueDAO, metadataDAO, externalPayloadStorageUtils, taskMappers);
MetadataMapperService metadataMapperService = new MetadataMapperService(metadataDAO);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package com.netflix.conductor.core.execution.mapper;

import com.netflix.conductor.common.metadata.tasks.Task;
import com.netflix.conductor.common.metadata.tasks.TaskDef;
import com.netflix.conductor.common.metadata.workflow.TaskType;
import com.netflix.conductor.common.metadata.workflow.WorkflowDef;
import com.netflix.conductor.common.metadata.workflow.WorkflowTask;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.core.execution.ParametersUtils;
import com.netflix.conductor.core.execution.SystemTaskType;
import com.netflix.conductor.core.utils.IDGenerator;
import com.netflix.conductor.dao.MetadataDAO;
import org.junit.Before;
import org.junit.Test;

import java.util.Arrays;
import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.Mockito.mock;

public class LambdaTaskMapperTest {

private ParametersUtils parametersUtils;

@Before
public void setUp() {
parametersUtils = mock(ParametersUtils.class);
}

@Test
public void getMappedTasks() throws Exception {

WorkflowTask taskToSchedule = new WorkflowTask();
taskToSchedule.setType(TaskType.LAMBDA.name());
taskToSchedule.setScriptExpression("if ($.input.a==1){return {testValue: true}} else{return {testValue: false} }");

String taskId = IDGenerator.generate();

WorkflowDef wd = new WorkflowDef();
Workflow w = new Workflow();
w.setWorkflowDefinition(wd);

TaskMapperContext taskMapperContext = TaskMapperContext.newBuilder()
.withWorkflowDefinition(wd)
.withWorkflowInstance(w)
.withTaskDefinition(new TaskDef())
.withTaskToSchedule(taskToSchedule)
.withRetryCount(0)
.withTaskId(taskId)
.build();


List<Task> mappedTasks = new LambdaTaskMapper(parametersUtils).getMappedTasks(taskMapperContext);

assertEquals(1, mappedTasks.size());
assertNotNull(mappedTasks);
assertEquals(TaskType.LAMBDA.name(), mappedTasks.get(0).getTaskType());
}

}
Loading

0 comments on commit 6ebf348

Please sign in to comment.