From eb0c264ad7a2ae7f61e75a6ac5382ef05e5df582 Mon Sep 17 00:00:00 2001 From: Maximilian Friedersdorff Date: Fri, 27 Jun 2025 20:46:52 +0100 Subject: [PATCH] Add doc comments --- internal/middleware/etag_cache.go | 3 ++- internal/middleware/logger.go | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/internal/middleware/etag_cache.go b/internal/middleware/etag_cache.go index d1878c2..47a27a2 100644 --- a/internal/middleware/etag_cache.go +++ b/internal/middleware/etag_cache.go @@ -1,3 +1,4 @@ +// Middleware to add naive caching headers package middleware import ( @@ -15,7 +16,7 @@ type ETag struct { } func (etag *ETag) Header() string { - return fmt.Sprintf("\"pb-%s-%s\"", etag.Name, etag.Value) + return fmt.Sprintf("\"gn-%s-%s\"", etag.Name, etag.Value) } func (etag *ETag) CacheControlHeader() string { diff --git a/internal/middleware/logger.go b/internal/middleware/logger.go index fe7f253..b8c279a 100644 --- a/internal/middleware/logger.go +++ b/internal/middleware/logger.go @@ -1,3 +1,4 @@ +// Middleware to Log out requests and response status code package middleware import ( @@ -7,6 +8,7 @@ import ( "forgejo.gwairfelin.com/max/gonotes/internal/conf" ) +// Response writer that store the status code for logging type loggingResponseWriter struct { http.ResponseWriter statusCode int @@ -21,6 +23,7 @@ func (w *loggingResponseWriter) WriteHeader(code int) { w.ResponseWriter.WriteHeader(code) } +// Middleware to log out requests and response status code func LoggingMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { lwr := NewLoggingResponseWriter(w)