Specification of `*` and '/*' in routing

I think the top-level * and /* behave a little differently than the documentation.

https://github.com/honojs/hono/releases/tag/v1.4.0

app.get('/', (c) => {
  return c.text('foo')
}) // <--- stop process

app.use('*', middleware()) // <--- not dispached!!

Currently, in both TrieRouter and RegExpRouter, * and /* have higher precedence than /. ( On TrieRouter, * has the highest priority, /* the next highest; on RegExpRouter, * and /* have the same priority. )

describe('star', () => {
  const router = new TrieRouter<string>()

  router.add('GET', '/', '/')
  router.add('GET', '/*', '/*')
  router.add('GET', '*', '*')

  router.add('GET', '/x', '/x')
  router.add('GET', '/x/*', '/x/*')

  it.only('top', async () => {
    const res = router.match('GET', '/')
    expect(res).not.toBeNull()
    expect(res.handlers).toEqual(['*', '/*', '/'])
  })

  it.only('Under a certain path', async () => {
    const res = router.match('GET', '/x')
    expect(res).not.toBeNull()
    expect(res.handlers).toEqual(['*', '/*', '/x', '/x/*'])
  })
})

describe('star', () => {
  const router = new RegExpRouter<string>()

  router.add('GET', '/', '/')
  router.add('GET', '/*', '/*')
  router.add('GET', '*', '*')

  router.add('GET', '/x', '/x')
  router.add('GET', '/x/*', '/x/*')

  it.only('top', async () => {
    const res = router.match('GET', '/')
    expect(res).not.toBeNull()
    expect(res.handlers).toEqual(['*', '/*', '/']) // => failed ['/*', '*', '/']
  })

  it.only('Under a certain path', async () => {
    const res = router.match('GET', '/x')
    expect(res).not.toBeNull()
    expect(res.handlers).toEqual(['*', '/*', '/x', '/x/*'])
  })
})

The scores appear to be as follows.

at TrieRouter

router.add('GET', '/', '/')  // score: 1.1
router.add('GET', '/*', '/*') // score: 0.2
router.add('GET', '*', '*') // score: 0.3 - 1 => Approx. -0.7

at RegExpRouter

router.add('GET', '/', '/')  // score: 1.1
router.add('GET', '/*', '/*') // score: 0.2 in RegExpRouter "/*" is an alias to "*".
router.add('GET', '*', '*') // score: 0.3

I think the current specification for TrieRouter is acceptable to us as users, so I can make it the official specification and adapt RegExpRouter to it. Alternatively, we can treat ‘/’ as an alias to '’, which would be the same as the RegExpRouter implementation.

[usualoma]

@yusukebe We did it! I believe this will put an end to the long struggle in May. Thanks to user feedback, I’m sure we’ve landed on a very good spec!

[yusukebe]

@usualoma

I’ve merged two PRs #275, #276 to master. I tried the graghql scenario, it works well!

import { buildSchema } from 'graphql'
import { Hono } from 'hono'
import { graphqlServer } from 'hono/graphql-server'

const app = new Hono()

const schema = buildSchema(`
type Query {
  hello: String
}
`)

const rootValue = {
  hello: () => 'Hello Hono!',
}

app.use(
  '/graphql',
  graphqlServer({
    schema,
    rootValue,
  })
)

app.get('*', (c) => {
  return c.text('fallback')
})

export default app

If there is no problem, I’ll release v1.4.1.