feat(any-by): add in-flight status object for observability

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: MANDEep22332

lib/node_modules/@stdlib/utils/async/any-by/lib/factory.js

@@ -21,7 +21,6 @@
 // MODULES //
 
 var isFunction = require( '@stdlib/assert/is-function' );
-var isCollection = require( '@stdlib/assert/is-collection' );
 var format = require( '@stdlib/string/format' );
 var PINF = require( '@stdlib/constants/float64/pinf' );
 var validate = require( './validate.js' );
@@ -130,6 +129,7 @@ function factory( options, predicate ) {
 	* @returns {void}
 	*/
 	function anyByAsync( collection, done ) {
+<<<<<<< HEAD
 		var timer = createTimer();
 
 		if ( !isCollection( collection ) ) {
@@ -139,21 +139,68 @@ function factory( options, predicate ) {
 			throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );
 		}
 		return limit( collection, opts, f, clbk );
+=======
+		var status;
+
+		status = {
+			'status': 'pending',
+			'ndone': 0,
+			'nerrors': 0
+		};
+
+		// Wrap the predicate to track progress:
+		limit( collection, opts, wrapper, clbk );
+
+		return status;
+>>>>>>> f1a651cded5 (feat(any-by): add in-flight status object for observability)
 
 		/**
-		* Callback invoked upon completion.
+		* Wraps the predicate function to track the number of completed invocations.
 		*
 		* @private
-		* @param {*} [error] - error
-		* @param {boolean} bool - test result
+		* @param {*} value - collection element
+		* @param {Callback} next - callback to invoke upon predicate completion
+		* @returns {void}
+		*/
+		function wrapper( value, next ) {
+			f( value, onResult );
+
+			/**
+			* Callback invoked upon predicate completion.
+			*
+			* @private
+			* @param {(Error|null)} err - error argument
+			* @param {*} result - predicate result
+			* @returns {void}
+			*/
+			function onResult( err, result ) {
+				status.ndone += 1;
+				next( err, result );
+			}
+		}
+
+		/**
+		* Callback invoked upon completion of all predicate invocations.
+		*
+		* @private
+		* @param {(Error|null)} error - error argument
+		* @param {boolean} bool - whether at least one element passed the predicate
 		* @returns {void}
 		*/
 		function clbk( error, bool ) {
 			var duration = timer();
 			if ( error ) {
+<<<<<<< HEAD
 				return done( error, false, duration );
 			}
 			done( null, bool, duration );
+=======
+				status.status = 'fail';
+				return done( error, false );
+			}
+			status.status = 'ok';
+			done( null, bool );
+>>>>>>> f1a651cded5 (feat(any-by): add in-flight status object for observability)
 		}
 	}
 }

lib/node_modules/@stdlib/utils/async/any-by/test/test.status.js

@@ -0,0 +1,98 @@
+/**
+* @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';
+
+// cspell:words ndone
+
+// MODULES //
+
+var tape = require( 'tape' );
+var factory = require( './../lib/factory.js' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+	t.ok( true, __filename );
+	t.ok( typeof factory === 'function', 'main export is a function' );
+	t.end();
+});
+
+tape( 'the function returns a status object that tracks progress (short-circuit)', function test( t ) {
+	var anyByAsync;
+	var files;
+	var op;
+
+	anyByAsync = factory( predicate );
+	files = [ './file1.js', './file2.js' ];
+	op = anyByAsync( files, done );
+
+	// Verify the status object immediately after invocation:
+	t.equal( typeof op, 'object', 'returns an object' );
+	t.equal( op.status, 'pending', 'initial status is pending' );
+	t.equal( op.ndone, 0, 'initial ndone is 0' );
+
+	function predicate( value, next ) {
+		setTimeout( onTimeout, 0 );
+
+		function onTimeout() {
+			next( null, true );
+		}
+	}
+
+	function done( err, result ) {
+		if ( err ) {
+			t.fail( err.message );
+			return t.end();
+		}
+		t.equal( result, true, 'returns expected result' );
+		t.equal( op.status, 'ok', 'status is ok upon completion' );
+
+		// Short-circuit: only one file was processed:
+		t.equal( op.ndone, 1, 'short-circuited after first match' );
+		t.end();
+	}
+});
+
+tape( 'the function returns a status object that tracks a full scan', function test( t ) {
+	var files;
+	var op;
+
+	files = [ './file1.js', './file2.js' ];
+	op = factory( predicate )( files, done );
+
+	function predicate( value, next ) {
+		setTimeout( onTimeout, 50 );
+
+		function onTimeout() {
+			// Always false, so all files must be checked:
+			next( null, false );
+		}
+	}
+
+	function done( err, result ) {
+		if ( err ) {
+			t.fail( err.message );
+			return t.end();
+		}
+		t.equal( result, false, 'returns expected result' );
+		t.equal( op.ndone, 2, 'all operations completed for a full scan' );
+		t.end();
+	}
+});