router-http 0.1.3 → 1.0.0

package/README.md

@@ -4,16 +4,15 @@
 [![Coverage Status](https://img.shields.io/coveralls/Kikobeats/router-http.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/router-http)
 [![NPM Status](https://img.shields.io/npm/dm/router-http.svg?style=flat-square)](https://www.npmjs.org/package/router-http)
 
-An HTTP router focused in only that, similar to [express@router](https://github.com/pillarjs/router), but:
+A middleware style router, similar to [express@router](https://github.com/pillarjs/router), plus:
 
-- Focused in just one thing.
+- Faster (x3 compared with Express).
 - Maintained and well tested.
-- Smaller and portable (1.4 kB).
-- Most of router API is supported.
+- Smaller (1.4 kB).
 
 Don't get me wrong: The original Express router is a piece of art. I used it for years and I just considered create this library after experienced a bug that never was addressed in the stable version due to the [lack of maintenance](https://github.com/pillarjs/router/pull/60).
 
-While I was evaluating the market for finding an alternative, I found [polka](https://github.com/lukeed/polka/tree/master/packages/polka) was a good starting point for creating a replacement. This module is different from polka in it isn't taking care about http.Server, it just acts as an isolated module.
+While I was evaluating the market for finding an alternative, I found [polka](https://github.com/lukeed/polka/tree/master/packages/polka) was a good starting point for creating a replacement. This library is different from polka in that it only contains the code that is strictly necessary for routing, nothing else.
 
 ## Install
 
@@ -30,17 +29,17 @@ const createRouter = require('router-http')
 
 const router = createRouter((error, req, res) => {
   const hasError = error !== undefined
-  res.statusCode = hasError ? 500 : 404
-  res.end(hasError ? err.message : 'Not Found')
+  res.statusCode = hasError ? error.statusCode ?? 500 : 404
+  res.end(hasError ? error.message ?? 'Internal Server Error' : 'Not Found')
 })
 ```
 
 The router requires a final handler that will be called if an error occurred or none of the routes match.
 
-After that, you can declare any HTTP verb route:
-
 ### Declaring routes
 
+The routes are declared using HTTP verbs:
+
 ```js
 /**
  * Declaring multiple routes based on the HTTP verb.
@@ -97,6 +96,18 @@ router
   })
 ```
 
+Also, you can declare conditional middlewares:
+
+```js
+/**
+ * Just add the middleware if it's production environment
+ */
+router
+  .use(process.env.NODE_ENV === 'production' && authentication())
+```
+
+They are only will add if the condition is satisfied.
+
 ### Prefixing routes
 
 In case you need you can prefix all the routes:
@@ -107,7 +118,7 @@ routes.get('/', (req, res) => res.end('Welcome to my API!'))
 /**
  * Prefix all routes with the API version
  */
-const router = Router(final)
+const router = createRouter(final)
 router
   .use('/latest', routes)
   .use('/v1', routes)
@@ -123,19 +134,44 @@ const server = http.createServer(router)
 
 ## Benchmark
 
-The performance is essentially the same than polka, and that is almost x3 faster than express.
+**express@4.18.2**
 
-See [benchmark](/benchmark) sections.
+```
+Running 30s test @ http://localhost:3000/user/123
+  8 threads and 100 connections
+  Thread Stats   Avg      Stdev     Max   +/- Stdev
+    Latency     4.12ms  653.26us  21.71ms   89.35%
+    Req/Sec     2.93k   159.60     5.99k    84.75%
+  700421 requests in 30.06s, 102.87MB read
+Requests/sec:  23304.22
+Transfer/sec:      3.42MB
+```
+
+**router-http@1.0.0**
+
+```
+Running 30s test @ http://localhost:3000/user/123
+  8 threads and 100 connections
+  Thread Stats   Avg      Stdev     Max   +/- Stdev
+    Latency     1.33ms  690.36us  30.28ms   97.16%
+    Req/Sec     9.27k     1.09k   11.76k    89.58%
+  2214097 requests in 30.02s, 276.61MB read
+Requests/sec:  73754.53
+Transfer/sec:      9.21MB
+```
+
+See more details, check [benchmark](/benchmark) section.
 
 ## Related
 
 - [send-http](https://github.com/Kikobeats/send-http) – A `res.end` with data type detection.
 - [http-body](https://github.com/Kikobeats/http-body) – Parse the http.IncomingMessage body into text/json/buffer.
-- [http-compression](https://github.com/Kikobeats/http-compression) – Adding compression (gzip/brotli) for your HTTP server in Node.js
-- [to-query](https://github.com/Kikobeats/to-query) Get query object from a request url.
+- [http-compression](https://github.com/Kikobeats/http-compression) – Adding compression (gzip/brotli) for your HTTP server in Node.js.
 
 ## License
 
+Full credits to [Luke Edwards](https://github.com/lukeed) for writing [Polka](https://github.com/lukeed/polka) and inspired this project.
+
 **router-http** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/router-http/blob/master/LICENSE.md) License.<br>
 Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/Kikobeats/router-http/contributors).
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "router-http",
   "description": "Simple HTTP router compatible with Express",
   "homepage": "https://nicedoc.io/Kikobeats/router-http",
-  "version": "0.1.3",
+  "version": "1.0.0",
   "main": "src/index.js",
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
@@ -28,13 +28,14 @@
     "routes"
   ],
   "dependencies": {
-    "trouter": "~3.2.0"
+    "trouter": "~3.2.1"
   },
   "devDependencies": {
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
     "ava": "latest",
     "c8": "latest",
+    "ci-publish": "latest",
     "conventional-github-releaser": "latest",
     "finepack": "latest",
     "git-authors-cli": "latest",
@@ -53,6 +54,21 @@
   "files": [
     "src"
   ],
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
+    "lint": "standard-markdown README.md && standard",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
+    "prerelease": "npm run update:check && npm run contributors",
+    "pretest": "npm run lint",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
+  },
   "license": "MIT",
   "commitlint": {
     "extends": [
@@ -73,20 +89,5 @@
   "simple-git-hooks": {
     "commit-msg": "npx commitlint --edit",
     "pre-commit": "npx nano-staged"
-  },
-  "scripts": {
-    "clean": "rm -rf node_modules",
-    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
-    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
-    "lint": "standard-markdown README.md && standard",
-    "postrelease": "npm run release:tags && npm run release:github && npm publish",
-    "prerelease": "npm run update:check",
-    "pretest": "npm run lint",
-    "release": "standard-version -a",
-    "release:github": "conventional-github-releaser -p angular",
-    "release:tags": "git push --follow-tags origin HEAD:master",
-    "test": "c8 ava",
-    "update": "ncu -u",
-    "update:check": "ncu -- --error-level 2"
   }
-}
+}

package/src/index.js

@@ -49,24 +49,24 @@ class Router extends Trouter {
   #middlewaresBy = []
 
   /**
-   * Middleware declaration, where the base is optional
+   * Middleware declaration, where the page is optional
    * .use(one)
    * .use('/v1', one)
    * .use(one, two)
    * .use('/v2', two)
    */
-  use = (base = '/', ...fns) => {
-    if (typeof base === 'function' || typeof base === 'boolean') {
-      this.#middlewares = this.#middlewares.concat(base, fns).filter(Boolean)
-    } else if (base === '/') {
+  use = (page = '/', ...fns) => {
+    if (typeof page === 'function' || typeof page === 'boolean') {
+      this.#middlewares = this.#middlewares.concat(page, fns).filter(Boolean)
+    } else if (page === '/') {
       this.#middlewares = this.#middlewares.concat(fns).filter(Boolean)
     } else {
-      base = lead(base)
+      page = lead(page)
       fns.filter(Boolean).forEach(fn => {
-        const array = this.#middlewaresBy[base] ?? []
+        const array = this.#middlewaresBy[page] ?? []
         // eslint-disable-next-line no-sequences
-        array.length > 0 || array.push((r, _, nxt) => (mutate(base, r), nxt()))
-        this.#middlewaresBy[base] = array.concat(fn)
+        array.length > 0 || array.push((r, _, nxt) => (mutate(page, r), nxt()))
+        this.#middlewaresBy[page] = array.concat(fn)
       })
     }
     return this
@@ -77,9 +77,9 @@ class Router extends Trouter {
     let fns = []
     let middlewares = this.#middlewares
     const route = this.find(req.method, info.pathname)
-    const base = value((req.path = info.pathname))
-    if (this.#middlewaresBy[base] !== undefined) {
-      middlewares = middlewares.concat(this.#middlewaresBy[base])
+    const page = value((req.path = info.pathname))
+    if (this.#middlewaresBy[page] !== undefined) {
+      middlewares = middlewares.concat(this.#middlewaresBy[page])
     }
     if (route) {
       fns = route.handlers