New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details → →

Book a Demo Sign in

@sendit-th/conductor-client

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sendit-th/conductor-client

Conductor client for nodejs

latest

Source

npm

Version: 1.3.0

Version published: 5 years ago

Maintainers: 8

Created: 7 years ago

Source

conductor-client

Install

npm i -s conductor-client

Example

This example will create 3 workflow (fail_rollback, withdraw_chickens, order_chickens), 19 tasks then start "order_chickens" workflow

const ConductorClient = require('conductor-client').default

const conductorClient = new ConductorClient({
  baseURL: 'http://localhost:8080/api'
})

const workflowDefs = [
  {
    name: 'fail_rollback',
    description: 'Fail rollback',
    version: 1,
    tasks: [
      {
        name: 'check_fail1',
        taskReferenceName: 'check_fail1',
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'check_fail1',
        taskReferenceName: 'check_fail2',
        inputParameters: {
          chickens: '${workflow.input.chickens}'
        },
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      }
    ],
    inputParameters: ['orderType', 'chickens', 'orderType'],
    schemaVersion: 2
  },
  {
    name: 'withdraw_chickens',
    description: 'Withdraw chickens',
    version: 1,
    tasks: [
      {
        name: 'is_take_home',
        taskReferenceName: 'is_take_home',
        type: 'DECISION',
        inputParameters: {
          orderType: '${workflow.input.orderType}'
        },
        caseValueParam: 'orderType',
        decisionCases: {
          takehome: [
            {
              name: 'put_chickens_on_box',
              taskReferenceName: 'put_chickens_on_box',
              inputParameters: {
                chickens: '${workflow.input.chickens}'
              },
              type: 'SIMPLE',
              startDelay: 0,
              optional: false
            }
          ]
        },
        defaultCase: [
          {
            name: 'withdraw_disk',
            taskReferenceName: 'withdraw_disk',
            type: 'SIMPLE',
            startDelay: 0,
            optional: false
          },
          {
            name: 'put_chickens_on_disk',
            taskReferenceName: 'put_chickens_on_disk',
            inputParameters: {
              chickens: '${workflow.input.chickens}'
            },
            type: 'SIMPLE',
            startDelay: 0,
            optional: false
          }
        ],
        startDelay: 0,
        optional: false
      }
    ],
    inputParameters: ['orderType', 'chickens', 'orderType'],
    schemaVersion: 2
  },
  {
    name: 'order_chickens',
    description: 'Order chickens',
    version: 1,
    tasks: [
      {
        name: 'get_money',
        taskReferenceName: 'get_money',
        inputParameters: {
          money: '${workflow.input.money}'
        },
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'print_slip',
        taskReferenceName: 'print_slip',
        inputParameters: {
          money: '${workflow.input.money}',
          chickens: '${workflow.input.chickens}',
          queueId: '${get_money.output.queueId}'
        },
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'check_chickens',
        taskReferenceName: 'check_chickens',
        inputParameters: {
          chickens: '${workflow.input.chickens}'
        },
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'is_got_chickens',
        taskReferenceName: 'is_got_chickens',
        type: 'DECISION',
        inputParameters: {
          isGotChickens: '${check_chickens.output.isGotChickens}'
        },
        caseValueParam: 'isGotChickens',
        decisionCases: {
          yes: [
            {
              name: 'withdraw_chickens',
              taskReferenceName: 'withdraw_chickens_yes',
              type: 'SUB_WORKFLOW',
              inputParameters: {
                orderType: '${workflow.input.orderType}',
                chickens: '${workflow.input.chickens}'
              },
              startDelay: 0,
              subWorkflowParam: {
                name: 'withdraw_chickens',
                version: 1
              },
              optional: false
            }
          ]
        },
        defaultCase: [
          {
            name: 'fire_chickens',
            taskReferenceName: 'fire_chickens',
            inputParameters: {
              chickens: '${workflow.input.chickens}'
            },
            type: 'SIMPLE',
            startDelay: 0,
            optional: false
          },
          {
            name: 'withdraw_chickens',
            taskReferenceName: 'withdraw_chickens_default',
            type: 'SUB_WORKFLOW',
            inputParameters: {
              orderType: '${workflow.input.orderType}',
              chickens: '${workflow.input.chickens}'
            },
            startDelay: 0,
            subWorkflowParam: {
              name: 'withdraw_chickens',
              version: 1
            },
            optional: false
          }
        ],
        startDelay: 0,
        optional: false
      },
      {
        name: 'put_chickens_on_counter',
        taskReferenceName: 'put_chickens_on_counter',
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'call_customer',
        taskReferenceName: 'call_customer',
        inputParameters: {
          queueId: '${get_money.output.queueId}'
        },
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      },
      {
        name: 'others_job',
        taskReferenceName: 'others_job',
        inputParameters: {
          dynamicTasks: '${call_customer.output.dynamicTasks}',
          dynamicTasksInput: '${call_customer.output.dynamicTasksInput}'
        },
        type: 'FORK_JOIN_DYNAMIC',
        dynamicForkTasksParam: 'dynamicTasks',
        dynamicForkTasksInputParamName: 'dynamicTasksInput'
      },
      {
        name: 'wait_others_job',
        joinOn: ['others_job'],
        taskReferenceName: 'system_join',
        type: 'JOIN'
      },
      {
        name: 'just_done',
        taskReferenceName: 'just_done',
        type: 'SIMPLE',
        startDelay: 0,
        optional: false
      }
    ],
    inputParameters: ['orderType', 'chickens', 'money'],
    failureWorkflow: 'fail_rollback',
    schemaVersion: 2
  }
]

const taskDefs = [
  {
    name: 'check_fail1',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['money'],
    outputKeys: ['queueId'],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'check_fail2',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['money'],
    outputKeys: ['queueId'],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'get_money',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['money'],
    outputKeys: ['queueId'],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'print_slip',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['money', 'queueId', 'chickens'],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'check_chickens',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['chickens'],
    outputKeys: ['isGotChickens'],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'is_got_chickens',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['chickens'],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'fire_chickens',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['chickens'],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'put_chickens_on_counter',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'call_customer',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['queueId'],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'is_take_home',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: ['order_type'],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'withdraw_disk',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'put_chickens_on_disk',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'put_chickens_on_box',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'just_wait',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'dy_fork_1',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'dy_fork_2',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'dy_fork_3',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'dy_fork_4',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  },
  {
    name: 'just_done',
    retryCount: 3,
    timeoutSeconds: 3600,
    inputKeys: [],
    outputKeys: [],
    timeoutPolicy: 'TIME_OUT_WF',
    retryLogic: 'FIXED',
    retryDelaySeconds: 60,
    responseTimeoutSeconds: 3600
  }
]

conductorClient
  .registerTaskDefs(taskDefs)
  .then(() =>
    conductorClient.updateWorkflowDefs(workflowDefs).then(() => {
      conductorClient.registerWatcher(
        'get_money',
        async (data, updater) => {
          try {
            console.log(data.taskType, data.inputData)
            await updater.inprogress({
              outputData: { queueId: '12354423' },
              callbackAfterSeconds: 123,
              logs: ['ello', 'eieiei', 'huhu', JSON.stringify({ hello: 'test' })]
            })

            setTimeout(() => {
              conductorClient.updateTask({
                workflowInstanceId: data.workflowInstanceId,
                taskId: data.taskId,
                status: 'COMPLETED',
                outputData: {
                  queueId: 'asdsadcccxzz'
                },
                logs: ['2233344']
              })
            }, 10000)
          } catch (error) {
            console.log(error)
          }
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'print_slip',
        async (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'check_chickens',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({ outputData: { isGotChickens: 'yes' } })
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'fire_chickens',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'put_chickens_on_counter',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'call_customer',
        (data, updater) => {
          const forkTasks = [
            {
              name: 'dy_fork_1',
              taskReferenceName: 'dy_fork_1',
              type: 'SIMPLE'
            },
            {
              name: 'dy_fork_2',
              taskReferenceName: 'dy_fork_2',
              type: 'SIMPLE'
            },
            {
              name: 'dy_fork_3',
              taskReferenceName: 'dy_fork_3',
              type: 'SIMPLE'
            },
            {
              name: 'dy_fork_4',
              taskReferenceName: 'dy_fork_4',
              type: 'SIMPLE'
            }
          ]
          const inputTasks = {
            dy_fork_1: { input1: 'Hello1' },
            dy_fork_2: { input2: 'Hello2' },
            dy_fork_3: { input1: '33223' },
            dy_fork_4: { input1: 'Hello4' }
          }
          console.log(data.taskType, data.inputData)
          updater.complete({
            outputData: {
              dynamicTasks: forkTasks,
              dynamicTasksInput: inputTasks
            }
          })
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'withdraw_disk',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'put_chickens_on_disk',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'put_chickens_on_box',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'just_wait',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'dy_fork_1',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'dy_fork_2',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'dy_fork_3',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )
      conductorClient.registerWatcher(
        'dy_fork_4',
        (data, updater) => {
          console.log(data, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )

      conductorClient.registerWatcher(
        'just_done',
        (data, updater) => {
          console.log(data.taskType, data.inputData)
          updater.complete({})
        },
        { pollingIntervals: 1000, autoAck: true, maxRunner: 1 },
        true
      )

      conductorClient.startWorkflow('order_chickens', {
        money: 500,
        orderType: 'takehome',
        chickens: 20
      })
      conductorClient.startWorkflow('order_chickens', {
        money: 500,
        orderType: 'takehome',
        chickens: 20
      })
    })
  )
  .catch(error => console.dir(error, { depth: 10 }))

ConductorClient method

constructor(options)
- Arguments
  - options (Object): see below
registerWatcher(taskType, callback = f => f, options = {}, startPolling = false)
- Description
  - register a watcher to polling for task
- Arguments
  - taskType (String): taskType to register
  - callback (Function(data, updater(data))): callback function that fired if found task
  - options (Object): see below, options to overide client options
  - startPolling (Boolean): if set to true, watcher will start polling right away
- Returns
  - worker (Worker's Object): worker object
startPolling()
- Description
  - If set startPolling to false on registerWatcher can call this method to let all workers start polling
getWorkflowDefinition(workflowName: string, varsion: number = 1)
- Description
  - get workflow by workflowName
getAllWorkflowDefs()
createWorkflowDef(workflowDefBody)
updateWorkflowDefs(workflowDefsBody = [])
unRegisterWorkflowDef(workflowDefName, version = 1)
getTaskDef(taskDefName)
getAllTaskDefs()
registerTaskDefs(taskDefsMeta = [])
updateTaskDef(taskDefMeta)
unRegisterTaskDef(taskDefName)
getWorkflow(workflowId, includeTasks = true)
searchWorkflows(start = 0, size = 20, sort = 'ASC:createTime', freeText, query)
getRunningWorkflows(workflowName, version = '1')
startWorkflow(workflowName, input, version = 1, correlationId)
restartWorkflow(workflowId)
terminateWorkflow(workflowId, reason = '')
pauseWorkflow(workflowId)
resumeWorkflow(workflowId)
skipTaskFromWorkflow(workflowId, taskReferenceName, taskInput, taskOutput)
rerunWorkflow(workflowId, reRunFromWorkflowId, workflowInput = {}, reRunFromTaskId, taskInput = {})

ConductorClient options

ConductorClient options will pass to watcher's options as default value and can overide per each worker by using registerWatcher

property	default value	type	description
baseURL	http://localhost:8080/api	String	base url of conductor server
workerID	computer's hostname e.g. someone's-computer.local	String	unique worker ID
pollingIntervals	1000	Number	polling interval in millisecond
maxRunner	1	Number	Nummber of running tasks per taskType
autoAck	true	Boolean	Auto send ack when poll a task

Watcher option

The same as ConductorClient options but this option will overided

property	default value	type	description
baseURL	http://localhost:8080/api	String	base url of conductor server
workerID	computer's hostname e.g. someone's-computer.local	String	unique worker ID
pollingIntervals	1000	Number	polling interval in millisecond
maxRunner	1	Number	Nummber of running tasks per taskType
autoAck	true	Boolean	Auto send ack when poll a task

Keywords

conductor

conductor-nodejs-client

FAQs

What is @sendit-th/conductor-client?

Is @sendit-th/conductor-client well maintained?

Package last updated on 30 Nov 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@sendit-th/conductor-client

conductor-client

Install

Example

ConductorClient method

ConductorClient options

Watcher option

Keywords

Related posts

Supply Chain Attack on Axios Pulls Malicious Dependency from npm

TeamPCP Compromises Telnyx Python SDK to Deliver Credential-Stealing Malware