We no longer use try...catch at all, if you want error catching in your task, you must not disable domains (they are enabled by default) - why?
We now force exit the domain when the task's method calls its completion callback
Domains now wrap only the firing of the task's method, rather than the preparation too as before
Removed superflous check to ensure a task has a method before execution
Ensured the actual check to ensure a task has a method before execution also checks if the method is actually a function (via checking for .bind) as the superflous check did
This could introduce the following issues in the following cases:
You may get errors that were suppressed before now showing themselves, this is good, but it may cause unexpected things to break loudly that were breaking silently before
If you have domains disabled and an error is thrown, you will get a different flow of logic than before as the error will be caught in your code, not TaskGroup's
The domain's flow has improved, but this may cause a different flow than you were expecting previously
This will introduce the following issues in the following cases:
If you are still on Node v0.8, synchronous errors and perhaps asynchronous errors thrown within your task method will no longer be caught by TaskGroup (due to Node 0.8's crippled domain functionality) and instead will need to be caught by your code either via preferably sent to the task method's completion callback rather than thrown, or via your own try...catch. But please upgrade to Node 0.10 or higher.
In other words, this release is the most stable yet, but do run your tests (you should always do this)
v4.0.5 August 3, 2014
Changed an error output to be of error type
v4.0.4 August 3, 2014
Added the ability to turn off using domains by setting the new task option domain to false (defaults to true)
Added the ability to turn off using ambi by setting the new task option ambi to false (defaults to true)
v4.0.3 July 11, 2014
Use setImmediate instead of nextTick to avoid (node) warning: Recursive process.nextTick detected. This will break in the next version of node. Please use setImmediate for recursive deferral. errors
Updated dependencies
v4.0.2 June 18, 2014
Added support for done, whenDone, onceDone, once, and on configuration options
v4.0.1 June 16, 2014
Fixed Recursive process.nextTick detected error (regression since v4.0.0)
v4.0.0 June 16, 2014
Significant rewrite with b/c breaks
Completion listeners should now be accomplished via .done(listener) (listens once) or .whenDone(listener) (listener persists)
These methods are promises in that they will execute the listener if the item is already complete
They listen for the done event
The execution of tasks and groups have had a great deal of investment to ensure execution is intuitive and consistent across different use cases
Refer to to src/lib/test/taskgroup-usage-test.coffee for the guaranteed expectations across different scenarios
In earlier versions you could use tasks.exit() during execution to clear remaning items, stop execution, and exit, you can no longer do this, instead use the completion callback with an error, or call tasks.clear() then the completion callback
complete event is now completed, but you really should be using the new done event or the promise methods
run event is now started
A lot of internal variables and methods have had their functionality changed or removed, if a method or variable is not in the public api, do not use it
There is now a default error and completed listener that will emit the done event if there are listeners for it, if there is no done event listeners, and an error has occured, we will throw the error
Tasks and groups will now only receive a default name when required, this is to prevent set names from being over-written by the default
Adding of tasks and groups to a group instance will now return the group instance rather than the added tasks to ensure chainability, if you want the created tasks, use .createTask(...) and .createGroup(...) instead, then add the result manually
Introductions
passed, failed, destroyed events are new
Task only
new timeout option that accepts a number of milliseconds to wait before throwing an error
new onError option that defaults to 'exit' but can also accept 'ignore' which will ignore duplicated exit errors (useful when combined with timeout event)
TaskGroup only
new onError option that defaults to 'exit' but can also accept 'ignore' which will ignore all task errors
new setNestedConfig(config) and setNestedTaskConfig(config) options to set configuration for all children
v3.4.0 May 8, 2014
Added context option for Task, to perform a late bind on the method
Asynchronous task methods can now accept optional arguments thanks to new ambi version
Re-added Node.js v0.8 support (regression since v3.3.3)
v3.3.4 November 27, 2013
Fixed the v3.3.3 fix
v3.3.3 November 27, 2013
Fixed possible "(node) warning: Recursive process.nextTick detected. This will break in the next version of node. Please use setImmediate for recursive deferral." error under certain circumstances
v3.3.2 November 19, 2013
Don't add or create empty tasks and groups
v3.3.1 November 6, 2013
Fixed child event bubbling by using duck typing (regression since v3.3.0)
Better error handling on uncaught task exceptions
Tasks will now get a default name set to ease debugging
v3.3.0 November 1, 2013
Bindings are now more explicit
Improved configuration parsing
Configuration is now accessed via getConfig()
Dropped component.io and bower support, just use ender or browserify
v3.2.4 October 27, 2013
Re-packaged
v3.2.3 September 18, 2013
Fixed cyclic dependency problem on windows (since v2.1.3)
Added bower support
v3.2.2 September 18, 2013
Component.io compatibility
v3.2.1 August 19, 2013
Republish with older verson of joe dev dependency to try and stop cyclic errors
Better node 0.8 support when catching thrown errors
v3.2.0 August 19, 2013
Wrapped Task execution in a domain to catch uncaught errors within the task execution, as well as added checks to ensure the completion callback does not fire multiple times
These will be reported via the error event that the Task will emit
If the Task is part of a TaskGroup, the TaskGroup will listen for this, kill the TaskGroup and emit an error event on the TaskGroup
Moved from EventEmitter2 to node's own EventEmitter to ensure domain compatibility
v3.1.2 April 6, 2013
Added getTotals() to TaskGroup
Added complete() to Task
v3.1.1 April 5, 2013
Fixed task run issue under certain circumstances
Added exit(err) function
v3.1.0 April 5, 2013
Tasks can now have the arguments that are sent to them customized by the args configuration option
Group inline functions now support an optional completion callback
Group events for items now have their first argument as the item the event was for
v3.0.0 April 5, 2013
Significant rewrite and b/c break
v2.0.0 March 27, 2013
Split from bal-util
v1.16.14 March 27, 2013
Killed explicit browser support, use Browserify instead
wait(delay,fn) introduced as an alternative to setTimeout
Group changes:
push and pushAndRun signatures are now ([context], task)
context is optional, and what we should bind to this
it saves us having to often wrap our task pushing into for each scopes
task completion callbacks are now optional, if not specified a task will be completed as soon as it finishes executing
balUtilEvents, balUtilModules changes:
Now make use of the balUtilFlow.push|pushAndRun new context argument to simplify some loops
v1.10.3 June 26, 2012
balUtilModules changes:
initNodeModules will now install modules from cache, unless force is true
v1.10.2 June 26, 2012
balUtilModules changes:
initNodeModules will now never install modules from cache
v1.10.1 June 26, 2012
balUtilModules changes:
Fixed npmCommand under some situations
v1.10.0 June 26, 2012
balUtilModules changes:
Added spawnMultiple, execMultiple, gitGitPath, getNodePath, and npmCommand
spawn and exec are now only for single commands, use the new spawnMultiple and execMultiple for multiple commands instead
error exit code is now anything that isnt 0
v1.9.4 June 22, 2012
Fixed a problem with large asynchronous groups
v1.9.3 June 22, 2012
balUtilFlow changes:
Added extractOptsAndCallback and extend
v1.9.2 June 21, 2012
balUtilFlow changes:
Added fireWithOptionalCallback, updated groups and emitters to use this
v1.9.1 June 21, 2012
balUtilModules changes:
initNodeModules now supports output option
v1.9.0 June 21, 2012
balUtilEvents changes:
EventEmitterEnhanced changes:
emitSync and emitAsync changes:
The next callback is now optional, if it is not detected then we will automatically mark the listener as completed once we have executed it (in other words, if it doesn't have a next callback, then we treat it as a synchronous listener)
v1.8.8 June 19, 2012
Fixed a problem with large synchronous groups
v1.8.7 June 19, 2012
Defaulted dependencies to an empty object, to hopefully fix npm issue #2540
v1.8.6 June 19, 2012
balUtilEvents changes:
Split emitSync and emitAsync out of EventSystem and into new EventEmitterEnhanced that EventSystem extends
v1.8.5 June 11, 2012
Made next callbacks necessary by default
v1.8.4 June 11, 2012
balUtilModule changes:
spawn
will now return results in the order of err, stdout, stderr, code, signal
now splits string commands using / /
balUtilFlow changes:
Group will now only return error as an array if we have more than one error
Updated for Joe v1.0.0
v1.8.3 June 9, 2012
balUtilCompare changes:
packageCompare will now fail gracefully if it receives malformed json
v1.8.2 June 9, 2012
Removed request dependency, we now use the native http/https modules
Considerable improvements to scandir, cpdir and rmdir
Note, passing false as the file or dir actions will now skip all of that type. Pass null if you do not want that.
dirAction is now fired before we read the directories children, if you want it to fire after then in the next callback, pass a callback in the 3rd argument. See rmdir for an example of this.
Fixed npm web to url warnings
v0.7 October 3, 2011
Added versionCompare and packageCompare functions
Added request dependency
v0.6 September 14, 2011
Updated util.Group to support async and sync grouping
v0.4 June 2, 2011
Added util.type for testing the type of a variable