feat: add github-action-benchmark (#8)

* feat: add github-action-benchmark

* update benchmark.yml

* update readme

* update benchmarks

.github/workflows/benchmark.yml

@@ -0,0 +1,38 @@
+on:
+  push:
+    paths:
+      - '**'
+      - "!**.md"
+  pull_request:
+    paths:
+      - '**'
+      - "!**.md"
+name: Benchmark
+jobs:
+  compare:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.version }}
+      - name: Fetch Repository
+        uses: actions/checkout@v3
+      - name: Run Benchmark
+        run: set -o pipefail; go test ./... -benchmem -run=^$ -bench . | tee output.txt
+      - name: Get Previous Benchmark Results
+        uses: actions/cache@v3
+        with:
+          path: ./cache
+          key: ${{ runner.os }}-benchmark
+      - name: Save Benchmark Results
+        uses: benchmark-action/github-action-benchmark@v1.16.2
+        with:
+          tool: 'go'
+          output-file-path: output.txt
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          benchmark-data-dir-path: 'benchmarks'
+          fail-on-alert: true
+          comment-on-alert: true
+          auto-push: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
+          save-data-file: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}

.github/workflows/tests.yml

@@ -17,16 +17,6 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
-       # block scenario, comment temporarily
-#      - uses: actions/cache@v3
-#        with:
-#          path: ~/go/pkg/mod
-#          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-#          restore-keys: |
-#            ${{ runner.os }}-go-
-
       - name: Unit Test
         run: go test -race -covermode=atomic -coverprofile=coverage.out ./...
 
-      - name: Benchmark
-        run: go test -bench=. -benchmem -run=none ./...

README.md

@@ -226,6 +226,11 @@ curl -N --location 'http://localhost:8888/chat/sse?username=hertz'
 #
 #event:direct
 #data:{"Type":"direct","From":"kitex","To":"hertz","Message":"hello hertz","Timestamp":"2023-04-10T23:48:56.212855+08:00"}
-#
 
-```
+```
+
+## Benchmark Results
+
+All benchmarks are stored for each commit, they can be viewed here:
+
+https://hertz-contrib.github.io/sse/benchmarks/

README_CN.md

@@ -223,6 +223,12 @@ curl -N --location 'http://localhost:8888/chat/sse?username=hertz'
 #
 #event:direct
 #data:{"Type":"direct","From":"kitex","To":"hertz","Message":"hello hertz","Timestamp":"2023-04-10T23:48:56.212855+08:00"}
-#
 
-```
+```
+
+
+## Benchmark 结果
+
+每次提交的所有的 Benchmark 结果都已存储，可在此处进行查看：
+
+https://hertz-contrib.github.io/sse/benchmarks/

encoder_test.go

@@ -244,10 +244,10 @@ func BenchmarkNoRetrySSE(b *testing.B) {
 }
 
 func BenchmarkSimpleSSE(b *testing.B) {
-	b.ResetTimer()
-	b.ReportAllocs()
 	buf := new(bytes.Buffer)
 
+	b.ResetTimer()
+	b.ReportAllocs()
 	for i := 0; i < b.N; i++ {
 		_ = Encode(buf, &Event{
 			Event: "new_message",