This is a non-official package.

If you are looking for official packages, you can find conductor-javascript in conductor-sdk repository


IMPORTANT

Because the “POST /tasks/{taskId}/ack“ api removed in ConductorV3, workers have been no longer to acknowledge a Conductor Server. To be compatible with ConductorV2 in following packages(^0.7.0), needAckTask option(default false) in ConductorWorker can control whether a worker acknowledges a Conductor Server.

netflix-conductor-utilities

A simple lib for worker of Netflix conductor

Install

`` bash
npm install netflix-conductor-utilities
`

Note: The previous versions before 0.6.1 only work for ConductorV2.

Usage

1. Metadata Manager
1. TaskMetadataManager : task metadata management
2. WorkflowMetadataManager : workflow metadata management
2. Utils
1. WorkflowManager : manipulate workflows
2. ConductorWorker : task worker
* simple usage
* simple usage with middleware

Metadata Manager

$3

`typescript
import {TaskMetadataManager} from 'netflix-conductor-utilities';

const taskMetaManager = new TaskMetadataManager({apiEndpoint: 'http://localhost:8080/api/'});

await taskMetaManager.registerTasks([{
name: 'a_task_id',
}]);
`

$3

`typescript
import {WorkflowTaskType, WorkflowMetadataManager} from 'netflix-conductor-utilities';

const workflowMetaManager = new WorkflowMetadataManager({apiEndpoint: 'http://localhost:8080/api/'});
const workflow = await workflowMetaManager.registerWorkflow({
name: 'test_wf',
tasks: [
{
"name": "a_task_id",
"taskReferenceName": "a_task_id_in_wf",
"type": WorkflowTaskType.simple,
"ownerEmail": "yujiechen0514@gmail.com"
}
],
});
`

Utils

$3

`typescript
import {WorkflowManager} from 'netflix-conductor-utilities';

const workflowManager = new WorkflowManager({apiEndpoint: 'http://localhost:8080/api/'});
const workflow = await workflowManager.startWorkflow({
name: 'test_wf',
});
`

$3

ConductorWorker is a generic class with
* OUTPUT : task output data
* INPUT : task input data
* CTX : polled task context. See: ConductorWorker with Middleware

#### ConductorWorker Simple Usage

`typescript
import {ConductorWorker} from 'netflix-conductor-utilities';

// 'a_task_id' worker
const worker = new ConductorWorker<{message: string}, {data: string}>({
url: 'http://localhost:8080',
workerid: 'my_worker_host',

// maximum number of parallel running tasks
maxConcurrent: 2,

// shoule be 'true' for a ConductorV2
needAckTask: false
});

// start
worker.start('a_task_id', async (input, task) => {
// send log
await task.sendLog('hi');
return {message: input.data};
}, 5000);

// stop
setTimeout(() => {
worker.stop();
}, 20000)
`

#### ConductorWorker Usage with Middleware

This middleware functionality is useful for fetching extra data into a “task context” before you deal with a polled task.

Each polled task has own "task-context" instance, it will pass through all middlewares.

For instance, you can create an awilix scoped container for each polled task

`typescript
const container = createContainer();
worker.use(async (ctx) => {
// scoped dependcies
const userId = ctx.input.userId;

// create a scoped container
const scopeContainer = container.createScope();
const user = await getCurrentUser(userId);
scopeContainer.register({ currentUser: asValue(user) });
ctx.scopeContainer = scopeContainer;
});
`

worker.use(middleware) set a middleware. It supports promise version and callback version.

`typescript
import {ConductorWorker} from 'netflix-conductor-utilities';

// 'a_task_id' worker
const worker = new ConductorWorker<{message: string}, {userId: string}>({
url: 'http://localhost:8080',
workerid: 'my_worker_host',

// maximum number of parallel running tasks
maxConcurrent: 2,

// shoule be 'true' for a ConductorV2
needAckTask: false
});

// add middleware - promise version
worker.use(async (ctx) => {
ctx.user = await getUser(ctx.input.userId);
});

// add middleware - callback version
worker.use((ctx, next) => {
getUser(ctx.input.userId)
.then((user) => {
ctx.user = user;
next();
})
.catch((err) => {
next(err);
});
});


// start
worker.start('a_task_id', async (input, task, ctx) => {
// access context
console.log(ctx.user)

// send log
await task.sendLog('hi');
return {message: input.userId};
}, 5000);

``

#### Other examples
See more example