Skip to content
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.

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

make tests for custom token() usage #127

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -376,13 +376,16 @@ function compile (format) {
}

var fmt = format.replace(/"/g, '\\"')
var js = ' "use strict"\n return "' + fmt.replace(/:([-\w]{2,})(?:\[([^\]]+)\])?/g, function (_, name, arg) {
var js = ' "use strict"\n return "' + fmt.replace(/:([-\w]{2,})(?:\[([^\]]*)\])?/g, function (_, name, arg) {
var tokenArguments = 'req, res'
var tokenFunction = 'tokens[' + String(JSON.stringify(name)) + ']'

if (arg !== undefined) {
tokenArguments += ', ' + String(JSON.stringify(arg))
}
else {
tokenArguments += ', undefined'
}

return '" +\n (' + tokenFunction + '(' + tokenArguments + ') || "-") + "'
}) + '"'
Expand Down
181 changes: 181 additions & 0 deletions test/morgan.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var join = require('path').join
var morgan = require('..')
var request = require('supertest')
var split = require('split')
var url = require('url')

describe('morgan()', function () {
describe('arguments', function () {
Expand Down Expand Up @@ -1316,6 +1317,186 @@ describe('morgan.compile(format)', function () {
})
})

describe('morgan.token(name, function)', function () {
it('should overwrite existing functions if called multiple times', function (done) {
function token (req, res, arg) {
return arg && url.parse(req.url)[arg]
}
var urlToken = morgan.url
morgan.token('url', token)
assert.equal(morgan.url, token)
morgan.token('url', urlToken)
done()
})

describe('should use the string `-` if return value of the token function is falsey', function () {
it('for NaN', function (done) {
morgan.token('NaN', function ret (req, res, arg) {
return NaN
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':NaN', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
it('for 0', function (done) {
morgan.token('zero', function ret (req, res, arg) {
return 0
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':zero', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
it('for undefined', function (done) {
morgan.token('undefined', function ret (req, res, arg) {
return undefined
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':undefined', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
it('for null', function (done) {
morgan.token('null', function ret (req, res, arg) {
return null
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':null', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
it('for ""', function (done) {
morgan.token('empty', function ret (req, res, arg) {
return ''
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':empty', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
it('for false', function (done) {
morgan.token('false', function ret (req, res, arg) {
return false
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':false', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})
})

it('should see empty brackets as an argument value', function (done) {
morgan.token('checkempty', function ret (req, res, arg) {
assert.equal(arg, '')
cb(null)
})
var cb = after(3, function (err, res, line) {
if (err) return done(err)
assert.equal(line, '-')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':checkempty[]', { stream: stream })

request(server)
.get('/')
.expect(200, cb)
})

it('should use the result', function (done) {
morgan.token('urlpart', function ret (req, res, arg) {
return url.parse(req.url)[arg]
})
var cb = after(2, function (err, res, line) {
if (err) return done(err)
assert.equal(line, 'foo=bar')
done()
})

var stream = createLineStream(function (line) {
cb(null, null, line)
})

var server = createServer(':urlpart[query]', { stream: stream })

request(server)
.post('/test')
.query('foo=bar')
.expect(200, cb)
})
})

function after (count, callback) {
var args = new Array(3)
var i = 0
Expand Down