index.js
4.43 KB
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
"use strict";
var getHostKey = require("./getHostKey");
var objectAssign = require("object-assign");
var defaultOptions =
{
defaultPorts: {ftp:21, http:80, https:443},
ignorePorts: true,
ignoreSchemes: true,
ignoreSubdomains: true,
maxSockets: Infinity,
maxSocketsPerHost: 1,
rateLimit: 0
};
function RequestQueue(options, handlers)
{
this.activeHosts = {}; // Socket counts stored by host
this.items = {}; // Items stored by ID
this.priorityQueue = []; // List of IDs
this.activeSockets = 0;
this.counter = 0;
this.handlers = handlers || {};
this.options = objectAssign({}, defaultOptions, options);
this.paused = false;
}
RequestQueue.prototype.dequeue = function(id)
{
var item = this.items[id];
var error;
if (item===undefined || item.active===true)
{
return new Error("ID not found");
}
dequeue(item, this);
remove(item, this);
return true;
};
RequestQueue.prototype.enqueue = function(input)
{
var idOrError;
// enqueue("url")
if (typeof input==="string" || input instanceof String===true)
{
input = { url:input };
}
idOrError = enqueue(input, this);
if (idOrError instanceof Error === false)
{
startNext(this);
}
return idOrError;
};
RequestQueue.prototype.length = function()
{
return this.priorityQueue.length;
};
RequestQueue.prototype.numActive = function()
{
return this.activeSockets;
};
RequestQueue.prototype.pause = function()
{
this.paused = true;
};
RequestQueue.prototype.resume = function()
{
this.paused = false;
startNext(this);
};
//::: PRIVATE FUNCTIONS
/*
Call a class' event handler if it exists.
*/
function callHandler(handler, args, timeout)
{
if (typeof handler === "function")
{
if (timeout > 0)
{
setTimeout( function()
{
handler.apply(null, args);
}, timeout);
}
else
{
handler.apply(null, args);
}
}
}
/*
Remove item (id) from queue, but nowhere else.
*/
function dequeue(item, instance)
{
var queueIndex = instance.priorityQueue.indexOf(item.id);
if (queueIndex < 0) return false;
instance.priorityQueue.splice(queueIndex, 1);
return true;
}
/*
Add item to queue and item list.
*/
function enqueue(input, instance)
{
var hostKey = getHostKey(input.url, instance.options);
var id = input.id;
if (hostKey === false)
{
return new Error("Invalid URI");
}
if (id == null) id = instance.counter++;
if (instance.items[id] !== undefined)
{
return new Error("Non-unique ID");
}
instance.items[id] = { active:false, hostKey:hostKey, id:id, input:input };
instance.priorityQueue.push(id);
return id;
}
/*
Generate a `done()` function for use in resuming the queue when an item's
process has been completed.
*/
function getDoneCallback(item, instance)
{
return function()
{
instance.activeSockets--;
remove(item, instance);
startNext(instance);
};
}
/*
Remove item from item list and activeHosts.
*/
function remove(item, instance)
{
instance.activeHosts[item.hostKey]--;
if (instance.activeHosts[item.hostKey] <= 0)
{
delete instance.activeHosts[item.hostKey];
}
delete instance.items[item.id];
if (instance.priorityQueue.length<=0 && instance.activeSockets<=0)
{
instance.counter = 0; // reset
callHandler(instance.handlers.end, []);
}
}
/*
Possibly start next request(s).
*/
function startNext(instance)
{
var availableSockets = instance.options.maxSockets - instance.activeSockets;
var i = 0;
var canStart,currItem,numItems;
if (instance.paused === true) return;
if (availableSockets <= 0) return;
while (i < instance.priorityQueue.length)
{
canStart = false;
currItem = instance.items[ instance.priorityQueue[i] ];
// Not important, but feature complete
if (instance.options.maxSocketsPerHost > 0)
{
if (instance.activeHosts[currItem.hostKey] === undefined)
{
// Create key with first count
instance.activeHosts[currItem.hostKey] = 1;
canStart = true;
}
else if (instance.activeHosts[currItem.hostKey] < instance.options.maxSocketsPerHost)
{
instance.activeHosts[currItem.hostKey]++;
canStart = true;
}
}
if (canStart === true)
{
instance.activeSockets++;
availableSockets--;
currItem.active = true;
dequeue(currItem, instance);
callHandler(instance.handlers.item, [currItem.input, getDoneCallback(currItem,instance)], instance.options.rateLimit);
if (availableSockets <= 0) break;
}
else
{
// Move onto next
i++;
}
}
}
module.exports = RequestQueue;