-
Notifications
You must be signed in to change notification settings - Fork 996
/
middleware.js
356 lines (332 loc) · 9 KB
/
middleware.js
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
'use strict'
/* global describe, it, beforeEach, afterEach */
const { expect } = require('chai')
const { globalMiddlewareFactory } = require('../lib/middleware')
let yargs
require('chai').should()
describe('middleware', () => {
beforeEach(() => {
yargs = require('../')
})
afterEach(() => {
delete require.cache[require.resolve('../')]
})
it('should add a list of callbacks to global middleware', () => {
const globalMiddleware = []
globalMiddlewareFactory(globalMiddleware)([() => {}, () => {}])
globalMiddleware.should.have.lengthOf(2)
})
it('should throw exception if middleware is not a function', () => {
const globalMiddleware = []
expect(() => {
globalMiddlewareFactory(globalMiddleware)(['callback1', 'callback2'])
}).to.throw('middleware must be a function')
})
it('should add a single callback to global middleware', () => {
const globalMiddleware = []
globalMiddlewareFactory(globalMiddleware)(function () {})
globalMiddleware.should.have.lengthOf(1)
})
it('runs the middleware before reaching the handler', function (done) {
yargs(['mw'])
.middleware(function (argv) {
argv.mw = 'mw'
})
.command(
'mw',
'adds func to middleware',
function () {},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.parse()
})
it('runs all middleware before reaching the handler', function (done) {
yargs(['mw'])
.middleware([
function (argv) {
argv.mw1 = 'mw1'
},
function (argv) {
argv.mw2 = 'mw2'
}
])
.command(
'mw',
'adds func list to middleware',
function () {},
function (argv) {
argv.mw1.should.equal('mw1')
argv.mw2.should.equal('mw2')
return done()
}
)
.exitProcess(false)
.parse()
})
it('should be able to register middleware regardless of when middleware is called', function (done) {
yargs(['mw'])
.middleware(function (argv) {
argv.mw1 = 'mw1'
})
.command(
'mw',
'adds func list to middleware',
function () {},
function (argv) {
// we should get the argv filled with data from the middleware
argv.mw1.should.equal('mw1')
argv.mw2.should.equal('mw2')
argv.mw3.should.equal('mw3')
argv.mw4.should.equal('mw4')
return done()
}
)
.middleware(function (argv) {
argv.mw2 = 'mw2'
})
.middleware([
function (argv) {
argv.mw3 = 'mw3'
},
function (argv) {
argv.mw4 = 'mw4'
}
])
.exitProcess(false)
.parse()
})
// addresses https://github.com/yargs/yargs/issues/1237
describe('async', () => {
it('fails when the promise returned by the middleware rejects', (done) => {
const error = new Error()
const handlerErr = new Error('should not have been called')
yargs('foo')
.command('foo', 'foo command', () => {}, (argv) => done(handlerErr), [ (argv) => Promise.reject(error) ])
.fail((msg, err) => {
expect(msg).to.equal(null)
expect(err).to.equal(error)
done()
})
.parse()
})
it('calls the command handler when all middleware promises resolve', (done) => {
const middleware = (key, value) => () => new Promise((resolve, reject) => {
setTimeout(() => {
return resolve({ [key]: value })
}, 5)
})
yargs('foo hello')
.command('foo <pos>', 'foo command', () => {}, (argv) => {
argv.hello.should.equal('world')
argv.foo.should.equal('bar')
done()
}, [ middleware('hello', 'world'), middleware('foo', 'bar') ])
.fail((msg, err) => {
return done(Error('should not have been called'))
})
.exitProcess(false)
.parse()
})
})
// see: https://github.com/yargs/yargs/issues/1281
it("doesn't modify globalMiddleware array when executing middleware", () => {
let count = 0
yargs('bar')
.middleware((argv) => {
count++
})
.command('foo', 'foo command', () => {}, () => {}, [
() => {
count++
}
])
.command('bar', 'bar command', () => {}, () => {}, [
() => {
count++
}
])
.exitProcess(false)
.parse()
count.should.equal(2)
})
it('allows middleware to be added in builder', (done) => {
yargs(['mw'])
.command(
'mw',
'adds func to middleware',
function (yargs) {
yargs.middleware(function (argv) {
argv.mw = 'mw'
})
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.exitProcess(false)
.parse()
})
it('passes yargs object to middleware', (done) => {
yargs(['mw'])
.command(
'mw',
'adds func to middleware',
function (yargs) {
yargs.middleware(function (argv, yargs) {
expect(typeof yargs.help).to.equal('function')
argv.mw = 'mw'
})
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.exitProcess(false)
.parse()
})
it('applies aliases before middleware is called', (done) => {
yargs(['mw', '--foo', '99'])
.middleware(function (argv) {
argv.f.should.equal(99)
argv.mw = 'mw'
})
.command(
'mw',
'adds func to middleware',
function (yargs) {
yargs.middleware((argv) => {
argv.f.should.equal(99)
argv.mw2 = 'mw2'
})
},
function (argv) {
argv.mw.should.equal('mw')
argv.mw2.should.equal('mw2')
return done()
}
)
.alias('foo', 'f')
.exitProcess(false)
.parse()
})
describe('applyBeforeValidation=true', () => {
it('runs before validation', function (done) {
yargs(['mw'])
.middleware(function (argv) {
argv.mw = 'mw'
}, true)
.command(
'mw',
'adds func to middleware',
{
'mw': {
'demand': true,
'string': true
}
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.exitProcess(false)
.parse()
})
it('throws an error if async function provided', function () {
expect(() => {
yargs(['mw'])
.middleware([function (argv) {
argv.mw = 'mw'
argv.other = true
return Promise.resolve(argv)
}], true)
.command(
'mw',
'adds func to middleware',
{
'mw': {
'demand': true,
'string': true
}
},
function (argv) {
throw Error('we should not get here')
}
)
.exitProcess(false)
.parse()
}).to.throw('middleware cannot return a promise when applyBeforeValidation is true')
})
it('runs before validation, when middleware is added in builder', (done) => {
yargs(['mw'])
.command(
'mw',
'adds func to middleware',
function (yargs) {
// we know that this middleware is being run in the context of the
// mw command.
yargs.middleware(function (argv) {
argv.mw = 'mw'
}, true)
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.demand('mw')
.exitProcess(false)
.parse()
})
it('applies aliases before middleware is called, for global middleware', (done) => {
yargs(['mw', '--foo', '99'])
.middleware(function (argv) {
argv.f.should.equal(99)
argv.mw = 'mw'
}, true)
.command(
'mw',
'adds func to middleware',
{
'mw': {
'demand': true
}
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.alias('foo', 'f')
.exitProcess(false)
.parse()
})
it('applies aliases before middleware is called, when middleware is added in builder', (done) => {
yargs(['mw', '--foo', '99'])
.command(
'mw',
'adds func to middleware',
function (yargs) {
yargs
.middleware((argv) => {
argv.f.should.equal(99)
argv.mw = 'mw'
}, true)
.demand('mw')
},
function (argv) {
argv.mw.should.equal('mw')
return done()
}
)
.alias('foo', 'f')
.exitProcess(false)
.parse()
})
})
})