forked from adonisjs/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.js
More file actions
250 lines (234 loc) · 5.56 KB
/
index.js
File metadata and controls
250 lines (234 loc) · 5.56 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
'use strict'
/**
* adonis-framework
*
* (c) Harminder Virk <virk@adonisjs.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
const _ = require('lodash')
const Ioc = require('adonis-fold').Ioc
const CE = require('../Exceptions')
let globalMiddleware = []
let namedMiddleware = {}
/**
* composes a closure to an object for consistent behaviour
*
* @method _composeFunction
*
* @param {Function} middleware
*
* @return {Object}
*
* @private
*/
const _composeFunction = function (middleware) {
return {instance: null, method: middleware, parameters: []}
}
/**
* composes a consistent object from the actual
* middleware object
*
* @method _composeObject
*
* @param {Object} middleware
*
* @return {Object}
*
* @private
*/
const _composeObject = function (middleware) {
const instance = middleware.instance || null
const method = instance ? instance[middleware.method] : middleware.method
return {instance, method, parameters: middleware.parameters}
}
/**
* Http middleware layer to register and resolve middleware
* for a given HTTP request.
* @module Middleware
*/
let Middleware = exports = module.exports = {}
/**
* clears off all global and named middleware
*
* @method new
*
* @public
*/
Middleware.new = function () {
globalMiddleware = []
namedMiddleware = {}
}
/**
* registers a new global or named middleware. If second
* parameter is empty, middleware will be considered
* global.
*
* @method register
*
* @param {String} [key] - unqiue key for named middleware
* @param {String} namespace - Reference to the binding of Ioc container
*
* @example
* Middleware.register('App/Http/Middleware/Auth')
* Middleware.register('app', 'App/Http/Middleware/Auth')
*
* @public
*/
Middleware.register = function (key, namespace) {
if (!namespace) {
globalMiddleware.push(key)
return
}
namedMiddleware[key] = namespace
}
/**
* concats a array of middleware inside global list.
*
* @method global
*
* @param {Array} arrayOfMiddleware
*
* @example
* Middleware.global(['App/Http/Middleware/Auth', '...'])
*
* @public
*/
Middleware.global = function (arrayOfMiddleware) {
globalMiddleware = globalMiddleware.concat(_.uniq(arrayOfMiddleware))
}
/**
* adds an object of middleware to named list.
*
* @method named
*
* @param {Object} namedMiddleware
*
* @example
* Middleware.named({'auth': 'App/Http/Middleware/Auth'}, {...})
*
* @public
*/
Middleware.named = function (namedMiddleware) {
_.each(namedMiddleware, (namespace, key) => Middleware.register(key, namespace))
}
/**
* returns list of global middleware
*
* @method getGlobal
*
* @return {Array}
*
* @public
*/
Middleware.getGlobal = function () {
return globalMiddleware
}
/**
* returns list of named middleware
*
* @method getNamed
*
* @return {Object}
*
* @public
*/
Middleware.getNamed = function () {
return namedMiddleware
}
/**
* fetch params defined next to named middleware while
* consuming them.
*
* @method fetchParams
*
* @param {String|Undefined} params
* @return {Array}
*
* @public
*/
Middleware.fetchParams = function (params) {
return params ? params.split(',') : []
}
/**
* returning an object of named middleware by
* parsing them.
*
* @method formatNamedMiddleware
*
* @param {Array} keys
* @return {Object}
*
* @example
* Middleware.formatNamedMiddleware(['auth:basic,jwt'])
* returns
* {'Adonis/Middleware/Auth': ['basic', 'jwt']}
*
* @throws {RunTimeException} If named middleware for a given
* key is not registered.
* @public
*/
Middleware.formatNamedMiddleware = function (keys) {
return _.reduce(keys, (structured, key) => {
const tokens = key.split(':')
const middlewareNamespace = namedMiddleware[tokens[0]]
if (!middlewareNamespace) {
throw CE.RuntimeException.missingNamedMiddleware(tokens[0])
}
structured[middlewareNamespace] = Middleware.fetchParams(tokens[1])
return structured
}, {})
}
/**
* resolves an array of middleware namespaces from
* ioc container
*
* @method resolve
*
* @param {Object} namedMiddlewareHash
* @param {Boolean} [includeGlobal=false]
*
* @return {Array}
*
* @example
* Middleware.resolve({}, true) // all global
* Middleware.resolve(Middleware.formatNamedMiddleware(['auth:basic', 'acl:user']))
*
* @public
*/
Middleware.resolve = function (namedMiddlewareHash, includeGlobal) {
const finalSet = includeGlobal ? Middleware.getGlobal().concat(_.keys(namedMiddlewareHash)) : _.keys(namedMiddlewareHash)
return _.map(finalSet, (item) => {
const func = Ioc.makeFunc(`${item}.handle`)
func.parameters = namedMiddlewareHash[item] || []
return func
})
}
/**
* composes middleware and calls them in sequence something similar
* to koa-compose.
*
* @method compose
*
* @param {Array} Middleware - Array of middleware resolved from Ioc container
* @param {Object} request - Http request object
* @param {Object} response - Http response object
*
* @public
*/
Middleware.compose = function (middlewareList, request, response) {
function * noop () {}
return function * (next) {
next = next || noop()
_(middlewareList)
.map((middleware) => {
return typeof (middleware) === 'function' ? _composeFunction(middleware) : _composeObject(middleware)
})
.forEachRight((middleware) => {
const values = [request, response, next].concat(middleware.parameters)
next = middleware.method.apply(middleware.instance, values)
})
return yield * next
}
}