Merge pull request #31 from piercus/develop

Develop

Author: piercus

.travis.yml

@@ -1,6 +1,7 @@
 language: node_js
 node_js:
   - '12'
+  - '14'
 install:
   - npm install -g codecov nyc
   - npm install

README.md

@@ -40,15 +40,15 @@ const worker = new StepFunctionWorker({
 
 Since version **3.0**, `concurrency` has been replaced by `poolConcurrency` and `taskConcurrency`.
 
-* `taskConcurrency` (`null` means Infinite)
+* `poolConcurrency` is the maximum number of parallel getActivity, http request (see [`sdk.getActivity`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property)) (default: `1`)
 
-It represent the maximum number of parallel tasks done by the worker (default: `null`).
+Increase this to have a more responsive worker, decrease this to consume less http connections.
 
-* `poolConcurrency` is the maximum number of parallel getActivity, http request (see [`sdk.getActivity`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property)) (default: `1`)
+* `taskConcurrency` (`null` means Infinite)
 
-Increase this to have a more responsive worker.
+It represent the maximum number of parallel tasks done by the worker (default: equals to `poolConcurrency`).
 
-Anyway, you should always have `poolConcurrency` < `taskConcurrency`.
+Anyway, you should always have `poolConcurrency` <= `taskConcurrency`.
 
 #### Set the Region
 

lib/worker.js

@@ -32,27 +32,39 @@ function Worker(options) {
 		throw (new Error('activityArn is mandatory inside Worker'));
 	}
 
-	if (typeof (options.concurrency) === 'number') {
-		throw (new TypeError('step-function-worker is not supporting `concurrency` parameter since version 3.0, see README.md'));
-	}
-
-	this.poolConcurrency = typeof (options.poolConcurrency) === 'number' ? options.poolConcurrency : 1;
-	this.taskConcurrency = typeof (options.taskConcurrency) === 'number' ? options.taskConcurrency : null;
-
-	this.activityArn = options.activityArn;
-	this.workerName = options.workerName;
 	this.logger = options.logger || {
 		debug() {},
 		info() {},
 		warn: console.warn,
 		error: console.error
 	};
+
+	if (typeof (options.concurrency) === 'number') {
+		// To uncomment in the future
+		// throw (new TypeError('step-function-worker `concurrency` parameter is deprectated since version 3.0, see README.md'));
+		this.logger.warn('[step-function-worker] `concurrency` parameter is deprectated since version 3.0 please use `poolConcurrency` instead, see README.md');
+		if (typeof (options.poolConcurrency) !== 'number') {
+			options.poolConcurrency = options.concurrency;
+		}
+	}
+
+	this.poolConcurrency = typeof (options.poolConcurrency) === 'number' ? options.poolConcurrency : 1;
+	this.taskConcurrency = typeof (options.taskConcurrency) === 'number' ? options.taskConcurrency : this.poolConcurrency;
+
+	if (this.poolConcurrency > this.taskConcurrency) {
+		throw (new Error(`poolConcurrency (${this.poolConcurrency}) < taskConcurrency (${this.taskConcurrency}) is invalid`));
+	}
+
+	this.workerName = options.workerName;
+
+	this.activityArn = options.activityArn;
+
 	this.fn = options.fn;
 	this._poolers = [];
 	this._tasks = [];
 
 	if (typeof (this.fn) !== 'function') {
-		throw (new TypeError('worker does not define any function'));
+		throw (new TypeError(`fn parameter should be a function (currently ${typeof (this.fn)})`));
 	}
 
 	const {region} = parser(options.activityArn);
@@ -79,7 +91,7 @@ function Worker(options) {
 /**
 * Start the worker pooling for new tasks
 * @param {function} cb callback(err)
-* @returns {Promise}
+* @returns {Promise} empty Promise
 */
 Worker.prototype.start = function () {
 	this.increasePool();