Skip to content

move req, res, and next args from #run() to constructor() #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2016
+100 −63
Merged

move req, res, and next args from #run() to constructor() #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions lib/ConnectSequence.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,12 @@ module.exports = ConnectSequence
/**
* @class
* @param {Array<Function>} [middlewareList] A list of middlewares to run
*/
function ConnectSequence () {
this.middlewares = []
}

ConnectSequence.run = deprecatedRun

ConnectSequence.prototype = {
append: append,
appendList: appendList,
run: run
}

/**
* Run sequencially each appended middleware, using the next argument as the final callback.
* @method
* @param {object} req The request object
* @param {object} res The response object
* @param {function} next The next middleware
* @returns {undefined}
*/
function run (req, res, next) {
function ConnectSequence (req, res, next) {
var errorMsg
if (arguments.length < 3) {
errorMsg = 'ConnectSequence#run() takes 3 arguments. '
Expand All @@ -51,13 +35,37 @@ function run (req, res, next) {
throw new TypeError(errorMsg)
}

this.req = req
this.res = res
this.next = next
this.middlewares = []
}

ConnectSequence.run = deprecatedRun

ConnectSequence.prototype = {
append: append,
appendList: appendList,
run: run
}

/**
* Run sequencially each appended middleware, using the next argument as the final callback.
* @method
* @param {object} req The request object
* @param {object} res The response object
* @param {function} next The next middleware
* @returns {undefined}
*/
function run () {
var that = this
var midSequence = this.middlewares.reverse()
var initialNext = next.bind(null, req, res, next)
var initialNext = this.next.bind(null, this.req, this.res, this.next)
var nestedCallSequence = midSequence.reduce(middlewareReducer, initialNext)
nestedCallSequence.call()

function middlewareReducer (prev, current) {
return current.bind(null, req, res, prev)
return current.bind(null, that.req, that.res, prev)
}
}

Expand Down
117 changes: 73 additions & 44 deletions tests/ConnectSequence.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ var expect = chai.expect
process.env.NODE_ENV = 'test'

describe('ConnectSequence', function () {
var seq, req, res, next

beforeEach(function () {
req = { foo: 'bar' }
res = {}
next = function (req, res) { res.foo = req.foo }
})

it('should be a function', function () {
expect(ConnectSequence).to.be.a('function')
})
Expand Down Expand Up @@ -194,25 +202,68 @@ describe('ConnectSequence', function () {
expect(ConnectSequence.prototype.appendList).to.be.a('function')
})

describe('.constructor', function () {
it('should be an object of type "ConnectSequence"', function () {
var seq = new ConnectSequence()
describe('.constructor()', function () {
it('should be an object of type `ConnectSequence`', function () {
seq = new ConnectSequence(req, res, next)
expect(seq).to.be.a('object')
expect(seq).to.be.an.instanceof(ConnectSequence)
})

it('should init the "middleware" instance property as an empty Array', function () {
var seq = new ConnectSequence()
it('should init the `middlewares` instance property as an empty Array', function () {
seq = new ConnectSequence(req, res, next)
expect(seq).to.has.a.property('middlewares')
expect(seq.middlewares).to.be.a('array')
expect(seq.middlewares.length).to.be.equal(0)
})

it('should throw `MissingArgumentError` if called with lower than 3 arguments', function () {
expect(function () {
seq = new ConnectSequence({})
}).to.throw(MissingArgumentError)

expect(function () {
seq = new ConnectSequence({}, {})
}).to.throw(MissingArgumentError)
})

it('should throw `TypeError` if the first argument is not an object', function () {
expect(function () {
seq = new ConnectSequence('not an object', {}, function (req, res) { return true })
}).to.throw(TypeError)
})

it('should throw `TypeError` if the second argument is not an object', function () {
expect(function () {
seq = new ConnectSequence({}, 'not an object', function (req, res) { return true })
}).to.throw(TypeError)
})

it('should throw `TypeError` if the third argument is not a function', function () {
expect(function () {
seq = new ConnectSequence({}, {}, 'not a function')
}).to.throw(TypeError)
})

it('should init the `req` object', function () {
seq = new ConnectSequence(req, res, next)
expect(seq.req).to.equal(req)
})

it('should init the `res` object', function () {
seq = new ConnectSequence(req, res, next)
expect(seq.res).to.equal(res)
})

it('should init the `next` function', function () {
seq = new ConnectSequence(req, res, next)
expect(seq.next).to.equal(next)
})
})
})

describe('#append()', function () {
it('should augments the length of the middlewares array by the number of given middlewares', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid = function (req, res, next) { next() }
seq.append(mid)
expect(seq.middlewares.length).to.equal(1)
Expand All @@ -227,7 +278,7 @@ describe('ConnectSequence', function () {
})

it('should keep the same order of the given middlewares', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid0 = function (req, res, next) { next() }
var mid1 = function (req, res, next) { next() }
var mid2 = function (req, res, next) { next() }
Expand All @@ -248,7 +299,7 @@ describe('ConnectSequence', function () {
})

it('should throw a TypeError and reject all middlewares if one is not a function', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid1 = function (req, res, next) { next() }
var mid2 = 'not a function'
var mid3 = function (req, res, next) { next() }
Expand All @@ -269,15 +320,15 @@ describe('ConnectSequence', function () {
it('should throw TypeError if the first argument is not an array', function () {
var funcs = [
function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
seq.appendList('not an array')
},
function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
seq.appendList({foo: 'not an array'})
},
function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
seq.appendList(function () { return 'not an array' })
}
]
Expand All @@ -287,7 +338,7 @@ describe('ConnectSequence', function () {
})

it('should augments the length of the middlewares array by the number of given middlewares', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid = function (req, res, next) { next() }
seq.appendList([mid])
expect(seq.middlewares.length).to.equal(1)
Expand All @@ -302,7 +353,7 @@ describe('ConnectSequence', function () {
})

it('should keep the same order of the given middlewares', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid0 = function (req, res, next) { next() }
var mid1 = function (req, res, next) { next() }
var mid2 = function (req, res, next) { next() }
Expand All @@ -323,7 +374,7 @@ describe('ConnectSequence', function () {
})

it('should throw a TypeError and reject all middlewares if one is not a function', function () {
var seq = new ConnectSequence()
seq = new ConnectSequence(req, res, next)
var mid1 = function (req, res, next) { next() }
var mid2 = 'not a function'
var mid3 = function (req, res, next) { next() }
Expand All @@ -341,14 +392,10 @@ describe('ConnectSequence', function () {
})

describe('#run()', function () {
var seq, req, res, next
var mid0, mid1, mid2, mid3
var func0, func1, func2

beforeEach(function () {
seq = new ConnectSequence()
req = {}
res = {}
seq = new ConnectSequence(req, res, next)
mid0 = function mid0 (req, res, next) {
ensureReqIdsDefined(req)
req.ids.push('mid0')
Expand All @@ -375,35 +422,14 @@ describe('ConnectSequence', function () {
expect(seq.run).to.be.a('function')
})

it('should throw MissingArgumentError if called with lower than 3 arguments', function () {
func0 = function () {
seq.appendList([mid0, mid1, mid2, mid3])
seq.run(req, res)
}
expect(func0).to.throw(MissingArgumentError)
})

it('should throw TypeError if the given arguments have a bad type', function () {
next = function (req, res) { return true }
seq.append(mid0, mid1, mid2, mid3)

func0 = function () { seq.run('not an object', {}, next) }
func1 = function () { seq.run({}, 'not an object', next) }
func2 = function () { seq.run({}, {}, 'not a function') }

var funcs = [func0, func1, func2]
for (var i = 0; i < funcs.length; i++) {
expect(funcs[i]).to.throw(TypeError)
}
})

it('should run the initial next middleware at last', function (done) {
next = function (req, res) {
req.ids = 'initialNext'
done()
}
seq = new ConnectSequence(req, res, next)
seq.append(mid0, mid0, mid0, mid0)
seq.run(req, res, next)
seq.run()
expect(req.ids).to.be.a(String)
expect(req.ids).to.equal('initialNext')
})
Expand All @@ -418,8 +444,9 @@ describe('ConnectSequence', function () {
expect(req.ids).to.contain('mid3')
setTimeout(done, 20)
}
seq = new ConnectSequence(req, res, next)
seq.append(mid0, mid1, mid2, mid3)
seq.run(req, res, next)
seq.run()
})

it('should run all the middlewares in the same order than the given array', function (done) {
Expand All @@ -428,8 +455,9 @@ describe('ConnectSequence', function () {
expect(req.ids.join()).to.equal('mid0,mid1,mid2,mid3,initial')
setTimeout(done, 20)
}
seq = new ConnectSequence(req, res, next)
seq.append(mid0, mid1, mid2, mid3)
seq.run(req, res, next)
seq.run()
})

it('should run each middleware as a callback of the previous', function (done) {
Expand All @@ -453,6 +481,7 @@ describe('ConnectSequence', function () {
var _mid3 = function (req, res, next) {
setTimeout(mid3.bind(null, req, res, next), 150)
}
seq = new ConnectSequence(req, res, next)
seq.append(_mid0, _mid1, _mid2, _mid3)
seq.run(req, res, next)
})
Expand Down