chore: cleanup

viveknathani · viveknathani · commit a5c9a4e7cc0c · 2025-05-20T19:40:34.000+05:30
diff --git a/Makefile b/Makefile
@@ -11,4 +11,7 @@ run:
 	export LOG_LEVEL=INFO && make build && ./bin/numero
 
 format:
-	golines -w .
+	golines -w .
+
+bench:
+	go run benchmark/main.go
diff --git a/README.md b/README.md
@@ -7,10 +7,6 @@
 
 `numero` is software for parsing and evaluating mathematical expressions. It is available as a library and as a web service.
 
-## motivation
-
-This project started as an exercise in doing some recreational programming. I always knew about the [shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm) but never really got to implement it. Lately, I've been writing a lot of code in Go and decided to just do this.
-
 ## usage
 
 The library can be used as follows.
@@ -59,6 +55,7 @@ curl --request POST \
 ## documentation
 
 **Supported functions**
+
 - `sin`
 - `cos`
 - `tan`
@@ -69,6 +66,7 @@ curl --request POST \
 - `min`
 
 **Supported operators**
+
 - `+`
 - `-`
 - `*`
@@ -95,6 +93,25 @@ Response body:
 }
 ```
 
+### benchmarks
+
+This runs a load test for 20 seconds. The test can be found [here](./benchmark/main.go). The tests were run on a 2021 Macbook Pro with an M1 chip.
+
+```bash
+make bench
+```
+| metric       | value   |
+|---------------|---------|
+| total requests| 30878   |
+| successful requests| 30878|
+| failed requests | 688    |
+| connection errors| 688   |
+| invalid responses| 0     |
+| average latency | 1.02 ms|
+| min latency     | 0.06 ms|
+| max latency     | 36.12 ms|
+| requests/second | 1543|
+
 ## contributing
 
 I am happy to accept pull requests. No hard rules.
@@ -113,6 +130,10 @@ make test
 make run-dev
 ```
 
+## motivation
+
+This project started as an exercise in doing some recreational programming. I always knew about the [shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm) but never really got to implement it. Lately, I've been writing a lot of code in Go and decided to just do this.
+
 ## acknowledgements
 
 created by Vivek Nathani ([@viveknathani_](https://twitter.com/viveknathani_)), licensed under the [MIT License](./LICENSE).
diff --git a/benchmark/main.go b/benchmark/main.go
@@ -170,8 +170,7 @@ func main() {
 		BaseURL:       *baseURL,
 	}
 
-	fmt.Printf("starting benchmark with %d concurrent users for %v\n", config.NumConcurrent, config.Duration)
-	fmt.Printf("target URL: %s\n\n", config.BaseURL)
+	fmt.Printf("running benchmark for %v\n", config.Duration)
 
 	stats := runBenchmark(config)
 
diff --git a/main.go b/main.go
@@ -52,38 +52,35 @@ func main() {
 	nlog.Info("hello from numero!")
 
 	PORT := "8084"
-	// Configure Fiber with optimized settings
+
 	app := fiber.New(fiber.Config{
-		Prefork:      true, // Uses multiple processes
-		ServerHeader: "Numero",
+		Prefork:      true,
+		ServerHeader: "numero",
 		ReadTimeout:  5 * time.Second,
 		WriteTimeout: 5 * time.Second,
 		IdleTimeout:  10 * time.Second,
-		BodyLimit:    4 * 1024,   // 4KB - adjust based on your needs
-		Concurrency:  256 * 1024, // Max concurrent connections
+		BodyLimit:    4 * 1024,
+		Concurrency:  256 * 1024,
 	})
 
-	// Add middlewares
 	app.Use(recover.New())
+
 	app.Use(compress.New(compress.Config{
 		Level: compress.LevelBestSpeed,
 	}))
+
 	app.Use(cors.New(cors.Config{
 		AllowOrigins: "*",
 	}))
 
-	// Serve README.md as HTML at root
 	app.Get("/", func(c *fiber.Ctx) error {
-		// Read README.md
 		md, err := os.ReadFile("README.md")
 		if err != nil {
 			return sendStandardResponse(c, fiber.StatusInternalServerError, nil, "failed to read README.md")
 		}
 
-		// Convert markdown to HTML
 		html := markdown.ToHTML(md, nil, nil)
 
-		// Add basic styling with HTML template
 		template := `<!DOCTYPE html>
 			<html>
 			<head>
@@ -117,11 +114,9 @@ func main() {
 	})
 
 	app.Post("/api/v1/eval", func(c *fiber.Ctx) error {
-		// Get request object from pool
 		req := evalPool.Get().(*EvalRequest)
 		defer evalPool.Put(req)
 
-		// Reset request fields
 		req.Expression = ""
 		req.Variables = nil
 

Original file line number	Diff line number	Diff line change
`@@ -170,8 +170,7 @@ func main() {`
`170`	`170`	`BaseURL: *baseURL,`
`171`	`171`	`}`
`172`	`172`
`173`		`- fmt.Printf("starting benchmark with %d concurrent users for %v\n", config.NumConcurrent, config.Duration)`
`174`		`- fmt.Printf("target URL: %s\n\n", config.BaseURL)`
	`173`	`+ fmt.Printf("running benchmark for %v\n", config.Duration)`
`175`	`174`
`176`	`175`	`stats := runBenchmark(config)`
`177`	`176`