tryer.js
5.61 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
// Conditional and repeated task invocation for node and browser.
/*globals setTimeout, define, module */
(function (globals) {
'use strict';
if (typeof define === 'function' && define.amd) {
define(function () {
return tryer;
});
} else if (typeof module !== 'undefined' && module !== null) {
module.exports = tryer;
} else {
globals.tryer = tryer;
}
// Public function `tryer`.
//
// Performs some action when pre-requisite conditions are met and/or until
// post-requisite conditions are satisfied.
//
// @option action {function} The function that you want to invoke. Defaults to `() => {}`.
// If `action` returns a promise, iterations will not end until
// the promise is resolved or rejected. Alternatively, `action`
// may take a callback argument, `done`, to signal that it is
// asynchronous. In that case, you are responsible for calling
// `done` when the action is finished.
//
// @option when {function} Predicate used to test pre-conditions. Should return `false`
// to postpone `action` or `true` to perform it. Defaults to
// `() => true`.
//
// @option until {function} Predicate used to test post-conditions. Should return `false`
// to retry `action` or `true` to terminate it. Defaults to
// `() => true`.
//
// @option fail {function} Callback to be invoked if `limit` tries are reached. Defaults
// to `() => {}`.
//
// @option pass {function} Callback to be invoked after `until` has returned truthily.
// Defaults to `() => {}`.
//
// @option interval {number} Retry interval in milliseconds. A negative number indicates
// that subsequent retries should wait for double the interval
// from the preceding iteration (exponential backoff). Defaults
// to -1000.
//
// @option limit {number} Maximum retry count, at which point the call fails and retries
// will cease. A negative number indicates that retries should
// continue indefinitely. Defaults to -1.
//
// @example
// tryer({
// when: () => db.isConnected,
// action: () => db.insert(user),
// fail () {
// log.error('No database connection, terminating.');
// process.exit(1);
// },
// interval: 1000,
// limit: 10
// });
//
// @example
// let sent = false;
// tryer({
// until: () => sent,
// action: done => {
// smtp.send(email, error => {
// if (! error) {
// sent = true;
// }
// done();
// });
// },
// pass: next,
// interval: -1000,
// limit: -1
// });
function tryer (options) {
options = normaliseOptions(options);
iterateWhen();
function iterateWhen () {
if (preRecur()) {
iterateUntil();
}
}
function preRecur () {
return conditionallyRecur('when', iterateWhen);
}
function conditionallyRecur (predicateKey, iterate) {
if (! options[predicateKey]()) {
incrementCount(options);
if (shouldFail(options)) {
options.fail();
} else {
recur(iterate, postIncrementInterval(options));
}
return false;
}
return true;
}
function iterateUntil () {
var result;
if (isActionSynchronous(options)) {
result = options.action();
if (result && isFunction(result.then)) {
return result.then(postRecur, postRecur);
}
return postRecur();
}
options.action(postRecur);
}
function postRecur () {
if (conditionallyRecur('until', iterateUntil)) {
options.pass();
}
}
}
function normaliseOptions (options) {
options = options || {};
return {
count: 0,
when: normalisePredicate(options.when),
until: normalisePredicate(options.until),
action: normaliseFunction(options.action),
fail: normaliseFunction(options.fail),
pass: normaliseFunction(options.pass),
interval: normaliseNumber(options.interval, -1000),
limit: normaliseNumber(options.limit, -1)
};
}
function normalisePredicate (fn) {
return normalise(fn, isFunction, yes);
}
function isFunction (fn) {
return typeof fn === 'function';
}
function yes () {
return true;
}
function normaliseFunction (fn) {
return normalise(fn, isFunction, nop);
}
function nop () {
}
function normalise (thing, predicate, defaultValue) {
if (predicate(thing)) {
return thing;
}
return defaultValue;
}
function normaliseNumber (number, defaultNumber) {
return normalise(number, isNumber, defaultNumber);
}
function isNumber (number) {
return typeof number === 'number' && number === number;
}
function isActionSynchronous (options) {
return options.action.length === 0;
}
function incrementCount (options) {
options.count += 1;
}
function shouldFail (options) {
return options.limit >= 0 && options.count >= options.limit;
}
function postIncrementInterval (options) {
var currentInterval = options.interval;
if (options.interval < 0) {
options.interval *= 2;
}
return currentInterval;
}
function recur (fn, interval) {
setTimeout(fn, Math.abs(interval));
}
}(this));