bun-crumb 0.11.0 → 0.12.1

package/README.md

@@ -9,11 +9,11 @@
 
 ### Features
 
--   Only Bun is supported
+- Only Bun is supported
 
--   No classes
+- No classes
 
--   Uses Bun’s HTTP API
+- Uses `Bun.serve` routes
 
 ### Installation
 
@@ -34,59 +34,158 @@ const products: Product[] = [];
 
 createRoute({
     url: '/products',
+
     method: 'GET',
+
     handler: (request, response: RouteResponse<{ body: Product[] }>) => {
         return response.send(
             [
-                { title: 'cookie', price: 100, id: 1 },
-                { title: 'bread', price: 1600, id: 2 },
+                { title: 'bananas', price: 0.57, id: 1 },
+
+                { title: 'bread', price: 0.89, id: 2 },
+
+                { title: 'milk', price: 0.83, id: 3 },
             ],
-            { status: 200 }
+
+            { status: 200 },
         );
     },
 });
 ```
 
-&nbsp;
+### Benchmarks
+
+- Machine:
+    - windows 11
+    - intel core i5 10300H
+    - 16gb ram
+
+- Load testing tool: grafana/k6
+
+- Bun version: 1.3.6
+
+<details> 
+    <summary>k6 script</summary>
+
+```bash
+    sleep 1 | k6 run script.js
+```
 
-Middleware / Pre-handlers
+```javascript
+import { PORT } from './constants.js';
+
+import http from 'k6/http';
+
+export const options = {
+    scenarios: {
+        load: {
+            executor: 'constant-arrival-rate',
+
+            rate: 16000,
+            timeUnit: '1s',
+
+            duration: '30s',
+            preAllocatedVUs: 1000,
+
+            maxVUs: 3000,
+        },
+    },
+};
+
+export default () => {
+    http.post(
+        'http://localhost:' + PORT + '/',
+        JSON.stringify({ key: 'value' }),
+        { headers: { 'Content-Type': 'application/json' } },
+    );
+};
+```
+
+</details>
+
+<details>
+    <summary>Pure Bun server code</summary>
 
 ```typescript
-import { createRoute, type RouteResponse } from 'bun-crumb';
+import { serve, stdout } from 'bun';
+
+import { PORT } from './constants';
+
+serve({
+    routes: {
+        '/': {
+            POST: (request) => {
+                return request.json().then(
+                    (body) =>
+                        new Response(JSON.stringify(body), {
+                            headers: { 'Content-Type': 'application/json' },
+                        }),
+                );
+            },
+        },
+    },
+    port: PORT,
+});
+stdout.write('Bun is running\n');
+```
 
-type Product = { title: string; price: number; id: number };
+</details>
 
-const products: Product[] = [];
+<details>
+    <summary>Fastify server code</summary>
 
-createRoute({
-    url: '/products',
+```typescript
+import Fastify from 'fastify';
+
+import { PORT } from './constants';
+
+const fastify = Fastify({ logger: false });
+
+fastify.route({
+    url: '/',
     method: 'POST',
-    preHandler: (request, response) => {
-        if (products.find((product) => product.id === request.body.id)) {
-            return response.send(
-                { message: 'Product with this id already exists' },
-                { status: 409 }
-            );
-        }
+    handler: (request, response) => {
+        return response.send(request.body);
     },
-    handler: (request, response: RouteResponse<{ body: Product }>) => {
-        products.push(body);
+});
 
-        return response.send(body, { status: 201 });
-    },
+fastify.listen({ port: PORT }, () => {
+    Bun.stdout.write('Fastify is running\n');
 });
 ```
 
-&nbsp;
+</details>
+
+<details>
+    <summary>Bun Crumb server code</summary>
 
-Setting Headers and Status
+```bash
+sleep 1 | k6 run script.js
+```
 
 ```typescript
-import { createRoute } from 'bun-crumb';
+import { PORT } from './constants';
+
+import { listen, createRoute } from 'bun-crumb';
 
+//
 createRoute({
-    url: '/auth',
+    url: '/',
+
     method: 'POST',
-    handler: (request, response) => {},
+
+    handler: (request, response) => {
+        return request.handleBody().then(response.send);
+    },
 });
+
+listen({ port: PORT });
 ```
+
+</details>
+
+| Library   | Total requests | RPS            | Requests failed | Avg. request duration |
+| --------- | -------------- | -------------- | --------------- | --------------------- |
+| Pure Bun  | 482681         | 15958.069946/s | 0.00% (0)       | 12.48ms               |
+| Bun Crumb | 474870         | 15789.504029/s | 0.02% (101)     | 23.08ms               |
+| Fastify   | 364525         | 12060.63486/s  | 0.27% (1002)    | 237.68ms              |

package/dist/bench/src/constants/MB_MULTIPLIER.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Multiplier between `bytes` and `megabytes`
+ *
+ * @example
+ * ```typescript
+ * const hugeBytes = 211_813_564;
+ * console.log(`Megabytes: `, hugeBytes / MB_MULTIPLIER);
+ * ```
+ */
+export declare const MB_MULTIPLIER = 1048582;

package/dist/bench/src/fastifyRoutes.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/handleBody.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/headersMicroBench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/k6/bunCrumb.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/k6/constants.d.ts

@@ -0,0 +1 @@
+export const PORT: 59957;

package/dist/bench/src/k6/fastify.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/k6/pureBun.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/k6/script.d.ts

@@ -0,0 +1,14 @@
+export namespace options {
+    namespace scenarios {
+        namespace load {
+            let executor: string;
+            let rate: number;
+            let timeUnit: string;
+            let duration: string;
+            let preAllocatedVUs: number;
+            let maxVUs: number;
+        }
+    }
+}
+declare function _default(): void;
+export default _default;

package/dist/bench/src/k6/server.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bench/src/prepareRoutes.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -13,12 +13,15 @@ import { BunRequest, CookieInit } from 'bun';
  *
  *
  *
+ *
+ *
  * declare module 'crumb-bun' {
  *    interface Schema {
  *        zod: ZodType;
  *    }
  * }
  * ```
+ *
  *  
  * ```json
  * // tsconfig.json
@@ -118,7 +121,7 @@ interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
-    send: (data: T['body'], options?: ResponseOptions) => void;
+    send: (data?: T['body'], options?: ResponseOptions) => void;
     /**
      * Sets `Location` header to provided `url` and `response.status` to provided `status`
      *
@@ -166,7 +169,7 @@ interface RouteResponse<T extends {
     setHeader: (name: Header['name'], value: Header['value']) => void;
     /**
      *
-     * @param options `Bun.Cookie` options parametr
+     * @param options `Bun.Cookie` options parameter
      *
      *
      *
@@ -212,7 +215,8 @@ interface ListenOptions {
 }
 
 /**
- * Starts serving http server.
+ *
+ *  Starts to serve http server.
  *
  *
  * @param {ListenOption} options - options

package/dist/index.js

@@ -1 +1 @@
-import{serve as e,Cookie as t}from"bun";class s extends Error{status;constructor(e,t){super(t),this.status=e,this.name="HttpError"}}const n=new Map,o=(e,n)=>o=>{const r=o.headers.get("Content-Type")??"text/plain",a=o;return a.handleBody=()=>((e,t,n,o)=>{const r={"application/json":e=>e.json().catch(()=>{throw new s(400,"Bad Request")}).then(e=>{if(n&&o&&!o(e,n))throw new s(400,"Request does not match schema");return e}),"text/plain":e=>e.text().catch(e=>{throw new s(400,e)}).then(e=>{if(n&&o&&!o(e,n))throw new s(400,"Request does not match schema");return e})};return t in r?r[t](e):Promise.reject(new s(415,"Unsupported media type"))})(o,r,e.schema,n),a.query=new URLSearchParams(o.url.split("?")[1]||""),Promise.resolve(((e,s)=>{let n=200,o="",r="";const a=new Headers,c={send:(e,t)=>{"object"==typeof e?(a.has("Content-Type")||a.set("Content-Type","application/json"),r=JSON.stringify(e)):"string"==typeof e?(a.has("Content-Type")||a.set("Content-Type","text/plain"),r=e):r=e,t&&(n=t.status,o=t.statusText)},redirect:(e,t)=>{r="",n=t||302,a.set("Location",e)},setHeader:(e,t)=>{a.set(e,t)},setCookie:e=>{a.append("Set-Cookie",new t(e).toString())}};return Promise.resolve(s.handler(e,c)).then(()=>new Response(r,{headers:a,status:n,statusText:o}))})(a,e)).then(e=>e).catch(e=>e instanceof s?new Response(e.message,{status:e.status}):new Response("Internal server error",{status:500}))},r=(e,t)=>{const s={};for(const n in e)Object.hasOwn(e,n)&&(s[n]=o(e[n],t));return s},a=(e,t)=>{const s={};for(const n of e)s[n[0]]=r(n[1],t);return e.clear(),s},c=t=>{e({port:t?.port,hostname:t?.hostname,development:t?.development??!1,routes:a(n,t?.schemaValidator)})},p=e=>{const t=n.get(e.url);t?t[e.method]=e:n.set(e.url,{[e.method]:e})};export{p as createRoute,c as listen};
+import{serve as e,stdout as t,Cookie as n}from"bun";class s extends Error{status;constructor(e,t){super(t),this.status=e,this.name="HttpError"}}const r=new Map,o=(e,t)=>r=>{const o=r.headers.get("Content-Type")??"text/plain",a=r;return a.handleBody=()=>((e,t,n,r)=>{const o={"application/json":e=>e.json().catch(()=>{throw new s(400,"Bad Request")}).then(e=>{if(n&&r&&!r(e,n))throw new s(400,"Request does not match schema");return e}),"text/plain":e=>e.text().catch(e=>{throw new s(400,e)}).then(e=>{if(n&&r&&!r(e,n))throw new s(400,"Request does not match schema");return e})};return t in o?o[t](e):Promise.reject(new s(415,"Unsupported media type"))})(r,o,e.schema,t),a.query=new URLSearchParams(r.url.split("?")[1]||""),Promise.resolve(((e,t)=>{let s=200,r="",o="";const a=new Headers,c={send:(e,t)=>{"object"==typeof e?(a.has("Content-Type")||a.set("Content-Type","application/json"),o=JSON.stringify(e)):"string"==typeof e?(a.has("Content-Type")||a.set("Content-Type","text/plain"),o=e):o=e,t&&(s=t.status,r=t.statusText)},redirect:(e,t)=>{o="",s=t||302,a.set("Location",e)},setHeader:(e,t)=>{a.set(e,t)},setCookie:e=>{a.append("Set-Cookie",new n(e).toString())}};return Promise.resolve(t.handler(e,c)).then(()=>new Response(o,{headers:a,status:s,statusText:r}))})(a,e)).then(e=>e).catch(e=>e instanceof s?new Response(e.message,{status:e.status}):new Response("Internal server error",{status:500}))},a=(e,t)=>{const n={};for(const s in e)Object.hasOwn(e,s)&&(n[s]=o(e[s],t));return n},c=(e,t)=>{const n={};for(const s of e)n[s[0]]=a(s[1],t);return e.clear(),n},h=n=>{const s=e({port:n?.port,hostname:n?.hostname,development:n?.development??!1,routes:c(r,n?.schemaValidator)});t.write("Server is running on "+s.url.href+"\n")},i=e=>{const t=r.get(e.url);t?t[e.method]=e:r.set(e.url,{[e.method]:e})};export{i as createRoute,h as listen};

package/dist/server.d.ts

@@ -25,6 +25,10 @@ export declare const _routes: Routes;
  * @param {Validate} schemaValidator schema validator function that receives `data` and `schema` arguments.
  *
  * @returns {Promise<unknown>} Promise with body
+ *
+ *
+ *
+ *
  */
 export declare const handleBody: (request: BunRequest, contentType: string, schema?: SchemaData, schemaValidator?: Validate) => Promise<unknown>;
 /**
@@ -90,7 +94,8 @@ export declare const prepareRoute: (route: Route, schemaValidator?: Validate) =>
  */
 export declare const prepareRoutes: (routes: Routes, schemaValidator?: Validate) => PreparedRoutes;
 /**
- * Starts serving http server.
+ *
+ *  Starts to serve http server.
  *
  *
  * @param {ListenOption} options - options

package/dist/types/route.d.ts

@@ -60,7 +60,7 @@ export interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
-    send: (data: T['body'], options?: ResponseOptions) => void;
+    send: (data?: T['body'], options?: ResponseOptions) => void;
     /**
      * Sets `Location` header to provided `url` and `response.status` to provided `status`
      *
@@ -108,7 +108,7 @@ export interface RouteResponse<T extends {
     setHeader: (name: Header['name'], value: Header['value']) => void;
     /**
      *
-     * @param options `Bun.Cookie` options parametr
+     * @param options `Bun.Cookie` options parameter
      *
      *
      *

package/dist/types/schema.d.ts

@@ -11,12 +11,15 @@
  *
  *
  *
+ *
+ *
  * declare module 'crumb-bun' {
  *    interface Schema {
  *        zod: ZodType;
  *    }
  * }
  * ```
+ *
  *  
  * ```json
  * // tsconfig.json

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bun-crumb",
-    "version": "0.11.0",
+    "version": "0.12.1",
     "author": "marigold",
     "module": "dist/index.js",
     "license": "UNLICENSED",