All files / utils/async/map-values/lib limit.js

100% Statements 150/150
100% Branches 25/25
100% Functions 4/4
100% Lines 150/150

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 1513x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 2x 2x 2x 36x 24x 36x 10x 10x 34x 34x 34x 34x 34x 34x 36x 100x 100x 70x 70x 100x 36x 36x 36x 36x 36x 36x 110x 110x 110x 110x 110x 22x 110x 70x 88x 18x 18x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 6x 6x 6x 110x 6x 6x 6x 98x 98x 98x 110x 110x 36x 36x 36x 36x 36x 36x 36x 36x 36x 104x 6x 6x 6x 98x 98x 104x 40x 40x 104x 28x 28x 28x 104x 36x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* 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
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
 
'use strict';
 
// MODULES //
 
var logger = require( 'debug' );
var objectKeys = require( '@stdlib/utils/keys' );
 
 
// VARIABLES //
 
var debug = logger( 'map-values-async:limit' );
 
 
// MAIN //
 
/**
* Invokes a function once for each own property in a source object, limiting the number of concurrently pending functions.
*
* @private
* @param {Object} obj - source object
* @param {Options} opts - function options
* @param {*} [opts.thisArg] - execution context
* @param {PositiveInteger} [opts.limit] - maximum number of pending function invocations
* @param {Function} fcn - function to invoke
* @param {Callback} done - function to invoke upon completion or upon encountering an error
* @returns {void}
*/
function limit( obj, opts, fcn, done ) {
	var maxIndex;
	var count;
	var keys;
	var flg;
	var lim;
	var len;
	var idx;
	var out;
	var i;
 
	keys = objectKeys( obj );
	len = keys.length;
	debug( 'Number of keys: %d', len );
 
	out = {};
	if ( len === 0 ) {
		debug( 'Finished processing an object.' );
		return done( null, out );
	}
	if ( len < opts.limit ) {
		lim = len;
	} else {
		lim = opts.limit;
	}
	debug( 'Concurrency limit: %d', lim );
	debug( 'Number of arguments: %d', fcn.length );
 
	maxIndex = len - 1;
	count = 0;
	idx = -1;
	for ( i = 0; i < lim; i++ ) {
		// This guard is necessary to protect against synchronous functions which exhaust all properties...
		if ( idx < maxIndex ) {
			next(); // eslint-disable-line node/callback-return
		}
	}
	/**
	* Callback to invoke a provided function for the next property.
	*
	* @private
	*/
	function next() {
		var key;
		idx += 1;
		key = keys[ idx ];
		debug( '%s: %s', key, JSON.stringify( obj[ key ] ) );
		if ( fcn.length === 2 ) {
			fcn.call( opts.thisArg, obj[ key ], cb );
		} else if ( fcn.length === 3 ) {
			fcn.call( opts.thisArg, obj[ key ], key, cb );
		} else {
			fcn.call( opts.thisArg, obj[ key ], key, obj, cb );
		}
		/**
		* Callback invoked once a provided function finishes transforming a property value.
		*
		* @private
		* @param {*} [error] - error
		* @param {*} [value] - transformed value
		* @returns {void}
		*/
		function cb( error, value ) {
			if ( flg ) {
				// Prevent further processing of properties:
				return;
			}
			if ( error ) {
				flg = true;
				return clbk( error );
			}
			debug( 'Transform result => %s: %s', key, JSON.stringify( value ) );
			out[ key ] = value;
			clbk();
		}
	}
 
	/**
	* Callback invoked once ready to process the next property.
	*
	* @private
	* @param {*} [error] - error
	* @returns {void}
	*/
	function clbk( error ) {
		if ( error ) {
			debug( 'Encountered an error: %s', error.message );
			return done( error );
		}
		count += 1;
		debug( 'Processed %d of %d properties.', count, len );
		if ( idx < maxIndex ) {
			return next();
		}
		if ( count === len ) {
			debug( 'Finished processing an object.' );
			return done( null, out );
		}
	}
}
 
 
// EXPORTS //
 
module.exports = limit;