hono 0.0.8 → 0.0.9

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+yusuke@kamawada.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/README.md

@@ -132,6 +132,19 @@ app.use('/message/*', addHeader)
 app.get('/message/hello', () => 'Hello Middleware!')
 ```
 
+### Custom 404 Response
+
+```js
+const customNotFound = (c, next) => {
+  next()
+  if (c.res.status === 404) {
+    c.res = new Response('Custom 404 Not Found', { status: 404 })
+  }
+}
+
+app.use('*', customNotFound)
+```
+
 ## Context
 
 ### req

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Minimal web framework for Cloudflare Workers and Fastly Compute@Edge",
   "main": "src/hono.js",
   "scripts": {

package/src/hono.d.ts

@@ -43,5 +43,6 @@ export class Hono {
 declare interface BuiltinMiddleware {}
 
 export class Middleware {
+  static defaultFilter: BuiltinMiddleware
   static poweredBy: BuiltinMiddleware
 }

package/src/hono.js

@@ -1,10 +1,10 @@
 'use strict'
 
 const Node = require('./node')
+const Middleware = require('./middleware')
 const compose = require('./compose')
 const methods = require('./methods')
-const defaultFilter = require('./middleware/defaultFilter')
-const Middleware = require('./middleware')
+const { getPathFromURL } = require('./util')
 
 const METHOD_NAME_OF_ALL = 'ALL'
 
@@ -23,12 +23,6 @@ class Router {
   }
 }
 
-const getPathFromURL = (url) => {
-  // XXX
-  const match = url.match(/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/)
-  return match[5]
-}
-
 class Hono {
   constructor() {
     this.router = new Router()
@@ -65,6 +59,10 @@ class Hono {
   }
 
   use(path, middleware) {
+    if (middleware.constructor.name !== 'Function') {
+      throw new TypeError('middleware must be a function!')
+    }
+
     const router = new Router()
     router.add(METHOD_NAME_OF_ALL, path, middleware)
     this.middlewareRouters.push(router)
@@ -89,13 +87,12 @@ class Hono {
     const [method, path] = [request.method, getPathFromURL(request.url)]
 
     const result = await this.matchRoute(method, path)
-    if (!result) return this.notFound()
 
     request.params = (key) => result.params[key]
 
-    let handler = result.handler[0] // XXX
+    let handler = result ? result.handler[0] : this.notFound // XXX
 
-    const middleware = [defaultFilter] // add defaultFilter later
+    const middleware = [Middleware.defaultFilter] // add defaultFilter later
 
     for (const mr of this.middlewareRouters) {
       const mwResult = mr.match(METHOD_NAME_OF_ALL, path)

package/src/hono.test.js

@@ -63,23 +63,23 @@ describe('params and query', () => {
 describe('Middleware', () => {
   const app = new Hono()
 
-  const logger = async (c, next) => {
+  const logger = (c, next) => {
     console.log(`${c.req.method} : ${c.req.url}`)
     next()
   }
 
-  const rootHeader = async (c, next) => {
+  const rootHeader = (c, next) => {
     next()
-    await c.res.headers.append('x-custom', 'root')
+    c.res.headers.append('x-custom', 'root')
   }
 
-  const customHeader = async (c, next) => {
+  const customHeader = (c, next) => {
     next()
-    await c.res.headers.append('x-message', 'custom-header')
+    c.res.headers.append('x-message', 'custom-header')
   }
-  const customHeader2 = async (c, next) => {
+  const customHeader2 = (c, next) => {
     next()
-    await c.res.headers.append('x-message-2', 'custom-header-2')
+    c.res.headers.append('x-message-2', 'custom-header-2')
   }
 
   app.use('*', logger)
@@ -113,3 +113,42 @@ describe('Middleware', () => {
     expect(await res.headers.get('x-message-2')).toBe('custom-header-2')
   })
 })
+
+describe('Custom 404', () => {
+  const app = new Hono()
+
+  const customNotFound = (c, next) => {
+    next()
+    if (c.res.status === 404) {
+      c.res = new fetch.Response('Custom 404 Not Found', { status: 404 })
+    }
+  }
+
+  app.notFound = () => {
+    return new fetch.Response('Default 404 Nout Found', { status: 404 })
+  }
+
+  app.use('*', customNotFound)
+  app.get('/hello', () => {
+    return new fetch.Response('hello')
+  })
+  it('Custom 404 Not Found', async () => {
+    let req = new fetch.Request('https://example.com/hello')
+    let res = await app.dispatch(req)
+    expect(res.status).toBe(200)
+    req = new fetch.Request('https://example.com/foo')
+    res = await app.dispatch(req)
+    expect(res.status).toBe(404)
+    expect(await res.text()).toBe('Custom 404 Not Found')
+  })
+})
+
+describe('Error Handling', () => {
+  const app = new Hono()
+
+  it('Middleware must be function', () => {
+    expect(() => {
+      app.use('*', {})
+    }).toThrow(TypeError)
+  })
+})

package/src/middleware/poweredBy.js

@@ -1,6 +1,6 @@
-const poweredBy = async (c, next) => {
+const poweredBy = (c, next) => {
   next()
-  await c.res.headers.append('X-Powered-By', 'Hono')
+  c.res.headers.append('X-Powered-By', 'Hono')
 }
 
 module.exports = poweredBy

package/src/middleware.js

@@ -1,7 +1,9 @@
+const defaultFilter = require('./middleware/defaultFilter')
 const poweredBy = require('./middleware/poweredBy')
 
 function Middleware() {}
 
+Middleware.defaultFilter = defaultFilter
 Middleware.poweredBy = poweredBy
 
 module.exports = Middleware

package/src/util.js

@@ -20,7 +20,14 @@ const getPattern = (label) => {
   }
 }
 
+const getPathFromURL = (url) => {
+  // XXX
+  const match = url.match(/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/)
+  return match[5]
+}
+
 module.exports = {
   splitPath,
   getPattern,
+  getPathFromURL,
 }

package/src/util.test.js

@@ -1,4 +1,4 @@
-const { splitPath, getPattern } = require('./util')
+const { splitPath, getPattern, getPathFromURL } = require('./util')
 
 describe('Utility methods', () => {
   it('splitPath', () => {
@@ -26,4 +26,19 @@ describe('Utility methods', () => {
     expect(res[0]).toBe('id')
     expect(res[1]).toBe('([0-9]+)')
   })
+
+  it('getPathFromURL', () => {
+    let path = getPathFromURL('https://example.com/')
+    expect(path).toBe('/')
+    path = getPathFromURL('https://example.com/hello')
+    expect(path).toBe('/hello')
+    path = getPathFromURL('https://example.com/hello/hey')
+    expect(path).toBe('/hello/hey')
+    path = getPathFromURL('https://example.com/hello?name=foo')
+    expect(path).toBe('/hello')
+    path = getPathFromURL('https://example.com/hello/hey?name=foo&name=bar')
+    expect(path).toBe('/hello/hey')
+    path = getPathFromURL('https://example.com/hello/hey#fragment')
+    expect(path).toBe('/hello/hey')
+  })
 })