pax_global_header00006660000000000000000000000064123717756450014533gustar00rootroot0000000000000052 comment=434950a0748cd38bf9a04f3fd4f3ff89cf565fda on-headers-1.0.0/000077500000000000000000000000001237177564500135565ustar00rootroot00000000000000on-headers-1.0.0/.gitignore000066400000000000000000000000441237177564500155440ustar00rootroot00000000000000coverage node_modules npm-debug.log on-headers-1.0.0/.npmignore000066400000000000000000000000341237177564500155520ustar00rootroot00000000000000coverage/ test/ .travis.yml on-headers-1.0.0/.travis.yml000066400000000000000000000004371237177564500156730ustar00rootroot00000000000000language: node_js node_js: - "0.8" - "0.10" - "0.11" matrix: allow_failures: - node_js: "0.11" fast_finish: true script: "npm run-script test-travis" after_script: "test $TRAVIS_NODE_VERSION = '0.10' && npm install coveralls@2.11.1 && cat ./coverage/lcov.info | coveralls" on-headers-1.0.0/History.md000066400000000000000000000003431237177564500155410ustar00rootroot000000000000001.0.0 / 2014-08-10 ================== * Honor `res.statusCode` change in `listener` * Move to `jshttp` orgainzation * Prevent `arguments`-related de-opt 0.0.0 / 2014-05-13 ================== * Initial implementation on-headers-1.0.0/LICENSE000066400000000000000000000021011237177564500145550ustar00rootroot00000000000000(The MIT License) Copyright (c) 2014 Douglas Christopher Wilson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. on-headers-1.0.0/README.md000066400000000000000000000031171237177564500150370ustar00rootroot00000000000000# on-headers [![NPM Version](https://img.shields.io/npm/v/on-headers.svg?style=flat)](https://www.npmjs.org/package/on-headers) [![Node.js Version](https://img.shields.io/badge/node.js->=_0.8-blue.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/jshttp/on-headers.svg?style=flat)](https://travis-ci.org/jshttp/on-headers) [![Coverage Status](https://img.shields.io/coveralls/jshttp/on-headers.svg?style=flat)](https://coveralls.io/r/jshttp/on-headers) [![Gittip](https://img.shields.io/gittip/dougwilson.svg?style=flat)](https://www.gittip.com/dougwilson/) Execute a listener when a response is about to write headers. ## Install ```sh $ npm install on-headers ``` ## API ```js var onHeaders = require('on-headers') ``` ### onHeaders(res, listener) This will add the listener `listener` to fire when headers are emitted for `res`. The listener is passed the `response` object as it's context (`this`). Headers are considered to be emitted only once, right before they are sent to the client. When this is called multiple times on the same `res`, the `listener`s are fired in the reverse order they were added. ## Examples ```js var http = require('http') var onHeaders = require('on-headers') http .createServer(onRequest) .listen(3000) function addPoweredBy() { // add if not set by end of request if (!this.getHeader('X-Powered-By')) { this.addHeader('X-Powered-By', 'Node.js') } } function onRequest(req, res) { onHeaders(res, addPoweredBy) res.setHeader('Content-Type', 'text/plain') res.end('hello!') } ``` ## License [MIT](LICENSE) on-headers-1.0.0/index.js000066400000000000000000000040111237177564500152170ustar00rootroot00000000000000/*! * on-headers * Copyright(c) 2014 Douglas Christopher Wilson * MIT Licensed */ /** * Reference to Array slice. */ var slice = Array.prototype.slice /** * Execute a listener when a response is about to write headers. * * @param {Object} res * @return {Function} listener * @api public */ module.exports = function onHeaders(res, listener) { if (!res) { throw new TypeError('argument res is required') } if (typeof listener !== 'function') { throw new TypeError('argument listener must be a function') } res.writeHead = createWriteHead(res.writeHead, listener) } function createWriteHead(prevWriteHead, listener) { var fired = false; // return function with core name and argument list return function writeHead(statusCode) { // set headers from arguments var args = setWriteHeadHeaders.apply(this, arguments); // fire listener if (!fired) { fired = true listener.call(this) // pass-along an updated status code if (typeof args[0] === 'number' && this.statusCode !== args[0]) { args[0] = this.statusCode args.length = 1 } } prevWriteHead.apply(this, args); } } function setWriteHeadHeaders(statusCode) { var length = arguments.length var headerIndex = length > 1 && typeof arguments[1] === 'string' ? 2 : 1 var headers = length >= headerIndex + 1 ? arguments[headerIndex] : undefined this.statusCode = statusCode // the following block is from node.js core if (Array.isArray(headers)) { // handle array case for (var i = 0, len = headers.length; i < len; ++i) { this.setHeader(headers[i][0], headers[i][1]) } } else if (headers) { // handle object case var keys = Object.keys(headers) for (var i = 0; i < keys.length; i++) { var k = keys[i] if (k) this.setHeader(k, headers[k]) } } // copy leading arguments var args = new Array(Math.min(length, headerIndex)) for (var i = 0; i < args.length; i++) { args[i] = arguments[i] } return args } on-headers-1.0.0/package.json000066400000000000000000000014511237177564500160450ustar00rootroot00000000000000{ "name": "on-headers", "description": "Execute a listener when a response is about to write headers", "version": "1.0.0", "author": "Douglas Christopher Wilson ", "license": "MIT", "keywords": [ "event", "headers", "http", "onheaders" ], "repository": "jshttp/on-headers", "dependencies": {}, "devDependencies": { "istanbul": "0.3.0", "mocha": "~1.21.4", "supertest": "~0.13.0" }, "engines": { "node": ">= 0.8.0" }, "scripts": { "test": "mocha --reporter spec --bail --check-leaks test/", "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/", "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/" } } on-headers-1.0.0/test/000077500000000000000000000000001237177564500145355ustar00rootroot00000000000000on-headers-1.0.0/test/test.js000066400000000000000000000156221237177564500160600ustar00rootroot00000000000000 var assert = require('assert') var http = require('http') var onHeaders = require('..') var request = require('supertest') describe('onHeaders(res, listener)', function () { it('should fire after setHeader', function (done) { var server = createServer(echoListener) request(server) .get('/') .expect('X-Outgoing-Echo', 'test') .expect(200, done) }) it('should fire before write', function (done) { var server = createServer(echoListener, handler) function handler(req, res) { res.setHeader('X-Outgoing', 'test') res.write('1') } request(server) .get('/') .expect('X-Outgoing-Echo', 'test') .expect(200, '1', done) }) it('should fire with no headers', function (done) { var server = createServer(listener, handler) function handler(req, res) {} function listener(req, res) { this.setHeader('X-Headers', Object.keys(this._headers || {}).join(',')) } request(server) .get('/') .expect('X-Headers', '') .expect(200, done) }) it('should fire only once', function (done) { var count = 0 var server = createServer(listener, handler) function handler(req, res) { res.writeHead(200) try { res.writeHead(200) } catch (e) {} } function listener(req, res) { count++ } request(server) .get('/') .expect(200, function (err) { if (err) return done(err) assert.equal(count, 1) done() }) }) it('should fire in reverse order', function (done) { var server = createServer(echoListener, handler) function handler(req, res) { onHeaders(res, appendHeader(1)) onHeaders(res, appendHeader(2)) onHeaders(res, appendHeader(3)) res.setHeader('X-Outgoing', 'test') } request(server) .get('/') .expect('X-Outgoing-Echo', 'test,3,2,1') .expect(200, done) }) describe('arguments', function () { describe('res', function () { it('should be required', function () { assert.throws(onHeaders.bind(), /res.*required/) }) }) describe('listener', function () { it('should be required', function (done) { var server = createServer() request(server) .get('/') .expect(500, /listener.*function/, done) }) it('should only accept function', function (done) { var server = createServer(42) request(server) .get('/') .expect(500, /listener.*function/, done) }) }) }) describe('setHeader', function () { it('should be available in listener', function (done) { var server = createServer(echoListener) request(server) .get('/') .expect('X-Outgoing-Echo', 'test') .expect(200, done) }) }) describe('writeHead(status)', function () { it('should make status available in listener', function (done) { var server = createServer(listener, handler) function handler(req, res) { res.writeHead(201) } function listener(req, res) { this.setHeader('X-Status', this.statusCode) } request(server) .get('/') .expect('X-Status', '201') .expect(201, done) }) it('should allow manipulation of status in listener', function (done) { var server = createServer(listener, handler) function handler(req, res) { res.writeHead(201) } function listener(req, res) { this.setHeader('X-Status', this.statusCode) this.statusCode = 202 } request(server) .get('/') .expect('X-Status', '201') .expect(202, done) }) it('should pass-through core error', function (done) { var server = createServer(echoListener, handler) function handler(req, res) { res.writeHead() // error } request(server) .get('/') .expect(500, done) }) }) describe('writeHead(status, reason)', function () { it('should be available in listener', function (done) { var server = createServer(echoListener, handler) function handler(req, res) { res.setHeader('X-Outgoing', 'test') res.writeHead(200, 'OK') } request(server) .get('/') .expect('X-Outgoing-Echo', 'test') .expect(200, done) }) }) describe('writeHead(status, reason, obj)', function () { it('should be available in listener', function (done) { var server = createServer(echoListener, handler) function handler(req, res) { res.writeHead(200, 'OK', {'X-Outgoing': 'test'}) } request(server) .get('/') .expect('X-Outgoing-Echo', 'test') .expect(200, done) }) }) describe('writeHead(status, obj)', function () { it('should be available in listener', function (done) { var server = createServer(listener, handler) function handler(req, res) { res.writeHead(201, {'X-Outgoing': 'test'}) } function listener(req, res) { this.setHeader('X-Status', this.statusCode) this.setHeader('X-Outgoing-Echo', this.getHeader('X-Outgoing')) } request(server) .get('/') .expect('X-Status', '201') .expect('X-Outgoing-Echo', 'test') .expect(201, done) }) it('should handle falsy keys', function (done) { var server = createServer(listener, handler) function handler(req, res) { res.writeHead(201, {'X-Outgoing': 'test', '': 'test'}) } function listener(req, res) { this.setHeader('X-Status', this.statusCode) this.setHeader('X-Outgoing-Echo', this.getHeader('X-Outgoing')) } request(server) .get('/') .expect('X-Status', '201') .expect('X-Outgoing-Echo', 'test') .expect(201, done) }) }) describe('writeHead(status, arr)', function () { it('should be available in listener', function (done) { var server = createServer(listener, handler) function handler(req, res) { res.writeHead(201, [['X-Outgoing', 'test']]) } function listener(req, res) { this.setHeader('X-Status', this.statusCode) this.setHeader('X-Outgoing-Echo', this.getHeader('X-Outgoing')) } request(server) .get('/') .expect('X-Status', '201') .expect('X-Outgoing-Echo', 'test') .expect(201, done) }) }) }) function createServer(listener, handler) { handler = handler || echoHandler return http.createServer(function (req, res) { try { onHeaders(res, listener) handler(req, res) res.statusCode = 200 } catch (err) { res.statusCode = 500 res.write(err.message) } finally { res.end() } }) } function appendHeader(num) { return function onHeaders() { this.setHeader('X-Outgoing', this.getHeader('X-Outgoing') + ',' + num) } } function echoHandler(req, res) { res.setHeader('X-Outgoing', 'test') } function echoListener() { this.setHeader('X-Outgoing-Echo', this.getHeader('X-Outgoing')) }