Merge pull request #2 from madkins23/server-pages

Server pages
madkins23 · Feb 15, 2024 · ef2f616 · ef2f616
2 parents 477685a + 1e0eb5e
commit ef2f616
Show file tree

Hide file tree

Showing 99 changed files with 6,434 additions and 49 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,44 @@
+name: Update benchmark pages
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 0'
+  push:
+    branches:
+      - server-pages
+
+jobs:
+  run_benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+          check-latest: true
+
+#      - name: Install the latest versions of each library
+#        run: go get -u ./... && go mod tidy
+
+      - name: Benchmark Go logging libraries
+        run: go test -bench=. bench/*.go > ${{ runner.temp }}/bench.txt
+
+      - name: Run Server / Get Pages
+        run: go run cmd/server/server.go -from=${{ runner.temp }}/bench.txt & scripts/pages
+
+#      - name: Benchmark Go logging libraries
+#        run: go run cmd/server/server.go -from=/tmp/bench.txt
+#
+#      - name: Get Pages from server
+#        run: wget -r localhost:8080/go-slog -nH --cut-dirs=1 -P docs
+
+      - name: Commit benchmark results to repo
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: Update benchmark results
+          commit: '--no-verify'
diff --git a/README.md b/README.md
@@ -57,6 +57,8 @@ The benchmark data generated can be processed by two applications:
 * [`server`](cmd/server/server.go)  
   runs a simple web server showing the same tables plus bar charts.
 
+[Recent benchmark data](https://madkins23.github.io/go-slog/index.html).
+
 ## Gin Logging Redirect
 
 Package `gin` contains utilities for using `slog` with `gin-gonic/gin`.

diff --git a/bench/README.md b/bench/README.md
@@ -318,6 +318,8 @@ The root page shows links to various test data pages and the warnings:
 Test pages show the same tables as `tabular` plus charts comparing the results:
 ![Test pages show the same tables as `tabular` plus charts comparing the results.](../cmd/server/images/test.png)
 
+[Recent benchmark data](https://madkins23.github.io/go-slog/index.html).
+
 ---
 
 [^1]: Don't use `-v` in the `go test -bench` command when using `gobenchdata`.

diff --git a/cmd/server/embed/choices.tmpl b/cmd/server/embed/choices.tmpl
@@ -1,9 +1,19 @@
+        <script>
+          function testChoice(form) {
+            window.location.href = "/go-slog/test/" + form.tag.value + ".html";
+            return true;
+          }
+          function hdlrChoice(form) {
+            window.location.href = "/go-slog/handler/" + form.tag.value + ".html";
+            return true;
+          }
+        </script>
         <table>
           <tr>
             <td align="right">Test:</td>
             <td>
-              <form action="test" class="choice">
-                <select name="tag" id="tag" onchange="this.form.submit();">
+              <form class="choice">
+                <select name="tag" id="tag" onchange="testChoice(this.form);">
                   <option value="" selected disabled hidden>- Choose -</option>
                   {{ range .Data.TestTags }}
                     <option value="{{ . }}" {{ if eq $.Test . }}selected{{ end }}>{{ $.Data.TestName . }}</option>
@@ -16,7 +26,7 @@
             <td align="right">Handler:</td>
             <td>
               <form action="handler" class="choice">
-                <select name="tag" id="tag" onchange="this.form.submit();">
+                <select name="tag" id="tag" onchange="hdlrChoice(this.form);">
                   <option value="" selected disabled hidden>- Choose -</option>
                   {{ range .Data.HandlerTags }}
                     <option value="{{ . }}" {{ if eq $.Handler . }}selected{{ end }}>{{ $.Data.HandlerName . }}</option>

diff --git a/cmd/server/embed/handler.tmpl b/cmd/server/embed/handler.tmpl
@@ -1,14 +1,14 @@
 <html>
 <head>
   <title>Benchmark Data</title>
-  <link rel="stylesheet" href="/style.css">
+  <link rel="stylesheet" href="/go-slog/style.css">
 </head>
 
 <body>
 <table class="top">
   <tr>
     <td>
-      <a href="/"><img src="home.svg" alt="Home" class="home" /></a>
+      <a href="/go-slog/index.html"><img src="/go-slog/home.svg" alt="Home" class="home" /></a>
       <h1 class="home">Handler {{ .Data.HandlerName .Handler }}</h1>
     </td>
     <td align="right">
@@ -43,12 +43,12 @@
     <td colspan=2 align="center">
       <table>
         <tr>
-          <td><img src="chart.svg?tag={{ .Handler }}&item=Nanos" alt="{{ .Data.HandlerName .Handler }} Ns/Op" class="chart" /></td>
-          <td><img src="chart.svg?tag={{ .Handler }}&item=MemAllocs" alt="{{ .Data.HandlerName .Handler }} Allocs/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Handler }}/Nanos.svg" alt="{{ .Data.HandlerName .Handler }} Ns/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Handler }}/MemAllocs.svg" alt="{{ .Data.HandlerName .Handler }} Allocs/Op" class="chart" /></td>
         </tr>
         <tr>
-          <td><img src="chart.svg?tag={{ .Handler }}&item=MemBytes" alt="{{ .Data.HandlerName .Handler }} Bytes/Op" class="chart" /></td>
-          <td><img src="chart.svg?tag={{ .Handler }}&item=GbPerSec" alt="{{ .Data.HandlerName .Handler }} GB/Sec" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Handler }}/MemBytes.svg" alt="{{ .Data.HandlerName .Handler }} Bytes/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Handler }}/GbPerSec.svg" alt="{{ .Data.HandlerName .Handler }} GB/Sec" class="chart" /></td>
         </tr>
       </table>
     </td>

diff --git a/cmd/server/embed/root.tmpl b/cmd/server/embed/root.tmpl
@@ -1,7 +1,7 @@
 <html>
 <head>
   <title>Benchmarks</title>
-  <link rel="stylesheet" href="/style.css">
+  <link rel="stylesheet" href="/go-slog/style.css">
 </head>
 
 <body>
@@ -11,7 +11,7 @@
         <legend>Tests</legend>
         <table>
           {{ range .Data.TestTags }}
-            <tr><td><a href="test?tag={{ . }}">{{ $.Data.TestName . }}</a></td></tr>
+            <tr><td><a href="/go-slog/test/{{ . }}.html">{{ $.Data.TestName . }}</a></td></tr>
           {{ end }}
         </table>
       </fieldset>
@@ -20,7 +20,7 @@
         <legend>Handlers</legend>
         <table>
           {{ range .Data.HandlerTags }}
-            <tr><td><a href="handler?tag={{ . }}">{{ $.Data.HandlerName . }}</a></td></tr>
+            <tr><td><a href="/go-slog/handler/{{ . }}.html">{{ $.Data.HandlerName . }}</a></td></tr>
           {{ end }}
         </table>
       </fieldset>

diff --git a/cmd/server/embed/test.tmpl b/cmd/server/embed/test.tmpl
@@ -1,14 +1,14 @@
 <html>
 <head>
   <title>Benchmark Data</title>
-  <link rel="stylesheet" href="/style.css">
+  <link rel="stylesheet" href="/go-slog/style.css">
 </head>
 
 <body>
 <table class="top">
   <tr>
     <td>
-      <a href="/"><img src="home.svg" alt="Home" class="home" /></a>
+      <a href="/go-slog/index.html"><img src="/go-slog/home.svg" alt="Home" class="home" /></a>
       <h1 class="home">Test {{ .Data.TestName .Test }}</h1>
     </td>
     <td align="right">
@@ -43,12 +43,12 @@
     <td colspan=2 align="center">
       <table>
         <tr>
-          <td><img src="chart.svg?tag={{ .Test }}&item=Nanos" alt="{{ .Data.TestName .Test }} Ns/Op" class="chart" /></td>
-          <td><img src="chart.svg?tag={{ .Test }}&item=MemAllocs" alt="{{ .Data.TestName .Test }} Allocs/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Test }}/Nanos.svg" alt="{{ .Data.TestName .Test }} Ns/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Test }}/MemAllocs.svg" alt="{{ .Data.TestName .Test }} Allocs/Op" class="chart" /></td>
         </tr>
         <tr>
-          <td><img src="chart.svg?tag={{ .Test }}&item=MemBytes" alt="{{ .Data.TestName .Test }} Bytes/Op" class="chart" /></td>
-          <td><img src="chart.svg?tag={{ .Test }}&item=GbPerSec" alt="{{ .Data.TestName .Test }} GB/Sec" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Test }}/MemBytes.svg" alt="{{ .Data.TestName .Test }} Bytes/Op" class="chart" /></td>
+          <td><img src="/go-slog/chart/{{ .Test }}/GbPerSec.svg" alt="{{ .Data.TestName .Test }} GB/Sec" class="chart" /></td>
         </tr>
       </table>
     </td>

diff --git a/cmd/server/server.go b/cmd/server/server.go
@@ -8,6 +8,7 @@ import (
 	"log/slog"
 	"net/http"
 	"os"
+	"strings"
 	"sync"
 	"time"
 
@@ -16,6 +17,9 @@ import (
 	"github.com/vicanso/go-charts/v2"
 	"golang.org/x/text/message"
 
+	"github.com/madkins23/gin-utils/pkg/handler"
+	"github.com/madkins23/gin-utils/pkg/shutdown"
+
 	ginslog "github.com/madkins23/go-slog/gin"
 	"github.com/madkins23/go-slog/internal/bench"
 	"github.com/madkins23/go-slog/internal/language"
@@ -26,6 +30,8 @@ import (
 
 type pageType string
 
+const port = 8080
+
 const (
 	pageRoot    = "root"
 	pageTest    = "bench"
@@ -43,7 +49,7 @@ var (
 )
 
 func main() {
-	flag.Parse() // Necessary for -json=<file> argument defined in infra package.
+	flag.Parse() // Necessary for -from=<file> argument defined in internal/bench package.
 
 	gin.DefaultWriter = ginslog.NewWriter(&ginslog.Options{})
 	gin.DefaultErrorWriter = ginslog.NewWriter(&ginslog.Options{Level: slog.LevelError})
@@ -58,23 +64,31 @@ func main() {
 		return
 	}
 
+	graceful := &shutdown.Graceful{}
+	graceful.Initialize()
+	defer graceful.Close()
+
 	router := gin.Default()
-	router.GET("/", pageFunction(pageRoot))
-	router.GET("/test", pageFunction(pageTest))
-	router.GET("/handler", pageFunction(pageHandler))
-	router.GET("/chart.svg", chartFunction)
-	router.GET("/home.svg", svgFunction(home))
-	router.GET("/style.css", textFunction(css))
+	rootPageFn := pageFunction(pageRoot)
+	router.GET("/go-slog/", rootPageFn)
+	router.GET("/go-slog/index.html", rootPageFn)
+	router.GET("/go-slog/test/:tag", pageFunction(pageTest))
+	router.GET("/go-slog/handler/:tag", pageFunction(pageHandler))
+	router.GET("/go-slog/chart/:tag/:item", chartFunction)
+	router.GET("/go-slog/home.svg", svgFunction(home))
+	router.GET("/go-slog/style.css", textFunction(css))
+	router.GET("/go-slog/exit", handler.Exit)
 
 	if err := router.SetTrustedProxies(nil); err != nil {
 		slog.Error("Don't trust proxies", "err", err)
 		os.Exit(1)
 	}
 
 	// Listen and serve on 0.0.0.0:8080 (for windows "localhost:8080"). {
-	slog.Info("Web Server @ http://localhost:8080")
-	if err := router.Run(); err != nil {
-		slog.Error("Error during ListenAndServe()", "err", err)
+	slog.Info("Web Server @ http://localhost:8080/go-slog")
+
+	if err := graceful.Serve(router, port); err != nil {
+		slog.Error("Running gin server", "err", err)
 	}
 }
 
@@ -150,14 +164,14 @@ var (
 )
 
 func chartFunction(c *gin.Context) {
-	itemArg := c.Query("item")
+	itemArg := strings.TrimSuffix(c.Param("item"), ".svg")
 	item, err := bench.TestItemsString(itemArg)
 	if err != nil {
-		slog.Error("Bad item URL argument", "arg", itemArg, "err", err)
+		slog.Error("Bad URL parameter", "param", itemArg, "err", err)
 		// TODO: what to do here?
 		return
 	}
-	tag := c.Query("tag")
+	tag := c.Param("tag")
 	cacheKey := tag + ":" + item.String()
 	chartCacheMutex.Lock()
 	ch, found := chartCache[cacheKey]
@@ -255,12 +269,15 @@ func pageFunction(page pageType) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		pageData := &pageData{Data: data, Printer: language.Printer()}
 		if page == pageTest || page == pageHandler {
-			if tag := c.Query("tag"); tag == "" {
-				slog.Error("No URL argument", "arg", "tag")
-			} else if page == pageTest {
-				pageData.Test = bench.TestTag(tag)
-			} else if page == pageHandler {
-				pageData.Handler = bench.HandlerTag(tag)
+			if tag := c.Param("tag"); tag == "" {
+				slog.Error("No URL parameter", "param", "tag")
+			} else {
+				tag := strings.TrimSuffix(tag, ".html")
+				if page == pageTest {
+					pageData.Test = bench.TestTag(tag)
+				} else if page == pageHandler {
+					pageData.Handler = bench.HandlerTag(tag)
+				}
 			}
 		}
 		if err := templates[page].Execute(c.Writer, pageData); err != nil {

diff --git a/docs/chart/Attributes/GbPerSec.svg b/docs/chart/Attributes/GbPerSec.svg
diff --git a/docs/chart/Attributes/MemAllocs.svg b/docs/chart/Attributes/MemAllocs.svg