├── .npmrc ├── HEADER.md ├── package.json ├── .gitignore ├── index.d.ts ├── CHANGELOG.md ├── index.js ├── README.md ├── test ├── readme.test.js └── index.test.js └── LICENSE /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false -------------------------------------------------------------------------------- /HEADER.md: -------------------------------------------------------------------------------- 1 | # @awaitjs/express 2 | 3 | Write Express middleware and route handlers using async/await 4 | 5 | # Usage 6 | 7 | ```javascript 8 | const { addAsync } = require('@awaitjs/express'); 9 | 10 | // Or, if you want to use `wrap()` 11 | const { wrap } = require('@awaitjs/express'); 12 | ``` 13 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@awaitjs/express", 3 | "version": "0.9.0", 4 | "description": "Write Express middleware and route handlers using async/await", 5 | "main": "index.js", 6 | "types": "index.d.ts", 7 | "scripts": { 8 | "docs": "acquit-markdown -r acquit-ignore -h ./HEADER.md -p ./test/readme.test.js > README.md", 9 | "test": "mocha test/*.test.js" 10 | }, 11 | "author": "Valeri Karpov ", 12 | "license": "Apache 2.0", 13 | "repository": { 14 | "type": "git", 15 | "url": "git://github.com/vkarpov15/awaitjs-express.git" 16 | }, 17 | "devDependencies": { 18 | "acquit": "1.0.0", 19 | "acquit-ignore": "0.1.0", 20 | "acquit-markdown": "0.1.0", 21 | "express": "4.x", 22 | "mocha": "4.0.0", 23 | "superagent": "3.x" 24 | }, 25 | "peerDependencies": { 26 | "@types/express": "4.x", 27 | "express": "4.x" 28 | }, 29 | "engines": { 30 | "node": ">=7.6.0" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | package-lock.json 64 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | import { Express, Router, IRouter, RouterOptions, RequestHandler } from 'express'; 2 | 3 | type PathParams = string | RegExp | Array; 4 | type AsyncRequestHandler = ((path: PathParams, fn: (...args: Parameters) => Promise) => void); 5 | 6 | export interface IRouterWithAsync { 7 | useAsync: IRouter['use'] | AsyncRequestHandler; 8 | deleteAsync: IRouter['delete'] | AsyncRequestHandler; 9 | getAsync: IRouter['get'] | AsyncRequestHandler; 10 | headAsync: IRouter['head'] | AsyncRequestHandler; 11 | paramAsync: IRouter['param'] | AsyncRequestHandler; 12 | patchAsync: IRouter['patch'] | AsyncRequestHandler; 13 | postAsync: IRouter['post'] | AsyncRequestHandler; 14 | putAsync: IRouter['put'] | AsyncRequestHandler; 15 | } 16 | 17 | export interface ExpressWithAsync extends Express, IRouterWithAsync { } 18 | export interface RouterWithAsync extends Router, IRouterWithAsync { } 19 | 20 | declare function addAsync(app: Express): ExpressWithAsync; 21 | declare function addAsync(app: Router): RouterWithAsync; 22 | export { addAsync }; 23 | 24 | export const decorateRouter: (router: Router) => RouterWithAsync; 25 | export const decorateApp: (router: Express) => ExpressWithAsync; 26 | 27 | declare function AsyncRouter(options?: RouterOptions): RouterWithAsync; 28 | export { AsyncRouter as Router }; 29 | 30 | declare function wrap(fn: ((...args: Parameters) => Promise) | Function, isParam?: boolean): Function; 31 | export { wrap }; 32 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 0.9.0 / 2021-10-22 2 | ================== 3 | * fix(index.d.ts): add workaround for TS linters that enforce no-misused-promises #30 #28 4 | 5 | 0.8.0 / 2021-07-13 6 | ================== 7 | * fix: avoid automatically calling `next()` if middleware doesn't return a promise #27 [letalumil](https://github.com/letalumil) 8 | 9 | 0.7.2 / 2021-02-15 10 | ================== 11 | * fix: fix race condition #23 [EvanSmith-git](https://github.com/EvanSmith-git) 12 | 13 | 0.7.1 / 2021-02-01 14 | ================== 15 | * refactor: DRY up code #21 [EvanSmith-git](https://github.com/EvanSmith-git) 16 | 17 | 0.7.0 / 2021-01-13 18 | ================== 19 | * feat: paramAsync() wrapped function #17 [saltire](https://github.com/saltire) 20 | 21 | 0.6.3 / 2020-10-19 22 | ================== 23 | * fix: add missing export #18 24 | 25 | 0.6.2 / 2020-10-19 26 | ================== 27 | * fix: add `wrap()` to TypeScript type definitions #18 28 | 29 | 0.6.1 / 2020-05-31 30 | ================== 31 | * fix: add `Router` export to typescript definitions #16 [saltire](https://github.com/saltire) 32 | 33 | 0.6.0 / 2020-04-23 34 | ================== 35 | * feat: export `Router` function that returns a new async-friendly Router #13 36 | 37 | 0.5.1 / 2020-03-29 38 | ================== 39 | * fix: add `decorateRouter` and `decorateApp` to TypeScript types #15 [zone117x](https://github.com/zone117x) 40 | 41 | 0.5.0 / 2020-03-19 42 | ================== 43 | * feat: add TypeScript types #11 [brandon-leapyear](https://github.com/brandon-leapyear) 44 | 45 | 0.4.0 / 2019-12-29 46 | ================== 47 | * feat: add `routeAsync()` to support chaining syntax with `getAsync()`, etc #9 48 | 49 | 0.3.0 / 2019-02-09 50 | ================== 51 | * feat: add `addAsync()` as an alias for `decorateApp()` and `decorateRouter()` #4 #1 [SapienTech](https://github.com/SapienTech) 52 | * fix: avoid error when using non-async middleware with `useAsync()`, etc. #7 #6 [0xCAFEADD1C7](https://github.com/0xCAFEADD1C7) 53 | 54 | 0.2.0 / 2019-01-14 55 | ================== 56 | * fix: handle multiple handlers in `getAsync()`, `useAsync()`, etc #5 57 | 58 | 0.1.4 / 2018-09-12 59 | ================== 60 | * fix: discontinue middleware chain if middleware calls `res.send()` 61 | 62 | 0.1.3 / 2018-09-02 63 | ================== 64 | * fix: add missing deleteAsync() and patchAsync() 65 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const assert = require('assert'); 2 | const express = require('express'); 3 | 4 | module.exports = { 5 | addAsync, 6 | decorateApp: addAsync, 7 | decorateRouter: addAsync, 8 | Router: function asyncRouter() { 9 | return addAsync(express.Router.apply(express, arguments)); 10 | }, 11 | wrap 12 | }; 13 | 14 | function addAsync(app) { 15 | app.routeAsync = function() { 16 | return addAsync(this.route.apply(this, arguments)); 17 | }; 18 | 19 | let methods = ['use', 'delete', 'get', 'head', 'param', 'patch', 'post', 'put']; 20 | for (let i = 0; i < methods.length; i++) { 21 | const method = methods[i]; 22 | app[`${method}Async`] = function() { 23 | const fn = arguments[arguments.length - 1]; 24 | assert.ok(typeof fn === 'function', 25 | `Last argument to \`${method}Async()\` must be a function`); 26 | const args = wrapArgs(arguments, method == 'param'); 27 | return app[method].apply(app, args); 28 | }; 29 | } 30 | 31 | return app; 32 | } 33 | 34 | /** 35 | * Call `wrap()` on all args 36 | */ 37 | 38 | function wrapArgs(fns, isParam) { 39 | const ret = []; 40 | for (const fn of fns) { 41 | if (typeof fn !== 'function') { 42 | ret.push(fn); 43 | continue; 44 | } 45 | ret.push(wrap(fn, isParam)); 46 | } 47 | return ret; 48 | } 49 | 50 | /** 51 | * Given a function that returns a promise, converts it into something you 52 | * can safely pass into `app.use()`, `app.get()`, `app.param()`, etc. 53 | */ 54 | 55 | function wrap(fn, isParam) { 56 | const isErrorHandler = fn.length == 4 && !isParam; 57 | 58 | let wrapped = async function() { 59 | // Ensure next function is only ran once 60 | arguments[2 + isErrorHandler] = _once(arguments[2 + isErrorHandler]); 61 | try { 62 | const promise = fn.apply(null, arguments); 63 | if (promise && typeof promise.then === 'function') { 64 | await promise; 65 | arguments[1 + isErrorHandler].headersSent ? null : arguments[2 + isErrorHandler](); 66 | } 67 | } catch(err) { 68 | arguments[1 + isErrorHandler].headersSent ? null : arguments[2 + isErrorHandler](err); 69 | } 70 | }; 71 | 72 | Object.defineProperty(wrapped, 'length', { // Length has to be set for express to recognize error handlers as error handlers 73 | value: isErrorHandler ? 4 : isParam ? 4 : 3 74 | }); 75 | 76 | Object.defineProperty(wrapped, 'name', { // Define a name for stack traces 77 | value: isErrorHandler ? 'wrappedErrorHandler' : isParam ? 'wrappedParamMiddleware' : 'wrappedMiddleware' 78 | }); 79 | 80 | return wrapped; 81 | } 82 | 83 | function _once(fn) { 84 | let called = false; 85 | return function() { 86 | if (called) { 87 | return; 88 | } 89 | called = true; 90 | fn.apply(null, arguments); 91 | }; 92 | } 93 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # @awaitjs/express 2 | 3 | Write Express middleware and route handlers using async/await 4 | 5 | # Usage 6 | 7 | ```javascript 8 | const { addAsync } = require('@awaitjs/express'); 9 | 10 | // Or, if you want to use `wrap()` 11 | const { wrap } = require('@awaitjs/express'); 12 | ``` 13 | 14 | 15 | # API 16 | 17 | ## addAsync() 18 | 19 | 20 | The `addAsync()` function is the preferred way to add async/await 21 | support to your Express app. This function adds several helper functions 22 | to your Express app. 23 | 24 | 25 | ### It adds `useAsync()`, `getAsync()`, etc. to your Express app 26 | 27 | 28 | The `addAsync()` function adds `useAsync()`, `deleteAsync()`, `getAsync()`, 29 | `headAsync()`, `paramAsync()`, `patchAsync()`, `postAsync()`, and `putAsync()`. 30 | 31 | 32 | ```javascript 33 | const express = require('express'); 34 | const app = addAsync(express()); 35 | 36 | // `useAsync()` is like `app.use()`, but supports async functions 37 | app.useAsync(async function(req, res, next) { 38 | await new Promise(resolve => setTimeout(resolve, 50)); 39 | }); 40 | 41 | // `getAsync()` is like `app.get()`, but supports async functions 42 | app.getAsync('*', async function(req, res, next) { 43 | throw new Error('Oops!'); 44 | }); 45 | 46 | // Because of `getAsync()`, this error handling middleware will run. 47 | // `addAsync()` also enables async error handling middleware. 48 | app.use(function(error, req, res, next) { 49 | res.send(error.message); 50 | }); 51 | 52 | const server = await app.listen(3000); 53 | ``` 54 | 55 | ## Router() 56 | 57 | 58 | This module exports a `Router()` function that is a drop-in 59 | replacement for `express.Router()`, except the returned 60 | router has `getAsync()`, `useAsync()`, etc. 61 | 62 | 63 | ### It exports a `Router` function that returns a new async-friendly router 64 | 65 | ```javascript 66 | const express = require('express'); 67 | const app = express(); // This app isn't async friendly. 68 | 69 | const router = Router(); // But this router is. 70 | router.getAsync('/foo', async function(req, res, next) { 71 | throw new Error('Oops!'); 72 | }); 73 | 74 | app.use(router); 75 | app.use(function(err, req, res, next) { 76 | res.send(err.message); 77 | }); 78 | 79 | const server = await app.listen(3000); 80 | ``` 81 | 82 | ## decorateApp 83 | 84 | acquit:ignore:end 85 | 86 | ### It is an alias for addAsync() 87 | 88 | ```javascript 89 | assert.equal(decorateApp, addAsync) 90 | ``` 91 | 92 | ## decorateRouter 93 | 94 | ### It is an alias for addAsync() 95 | 96 | ```javascript 97 | assert.equal(decorateRouter, addAsync) 98 | ``` 99 | 100 | ## wrap() 101 | 102 | 103 | If you need more fine-grained control than what `addAsync()` gives 104 | you, you can use the `wrap()` function. This function wraps an async 105 | Express middleware or route handler for better error handling. 106 | 107 | 108 | ### It wraps an async function with Express-compatible error handling 109 | 110 | ```javascript 111 | const express = require('express'); 112 | const app = express(); 113 | 114 | // `wrap()` takes an async middleware or route handler and adds a 115 | // `.catch()` to handle any errors. It also prevents double-calling 116 | // `next()`. 117 | app.get('*', wrap(async function(req, res, next) { 118 | throw new Error('Oops!'); 119 | })); 120 | 121 | // `wrap()` also supports async error handling middleware. 122 | app.use(wrap(async function(error, req, res, next) { 123 | throw new Error('foo'); 124 | })); 125 | 126 | app.use(function(error, req, res, next) { 127 | res.send(error.message); // Will send back 'foo' 128 | }); 129 | 130 | const server = await app.listen(3000); 131 | ``` 132 | -------------------------------------------------------------------------------- /test/readme.test.js: -------------------------------------------------------------------------------- 1 | const assert = require('assert'); 2 | const { addAsync, decorateApp, decorateRouter, wrap, Router } = require('../'); 3 | const superagent = require('superagent'); 4 | 5 | describe('API', function() { 6 | /** 7 | * The `addAsync()` function is the preferred way to add async/await 8 | * support to your Express app. This function adds several helper functions 9 | * to your Express app. 10 | */ 11 | describe('addAsync()', function() { 12 | /** 13 | * The `addAsync()` function adds `useAsync()`, `deleteAsync()`, `getAsync()`, 14 | * `headAsync()`, `paramAsync()`, `patchAsync()`, `postAsync()`, and `putAsync()`. 15 | */ 16 | it('adds `useAsync()`, `getAsync()`, etc. to your Express app', async function() { 17 | const express = require('express'); 18 | const app = addAsync(express()); 19 | 20 | // `useAsync()` is like `app.use()`, but supports async functions 21 | app.useAsync(async function(req, res, next) { 22 | await new Promise(resolve => setTimeout(resolve, 50)); 23 | }); 24 | 25 | // `getAsync()` is like `app.get()`, but supports async functions 26 | app.getAsync('*', async function(req, res, next) { 27 | throw new Error('Oops!'); 28 | }); 29 | 30 | // Because of `getAsync()`, this error handling middleware will run. 31 | // `addAsync()` also enables async error handling middleware. 32 | app.use(function(error, req, res, next) { 33 | res.send(error.message); 34 | }); 35 | 36 | const server = await app.listen(3000); 37 | // acquit:ignore:start 38 | const res = await superagent.get('http://localhost:3000'); 39 | 40 | assert.equal(res.text, 'Oops!'); 41 | 42 | await server.close(); 43 | // acquit:ignore:end 44 | }); 45 | }); 46 | 47 | /** 48 | * This module exports a `Router()` function that is a drop-in 49 | * replacement for `express.Router()`, except the returned 50 | * router has `getAsync()`, `useAsync()`, etc. 51 | */ 52 | describe('Router()', function() { 53 | it('exports a `Router` function that returns a new async-friendly router', async function() { 54 | const express = require('express'); 55 | const app = express(); // This app isn't async friendly. 56 | 57 | const router = Router(); // But this router is. 58 | router.getAsync('/foo', async function(req, res, next) { 59 | throw new Error('Oops!'); 60 | }); 61 | 62 | app.use(router); 63 | app.use(function(err, req, res, next) { 64 | res.send(err.message); 65 | }); 66 | 67 | const server = await app.listen(3000); 68 | // acquit:ignore:start 69 | const res = await superagent.get('http://localhost:3000/foo'); 70 | 71 | assert.equal(res.text, 'Oops!'); 72 | 73 | await server.close(); 74 | // acquit:ignore:end 75 | }); 76 | }); 77 | 78 | describe('decorateApp', function() { 79 | it('is an alias for addAsync()', function() { 80 | assert.equal(decorateApp, addAsync) 81 | }); 82 | }); 83 | 84 | describe('decorateRouter', function() { 85 | it('is an alias for addAsync()', function() { 86 | assert.equal(decorateRouter, addAsync) 87 | }); 88 | }); 89 | 90 | /** 91 | * If you need more fine-grained control than what `addAsync()` gives 92 | * you, you can use the `wrap()` function. This function wraps an async 93 | * Express middleware or route handler for better error handling. 94 | */ 95 | describe('wrap()', function() { 96 | it('wraps an async function with Express-compatible error handling', async function() { 97 | const express = require('express'); 98 | const app = express(); 99 | 100 | // `wrap()` takes an async middleware or route handler and adds a 101 | // `.catch()` to handle any errors. It also prevents double-calling 102 | // `next()`. 103 | app.get('*', wrap(async function(req, res, next) { 104 | throw new Error('Oops!'); 105 | })); 106 | 107 | // `wrap()` also supports async error handling middleware. 108 | app.use(wrap(async function(error, req, res, next) { 109 | throw new Error('foo'); 110 | })); 111 | 112 | app.use(function(error, req, res, next) { 113 | res.send(error.message); // Will send back 'foo' 114 | }); 115 | 116 | const server = await app.listen(3000); 117 | // acquit:ignore:start 118 | const res = await superagent.get('http://localhost:3000'); 119 | 120 | assert.equal(res.text, 'foo'); 121 | 122 | await server.close(); 123 | // acquit:ignore:end 124 | }); 125 | }); 126 | }); 127 | -------------------------------------------------------------------------------- /test/index.test.js: -------------------------------------------------------------------------------- 1 | const assert = require('assert'); 2 | const express = require('express'); 3 | const superagent = require('superagent'); 4 | const { addAsync, wrap, Router } = require('../'); 5 | 6 | describe('Router', function() { 7 | it('creates a new async-friendly router', async function() { 8 | const app = express(); 9 | 10 | const router = Router(); 11 | router.getAsync('/foo', async function(req, res, next) { 12 | throw new Error('Oops!'); 13 | }); 14 | 15 | app.use(router); 16 | app.use(function(err, req, res, next) { 17 | res.status(500).send(err.message); 18 | }); 19 | 20 | const server = await app.listen(3000); 21 | 22 | const res = await superagent.get('http://localhost:3000/foo'). 23 | catch(err => err); 24 | 25 | assert.ok(res instanceof Error); 26 | assert.equal(res.response.text, 'Oops!'); 27 | 28 | await server.close(); 29 | }); 30 | }); 31 | 32 | describe('addAsync', function() { 33 | it('works', async function() { 34 | const app = addAsync(express()); 35 | 36 | app.useAsync(async function(req, res, next) { 37 | throw new Error('Oops!'); 38 | }); 39 | 40 | app.use(function(error, req, res, next) { 41 | res.send(error.message); 42 | }); 43 | 44 | const server = await app.listen(3000); 45 | 46 | const res = await superagent.get('http://localhost:3000'); 47 | 48 | assert.equal(res.text, 'Oops!'); 49 | 50 | await server.close(); 51 | }); 52 | 53 | it('handles middleware in getter', async function() { 54 | const app = addAsync(express()); 55 | 56 | const m = async function() { 57 | throw new Error('Oops!'); 58 | }; 59 | 60 | app.getAsync('*', m, async function(req, res, next) { 61 | throw new Error('Unexpected'); 62 | }); 63 | 64 | app.use(function(error, req, res, next) { 65 | res.send(error.message); 66 | }); 67 | 68 | const server = await app.listen(3000); 69 | 70 | const res = await superagent.get('http://localhost:3000'); 71 | 72 | assert.equal(res.text, 'Oops!'); 73 | 74 | await server.close(); 75 | }); 76 | 77 | 78 | it('should work with mixed async and non-async handlers', async function() { 79 | const app = addAsync(express()); 80 | 81 | app.getAsync('/', function (req,res,next) { 82 | req.helloMessage = 'Hello, World!'; 83 | next() 84 | }, async function routeHandler(req, res) { 85 | await new Promise(resolve => setTimeout(resolve, 10)); 86 | res.send(req.helloMessage); 87 | }); 88 | 89 | const server = await app.listen(3000); 90 | 91 | const res = await superagent.get('http://localhost:3000'); 92 | assert.equal(res.text, 'Hello, World!'); 93 | 94 | await server.close(); 95 | }); 96 | 97 | it('should work with mixed async and non-async handlers, when throwing errors', async function() { 98 | const app = addAsync(express()); 99 | 100 | app.getAsync('/', function (req,res,next) { 101 | throw new Error('Oops!'); 102 | }, async function routeHandler(req, res) { 103 | await new Promise(resolve => setTimeout(resolve, 10)); 104 | res.send(req.helloMessage); 105 | }); 106 | 107 | app.useAsync(async function (err,req,res,next) { 108 | res.send(err.message); 109 | }); 110 | 111 | const server = await app.listen(3000); 112 | 113 | const res = await superagent.get('http://localhost:3000'); 114 | 115 | assert.equal(res.text, 'Oops!'); 116 | 117 | await server.close(); 118 | }); 119 | 120 | it('should be consistent with normal express routes', async function() { 121 | const app = addAsync(express()); 122 | 123 | app.get('/normal', function (req,res,next) { 124 | req.testMessage = '1'; 125 | next() 126 | }, function (req,res,next) { 127 | req.testMessage += '2'; 128 | next() 129 | }, function (req,res,next) { 130 | setTimeout(() => { 131 | req.testMessage += '3'; 132 | next(); 133 | }, 10); 134 | }, async function routeHandler(req, res) { 135 | await new Promise(resolve => setTimeout(resolve, 10)); 136 | res.send(req.testMessage); 137 | }); 138 | 139 | app.getAsync('/async', function (req,res,next) { 140 | req.testMessage = '1'; 141 | next() 142 | }, function (req,res,next) { 143 | return new Promise((resolve)=> { 144 | req.testMessage += '2'; 145 | resolve(); 146 | }) 147 | }, function (req,res,next) { 148 | setTimeout(() => { 149 | req.testMessage += '3'; 150 | next(); 151 | }, 10); 152 | }, async function routeHandler(req, res) { 153 | await new Promise(resolve => setTimeout(resolve, 10)); 154 | res.send(req.testMessage); 155 | }); 156 | 157 | const server = await app.listen(3000); 158 | 159 | const resNormal = await superagent.get('http://localhost:3000/normal'); 160 | const resAsync = await superagent.get('http://localhost:3000/async'); 161 | await server.close(); 162 | 163 | assert.equal(resNormal.text, '123'); 164 | assert.equal(resAsync.text, '123'); 165 | }); 166 | }); 167 | 168 | describe('wrap', function() { 169 | it('works', async function() { 170 | const app = express(); 171 | 172 | app.use(wrap(async function(req, res, next) { 173 | await new Promise(resolve => setTimeout(resolve, 10)); 174 | next(); 175 | })); 176 | 177 | app.get('/', wrap(async function(req, res) { 178 | await new Promise(resolve => setTimeout(resolve, 10)); 179 | res.send('Hello, World!'); 180 | })); 181 | 182 | const server = await app.listen(3000); 183 | 184 | const res = await superagent.get('http://localhost:3000'); 185 | 186 | assert.equal(res.text, 'Hello, World!'); 187 | 188 | await server.close(); 189 | }); 190 | 191 | it('errors in middleware', async function() { 192 | const app = express(); 193 | 194 | app.use(wrap(async function middleware(req, res, next) { 195 | throw new Error('Oops!'); 196 | })); 197 | 198 | app.get('/', wrap(async function routeHandler(req, res) { 199 | await new Promise(resolve => setTimeout(resolve, 10)); 200 | res.send('Hello, World!'); 201 | })); 202 | 203 | app.use(function errorHandler(error, req, res, next) { 204 | res.send(error.message); 205 | }); 206 | 207 | const server = await app.listen(3000); 208 | 209 | const res = await superagent.get('http://localhost:3000'); 210 | 211 | assert.equal(res.text, 'Oops!'); 212 | 213 | await server.close(); 214 | }); 215 | 216 | it('async error handlers', async function() { 217 | const app = express(); 218 | 219 | app.use(wrap(async function(req, res, next) { 220 | throw new Error('Oops!'); 221 | })); 222 | 223 | app.get('/', wrap(async function(req, res) { 224 | await new Promise(resolve => setTimeout(resolve, 10)); 225 | res.send('Hello, World!'); 226 | })); 227 | 228 | app.use(wrap(async function(error, req, res, next) { 229 | await new Promise(resolve => setTimeout(resolve, 10)); 230 | next(new Error('New: ' + error.message)); 231 | })); 232 | 233 | app.use(wrap(async function(error, req, res, next) { 234 | res.send(error.message); 235 | })); 236 | 237 | const server = await app.listen(3000); 238 | 239 | const res = await superagent.get('http://localhost:3000'); 240 | 241 | assert.equal(res.text, 'New: Oops!'); 242 | 243 | await server.close(); 244 | }); 245 | 246 | it('early exit', async function() { 247 | const app = express(); 248 | let ran = false; 249 | 250 | app.use(wrap(async function(req, res) { 251 | res.send('Hello!'); 252 | })); 253 | 254 | app.get('/', wrap(async function(req, res) { 255 | ran = true; 256 | res.send('Hello, World!'); 257 | })); 258 | 259 | const server = await app.listen(3000); 260 | 261 | const res = await superagent.get('http://localhost:3000'); 262 | 263 | assert.equal(res.text, 'Hello!'); 264 | assert.ok(!ran); 265 | 266 | await server.close(); 267 | }); 268 | 269 | it('supports chaining with route() (gh-9)', async function() { 270 | const app = express(); 271 | const router = addAsync(express.Router()); 272 | 273 | let ran = false; 274 | router.routeAsync('/foo').getAsync(async function(req, res) { 275 | ran = true; 276 | res.send('Hello, World'); 277 | }); 278 | 279 | app.use(router); 280 | 281 | const server = await app.listen(3000); 282 | 283 | const res = await superagent.get('http://localhost:3000/foo'); 284 | 285 | assert.equal(res.text, 'Hello, World'); 286 | assert.ok(ran); 287 | 288 | await server.close(); 289 | }); 290 | }); 291 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------