gromer

git clone https://pyrossh.dev/repos/gromer.git

gromer is a framework and cli to build multipage web apps in golang using htmx and alpinejs.

Readme

Commits

Files

a135e427 — Peter John

tag: v0.18.1

v0.18.1

3 years ago

fix styles caching

Files changed (5) hide show

_example/main.go +14 -10
api_explorer.go +28 -22
cmd/gromer/main.go +13 -9
handlebars/template.go +14 -0
http.go +56 -48

_example/main.go CHANGED Viewed

@@ -29,19 +29,23 @@ func init() {
 func main() {
 	port := os.Getenv("PORT")
-	r := mux.NewRouter()
+	baseRouter := mux.NewRouter()
-	r.Use(gromer.LogMiddleware)
+	baseRouter.Use(gromer.LogMiddleware)
-	r.NotFoundHandler = gromer.StatusHandler(not_found_404.GET)
+	baseRouter.NotFoundHandler = gromer.StatusHandler(not_found_404.GET)
+	staticRouter := baseRouter.NewRoute().Subrouter()
+	staticRouter.Use(gromer.CacheMiddleware)
-	gromer.Static(r, "/assets/", assets.FS)
+	gromer.StaticRoute(staticRouter, "/assets/", assets.FS)
-	gromer.Handle(r, "GET", "/styles.css", gromer.Styles)
+	gromer.StylesRoute(staticRouter, "/styles.css")
+	pageRouter := baseRouter.NewRoute().Subrouter()
-	gromer.Handle(r, "GET", "/api", gromer.ApiExplorer)
+	gromer.ApiExplorerRoute(pageRouter, "/explorer")
-	gromer.Handle(r, "GET", "/", pages.GET)
+	gromer.Handle(pageRouter, "GET", "/", pages.GET)
-	gromer.Handle(r, "GET", "/about", about.GET)
+	gromer.Handle(pageRouter, "GET", "/about", about.GET)
-	apiRouter := r.NewRoute().Subrouter()
+	apiRouter := baseRouter.NewRoute().Subrouter()
 	apiRouter.Use(gromer.CorsMiddleware)
 	gromer.Handle(apiRouter, "GET", "/api/recover", recover.GET)
 	gromer.Handle(apiRouter, "GET", "/api/todos", todos.GET)
@@ -53,7 +57,7 @@ func main() {
 	log.Info().Msg("http server listening on http://localhost:"+port)
-	srv := server.New(r, nil)
+	srv := server.New(baseRouter, nil)
 	if err := srv.ListenAndServe(":"+port); err != nil {
 		log.Fatal().Stack().Err(err).Msg("failed to listen")
 	}

api_explorer.go CHANGED Viewed

@@ -1,32 +1,34 @@
 package gromer
 import (
-	"context"
 	"encoding/json"
 	"html/template"
+	"net/http"
 	"strings"
 	"github.com/carlmjohnson/versioninfo"
+	"github.com/gorilla/mux"
 	"github.com/pyros2097/gromer/assets"
 	. "github.com/pyros2097/gromer/handlebars"
 )
-func ApiExplorer(ctx context.Context) (HtmlContent, int, error) {
+func ApiExplorerRoute(router *mux.Router, path string) {
+	router.Path(path).Methods("GET").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-	cmcss, _ := assets.FS.ReadFile("css/codemirror@5.63.1.css")
+		cmcss, _ := assets.FS.ReadFile("css/codemirror@5.63.1.css")
-	stylescss, _ := assets.FS.ReadFile("css/styles.css")
+		stylescss, _ := assets.FS.ReadFile("css/styles.css")
-	cmjs, _ := assets.FS.ReadFile("js/codemirror@5.63.1.min.js")
+		cmjs, _ := assets.FS.ReadFile("js/codemirror@5.63.1.min.js")
-	cmjsjs, _ := assets.FS.ReadFile("js/codemirror-javascript@5.63.1.js")
+		cmjsjs, _ := assets.FS.ReadFile("js/codemirror-javascript@5.63.1.js")
-	apiRoutes := []RouteDefinition{}
+		apiRoutes := []RouteDefinition{}
-	for _, v := range RouteDefs {
+		for _, v := range RouteDefs {
-		if strings.Contains(v.Path, "/api/") {
+			if strings.Contains(v.Path, "/api/") {
-			apiRoutes = append(apiRoutes, v)
+				apiRoutes = append(apiRoutes, v)
+			}
 		}
+		apiData, err := json.Marshal(apiRoutes)
+		if err != nil {
+			RespondError(w, 500, err)
-	}
+		}
-	apiData, err := json.Marshal(apiRoutes)
-	if err != nil {
-		return HtmlErr(400, err)
-	}
-	return Html(`
+		status, err := Html(`
 		<!DOCTYPE html>
 		<html lang="en">
 			<head>
@@ -260,10 +262,14 @@ func ApiExplorer(ctx context.Context) (HtmlContent, int, error) {
 			</body>
 		</html>
 	`).Props(
-		"commit", versioninfo.Revision[0:7],
+			"commit", versioninfo.Revision[0:7],
-		"routes", apiRoutes,
+			"routes", apiRoutes,
-		"apiData", template.HTML(string(apiData)),
+			"apiData", template.HTML(string(apiData)),
-		"css", template.HTML(string(cmcss)+"\n\n"+string(stylescss)),
+			"css", template.HTML(string(cmcss)+"\n\n"+string(stylescss)),
-		"js", template.HTML(string(cmjs)+"\n\n"+string(cmjsjs)),
+			"js", template.HTML(string(cmjs)+"\n\n"+string(cmjsjs)),
-	).Render()
+		).RenderWriter(w)
+		if err != nil {
+			RespondError(w, status, err)
+		}
+	})
 }

cmd/gromer/main.go CHANGED Viewed

@@ -195,25 +195,29 @@ func init() {
 func main() {
 	port := os.Getenv("PORT")
-	r := mux.NewRouter()
+	baseRouter := mux.NewRouter()
-	r.Use(gromer.LogMiddleware)
+	baseRouter.Use(gromer.LogMiddleware)
 	{{#if notFoundPkg}}
-	r.NotFoundHandler = gromer.StatusHandler({{ notFoundPkg }}.GET)
+	baseRouter.NotFoundHandler = gromer.StatusHandler({{ notFoundPkg }}.GET)
 	{{/if}}
+	staticRouter := baseRouter.NewRoute().Subrouter()
+	staticRouter.Use(gromer.CacheMiddleware)
-	gromer.Static(r, "/assets/", assets.FS)
+	gromer.StaticRoute(staticRouter, "/assets/", assets.FS)
-	gromer.Handle(r, "GET", "/styles.css", gromer.Styles)
+	gromer.StylesRoute(staticRouter, "/styles.css")
+	pageRouter := baseRouter.NewRoute().Subrouter()
-	gromer.Handle(r, "GET", "/api", gromer.ApiExplorer)
+	gromer.ApiExplorerRoute(pageRouter, "/explorer")
-	{{#each pageRoutes as |route| }}gromer.Handle(r, "{{ route.Method }}", "{{ route.Path }}", {{ route.Pkg }}.{{ route.Method }})
+	{{#each pageRoutes as |route| }}gromer.Handle(pageRouter, "{{ route.Method }}", "{{ route.Path }}", {{ route.Pkg }}.{{ route.Method }})
 	{{/each}}
-	apiRouter := r.NewRoute().Subrouter()
+	apiRouter := baseRouter.NewRoute().Subrouter()
 	apiRouter.Use(gromer.CorsMiddleware)
 	{{#each apiRoutes as |route| }}gromer.Handle(apiRouter, "{{ route.Method }}", "{{ route.Path }}", {{ route.Pkg }}.{{ route.Method }})
 	{{/each}}
 	log.Info().Msg("http server listening on http://localhost:"+port)
-	srv := server.New(r, nil)
+	srv := server.New(baseRouter, nil)
 	if err := srv.ListenAndServe(":"+port); err != nil {
 		log.Fatal().Stack().Err(err).Msg("failed to listen")
 	}

handlebars/template.go CHANGED Viewed

@@ -2,6 +2,8 @@ package handlebars
 import (
 	"fmt"
+	"io"
+	"net/http"
 	"github.com/aymerick/raymond/ast"
 	"github.com/aymerick/raymond/parser"
@@ -73,6 +75,18 @@ func (t *Template) Render() (HtmlContent, int, error) {
 	return t.RenderWithStatus(200)
 }
+func (t *Template) RenderWriter(w io.Writer) (int, error) {
+	s, status, err := t.Render()
+	if err != nil {
+		return status, err
+	}
+	if v, ok := w.(http.ResponseWriter); ok {
+		v.WriteHeader(status)
+	}
+	w.Write([]byte(s))
+	return 200, nil
+}
 func (t *Template) Prop(key string, v any) *Template {
 	t.Context.Set(key, v)
 	return t

http.go CHANGED Viewed

@@ -269,6 +269,7 @@ func headerSize(h http.Header) int64 {
 type LogResponseWriter struct {
 	http.ResponseWriter
+	startTime             time.Time
 	responseStatusCode    int
 	responseContentLength int
 	responseHeaderSize    int
@@ -276,7 +277,7 @@ type LogResponseWriter struct {
 }
 func NewLogResponseWriter(w http.ResponseWriter) *LogResponseWriter {
-	return &LogResponseWriter{ResponseWriter: w}
+	return &LogResponseWriter{ResponseWriter: w, startTime: time.Now()}
 }
 func (w *LogResponseWriter) WriteHeader(code int) {
@@ -294,51 +295,54 @@ func (w *LogResponseWriter) SetError(err error) {
 	w.err = err
 }
+func (w *LogResponseWriter) LogRequest(r *http.Request) {
+	ip, _, _ := net.SplitHostPort(r.RemoteAddr)
+	if len(ip) > 0 && ip[0] == '[' {
+		ip = ip[1 : len(ip)-1]
+	}
+	logger := log.WithLevel(zerolog.InfoLevel)
+	if w.err != nil {
+		stack := string(debug.Stack())
+		logger = log.WithLevel(zerolog.ErrorLevel).Err(w.err).Str("stack", stack).Stack()
+	}
+	ua := useragent.Parse(r.UserAgent())
+	logger.Msgf("%s %d %.2f KB %s %s %s", r.Method,
+		w.responseStatusCode,
+		float32(w.responseContentLength)/1024.0,
+		time.Since(w.startTime).Round(time.Millisecond).String(), ua.Name, r.URL.Path)
+	// logger.
+	// 	Str("method", r.Method).
+	// 	Str("url", r.URL.String()).
+	// 	Int("header_size", int(headerSize(r.Header))).
+	// 	Int64("body_size", r.ContentLength).
+	// 	Str("host", r.Host).
+	// 	// Str("agent", r.UserAgent()).
+	// 	Str("referer", r.Referer()).
+	// 	Str("proto", r.Proto).
+	// 	Str("remote_ip", ip).
+	// 	Int("status", logRespWriter.responseStatusCode).
+	// 	Int("resp_header_size", logRespWriter.responseHeaderSize).
+	// 	Int("resp_body_size", logRespWriter.responseContentLength).
+	// 	Str("latency", time.Since(startTime).String()).
+	// 	Msgf("")
+}
-var LogMiddleware = mux.MiddlewareFunc(func(next http.Handler) http.Handler {
+func LogMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		logRespWriter := NewLogResponseWriter(w)
 		defer func() {
 			if err := recover(); err != nil {
-				stack := string(debug.Stack())
-				RespondError(w, 599, fmt.Errorf("panic: %+v\n %s", err, stack))
+				RespondError(logRespWriter, 599, fmt.Errorf("%+v", err))
+				logRespWriter.LogRequest(r)
 			}
 		}()
-		startTime := time.Now()
-		logRespWriter := NewLogResponseWriter(w)
 		next.ServeHTTP(logRespWriter, r)
 		if IsCloundRun {
 			return
 		}
-		ip, _, _ := net.SplitHostPort(r.RemoteAddr)
-		if len(ip) > 0 && ip[0] == '[' {
-			ip = ip[1 : len(ip)-1]
-		}
-		logger := log.WithLevel(zerolog.InfoLevel)
-		if logRespWriter.err != nil {
-			logger = log.WithLevel(zerolog.ErrorLevel).Err(logRespWriter.err).Stack()
-		}
-		ua := useragent.Parse(r.UserAgent())
-		logger.Msgf("%s %d %.2f KB %s %s %s", r.Method,
-			logRespWriter.responseStatusCode,
+		logRespWriter.LogRequest(r)
-			float32(logRespWriter.responseContentLength)/1024.0,
-			time.Since(startTime).Round(time.Millisecond).String(), ua.Name, r.URL.Path)
-		// logger.
-		// 	Str("method", r.Method).
-		// 	Str("url", r.URL.String()).
-		// 	Int("header_size", int(headerSize(r.Header))).
-		// 	Int64("body_size", r.ContentLength).
-		// 	Str("host", r.Host).
-		// 	// Str("agent", r.UserAgent()).
-		// 	Str("referer", r.Referer()).
-		// 	Str("proto", r.Proto).
-		// 	Str("remote_ip", ip).
-		// 	Int("status", logRespWriter.responseStatusCode).
-		// 	Int("resp_header_size", logRespWriter.responseHeaderSize).
-		// 	Int("resp_body_size", logRespWriter.responseContentLength).
-		// 	Str("latency", time.Since(startTime).String()).
-		// 	Msgf("")
 	})
-})
+}
 func CorsMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -353,6 +357,13 @@ func CorsMiddleware(next http.Handler) http.Handler {
 	})
 }
+func CacheMiddleware(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Cache-Control", "public, max-age=2592000") // perma cache for 1 month
+		next.ServeHTTP(w, r)
+	})
+}
 func StatusHandler(h interface{}) http.Handler {
 	return LogMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		ctx := context.WithValue(context.WithValue(r.Context(), "url", r.URL), "header", r.Header)
@@ -366,21 +377,22 @@ func StatusHandler(h interface{}) http.Handler {
 		}
 		w.Header().Set("Content-Type", "text/html")
-		// This has to be at end always
+		// This has to be at end always after headers are set
 		w.WriteHeader(responseStatus)
 		w.Write([]byte(response.(handlebars.HtmlContent)))
 	})).(http.Handler)
 }
-func WrapCache(h http.Handler) http.Handler {
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+func StaticRoute(router *mux.Router, path string, fs embed.FS) {
-		w.Header().Set("Cache-Control", "public, max-age=2592000") // perma cache for 1 month
+	router.Path(path).Methods("GET").Handler(http.StripPrefix(path, http.FileServer(http.FS(fs))))
-		h.ServeHTTP(w, r)
-	})
 }
-func Static(router *mux.Router, path string, fs embed.FS) {
+func StylesRoute(router *mux.Router, path string) {
-	router.PathPrefix(path).Handler(http.StripPrefix(path, WrapCache(http.FileServer(http.FS(fs)))))
+	router.Path(path).Methods("GET").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "text/css")
+		w.WriteHeader(200)
+		w.Write([]byte(handlebars.GetStyles()))
+	})
 }
 func Handle(router *mux.Router, method, route string, h interface{}) {
@@ -391,10 +403,6 @@ func Handle(router *mux.Router, method, route string, h interface{}) {
 	}).Methods(method, "OPTIONS")
 }
-func Styles(c context.Context) (handlebars.CssContent, int, error) {
-	return handlebars.GetStyles(), 200, nil
-}
 func GetUrl(ctx context.Context) *url.URL {
 	return ctx.Value("url").(*url.URL)
 }

~repos /gromer

git clone https://pyrossh.dev/repos/gromer.git

gromer is a framework and cli to build multipage web apps in golang using htmx and alpinejs.

tag: v0.18.1

v0.18.1