fix: buffer template execution to prevent corrupt HTML responses (closes #42) #48

Merged
sneak merged 2 commits from :fix/template-execution-buffering into main 2026-02-16 07:05:45 +01:00
6 changed files with 111 additions and 42 deletions

View File

@ -32,11 +32,7 @@ func (h *Handlers) HandleAppNew() http.HandlerFunc {
return func(writer http.ResponseWriter, request *http.Request) { return func(writer http.ResponseWriter, request *http.Request) {
data := h.addGlobals(map[string]any{}, request) data := h.addGlobals(map[string]any{}, request)
err := tmpl.ExecuteTemplate(writer, "app_new.html", data) h.renderTemplate(writer, tmpl, "app_new.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }
@ -66,7 +62,7 @@ func (h *Handlers) HandleAppCreate() http.HandlerFunc {
if name == "" || repoURL == "" { if name == "" || repoURL == "" {
data["Error"] = "Name and repository URL are required" data["Error"] = "Name and repository URL are required"
_ = tmpl.ExecuteTemplate(writer, "app_new.html", data) h.renderTemplate(writer, tmpl, "app_new.html", data)
return return
} }
@ -91,7 +87,7 @@ func (h *Handlers) HandleAppCreate() http.HandlerFunc {
if createErr != nil { if createErr != nil {
h.log.Error("failed to create app", "error", createErr) h.log.Error("failed to create app", "error", createErr)
data["Error"] = "Failed to create app: " + createErr.Error() data["Error"] = "Failed to create app: " + createErr.Error()
_ = tmpl.ExecuteTemplate(writer, "app_new.html", data) h.renderTemplate(writer, tmpl, "app_new.html", data)
return return
} }
@ -152,11 +148,7 @@ func (h *Handlers) HandleAppDetail() http.HandlerFunc {
"Success": request.URL.Query().Get("success"), "Success": request.URL.Query().Get("success"),
}, request) }, request)
err := tmpl.ExecuteTemplate(writer, "app_detail.html", data) h.renderTemplate(writer, tmpl, "app_detail.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }
@ -185,11 +177,7 @@ func (h *Handlers) HandleAppEdit() http.HandlerFunc {
"App": application, "App": application,
}, request) }, request)
err := tmpl.ExecuteTemplate(writer, "app_edit.html", data) h.renderTemplate(writer, tmpl, "app_edit.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }
@ -245,7 +233,7 @@ func (h *Handlers) HandleAppUpdate() http.HandlerFunc {
"App": application, "App": application,
"Error": "Failed to update app", "Error": "Failed to update app",
}, request) }, request)
_ = tmpl.ExecuteTemplate(writer, "app_edit.html", data) h.renderTemplate(writer, tmpl, "app_edit.html", data)
return return
} }
@ -369,11 +357,7 @@ func (h *Handlers) HandleAppDeployments() http.HandlerFunc {
"Deployments": deployments, "Deployments": deployments,
}, request) }, request)
err := tmpl.ExecuteTemplate(writer, "deployments.html", data) h.renderTemplate(writer, tmpl, "deployments.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }

View File

@ -13,11 +13,7 @@ func (h *Handlers) HandleLoginGET() http.HandlerFunc {
return func(writer http.ResponseWriter, request *http.Request) { return func(writer http.ResponseWriter, request *http.Request) {
data := h.addGlobals(map[string]any{}, request) data := h.addGlobals(map[string]any{}, request)
err := tmpl.ExecuteTemplate(writer, "login.html", data) h.renderTemplate(writer, tmpl, "login.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }
@ -42,7 +38,7 @@ func (h *Handlers) HandleLoginPOST() http.HandlerFunc {
if username == "" || password == "" { if username == "" || password == "" {
data["Error"] = "Username and password are required" data["Error"] = "Username and password are required"
_ = tmpl.ExecuteTemplate(writer, "login.html", data) h.renderTemplate(writer, tmpl, "login.html", data)
return return
} }
@ -50,7 +46,7 @@ func (h *Handlers) HandleLoginPOST() http.HandlerFunc {
user, authErr := h.auth.Authenticate(request.Context(), username, password) user, authErr := h.auth.Authenticate(request.Context(), username, password)
if authErr != nil { if authErr != nil {
data["Error"] = "Invalid username or password" data["Error"] = "Invalid username or password"
_ = tmpl.ExecuteTemplate(writer, "login.html", data) h.renderTemplate(writer, tmpl, "login.html", data)
return return
} }
@ -60,7 +56,7 @@ func (h *Handlers) HandleLoginPOST() http.HandlerFunc {
h.log.Error("failed to create session", "error", sessionErr) h.log.Error("failed to create session", "error", sessionErr)
data["Error"] = "Failed to create session" data["Error"] = "Failed to create session"
_ = tmpl.ExecuteTemplate(writer, "login.html", data) h.renderTemplate(writer, tmpl, "login.html", data)
return return
} }

View File

@ -69,10 +69,6 @@ func (h *Handlers) HandleDashboard() http.HandlerFunc {
"AppStats": appStats, "AppStats": appStats,
}, request) }, request)
execErr := tmpl.ExecuteTemplate(writer, "dashboard.html", data) h.renderTemplate(writer, tmpl, "dashboard.html", data)
if execErr != nil {
h.log.Error("template execution failed", "error", execErr)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }

View File

@ -2,6 +2,7 @@
package handlers package handlers
import ( import (
"bytes"
"encoding/json" "encoding/json"
"log/slog" "log/slog"
"net/http" "net/http"
@ -18,6 +19,7 @@ import (
"git.eeqj.de/sneak/upaas/internal/service/auth" "git.eeqj.de/sneak/upaas/internal/service/auth"
"git.eeqj.de/sneak/upaas/internal/service/deploy" "git.eeqj.de/sneak/upaas/internal/service/deploy"
"git.eeqj.de/sneak/upaas/internal/service/webhook" "git.eeqj.de/sneak/upaas/internal/service/webhook"
"git.eeqj.de/sneak/upaas/templates"
) )
// Params contains dependencies for Handlers. // Params contains dependencies for Handlers.
@ -80,6 +82,28 @@ func (h *Handlers) addGlobals(
return data return data
} }
// renderTemplate executes the named template into a buffer first, then writes
// to the ResponseWriter only on success. This prevents partial/corrupt HTML
// responses when template execution fails partway through.
func (h *Handlers) renderTemplate(
writer http.ResponseWriter,
tmpl *templates.TemplateExecutor,
name string,
data any,
) {
var buf bytes.Buffer
err := tmpl.ExecuteTemplate(&buf, name, data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
return
}
_, _ = buf.WriteTo(writer)
}
func (h *Handlers) respondJSON( func (h *Handlers) respondJSON(
writer http.ResponseWriter, writer http.ResponseWriter,
_ *http.Request, _ *http.Request,

View File

@ -0,0 +1,73 @@
package handlers_test
import (
"net/http"
"net/http/httptest"
"testing"
"github.com/stretchr/testify/assert"
)
// TestRenderTemplateBuffersOutput verifies that successful template rendering
// produces a complete HTML response (not partial/corrupt).
func TestRenderTemplateBuffersOutput(t *testing.T) {
t.Parallel()
testCtx := setupTestHandlers(t)
// The setup page is simple and has no DB dependencies
request := httptest.NewRequest(http.MethodGet, "/setup", nil)
recorder := httptest.NewRecorder()
handler := testCtx.handlers.HandleSetupGET()
handler.ServeHTTP(recorder, request)
assert.Equal(t, http.StatusOK, recorder.Code)
body := recorder.Body.String()
// A properly buffered response should contain the closing </html> tag,
// proving the full template was rendered before being sent.
assert.Contains(t, body, "</html>")
// Should NOT contain the error text that would be appended on failure
assert.NotContains(t, body, "Internal Server Error")
}
// TestDashboardRenderTemplateBuffersOutput verifies the dashboard handler
// also uses buffered template rendering.
func TestDashboardRenderTemplateBuffersOutput(t *testing.T) {
t.Parallel()
testCtx := setupTestHandlers(t)
request := httptest.NewRequest(http.MethodGet, "/", nil)
recorder := httptest.NewRecorder()
handler := testCtx.handlers.HandleDashboard()
handler.ServeHTTP(recorder, request)
assert.Equal(t, http.StatusOK, recorder.Code)
body := recorder.Body.String()
assert.Contains(t, body, "</html>")
assert.NotContains(t, body, "Internal Server Error")
}
// TestLoginRenderTemplateBuffersOutput verifies the login handler
// uses buffered template rendering.
func TestLoginRenderTemplateBuffersOutput(t *testing.T) {
t.Parallel()
testCtx := setupTestHandlers(t)
request := httptest.NewRequest(http.MethodGet, "/login", nil)
recorder := httptest.NewRecorder()
handler := testCtx.handlers.HandleLoginGET()
handler.ServeHTTP(recorder, request)
assert.Equal(t, http.StatusOK, recorder.Code)
body := recorder.Body.String()
assert.Contains(t, body, "</html>")
assert.NotContains(t, body, "Internal Server Error")
}

View File

@ -18,11 +18,7 @@ func (h *Handlers) HandleSetupGET() http.HandlerFunc {
return func(writer http.ResponseWriter, request *http.Request) { return func(writer http.ResponseWriter, request *http.Request) {
data := h.addGlobals(map[string]any{}, request) data := h.addGlobals(map[string]any{}, request)
err := tmpl.ExecuteTemplate(writer, "setup.html", data) h.renderTemplate(writer, tmpl, "setup.html", data)
if err != nil {
h.log.Error("template execution failed", "error", err)
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
}
} }
} }
@ -62,7 +58,7 @@ func (h *Handlers) renderSetupError(
"Username": username, "Username": username,
"Error": errorMsg, "Error": errorMsg,
}, request) }, request)
_ = tmpl.ExecuteTemplate(writer, "setup.html", data) h.renderTemplate(writer, tmpl, "setup.html", data)
} }
// HandleSetupPOST handles the setup form submission. // HandleSetupPOST handles the setup form submission.