hono 0.0.2 → 0.0.3

package/README.md

@@ -1,6 +1,21 @@
-# hono
+# Hono
 
-Minimal web framework for Cloudflare Workers.
+Hono [炎] - Tiny web framework for Cloudflare Workers and others.
+
+```js
+const app = Hono()
+
+app.get('/', () => new Response('Hono!!'))
+
+app.fire()
+```
+
+## Feature
+
+- Fast - the router is implemented with Trie-Tree structure.
+- Tiny - use only standard API.
+- Portable - zero dependencies.
+- Optimized for Cloudflare Workers.
 
 ## Install
 
@@ -14,18 +29,48 @@ or
 $ npm install hono
 ```
 
-## Hello hono!
+## Routing
+
+### Basic
 
 ```js
-const Hono = require("hono");
-const app = Hono();
+app.get('/', () => 'GET /')
+app.post('/', () => 'POST /')
+app.get('/wild/*/card', () => 'GET /wild/*/card')
+```
 
-app.get("/", () => new Response("Hono!!"));
+### Named Parameter
 
-app.fire(); // call `addEventListener`
+```js
+app.get('/user/:name', (req) => {
+  const name = req.params('name')
+  ...
+})
 ```
 
-Then, run `wrangler dev`.
+### Regexp
+
+```js
+app.get('/post/:date{[0-9]+}/:title{[a-z]+}', (req) => {
+  const date = req.params('date')
+  const title = req.params('title')
+  ...
+```
+
+### Chained Route
+
+```js
+app
+  .route('/api/book')
+  .get(() => 'GET /api/book')
+  .post(() => 'POST /api/book')
+  .put(() => 'PUT /api/book')
+```
+
+## Related projects
+
+- goblin <https://github.com/bmf-san/goblin>
+- itty-router <https://github.com/kwhitley/itty-router>
 
 ## Author
 

package/example/basic/index.js

@@ -0,0 +1,7 @@
+const Hono = require('../../src/hono')
+const app = Hono()
+
+app.get('/', () => 'Hono!!')
+app.get('/hello', () => 'This is /hello')
+
+app.fire()

package/example/basic/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "name": "sandbox",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "sandbox",
+      "version": "1.0.0",
+      "license": "ISC"
+    }
+  }
+}

package/example/basic/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "sandbox",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Yusuke Wada <yusuke@kamawada.com> (https://github.com/yusukebe)",
+  "license": "ISC"
+}

package/example/basic/wrangler.toml

@@ -0,0 +1,8 @@
+name = "basic"
+type = "webpack"
+route = ''
+zone_id = ''
+usage_model = ''
+compatibility_flags = []
+workers_dev = true
+compatibility_date = "2021-12-15"

package/hono.mini.js

@@ -0,0 +1 @@
+const Router=require("./router");class Route{constructor(t,e){this.method=t;this.handler=e}}class App{constructor(){this.router=new Router}addRoute(t,e,n){this.router.add(e,new Route(t,n))}handle(t){const e=this.dispatch(t.request);return t.respondWith(e)}dispatch(t){const e=new URL(t.url);const n=e.pathname;const r=this.router.match(n);if(!r){return this.notFound()}const o=t.method.toLowerCase();const s=r[0];if(s.method==o){const i=s.handler;return i(t)}return this.notFound()}notFound(){return new Response("Not Found",{status:404,headers:{"content-type":"text/plain"}})}fire(){addEventListener("fetch",t=>{this.handle(t)})}}const proxyHandler={get:(e,n)=>(...t)=>{if(e.constructor.prototype.hasOwnProperty(n)){return e[n](t[0])}else{e.addRoute(n,t[0],t[1]);return}}};const app=new App;function Hono(){return new Proxy(app,proxyHandler)}module.exports=Hono;class Router{constructor(){this.node=new Node({label:"/"})}add(t,e){this.node.insert(t,e)}match(t){return this.node.search(t)}}class Node{constructor({label:t,stuff:e,children:n}={}){this.label=t||"";this.stuff=e||{};this.children=n||[]}insert(t,e){let n=this;if(t=="/"){n.label=t;n.stuff=e}const r=this.splitPath(t);for(const o of r){let t=n.children[o];if(t){n=t}else{n.children[o]=new Node({label:o,stuff:e,children:[]});n=n.children[o]}}}splitPath(t){const e=[];for(const n of t.split("/")){if(n){e.push(n)}}return e}getPattern(t){const e=t.match(/^\:.+?\{(.+)\}$/);if(e){return"("+e[1]+")"}return"(.+)"}getParamName(t){const e=t.match(/^\:([^\{\}]+)/);if(e){return e[1]}}noRoute(){return null}search(t){let e=this;const n={};for(const r of this.splitPath(t)){const o=e.children[r];if(o){e=o;continue}if(Object.keys(e.children).length==0){if(e.label!=r){return this.noRoute()}break}let t=false;for(const s in e.children){if(s=="*"){e=e.children[s];t=true;break}if(s.match(/^:/)){const i=this.getPattern(s);const c=r.match(new RegExp(i));if(c){const h=this.getParamName(s);n[h]=c[0];e=e.children[s];t=true;break}return this.noRoute()}}if(t==false){return this.noRoute()}}return[e.stuff,n]}}module.exports=Router;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Minimal web framework for Cloudflare Workers",
   "main": "src/hono.js",
   "scripts": {
@@ -16,5 +16,9 @@
   "devDependencies": {
     "jest": "^27.4.5",
     "node-fetch": "^2.6.6"
+  },
+  "dependencies": {
+    "global": "^4.4.0",
+    "wrangler": "^0.0.0-beta.6"
   }
 }

package/src/hono.js

@@ -1,77 +1,103 @@
-const Router = require('./router')
+const Node = require('./node')
 
-class Route {
-  constructor(method, handler) {
-    this.method = method;
-    this.handler = handler;
+class Router {
+  constructor() {
+    this.node = new Node()
+    this.tempPath = '/'
   }
-}
 
-class App {
-  constructor() {
-    this.router = new Router();
+  route(path) {
+    this.tempPath = path
+    return WrappedRouter(this)
   }
 
   addRoute(method, path, handler) {
-    this.router.add(path, new Route(method, handler))
+    this.node.insert(method, path, handler)
+    return WrappedRouter(this)
+  }
+
+  matchRoute(method, path) {
+    method = method.toLowerCase()
+    const res = this.node.search(method, path)
+    return res
   }
 
   handle(event) {
-    const response = this.dispatch(event.request)
+    const result = this.dispatch(event.request)
+    const response = this.filter(result)
     return event.respondWith(response)
   }
 
+  filter(result) {
+    if (result instanceof Response) {
+      return result
+    }
+    if (typeof result === 'object') {
+      return new Response(JSON.stringify(result), {
+        status: 200,
+        headers: {
+          'Content-Type': 'application/json',
+        },
+      })
+    }
+    if (typeof result === 'string') {
+      return new Response(result, {
+        status: 200,
+        headers: {
+          'Content-Type': 'text/plain',
+        },
+      })
+    }
+    return this.notFound()
+  }
+
   dispatch(request) {
     const url = new URL(request.url)
     const path = url.pathname
-    const match = this.router.match(path)
+    const method = request.method
+    const res = this.matchRoute(method, path)
 
-    if (!match) {
+    if (!res) {
       return this.notFound()
     }
 
-    const method = request.method.toLowerCase()
-    const route = match[0]
-    if (route.method == method) {
-      const handler = route.handler
-      return handler(request)
-    }
-    return this.notFound()
+    const handler = res.handler
+    return handler(request)
   }
 
   notFound() {
     return new Response('Not Found', {
       status: 404,
       headers: {
-        'content-type': 'text/plain'
-      }
+        'content-type': 'text/plain',
+      },
     })
   }
 
   fire() {
-    addEventListener("fetch", (event) => {
+    addEventListener('fetch', (event) => {
       this.handle(event)
     })
   }
 }
 
 const proxyHandler = {
-  get: (target, prop) => (...args) => {
-    if (target.constructor.prototype.hasOwnProperty(prop)) {
-      return target[prop](args[0])
-    } else {
-      target.addRoute(prop, args[0], args[1])
-      return
-    }
-  }
+  get:
+    (target, prop) =>
+    (...args) => {
+      if (target.constructor.prototype.hasOwnProperty(prop)) {
+        return target[prop](...args)
+      } else {
+        if (args.length === 1) {
+          return target.addRoute(prop, target.tempPath, ...args)
+        }
+        return target.addRoute(prop, ...args)
+      }
+    },
 }
 
-const app = new App()
-
-function Hono() {
-  return new Proxy(
-    app, proxyHandler
-  )
+const WrappedRouter = (router = new Router()) => {
+  return new Proxy(router, proxyHandler)
 }
 
-module.exports = Hono
+module.exports = WrappedRouter

package/src/hono.test.js

@@ -1,17 +1,17 @@
 const Hono = require('./hono')
 const fetch = require('node-fetch')
 
-const app = new Hono()
+const app = Hono()
 
 describe('GET match', () => {
   app.get('/hello', () => {
     return new fetch.Response('hello', {
-      status: 200
+      status: 200,
     })
   })
   app.notFound = () => {
     return new fetch.Response('not found', {
-      status: 404
+      status: 404,
     })
   }
   it('GET /hello is ok', () => {

package/src/{router.js → node.js}

@@ -1,44 +1,44 @@
-// Ref: https://github.com/bmf-san/goblin
+const methodNameOfAll = 'all'
 
-class Router {
-  constructor() {
-    this.node = new Node({ label: "/" })
-  }
-  add(path, stuff) {
-    this.node.insert(path, stuff);
-  }
-  match(path) {
-    return this.node.search(path);
+class Result {
+  constructor({ handler, params } = {}) {
+    this.handler = handler
+    this.params = params || {}
   }
 }
 
 class Node {
-  constructor({ label, stuff, children } = {}) {
-    this.label = label || "";
-    this.stuff = stuff || {};
-    this.children = children || [];
+  constructor({ method, label, handler, children } = {}) {
+    this.label = label || ''
+    this.children = children || []
+    this.method = {}
+    if (method && handler) {
+      this.method[method] = handler
+    }
   }
 
-  insert(path, stuff) {
+  insert(method, path, handler) {
     let curNode = this
-    if (path == '/') {
-      curNode.label = path
-      curNode.stuff = stuff
-    }
     const ps = this.splitPath(path)
     for (const p of ps) {
       let nextNode = curNode.children[p]
       if (nextNode) {
         curNode = nextNode
       } else {
-        curNode.children[p] = new Node({ label: p, stuff: stuff, children: [] })
+        curNode.children[p] = new Node({
+          label: p,
+          handler: handler,
+        })
         curNode = curNode.children[p]
       }
     }
+    if (!curNode.method[method]) {
+      curNode.method[method] = handler
+    }
   }
 
   splitPath(path) {
-    const ps = []
+    let ps = ['/']
     for (const p of path.split('/')) {
       if (p) {
         ps.push(p)
@@ -64,30 +64,29 @@ class Node {
     }
   }
 
-  noRoute() {
-    return null
-  }
-
-  search(path) {
-
+  search(method, path) {
     let curNode = this
     const params = {}
 
+    if (path === '/') {
+      const root = this.children['/']
+      if (!root.method[method]) {
+        return this.noRoute()
+      }
+    }
+
     for (const p of this.splitPath(path)) {
-      const nextNode = curNode.children[p]
+      let nextNode = curNode.children[p]
+
       if (nextNode) {
         curNode = nextNode
         continue
       }
-      if (Object.keys(curNode.children).length == 0) {
-        if (curNode.label != p) {
-          return this.noRoute()
-        }
-        break
-      }
+
       let isParamMatch = false
       for (const key in curNode.children) {
-        if (key == "*") { // Wildcard
+        if (key === '*') {
+          // Wildcard
           curNode = curNode.children[key]
           isParamMatch = true
           break
@@ -109,8 +108,20 @@ class Node {
         return this.noRoute()
       }
     }
-    return [curNode.stuff, params]
+
+    let handler = curNode.method[methodNameOfAll] || curNode.method[method]
+
+    if (handler) {
+      const res = new Result({ handler: handler, params: params })
+      return res
+    } else {
+      return this.noRoute()
+    }
+  }
+
+  noRoute() {
+    return null
   }
 }
 
-module.exports = Router
+module.exports = Node

package/src/node.root.test.js

@@ -0,0 +1,17 @@
+const Node = require('./node')
+
+describe('Basic Usage', () => {
+  const node = new Node()
+  node.insert('get', '/', 'get root')
+  it('get /', () => {
+    expect(node.search('get', '/')).not.toBeNull()
+  })
+})
+
+describe('Basic Usage', () => {
+  const node = new Node()
+  node.insert('get', '/hello', 'get hello')
+  it('get /', () => {
+    expect(node.search('get', '/')).toBeNull()
+  })
+})

package/src/node.test.js

@@ -0,0 +1,109 @@
+const Node = require('./node')
+const node = new Node()
+
+describe('Util Methods', () => {
+  it('node.splitPath', () => {
+    let ps = node.splitPath('/')
+    expect(ps[0]).toBe('/')
+    ps = node.splitPath('/hello')
+    expect(ps[0]).toBe('/')
+    expect(ps[1]).toBe('hello')
+  })
+})
+
+describe('Basic Usage', () => {
+  node.insert('get', '/hello', 'get hello')
+  node.insert('post', '/hello', 'post hello')
+  node.insert('get', '/hello/foo', 'get hello foo')
+
+  it('get, post /hello', () => {
+    expect(node.search('get', '/')).toBeNull()
+    expect(node.search('post', '/')).toBeNull()
+
+    expect(node.search('get', '/hello').handler).toBe('get hello')
+    expect(node.search('post', '/hello').handler).toBe('post hello')
+    expect(node.search('put', '/hello')).toBeNull()
+  })
+  it('get /nothing', () => {
+    expect(node.search('get', '/nothing')).toBeNull()
+  })
+  it('/hello/foo, /hello/bar', () => {
+    expect(node.search('get', '/hello/foo').handler).toBe('get hello foo')
+    expect(node.search('post', '/hello/foo')).toBeNull()
+    expect(node.search('get', '/hello/bar')).toBeNull()
+  })
+  it('/hello/foo/bar', () => {
+    expect(node.search('get', '/hello/foo/bar')).toBeNull()
+  })
+})
+
+describe('Name path', () => {
+  it('get /entry/123', () => {
+    node.insert('get', '/entry/:id', 'get entry')
+    let res = node.search('get', '/entry/123')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get entry')
+    expect(res.params).not.toBeNull()
+    expect(res.params['id']).toBe('123')
+    expect(res.params['id']).not.toBe('1234')
+  })
+
+  it('get /entry/456/comment', () => {
+    node.insert('get', '/entry/:id', 'get entry')
+    res = node.search('get', '/entry/456/comment')
+    expect(res).toBeNull()
+  })
+
+  it('get /entry/789/comment/123', () => {
+    node.insert('get', '/entry/:id/comment/:comment_id', 'get comment')
+    res = node.search('get', '/entry/789/comment/123')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get comment')
+    expect(res.params['id']).toBe('789')
+    expect(res.params['comment_id']).toBe('123')
+  })
+})
+
+describe('Wildcard', () => {
+  it('/wildcard-abc/xxxxxx/wildcard-efg', () => {
+    node.insert('get', '/wildcard-abc/*/wildcard-efg', 'wildcard')
+    res = node.search('get', '/wildcard-abc/xxxxxx/wildcard-efg')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('wildcard')
+  })
+})
+
+describe('Regexp', () => {
+  node.insert(
+    'get',
+    '/regex-abc/:id{[0-9]+}/comment/:comment_id{[a-z]+}',
+    'regexp'
+  )
+  it('/regexp-abc/123/comment/abc', () => {
+    res = node.search('get', '/regex-abc/123/comment/abc')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('regexp')
+    expect(res.params['id']).toBe('123')
+    expect(res.params['comment_id']).toBe('abc')
+  })
+  it('/regexp-abc/abc', () => {
+    res = node.search('get', '/regex-abc/abc')
+    expect(res).toBeNull()
+  })
+  it('/regexp-abc/123/comment/123', () => {
+    res = node.search('get', '/regex-abc/123/comment/123')
+    expect(res).toBeNull()
+  })
+})
+
+describe('All', () => {
+  node.insert('all', '/all-methods', 'all methods')
+  it('/all-methods', () => {
+    res = node.search('get', '/all-methods')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('all methods')
+    res = node.search('put', '/all-methods')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('all methods')
+  })
+})

package/src/router.test.js

@@ -1,66 +1,76 @@
-const Router = require('./router')
+const Router = require('./hono')
+let router = Router()
 
-let router = new Router()
+describe('Basic Usage', () => {
+  it('get, post hello', () => {
+    router.get('/hello', 'get hello')
+    router.post('/hello', 'post hello')
 
-describe('root match', () => {
-  it('/ match', () => {
-    router.add('/', 'root')
-    let match = router.match('/')
-    expect(match).not.toBeNull()
-    expect(match[0]).toBe('root')
-    match = router.match('/foo')
-    expect(match).toBeNull()
-  })
+    let res = router.matchRoute('GET', '/hello')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get hello')
 
-  it('/hello match', () => {
-    router.add('/hello', 'hello')
-    match = router.match('/foo')
-    expect(match).toBeNull()
-    match = router.match('/hello')
-    expect(match[0]).toBe('hello')
-  })
-})
+    res = router.matchRoute('POST', '/hello')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('post hello')
 
-describe('path match', () => {
-  router.add('/entry/:id', 'entry-id')
-  router.add('/entry/:id/:comment', 'entry-id-comment')
-  router.add('/year/:year{[0-9]{4}}/:month{[0-9]{2}}', 'date-regex')
+    res = router.matchRoute('PUT', '/hello')
+    expect(res).toBeNull()
 
-  it('entry id match', () => {
-    const match = router.match('/entry/123')
-    expect(match[0]).toBe('entry-id')
-    expect(match[1]['id']).toBe('123')
+    res = router.matchRoute('GET', '/')
+    expect(res).toBeNull()
   })
+})
 
-  it('entry id and comment match', () => {
-    const match = router.match('/entry/123/45678')
-    expect(match[0]).toBe('entry-id-comment')
-    expect(match[1]['id']).toBe('123')
-    expect(match[1]['comment']).toBe('45678')
+describe('Complex', () => {
+  it('Named Param', () => {
+    router.get('/entry/:id', 'get entry')
+    res = router.matchRoute('GET', '/entry/123')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get entry')
+    expect(res.params['id']).toBe('123')
   })
-
-  it('date-regex', () => {
-    const match = router.match('/year/2021/12')
-    expect(match[0]).toBe('date-regex')
-    expect(match[1]['year']).toBe('2021')
-    expect(match[1]['month']).toBe('12')
+  it('Wildcard', () => {
+    router.get('/wild/*/card', 'get wildcard')
+    res = router.matchRoute('GET', '/wild/xxx/card')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get wildcard')
   })
-
-  it('not match', () => {
-    let match = router.match('/foo')
-    expect(match).toBeNull()
-    match = router.match('/year/abc')
-    expect(match).toBeNull()
+  it('Regexp', () => {
+    router.get('/post/:date{[0-9]+}/:title{[a-z]+}', 'get post')
+    res = router.matchRoute('GET', '/post/20210101/hello')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get post')
+    expect(res.params['date']).toBe('20210101')
+    expect(res.params['title']).toBe('hello')
+    res = router.matchRoute('GET', '/post/onetwothree')
+    expect(res).toBeNull()
+    res = router.matchRoute('GET', '/post/123/123')
+    expect(res).toBeNull()
   })
 })
 
-describe('wildcard', () => {
-  it('match', () => {
-    router = new Router()
-    router.add('/abc/*/def')
-    let match = router.match('/abc/xxx/def')
-    expect(match).not.toBeNull()
-    match = router.match('/abc/xxx/abc')
-    expect(match).toBeNull()
+describe('Chained Route', () => {
+  it('Return rooter object', () => {
+    router = router.patch('/hello', 'patch hello')
+    expect(router).not.toBeNull()
+    router = router.delete('/hello', 'delete hello')
+    res = router.matchRoute('DELETE', '/hello')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('delete hello')
+  })
+  it('Chain with route method', () => {
+    router.route('/api/book').get('get book').post('post book').put('put book')
+    res = router.matchRoute('GET', '/api/book')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('get book')
+    res = router.matchRoute('POST', '/api/book')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('post book')
+    res = router.matchRoute('PUT', '/api/book')
+    expect(res).not.toBeNull()
+    expect(res.handler).toBe('put book')
+    res = router.matchRoute('DELETE', '/api/book')
+    expect(res).toBeNull()
   })
 })