123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239 |
- 'use strict';
- /**
- * Module dependencies.
- */
- const isGeneratorFunction = require('is-generator-function');
- const debug = require('debug')('koa:application');
- const onFinished = require('on-finished');
- const response = require('./response');
- const compose = require('koa-compose');
- const isJSON = require('koa-is-json');
- const context = require('./context');
- const request = require('./request');
- const statuses = require('statuses');
- const Cookies = require('cookies');
- const accepts = require('accepts');
- const Emitter = require('events');
- const assert = require('assert');
- const Stream = require('stream');
- const http = require('http');
- const only = require('only');
- const convert = require('koa-convert');
- const deprecate = require('depd')('koa');
- /**
- * Expose `Application` class.
- * Inherits from `Emitter.prototype`.
- */
- module.exports = class Application extends Emitter {
- /**
- * Initialize a new `Application`.
- *
- * @api public
- */
- constructor() {
- super();
- this.proxy = false;
- this.middleware = [];
- this.subdomainOffset = 2;
- this.env = process.env.NODE_ENV || 'development';
- this.context = Object.create(context);
- this.request = Object.create(request);
- this.response = Object.create(response);
- }
- /**
- * Shorthand for:
- *
- * http.createServer(app.callback()).listen(...)
- *
- * @param {Mixed} ...
- * @return {Server}
- * @api public
- */
- listen(...args) {
- debug('listen');
- const server = http.createServer(this.callback());
- return server.listen(...args);
- }
- /**
- * Return JSON representation.
- * We only bother showing settings.
- *
- * @return {Object}
- * @api public
- */
- toJSON() {
- return only(this, [
- 'subdomainOffset',
- 'proxy',
- 'env'
- ]);
- }
- /**
- * Inspect implementation.
- *
- * @return {Object}
- * @api public
- */
- inspect() {
- return this.toJSON();
- }
- /**
- * Use the given middleware `fn`.
- *
- * Old-style middleware will be converted.
- *
- * @param {Function} fn
- * @return {Application} self
- * @api public
- */
- use(fn) {
- if (typeof fn !== 'function') throw new TypeError('middleware must be a function!');
- if (isGeneratorFunction(fn)) {
- deprecate('Support for generators will be removed in v3. ' +
- 'See the documentation for examples of how to convert old middleware ' +
- 'https://github.com/koajs/koa/blob/master/docs/migration.md');
- fn = convert(fn);
- }
- debug('use %s', fn._name || fn.name || '-');
- this.middleware.push(fn);
- return this;
- }
- /**
- * Return a request handler callback
- * for node's native http server.
- *
- * @return {Function}
- * @api public
- */
- callback() {
- const fn = compose(this.middleware);
- if (!this.listeners('error').length) this.on('error', this.onerror);
- const handleRequest = (req, res) => {
- res.statusCode = 404;
- const ctx = this.createContext(req, res);
- const onerror = err => ctx.onerror(err);
- const handleResponse = () => respond(ctx);
- onFinished(res, onerror);
- return fn(ctx).then(handleResponse).catch(onerror);
- };
- return handleRequest;
- }
- /**
- * Initialize a new context.
- *
- * @api private
- */
- createContext(req, res) {
- const context = Object.create(this.context);
- const request = context.request = Object.create(this.request);
- const response = context.response = Object.create(this.response);
- context.app = request.app = response.app = this;
- context.req = request.req = response.req = req;
- context.res = request.res = response.res = res;
- request.ctx = response.ctx = context;
- request.response = response;
- response.request = request;
- context.originalUrl = request.originalUrl = req.url;
- context.cookies = new Cookies(req, res, {
- keys: this.keys,
- secure: request.secure
- });
- request.ip = request.ips[0] || req.socket.remoteAddress || '';
- context.accept = request.accept = accepts(req);
- context.state = {};
- return context;
- }
- /**
- * Default error handler.
- *
- * @param {Error} err
- * @api private
- */
- onerror(err) {
- assert(err instanceof Error, `non-error thrown: ${err}`);
- if (404 == err.status || err.expose) return;
- if (this.silent) return;
- const msg = err.stack || err.toString();
- console.error();
- console.error(msg.replace(/^/gm, ' '));
- console.error();
- }
- };
- /**
- * Response helper.
- */
- function respond(ctx) {
- // allow bypassing koa
- if (false === ctx.respond) return;
- const res = ctx.res;
- if (!ctx.writable) return;
- let body = ctx.body;
- const code = ctx.status;
- // ignore body
- if (statuses.empty[code]) {
- // strip headers
- ctx.body = null;
- return res.end();
- }
- if ('HEAD' == ctx.method) {
- if (!res.headersSent && isJSON(body)) {
- ctx.length = Buffer.byteLength(JSON.stringify(body));
- }
- return res.end();
- }
- // status body
- if (null == body) {
- body = ctx.message || String(code);
- if (!res.headersSent) {
- ctx.type = 'text';
- ctx.length = Buffer.byteLength(body);
- }
- return res.end(body);
- }
- // responses
- if (Buffer.isBuffer(body)) return res.end(body);
- if ('string' == typeof body) return res.end(body);
- if (body instanceof Stream) return body.pipe(res);
- // body: json
- body = JSON.stringify(body);
- if (!res.headersSent) {
- ctx.length = Buffer.byteLength(body);
- }
- res.end(body);
- }
|