🎉 feat: add benchmark

Author: SaltyAom

.npmignore

@@ -5,12 +5,14 @@
 .cjs.swcrc
 .es.swcrc
 bun.lockb
+bun.lock
 
 node_modules
 tsconfig.json
 pnpm-lock.yaml
 jest.config.js
 nodemon.json
+benchmarks
 
 example
 tests

README.md

@@ -1,16 +1,35 @@
 # JSON Accelerator
 
-Accelerate JSON stringification by providing OpenAPI/TypeBox model
+Accelerate JSON stringification by providing OpenAPI/TypeBox model.
+
+By providing model ahead of time, the library will generate a function that will serialize the object into a JSON string.
+
+```
+$ npx tsx benchmarks/medium.ts
+
+clk: ~3.02 GHz
+cpu: Apple M1 Max
+runtime: node 22.6.0 (arm64-darwin)
+
+summary
+  JSON Acclerator
+   1.72x faster than JSON Stingify
+   2.05x faster than Fast Json Stringify
+```
 
 ## Installation
 
 ```bash
+# Using either one of the package manager
+npm install json-accelerator
+yarn add json-accelerator
+pnpm add json-accelerator
 bun add json-accelerator
 ```
 
 ## Usage
 
-It is expected to use [https://github.com/sinclairzx81/typebox](TypeBox) to define the schema, but and OpenAPI schema should also work.
+It is designed to be used with [https://github.com/sinclairzx81/typebox](TypeBox) but an OpenAPI schema should also work.
 
 ```typescript
 import { Type as t } from '@sinclair/typebox'
@@ -55,8 +74,7 @@ const value = {
 const guard = TypeCompiler.Compile(shape)
 const encode = createAccelerator(shape)
 
-if(guard.Check(value))
-	encode(value)
+if (guard.Check(value)) encode(value)
 ```
 
 If the shape is incorrect, the output will try to corece the value into an expected model but if failed the error will be thrown.

benchmarks/medium.ts

@@ -0,0 +1,70 @@
+import { t } from 'elysia'
+import { benchmark } from './utils'
+
+benchmark(
+	t.Object({
+		id: t.Number(),
+		name: t.Literal('SaltyAom'),
+		bio: t.String(),
+		user: t.Object({
+			name: t.String(),
+			password: t.String()
+		}),
+		playing: t.Optional(t.String()),
+		games: t.Array(
+			t.Object({
+				name: t.String(),
+				hoursPlay: t.Number({ default: 0 }),
+				tags: t.Array(t.String())
+			})
+		),
+		metadata: t.Intersect([
+			t.Object({
+				alias: t.String()
+			}),
+			t.Object({
+				country: t.Nullable(t.String())
+			})
+		]),
+		social: t.Optional(
+			t.Object({
+				facebook: t.Optional(t.String()),
+				twitter: t.Optional(t.String()),
+				youtube: t.Optional(t.String())
+			})
+		)
+	}),
+	{
+		id: 1,
+		name: 'SaltyAom',
+		bio: 'I like train',
+		user: {
+			name: 'SaltyAom',
+			password: '123456'
+		},
+		games: [
+			{
+				name: 'MiSide',
+				hoursPlay: 17,
+				tags: ['Psychological Horror', 'Cute', 'Dating Sim']
+			},
+			{
+				name: 'Strinova',
+				hoursPlay: 365,
+				tags: ['Free to Play', 'Anime', 'Third-Person Shooter']
+			},
+			{
+				name: "Tom Clancy's Rainbow Six Siege",
+				hoursPlay: 287,
+				tags: ['FPS', 'Multiplayer', 'Tactical']
+			}
+		],
+		metadata: {
+			alias: 'SaltyAom',
+			country: 'Thailand'
+		},
+		social: {
+			twitter: 'SaltyAom'
+		}
+	}
+)

benchmarks/multiple-queries.ts

@@ -0,0 +1,23 @@
+import { t } from 'elysia'
+import { benchmark } from './utils'
+
+benchmark(
+	t.Array(
+		t.Object({
+			id: t.Number(),
+			randomNumber: t.Number()
+		})
+	),
+	[
+		{ id: 4174, randomNumber: 331 },
+		{ id: 51, randomNumber: 6544 },
+		{ id: 4462, randomNumber: 952 },
+		{ id: 2221, randomNumber: 532 },
+		{ id: 9276, randomNumber: 3097 },
+		{ id: 3056, randomNumber: 7293 },
+		{ id: 6964, randomNumber: 620 },
+		{ id: 675, randomNumber: 6601 },
+		{ id: 8414, randomNumber: 6569 },
+		{ id: 2753, randomNumber: 4065 }
+	]
+)

benchmarks/small.ts

@@ -0,0 +1,23 @@
+import { t } from 'elysia'
+import { benchmark } from './utils'
+
+benchmark(
+	t.Object({
+		id: t.Number(),
+		name: t.Literal('SaltyAom'),
+		bio: t.String(),
+		metadata: t.Object({
+			alias: t.String(),
+			country: t.String()
+		})
+	}),
+	{
+		id: 1,
+		name: 'SaltyAom',
+		bio: 'I like train',
+		metadata: {
+			alias: 'SaltyAom',
+			country: 'Thailand'
+		}
+	}
+)

benchmarks/utils.ts

@@ -0,0 +1,34 @@
+import { bench, run, barplot, summary } from 'mitata'
+
+import { createAccelerator } from '../src'
+import fastJson from 'fast-json-stringify'
+import type { TAnySchema } from '@sinclair/typebox'
+
+export const benchmark = <T extends TAnySchema>(
+	model: T,
+	value: T['static']
+) => {
+	const fastJsonStringify = fastJson(model)
+	const encode = createAccelerator(model)
+
+	if (encode(value) !== JSON.stringify(value))
+		throw new Error('Invalid result')
+
+	barplot(() => {
+		summary(() => {
+			bench('JSON Stingify', () => {
+				return JSON.stringify(value)
+			})
+
+			bench('Fast Json Stringify', () => {
+				return fastJsonStringify(value)
+			})
+
+			bench('JSON Accelerator', () => {
+				return encode(value)
+			})
+		})
+	})
+
+	run()
+}

bun.lock

@@ -2,32 +2,31 @@ import { t } from 'elysia'
 import { createAccelerator } from '../src/index'
 
 const shape = t.Object({
-	a: t.Array(t.Number())
-	// a: t.Literal('a'),
-	// b: t.Number(),
-	// c: t.Object({
-	// 	a: t.String()
-	// }),
-	// d: t.Array(
-	// 	t.Object({
-	// 		a: t.Array(t.String())
-	// 	})
-	// ),
-	// e: t.Intersect([
-	// 	t.Object({
-	// 		a: t.String()
-	// 	}),
-	// 	t.Object({
-	// 		b: t.Optional(t.Number())
-	// 	})
-	// ])
+	a: t.Literal('a'),
+	b: t.Number(),
+	c: t.Object({
+		a: t.String()
+	}),
+	d: t.Array(
+		t.Object({
+			a: t.Array(t.String())
+		})
+	),
+	e: t.Intersect([
+		t.Object({
+			a: t.String()
+		}),
+		t.Object({
+			b: t.Optional(t.Number())
+		})
+	])
 })
 
 const stringify = createAccelerator(shape)
 
 console.log(
 	stringify({
-		a: [1, 2],
+		a: 'a',
 		b: 1,
 		c: { a: 'a' },
 		d: [{ a: ['a', 'b'] }, { a: ['a', 'a'] }],

example/index.ts

@@ -22,7 +22,10 @@
 		"@types/bun": "1.2.2",
 		"elysia": "^1.2.11",
 		"eslint": "9.6.0",
+		"fast-json-stringify": "^6.0.1",
+		"mitata": "^1.0.33",
 		"tsup": "^8.1.0",
+		"tsx": "^4.19.2",
 		"typescript": "^5.5.3"
 	},
 	"main": "./dist/cjs/index.js",

package.json

@@ -40,6 +40,22 @@ describe('Core', () => {
 		isEqual(shape, value)
 	})
 
+	it('handle null', () => {
+		const shape = t.Null()
+
+		const value = null satisfies typeof shape.static
+
+		isEqual(shape, value)
+	})
+
+	it('handle undefined', () => {
+		const shape = t.Undefined()
+
+		const value = undefined satisfies typeof shape.static
+
+		expect(createAccelerator(shape)(value)).toBe('')
+	})
+
 	it('handle object', () => {
 		const shape = t.Object({
 			name: t.String(),
@@ -405,4 +421,23 @@ describe('Core', () => {
 
 		isEqual(shape, value)
 	})
+
+	it('handle additionalProperties', () => {
+		const shape = t.Object(
+			{
+				name: t.String(),
+				playing: t.Optional(t.String())
+			},
+			{
+				additionalProperties: true
+			}
+		)
+
+		const value = {
+			name: 'saltyaom',
+			playing: 'Strinova'
+		} satisfies typeof shape.static
+
+		isEqual(shape, value)
+	})
 })