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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
( function ( mw, uw, $, OO ) {
/**
* A queue that will execute the asynchronous function `action` for each item in the queue in
* order, taking care not to allow more than `count` instances to be executing at the same time.
*
* Items can be added or removed (#addItem, #removeItem) while the queue is already being
* executed.
*
* @mixins OO.EventEmitter
* @param {Object} options
* @param {Function} options.action Action to execute for each item, must return a Promise
* @param {number} options.count Number of functions to execute concurrently
*/
uw.ConcurrentQueue = function UWConcurrentQueue( options ) {
OO.EventEmitter.call( this );
this.count = options.count;
this.action = options.action;
this.queued = [];
this.running = [];
this.done = [];
this.runningPromises = [];
this.completed = false;
this.executing = false;
};
OO.initClass( uw.ConcurrentQueue );
OO.mixinClass( uw.ConcurrentQueue, OO.EventEmitter );
/**
* A 'progress' event is emitted when one of the functions' promises is resolved or rejected.
*
* @event progress
*/
/**
* A 'complete' event is emitted when all of the functions' promises have been resolved or rejected.
*
* @event complete
*/
/**
* A 'change' event is emitted when an item is added to or removed from the queue.
*
* @event change
*/
/**
* Add an item to the queue.
*
* @param {Object} item
* @return {boolean} true
*/
uw.ConcurrentQueue.prototype.addItem = function ( item ) {
this.queued.push( item );
this.emit( 'change' );
if ( this.executing ) {
this.executeNext();
}
return true;
};
/**
* Remove an item from the queue.
*
* While it's possible to remove an item that is being executed, it doesn't stop the execution.
*
* @param {Object} item
* @return {boolean} Whether the item was removed
*/
uw.ConcurrentQueue.prototype.removeItem = function ( item ) {
var index, found;
found = false;
index = this.queued.indexOf( item );
if ( index !== -1 ) {
this.queued.splice( index, 1 );
found = true;
}
index = this.done.indexOf( item );
if ( index !== -1 ) {
this.done.splice( index, 1 );
found = true;
}
index = this.running.indexOf( item );
if ( index !== -1 ) {
// Try aborting the promise if possible
if ( this.runningPromises[ index ].abort ) {
this.runningPromises[ index ].abort();
}
this.running.splice( index, 1 );
this.runningPromises.splice( index, 1 );
found = true;
}
if ( found ) {
this.emit( 'change' );
this.checkIfComplete();
}
// Ensure we're still using as many threads as requested
this.executeNext();
return found;
};
/**
* @private
* @param {Object} item
*/
uw.ConcurrentQueue.prototype.promiseComplete = function ( item ) {
var index;
index = this.running.indexOf( item );
// Check that this item wasn't removed while it was being executed
if ( index !== -1 ) {
this.running.splice( index, 1 );
this.runningPromises.splice( index, 1 );
this.done.push( item );
this.emit( 'progress' );
}
this.checkIfComplete();
this.executeNext();
};
/**
* @private
*/
uw.ConcurrentQueue.prototype.executeNext = function () {
var item, promise;
if ( this.running.length === this.count || !this.executing ) {
return;
}
item = this.queued.shift();
if ( !item ) {
return;
}
this.running.push( item );
promise = this.action.call( null, item );
this.runningPromises.push( promise );
promise.always( this.promiseComplete.bind( this, item ) );
};
/**
* Start executing the queue. If the queue is already executing, do nothing.
*
* When the queue finishes executing, a 'complete' event will be emitted.
*/
uw.ConcurrentQueue.prototype.startExecuting = function () {
var i;
if ( this.executing ) {
return;
}
this.completed = false;
this.executing = true;
for ( i = 0; i < this.count; i++ ) {
this.executeNext();
}
// In case the queue was empty
this.checkIfComplete();
};
/**
* Abort executing the queue. Remove all queued items and abort running ones.
*/
uw.ConcurrentQueue.prototype.abortExecuting = function () {
while ( this.queued.length > 0 ) {
this.removeItem( this.queued[ 0 ] );
}
while ( this.running.length > 0 ) {
this.removeItem( this.running[ 0 ] );
}
};
/**
* @private
*/
uw.ConcurrentQueue.prototype.checkIfComplete = function () {
if ( this.running.length === 0 && this.queued.length === 0 ) {
if ( !this.completed ) {
this.completed = true;
this.executing = false;
this.emit( 'complete' );
}
}
};
}( mediaWiki, mediaWiki.uploadWizard, jQuery, OO ) );
|
