@io-orkes/conductor-javascript 1.0.1 → 1.1.0

package/dist/index.d.ts

@@ -1893,45 +1893,20 @@ interface ConductorWorker {
     concurrency?: number;
 }
 
-interface TaskManagerOptions {
+declare type TaskErrorHandler = (error: Error, task?: Task) => void;
+interface TaskRunnerOptions {
     workerID: string;
     domain: string | undefined;
     pollInterval?: number;
     concurrency?: number;
 }
-interface TaskManagerConfig {
-    logger?: ConductorLogger;
-    options?: Partial<TaskManagerOptions>;
-    onError?: TaskErrorHandler;
-}
-/**
- * Responsible for initializing and managing the runners that poll and work different task queues.
- */
-declare class TaskManager {
-    private tasks;
-    private readonly client;
-    private readonly logger;
-    private readonly errorHandler;
-    private workers;
-    private readonly taskManageOptions;
-    constructor(client: ConductorClient, workers: Array<ConductorWorker>, config?: TaskManagerConfig);
-    /**
-     * Start polling for tasks
-     */
-    startPolling: () => void;
-    /**
-     * Stops polling for tasks
-     */
-    stopPolling: () => void;
-}
-
-declare type TaskErrorHandler = (error: Error, task?: Task) => void;
 interface RunnerArgs {
     worker: ConductorWorker;
     taskResource: TaskResourceService;
-    options: Required<TaskManagerOptions>;
+    options: Required<TaskRunnerOptions>;
     logger?: ConductorLogger;
     onError?: TaskErrorHandler;
+    concurrency?: number;
 }
 declare const noopErrorHandler: TaskErrorHandler;
 /**
@@ -1944,27 +1919,62 @@ declare const noopErrorHandler: TaskErrorHandler;
  *
  */
 declare class TaskRunner {
-    isPolling: boolean;
     taskResource: TaskResourceService;
     worker: ConductorWorker;
-    logger: ConductorLogger;
-    options: Required<TaskManagerOptions>;
+    private logger;
+    private options;
     errorHandler: TaskErrorHandler;
+    private poller;
     constructor({ worker, taskResource, options, logger, onError: errorHandler, }: RunnerArgs);
     /**
      * Starts polling for work
      */
-    startPolling: () => Promise<void>;
+    startPolling: () => void;
     /**
      * Stops Polling for work
      */
     stopPolling: () => void;
-    poll: () => Promise<void>;
+    updateOptions(options: Partial<TaskRunnerOptions>): void;
+    get getOptions(): TaskRunnerOptions;
+    private pollAndExecute;
     updateTaskWithRetry: (task: Task, taskResult: TaskResult) => Promise<void>;
     executeTask: (task: Task) => Promise<void>;
     handleUnknownError: (unknownError: unknown) => void;
 }
 
+declare type TaskManagerOptions = TaskRunnerOptions;
+interface TaskManagerConfig {
+    logger?: ConductorLogger;
+    options?: Partial<TaskManagerOptions>;
+    onError?: TaskErrorHandler;
+}
+/**
+ * Responsible for initializing and managing the runners that poll and work different task queues.
+ */
+declare class TaskManager {
+    private tasks;
+    private readonly client;
+    private readonly logger;
+    private readonly errorHandler;
+    private workers;
+    private readonly taskManageOptions;
+    constructor(client: ConductorClient, workers: Array<ConductorWorker>, config?: TaskManagerConfig);
+    private workerManagerWorkerOptions;
+    /**
+     * new options will get merged to existing options
+     * @param options new options to update polling options
+     */
+    updatePollingOptions: (options: Partial<TaskManagerOptions>) => void;
+    /**
+     * Start polling for tasks
+     */
+    startPolling: () => void;
+    /**
+     * Stops polling for tasks
+     */
+    stopPolling: () => void;
+}
+
 declare class ConductorError extends Error {
     private _trace;
     private __proto__;
@@ -2167,4 +2177,4 @@ declare class HumanExecutor {
     completeTask(taskId: string, requestBody?: Record<string, Record<string, any>>): Promise<void>;
 }
 
-export { Action, ApiError, AssignmentPolicy, BackToAssigment, BaseHttpRequest, CancelError, CancelablePromise, ClearAssigment, CommonTaskDef, ConductorClient, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, Escalate, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FFAAssignment, Fixed, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskActionLogEntry, HumanTaskEntry, HumanTaskLoad, HumanTaskStateLogEntry, HumanTaskTemplate, HumanTaskTemplateEntry, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, LeastBusyGroupMemberAssignment, MetadataResourceService, Never, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response, RunnerArgs, SaveScheduleRequest, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultHumanTaskEntry, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
+export { Action, ApiError, AssignmentPolicy, BackToAssigment, BaseHttpRequest, CancelError, CancelablePromise, ClearAssigment, CommonTaskDef, ConductorClient, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, Escalate, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FFAAssignment, Fixed, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskActionLogEntry, HumanTaskEntry, HumanTaskLoad, HumanTaskStateLogEntry, HumanTaskTemplate, HumanTaskTemplateEntry, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, LeastBusyGroupMemberAssignment, MetadataResourceService, Never, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response, RunnerArgs, SaveScheduleRequest, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultHumanTaskEntry, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };

package/dist/index.js

@@ -101,11 +101,7 @@ __export(conductor_javascript_exports, {
 });
 module.exports = __toCommonJS(conductor_javascript_exports);
 
-// src/task/TaskRunner.ts
-var DEFAULT_ERROR_MESSAGE = "An unknown error occurred";
-var MAX_RETRIES = 3;
-var noopErrorHandler = (__error) => {
-};
+// src/task/helpers.ts
 var noopLogger = {
   debug: (...args) => {
   },
@@ -114,6 +110,88 @@ var noopLogger = {
   error: (...args) => {
   }
 };
+
+// src/task/Poller.ts
+var Poller = class {
+  constructor(pollFunction, pollerOptions, logger) {
+    this.concurrentCalls = [];
+    this.pollFunction = async () => {
+    };
+    this.isPolling = false;
+    this.options = {
+      pollInterval: 1e3,
+      concurrency: 1
+    };
+    this.logger = noopLogger;
+    this.startPolling = () => {
+      if (this.isPolling) {
+        throw new Error("Runner is already started");
+      }
+      return this.poll();
+    };
+    this.stopPolling = () => {
+      this.isPolling = false;
+      this.concurrentCalls.forEach((call) => call.stop());
+    };
+    this.poll = async () => {
+      if (!this.isPolling) {
+        this.isPolling = true;
+        for (let i = 0; i < this.options.concurrency; i++) {
+          this.concurrentCalls.push(this.singlePoll());
+        }
+      }
+    };
+    this.singlePoll = () => {
+      let poll = this.isPolling;
+      let timeout;
+      const pollingCall = async () => {
+        while (poll) {
+          await this.pollFunction();
+          await new Promise((r) => timeout = setTimeout(() => r(true), this.options.pollInterval));
+        }
+      };
+      return {
+        promise: pollingCall(),
+        stop: () => {
+          clearTimeout(timeout);
+          poll = false;
+          this.logger.debug("stopping single poll call");
+        }
+      };
+    };
+    this.pollFunction = pollFunction;
+    this.options = __spreadValues(__spreadValues({}, this.options), pollerOptions);
+    this.logger = logger || noopLogger;
+  }
+  updateConcurrency(concurrency) {
+    if (concurrency > 0 && concurrency !== this.options.concurrency) {
+      if (concurrency < this.options.concurrency) {
+        const result = this.concurrentCalls.splice(0, this.options.concurrency - concurrency);
+        result.forEach((call) => {
+          call.stop();
+          this.logger.debug("stopping some spawned calls");
+        });
+      } else {
+        for (let i = 0; i < concurrency - this.options.concurrency; i++) {
+          this.concurrentCalls.push(this.singlePoll());
+          this.logger.debug("spawning additional poll calls");
+        }
+      }
+      this.options.concurrency = concurrency;
+    }
+  }
+  updateOptions(options) {
+    const newOptions = __spreadValues(__spreadValues({}, this.options), options);
+    this.updateConcurrency(newOptions.concurrency);
+    this.options = newOptions;
+  }
+};
+
+// src/task/TaskRunner.ts
+var DEFAULT_ERROR_MESSAGE = "An unknown error occurred";
+var MAX_RETRIES = 3;
+var noopErrorHandler = (__error) => {
+};
 var TaskRunner = class {
   constructor({
     worker,
@@ -122,32 +200,24 @@ var TaskRunner = class {
     logger = noopLogger,
     onError: errorHandler = noopErrorHandler
   }) {
-    this.isPolling = false;
     this.startPolling = () => {
-      if (this.isPolling) {
-        throw new Error("Runner is already started");
-      }
-      this.isPolling = true;
-      return this.poll();
+      this.poller.startPolling();
     };
     this.stopPolling = () => {
-      this.isPolling = false;
+      this.poller.stopPolling();
     };
-    this.poll = async () => {
-      while (this.isPolling) {
-        try {
-          const { workerID } = this.options;
-          const task = await this.taskResource.poll(this.worker.taskDefName, workerID, this.options.domain);
-          if (task && task.taskId) {
-            await this.executeTask(task);
-          } else {
-            this.logger.debug(`No tasks for ${this.worker.taskDefName}`);
-          }
-        } catch (unknownError) {
-          this.handleUnknownError(unknownError);
-          this.errorHandler(unknownError);
+    this.pollAndExecute = async () => {
+      try {
+        const { workerID } = this.options;
+        const task = await this.taskResource.poll(this.worker.taskDefName, workerID, this.worker.domain ?? this.options.domain);
+        if (task && task.taskId) {
+          await this.executeTask(task);
+        } else {
+          this.logger.debug(`No tasks for ${this.worker.taskDefName}`);
         }
-        await new Promise((r) => setTimeout(() => r(true), this.options.pollInterval));
+      } catch (unknownError) {
+        this.handleUnknownError(unknownError);
+        this.errorHandler(unknownError);
       }
     };
     this.updateTaskWithRetry = async (task, taskResult) => {
@@ -201,6 +271,18 @@ var TaskRunner = class {
     this.worker = worker;
     this.options = options;
     this.errorHandler = errorHandler;
+    this.poller = new Poller(this.pollAndExecute, { concurrency: options.concurrency, pollInterval: options.pollInterval }, this.logger);
+  }
+  updateOptions(options) {
+    const newOptions = __spreadValues(__spreadValues({}, this.options), options);
+    this.poller.updateOptions({
+      concurrency: newOptions.concurrency,
+      pollInterval: newOptions.pollInterval
+    });
+    this.options = newOptions;
+  }
+  get getOptions() {
+    return this.options;
   }
 };
 
@@ -2170,25 +2252,35 @@ function workerId(options) {
 var TaskManager = class {
   constructor(client, workers, config = {}) {
     this.tasks = {};
+    this.workerManagerWorkerOptions = (worker) => {
+      return __spreadProps(__spreadValues({}, this.taskManageOptions), {
+        concurrency: worker.concurrency ?? this.taskManageOptions.concurrency,
+        domain: worker.domain ?? this.taskManageOptions.domain
+      });
+    };
+    this.updatePollingOptions = (options) => {
+      this.workers.forEach((worker) => {
+        const newOptions = __spreadValues(__spreadValues({}, this.workerManagerWorkerOptions(worker)), options);
+        const runners = this.tasks[worker.taskDefName];
+        runners.forEach((runner) => {
+          runner.updateOptions(newOptions);
+        });
+      });
+    };
     this.startPolling = () => {
       this.workers.forEach((worker) => {
         this.tasks[worker.taskDefName] = [];
-        const options = __spreadProps(__spreadValues({}, this.taskManageOptions), {
-          concurrency: worker.concurrency ?? this.taskManageOptions.concurrency,
-          domain: worker.domain ?? this.taskManageOptions.domain
-        });
+        const options = this.workerManagerWorkerOptions(worker);
         this.logger.debug(`Starting taskDefName=${worker.taskDefName} concurrency=${options.concurrency} domain=${options.domain}`);
-        for (let i = 0; i < options.concurrency; i++) {
-          const runner = new TaskRunner({
-            worker,
-            options,
-            taskResource: this.client.taskResource,
-            logger: this.logger,
-            onError: this.errorHandler
-          });
-          runner.startPolling();
-          this.tasks[worker.taskDefName].push(runner);
-        }
+        const runner = new TaskRunner({
+          worker,
+          options,
+          taskResource: this.client.taskResource,
+          logger: this.logger,
+          onError: this.errorHandler
+        });
+        runner.startPolling();
+        this.tasks[worker.taskDefName].push(runner);
       });
     };
     this.stopPolling = () => {