feat: add suport for routes with underline and remove default 404 handler

Author: pedronauck

lib/index.js

@@ -1,14 +1,13 @@
 const UrlPattern = require('url-pattern')
-const { send } = require('micro')
-const { getParamsAndQuery } = require('../utils')
+const { getParamsAndQuery, patternOpts } = require('../utils')
 
 const METHODS = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']
 
 const methodFn = method => (path, handler) => {
   if (!path) throw new Error('You need to set a valid path')
   if (!handler) throw new Error('You need to set a valid handler')
 
-  const route = new UrlPattern(path)
+  const route = new UrlPattern(path, patternOpts)
 
   return (req, res) => {
     const { params, query } = getParamsAndQuery(route, req.url)
@@ -25,7 +24,7 @@ exports.router = (...funcs) => async (req, res) => {
     if (result || res.headersSent) return result
   }
 
-  send(res, 404, `Cannot ${req.method} ${req.url}`)
+  return false
 }
 
 METHODS.forEach(method => {

lib/index.test.js

@@ -34,54 +34,51 @@ test('routes with params and query', async t => {
   t.is(response, 'Hello world now')
 })
 
-test('async handlers', async t => {
-  const hello = async req =>
-    await Promise.resolve(`Hello ${req.params.msg} ${req.query.time}`)
-
+test('routes with underline', async t => {
   const routes = router(
-    get('/hello/:msg', hello)
+    get('/foo_bar', () => 'Hello with underline')
   )
 
   const url = await server(routes)
-  const response = await request(`${url}/hello/world?time=now`)
+  const response = await request(`${url}/foo_bar`)
 
-  t.is(response, 'Hello world now')
+  t.is(response, 'Hello with underline')
 })
 
-test('default 404 handler', async t => {
-  const hello = () => 'Hello world'
+test('async handlers', async t => {
+  const hello = req =>
+    Promise.resolve(`Hello ${req.params.msg} ${req.query.time}`)
 
   const routes = router(
-    get('/hello', hello)
+    get('/hello/:msg', hello)
   )
 
   const url = await server(routes)
-  const helloResponse = await request(`${url}/hello`)
-  t.is(helloResponse, 'Hello world')
-
-  const notfoundResponse = await request(`${url}/api`, {
-    simple: false,
-    resolveWithFullResponse: true
-  })
-  t.is(notfoundResponse.statusCode, 404)
-  t.is(notfoundResponse.body, 'Cannot GET /api')
+  const response = await request(`${url}/hello/world?time=now`)
+
+  t.is(response, 'Hello world now')
 })
 
-test('custom 404 handler', async t => {
-  const hello = () => 'Hello world'
-  const notfound = () => 'Not found'
+test('composed routes', async t => {
+  const fooRouter = router(
+    get('/foo', () => `Hello foo`)
+  )
+
+  const barRouter = router(
+    get('/bar', () => `Hello bar`)
+  )
 
   const routes = router(
-    get('/hello', hello),
-    get('/*', notfound)
+    fooRouter,
+    barRouter
   )
 
   const url = await server(routes)
-  const helloResponse = await request(`${url}/hello`)
-  const notfoundResponse = await request(`${url}/api`)
+  const fooResponse = await request(`${url}/foo`)
+  const barResponse = await request(`${url}/bar`)
 
-  t.is(helloResponse, 'Hello world')
-  t.is(notfoundResponse, 'Not found')
+  t.is(fooResponse, 'Hello foo')
+  t.is(barResponse, 'Hello bar')
 })
 
 test('multiple matching routes', async t => {
@@ -114,7 +111,7 @@ test('multiple matching async routes', async t => {
   t.is(pathResponse, 'Hello world')
 })
 
-test('error without path and handler', async t => {
+test('error without path and handler', t => {
   const fn = () => {
     router(get())
   }
@@ -123,7 +120,7 @@ test('error without path and handler', async t => {
   t.is(error.message, 'You need to set a valid path')
 })
 
-test('error without handler', async t => {
+test('error without handler', t => {
   const fn = () => {
     router(get('/hey'))
   }

utils/index.js

@@ -1,14 +1,19 @@
 const { parse } = require('url')
 const UrlPattern = require('url-pattern')
 
+const patternOpts = {
+  segmentNameCharset: 'a-zA-Z0-9_-'
+}
+
 const getParamsAndQuery = (pattern, url) => {
   const { query, pathname } = parse(url, true)
-  const route = pattern instanceof UrlPattern ? pattern : new UrlPattern(pattern)
+  const route = pattern instanceof UrlPattern ? pattern : new UrlPattern(pattern, patternOpts)
   const params = route.match(pathname)
 
   return { query, params }
 }
 
 module.exports = {
-  getParamsAndQuery
+  getParamsAndQuery,
+  patternOpts
 }