This will make the leading slashes (mainly used for groups) completely optional. Meaning both http://localhost:8080/group/ and http://localhost:8080/group will both point to the same route.

If you don't want the leading slash, a simple unwrapping of the getPath returning the leadingSlash function will do.

All tests pass.

This PR removes @medley/router and uses a router same as medley-router but with minor changes and typings.

TODOS:

• Write tests (I'm very new to jest and testing, So i'll probably need help for this)

Dropping trek router fork to Hono Regex Router fork.

This migration improves the router benchmark:

Benchmark: Running on MacBook Pro 14' M1 Max, 64GB RAM

Trek Router fork:

'use strict'

const { title, now, print, operations } = require('../utils')
const { default: Router } = require('@saltyaom/trek-router')

const router = new Router()

title('@saltyaom/trek-router benchmark')

const routes = [
    { method: 'GET', url: 'http://localhost:8080/user' },
    { method: 'GET', url: 'http://localhost:8080/user/comments' },
    { method: 'GET', url: 'http://localhost:8080/user/avatar' },
    { method: 'GET', url: 'http://localhost:8080/user/lookup/username/:username' },
    { method: 'GET', url: 'http://localhost:8080/user/lookup/email/:address' },
    { method: 'GET', url: 'http://localhost:8080/event/:id' },
    { method: 'GET', url: 'http://localhost:8080/event/:id/comments' },
    { method: 'POST', url: 'http://localhost:8080/event/:id/comment' },
    { method: 'GET', url: 'http://localhost:8080/map/:location/events' },
    { method: 'GET', url: 'http://localhost:8080/status' },
    { method: 'GET', url: 'http://localhost:8080/very/deeply/nested/route/hello/there' },
    { method: 'GET', url: 'http://localhost:8080/static/*' }
]

function noop() {}
var i = 0
var time = 0

routes.forEach((route) => {
    router.add(route.method, route.url, noop)
})

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/user')
}
print('short static:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/user/comments')
}
print('static with same radix:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/user/lookup/username/john')
}
print('dynamic route:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/event/abcd1234/comments')
}
print('mixed static dynamic:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/very/deeply/nested/route/hello/there')
}
print('long static:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', '/static/index.html')
}
print('wildcard:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.find('GET', 'http://localhost:8080/user')
    router.find('GET', 'http://localhost:8080/user/comments')
    router.find('GET', 'http://localhost:8080/user/lookup/username/john')
    router.find('GET', 'http://localhost:8080/event/abcd1234/comments')
    router.find('GET', 'http://localhost:8080/very/deeply/nested/route/hello/there')
    router.find('GET', 'http://localhost:8080/static/index.html')
}
print('all together:', time)

Hono Router fork:

import { RegExpRouter } from 'hono/dist/router/reg-exp-router'
const { title, now, print, operations } = require('../utils')

const router = new RegExpRouter()

title('kingworld fork: hono/reg-exp-router')

const routes = [
    { method: 'GET', url: 'http://localhost:8080/user' },
    { method: 'GET', url: 'http://localhost:8080/user/comments' },
    { method: 'GET', url: 'http://localhost:8080/user/avatar' },
    { method: 'GET', url: 'http://localhost:8080/user/lookup/username/:username' },
    { method: 'GET', url: 'http://localhost:8080/user/lookup/email/:address' },
    { method: 'GET', url: 'http://localhost:8080/event/:id' },
    { method: 'GET', url: 'http://localhost:8080/event/:id/comments' },
    { method: 'POST', url: 'http://localhost:8080/event/:id/comment' },
    { method: 'GET', url: 'http://localhost:8080/map/:location/events' },
    { method: 'GET', url: 'http://localhost:8080/status' },
    { method: 'GET', url: 'http://localhost:8080/very/deeply/nested/route/hello/there' },
    { method: 'GET', url: 'http://localhost:8080/static/*' }
]

function noop() {}
var i = 0
var time = 0

routes.forEach((route) => {
    router.add(route.method, route.url, noop)
})

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/user')
}
print('short static:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/user/comments')
}
print('static with same radix:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/user/lookup/username/john')
}
print('dynamic route:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/event/abcd1234/comments')
}
print('mixed static dynamic:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/very/deeply/nested/route/hello/there')
}
print('long static:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', '/static/index.html')
}
print('wildcard:', time)

time = now()
for (i = 0; i < operations; i++) {
    router.match('GET', 'http://localhost:8080/user')
    router.match('GET', 'http://localhost:8080/user/comments')
    router.match('GET', 'http://localhost:8080/user/lookup/username/john')
    router.match('GET', 'http://localhost:8080/event/abcd1234/comments')
    router.match('GET', 'http://localhost:8080/very/deeply/nested/route/hello/there')
    router.match('GET', 'http://localhost:8080/static/index.html')
}
print('all together:', time)

Utils:

'use strict'

const chalk = require('chalk')

const operations = 1000000

let hrtime

// hrttime polyfill
;(function () {
    const nowOffset = Date.now()
    const now = () => Date.now() - nowOffset
    hrtime =
        process.hrtime ||
        ((previousTimestamp) => {
            const baseNow = Math.floor((Date.now() - now()) * 1e-3)
            const clocktime = now() * 1e-3
            let seconds = Math.floor(clocktime) + baseNow
            let nanoseconds = Math.floor((clocktime % 1) * 1e9)

            if (previousTimestamp) {
                seconds = seconds - previousTimestamp[0]
                nanoseconds = nanoseconds - previousTimestamp[1]
                if (nanoseconds < 0) {
                    seconds--
                    nanoseconds += 1e9
                }
            }
            return [seconds, nanoseconds]
        })
})()

function now() {
    var ts = hrtime()

    return ts[0] * 1e3 + ts[1] / 1e6
}

function getOpsSec(ms) {
    return Number(((operations * 1000) / ms).toFixed()).toLocaleString()
}

function print(name, time) {
    console.log(chalk.yellow(name), getOpsSec(now() - time), 'ops/sec')
}

function title(name) {
    console.log(
        chalk.green(`
${'='.repeat(name.length + 2)}
 ${name}
${'='.repeat(name.length + 2)}`)
    )
}

function Queue() {
    this.q = []
    this.running = false
}

Queue.prototype.add = function add(job) {
    this.q.push(job)
    if (!this.running) this.run()
}

Queue.prototype.run = function run() {
    this.running = true
    const job = this.q.shift()
    job(() => {
        if (this.q.length) {
            this.run()
        } else {
            this.running = false
        }
    })
}

module.exports = { now, getOpsSec, print, title, Queue, operations }

I'm working on another bun project and I found that you can get more contributors with a website. I built a really simple website and documentation generation tool if you want to add it to your project. Its under the MIT License- I'm just sending it around the bun community so it gains some more traction. If you want to check it out, it's right here. It's all integrated with Github Actions so all you have to do is add the code to GitHub actions and then you're are all set. If you don't want to, just let me know and close this issue- good luck with your project!

Also, just a tip, add a bunch of issues you need help with and label them "good first issue" because then people will see your project from places like goodfirstissues.com.

Reverts SaltyAom/kingworld#6

I benchmark the wrong version of Trek Router. For some reason, KingWorld is slower when using Hono Regex Router when bruteforce.

import { KingWorld } from 'kingworld';

new KingWorld()
    .get('/', () => 'Hi')
    .get('/error', () => {
        throw new Error('test')
    })
    .onError(error => {
        console.log(error.name === 'test');
    })
    .listen(8080)

If you start the app and visit http://localhost:8080/error should only see "false" in the logs, instead I see this.

➜  bun-test git:(main) ✗ bun run ./src/index.ts
[0.09ms] ".env"
false
1 | import { KingWorld } from 'kingworld';
2 | 
3 | new KingWorld()
4 |     .get('/', () => 'Hi')
5 |     .get('/error', () => {
6 |         throw new Error('test')
                  ^
error: test
      at /Users/xo/code/bun-test/src/index.ts:6:14
      at /Users/xo/code/bun-test/node_modules/kingworld/build/es/index.js:285:24
      at handle (/Users/xo/code/bun-test/node_modules/kingworld/build/es/index.js:220:17)

Currently this returns 200 HM as there seems to be a bug in bun. Tracking in https://discord.com/channels/876711213126520882/1044751397993840770/1044751397993840770

return new Response(JSON.stringify({
    field: 'value'
}), {
    status: 200,
    statusText: 'test'
});

import KingWorld from 'kingworld';

type Data = {
    field: number;
}

const app = new KingWorld()
    .state<'result', Data | null>('result', null)
    .get('/', context => context.store.result.field)
    .listen(3000);
	 
console.log(`🦊 KINGWORLD is running at :${app.server.port}`);

Context is typed as the following.

(parameter) context: Context<TypedSchemaToRoute<MergeSchema<{}, {}>>, {
    result: Data;
}>

result should be typed as Data | null.

Currently if I run this I get the following error when browsing to http://localhost:3000.

null is not an object (evaluating 'context.store.result.field')

I was hoping something like this could be added?

import KingWorld from 'kingworld'

const server = new KingWorld()
	.get('/', () => 'Hello KingWorld')
	.listen(0)
	 
console.log('🦊 KINGWORLD is running at :%s', server.port)

This would also help in this case.

import KingWorld from 'kingworld'

const server = new KingWorld()
	.get('/', () => 'Hello KingWorld')
	.listen(process.env.PORT ?? 0)

console.log('🦊 KINGWORLD is running at :%s', server.port)