patternjavascriptMinor
Sequential function call in JavaScript
Viewed 0 times
sequentialcalljavascriptfunction
Problem
I've created this code which can call functions/ajax requests or pieces of code sequentially, using jQuery. The code not only can call functions/ajax requests or pieces of code sequentially but it also tracks when those calls fail or succeed and when the code fails it stops and doesn't exectue the rest of the queue.
(Bold italic are the names of the queues)
In my example i've 5 timeouts who get queued, the 2 first share a queue named first (1 and 1b) get executed at the same time and when those 2 finish and succeed(fire resolve) the next on the queue gets executed (next in queue is two which contains only 1 timeout).
After two gets executed and succeed the third gets executed. I've coded in a way that the third fires a reject which changes the state of promise to reject(fails the request) and thanks to that the last timeout doesn't get called(to simulate a failed ajax request).
I know the code is pretty messy (it's my first version). I would like some ideas on how I could structure this better or reduce the code considerably.
A problem I have with my code is that when I add a
Code: http://jsfiddle.net/g55PC/
```
function myqueue(){
var myself=this;
var ord=[];// contains names used in promiseArr
var funcArr=[];// contains setTimeout functions
var me = $(document);
this.add = function (func, name) {
if (typeof funcArr[name] !== "object") funcArr[name] = [];
funcArr[name].push(func);
if($.inArray(name, ord)==-1){
ord.unshift(name);
}
}
this.call= function (name) {
me.queue("deferQueue", function () {
var promiseArr=[];
for(func in funcArr[name]){
promiseArr[func]=(function(){
var dfd = new jQuery.Deferred();
funcArr[name]func;
(Bold italic are the names of the queues)
In my example i've 5 timeouts who get queued, the 2 first share a queue named first (1 and 1b) get executed at the same time and when those 2 finish and succeed(fire resolve) the next on the queue gets executed (next in queue is two which contains only 1 timeout).
After two gets executed and succeed the third gets executed. I've coded in a way that the third fires a reject which changes the state of promise to reject(fails the request) and thanks to that the last timeout doesn't get called(to simulate a failed ajax request).
I know the code is pretty messy (it's my first version). I would like some ideas on how I could structure this better or reduce the code considerably.
A problem I have with my code is that when I add a
setTimeout, I have to include the deferred.resolve() in it. I don't see a way around this. Does anyone have an idea how to resolve this problem?Code: http://jsfiddle.net/g55PC/
```
function myqueue(){
var myself=this;
var ord=[];// contains names used in promiseArr
var funcArr=[];// contains setTimeout functions
var me = $(document);
this.add = function (func, name) {
if (typeof funcArr[name] !== "object") funcArr[name] = [];
funcArr[name].push(func);
if($.inArray(name, ord)==-1){
ord.unshift(name);
}
}
this.call= function (name) {
me.queue("deferQueue", function () {
var promiseArr=[];
for(func in funcArr[name]){
promiseArr[func]=(function(){
var dfd = new jQuery.Deferred();
funcArr[name]func;
Solution
Naming
First off, I'd name my variables in the purpose they serve. Rather than
Queue adding and removing
You should remove the items that have executed from the queue. That's what a queue is all about, and that's what your code lacks at the moment.
Also,
Collection of callbacks
You don't need 2 arrays to store the order of named queues. You can have one array, but each item is named. One advantage of this is that you only have one array to push to, and you keep the absolute order, regardless of name. And no more nested loops.
You can then use
This code defaults to all items when
Async control
Now, you don't have total control over the process that takes place in the queued function. The user could pop-in an async operation, and your library won't even know it, and will run wild. That's where your deferreds come in to play.
However, you don't really need deferreds. You can pass in a function to the queued function that calls the next function. This is similar to ExpressJS's middlewares, where there's a magical
Here's how to use it:
Fluent API
Consider fluent, aka "jQuery-like" APIs. It's pretty simple, just have the methods return the current instance, and that's it:
Then you can do something like jQuery and other libraries:
Demonstration
Here's a small demo I have made here. It has some bugs in some corner cases and needs a few fixing. But given your code example, it works quite similarly. Not to mention, it is a bit shorter, and uses no libraries.
``
First off, I'd name my variables in the purpose they serve. Rather than
ord, funcHash or even me.Queue adding and removing
You should remove the items that have executed from the queue. That's what a queue is all about, and that's what your code lacks at the moment.
Also,
unshift and shift are more costly operations than 'pop' and 'push' because they need to move the array contents to new indices. You're correct in your implementation, that enqueue should use the unshift while execution uses pop.Collection of callbacks
You don't need 2 arrays to store the order of named queues. You can have one array, but each item is named. One advantage of this is that you only have one array to push to, and you keep the absolute order, regardless of name. And no more nested loops.
function enqueue(fn,name){
queue.push({
name : name,
fn : fn
})
}You can then use
Array.prototype.filter to filter out the queue, if you want to only unload certain queued items with a certain name. Here's how you can do it:function dequeue(name){
var fns = queue.filter(function(current){
return (current.name === name);
});
// pop-off and run
}This code defaults to all items when
name is not suppliedfunction dequeueAll(name){
var fns = (!name) ? queue : queue.filter(function(current){
return (current.name === name);
});
// pop-off and run all
}Async control
Now, you don't have total control over the process that takes place in the queued function. The user could pop-in an async operation, and your library won't even know it, and will run wild. That's where your deferreds come in to play.
However, you don't really need deferreds. You can pass in a function to the queued function that calls the next function. This is similar to ExpressJS's middlewares, where there's a magical
next function supplied to each middleware. Here's how it's implemented// Lets assume you have a queue like the one above, filtered optionally
(function recursive(index){
// get the item at the index
var currentItem = queue[index];
// This is to check if there's no more functions in the queue
if(!currentItem) return;
//Otherwise, run providing the instance of your object, and the magic "next"
currentItem.fn.call(instance,function(){
//This function gets called when the current queued item is done executing
// Splice off this item from the queue. We use splice since the
// item we might be operating on is from a filtered set, not in the same
// index as the original queue
queue.splice(queue.indexOf(currentItem),1);
// Run the next item
recursive(++index);
});
// start with 0
}(0));Here's how to use it:
// So you can have something synchronous
enqueue(function(next){
//do something
next();
});
// Or something asynchronous
enqueue(function(next){
somethingAsync(function(){
// done?
next();
});
});Fluent API
Consider fluent, aka "jQuery-like" APIs. It's pretty simple, just have the methods return the current instance, and that's it:
enqueue : function(){
...
return this;
}Then you can do something like jQuery and other libraries:
myQueue.enqueue(function(){...}).enqueue(function(){...}).enqueue(function(){...})Demonstration
Here's a small demo I have made here. It has some bugs in some corner cases and needs a few fixing. But given your code example, it works quite similarly. Not to mention, it is a bit shorter, and uses no libraries.
``
function Queue() {
this.queue = []
}
Queue.prototype = {
constructor: Queue,
enqueue: function (fn, queueName) {
this.queue.push({
name: queueName || 'global',
fn: fn || function (next) {
next()
}
});
return this
},
dequeue: function (queueName) {
var allFns = (!queueName) ? this.queue : this.queue.filter(function (current) {
return (current.name === queueName)
});
var poppedFn = allFns.pop();
if (poppedFn) poppedFn.fn.call(this);
return this
},
dequeueAll: function (queueName) {
var instance = this;
var queue = this.queue;
var allFns = (!queueName) ? this.queue : this.queue.filter(function (current) {
return (current.name === queueName)
});
(function recursive(index) {
var currentItem = allFns[index];
if (!currentItem) return;
currentItem.fn.call(instance, function () {
queue.splice(queue.indexOf(currentItem), 1);
recursive(index)
})
}(0));
return this
}
};
var myQueue = new Queue();
myQueue.enqueue(function (next) {
console.log('D1: first test1');
next()
}, 'first').enqueue(function (next) {
setTimeout(function () {
console.log('D1: first test2');
next()
}, 2000)
}, 'first').enqueue(function (next) {
console.log('D1: second test1');
next()
}, 'second').enqueue(function (next) {
console.log('D1: second test2');
next()
}, 'second').dequeueAll();
`Code Snippets
function enqueue(fn,name){
queue.push({
name : name,
fn : fn
})
}function dequeue(name){
var fns = queue.filter(function(current){
return (current.name === name);
});
// pop-off and run
}function dequeueAll(name){
var fns = (!name) ? queue : queue.filter(function(current){
return (current.name === name);
});
// pop-off and run all
}// Lets assume you have a queue like the one above, filtered optionally
(function recursive(index){
// get the item at the index
var currentItem = queue[index];
// This is to check if there's no more functions in the queue
if(!currentItem) return;
//Otherwise, run providing the instance of your object, and the magic "next"
currentItem.fn.call(instance,function(){
//This function gets called when the current queued item is done executing
// Splice off this item from the queue. We use splice since the
// item we might be operating on is from a filtered set, not in the same
// index as the original queue
queue.splice(queue.indexOf(currentItem),1);
// Run the next item
recursive(++index);
});
// start with 0
}(0));// So you can have something synchronous
enqueue(function(next){
//do something
next();
});
// Or something asynchronous
enqueue(function(next){
somethingAsync(function(){
// done?
next();
});
});Context
StackExchange Code Review Q#38420, answer score: 4
Revisions (0)
No revisions yet.