Merge pull request #346 from gofiber/missing-bench

Add Missing Parallel Benchmarks for Mustache Engine
gofiber · Feb 22, 2024 · 0b4ca55 · 0b4ca55
2 parents 3351c2f + 4322850
commit 0b4ca55
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 27 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -54,10 +54,17 @@ jobs:
       - name: Save Benchmark Results
         uses: benchmark-action/[email protected]
         with:
-          tool: "go"
+          # What benchmark tool the output.txt came from
+          tool: 'go'
+          # Where the output from the benchmark tool is stored
           output-file-path: output.txt
+          # Where the previous data file is stored
+          external-data-json-path: ./cache/benchmark-data.json
+          # Secret for Github
           github-token: ${{ secrets.BENCHMARK_TOKEN }}
+          # Directory that contains benchmark files on the GitHub pages branch
           benchmark-data-dir-path: "benchmarks"
+          # Workflow will fail when an alert happens
           fail-on-alert: true
           comment-on-alert: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
           #summary-always: ${{ github.event_name != 'push' && github.event_name != 'workflow_dispatch' }}

diff --git a/ace/ace_test.go b/ace/ace_test.go
@@ -262,7 +262,7 @@ func Benchmark_Ace_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -276,7 +276,7 @@ func Benchmark_Ace_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -290,7 +290,7 @@ func Benchmark_Ace_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -305,7 +305,7 @@ func Benchmark_Ace_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/amber/amber_test.go b/amber/amber_test.go
@@ -243,7 +243,7 @@ func Benchmark_Amber_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -257,7 +257,7 @@ func Benchmark_Amber_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -271,7 +271,7 @@ func Benchmark_Amber_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -286,7 +286,7 @@ func Benchmark_Amber_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/handlebars/handlebars_test.go b/handlebars/handlebars_test.go
@@ -243,7 +243,7 @@ func Benchmark_Handlebars_Parallel(b *testing.B) {
 	// Note we don't register isAdmin again because handlebars does not support re-registering helpers
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -257,7 +257,7 @@ func Benchmark_Handlebars_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -272,7 +272,7 @@ func Benchmark_Handlebars_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -287,7 +287,7 @@ func Benchmark_Handlebars_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/html/html_test.go b/html/html_test.go
@@ -335,7 +335,7 @@ func Benchmark_Html_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -349,7 +349,7 @@ func Benchmark_Html_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -363,7 +363,7 @@ func Benchmark_Html_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -378,7 +378,7 @@ func Benchmark_Html_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/jet/jet_test.go b/jet/jet_test.go
@@ -235,7 +235,7 @@ func Benchmark_Jet_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -249,7 +249,7 @@ func Benchmark_Jet_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -263,7 +263,7 @@ func Benchmark_Jet_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -278,7 +278,7 @@ func Benchmark_Jet_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/mustache/mustache_test.go b/mustache/mustache_test.go
@@ -151,3 +151,38 @@ func Benchmark_Mustache(b *testing.B) {
 		}
 	})
 }
+
+func Benchmark_Mustache_Parallel(b *testing.B) {
+	expectSimple := `<h1>Hello, Parallel!</h1>`
+	engine := New("./views", ".mustache")
+	require.NoError(b, engine.Load())
+
+	b.Run("simple", func(bb *testing.B) {
+		bb.ReportAllocs()
+		bb.ResetTimer()
+		bb.RunParallel(func(pb *testing.PB) {
+			for pb.Next() {
+				var buf bytes.Buffer
+				//nolint:gosec,errcheck // Return value not needed for benchmark
+				_ = engine.Render(&buf, "simple", map[string]interface{}{
+					"Title": "Hello, Parallel!",
+				})
+			}
+		})
+	})
+
+	b.Run("simple_asserted", func(bb *testing.B) {
+		bb.ReportAllocs()
+		bb.ResetTimer()
+		bb.RunParallel(func(pb *testing.PB) {
+			for pb.Next() {
+				var buf bytes.Buffer
+				err := engine.Render(&buf, "simple", map[string]interface{}{
+					"Title": "Hello, Parallel!",
+				})
+				require.NoError(bb, err)
+				require.Equal(bb, expectSimple, trim(buf.String()))
+			}
+		})
+	})
+}
diff --git a/pug/pug_test.go b/pug/pug_test.go
@@ -256,7 +256,7 @@ func Benchmark_Pug_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -270,7 +270,7 @@ func Benchmark_Pug_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended", func(bb *testing.B) {
+	b.Run("extended", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -284,7 +284,7 @@ func Benchmark_Pug_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -299,7 +299,7 @@ func Benchmark_Pug_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_extended_asserted", func(bb *testing.B) {
+	b.Run("extended_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {

diff --git a/slim/slim_test.go b/slim/slim_test.go
@@ -219,7 +219,7 @@ func Benchmark_Slim_Parallel(b *testing.B) {
 	})
 	require.NoError(b, engine.Load())
 
-	b.Run("parallel_simple", func(bb *testing.B) {
+	b.Run("simple", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {
@@ -233,7 +233,7 @@ func Benchmark_Slim_Parallel(b *testing.B) {
 		})
 	})
 
-	b.Run("parallel_simple_asserted", func(bb *testing.B) {
+	b.Run("simple_asserted", func(bb *testing.B) {
 		bb.ReportAllocs()
 		bb.ResetTimer()
 		bb.RunParallel(func(pb *testing.PB) {