chore(appliance): extract layout template (#63467)

Craig Furman · web-flow · commit 1c90d9182281 · 2024-06-25T15:34:46.000+01:00
To avoid duplication of common elements from page to page. In preparation for introducing some more pages, it made sense to extract a layout. Relates to https://linear.app/sourcegraph/issue/REL-20/maintenance-ui-admin-must-configure-initial-password-on-first-boot but does not close it.
diff --git a/internal/appliance/BUILD.bazel b/internal/appliance/BUILD.bazel
@@ -18,6 +18,7 @@ go_library(
         "web/static/css/bootstrap.min.css",
         "web/static/css/custom.css",
         "web/static/script/bootstrap.bundle.min.js",
+        "web/template/layout.gohtml",
     ],
     importpath = "github.com/sourcegraph/sourcegraph/internal/appliance",
     visibility = ["//:__subpackages__"],
diff --git a/internal/appliance/html.go b/internal/appliance/html.go
@@ -4,27 +4,25 @@ import (
 	"context"
 	"fmt"
 	"html/template"
+	"io"
 	"net/http"
+	"path/filepath"
 
 	"github.com/life4/genesis/slices"
 
 	"github.com/sourcegraph/log"
 
 	"github.com/sourcegraph/sourcegraph/internal/appliance/config"
 	"github.com/sourcegraph/sourcegraph/internal/releaseregistry"
+	"github.com/sourcegraph/sourcegraph/lib/errors"
 )
 
 const (
-	templateSetup = "web/template/setup.gohtml"
-	formValueOn   = "on"
+	formValueOn = "on"
 )
 
-var (
-	setupTmpl *template.Template
-)
-
-func init() {
-	setupTmpl = template.Must(template.ParseFS(templateFS, templateSetup))
+func templatePath(name string) string {
+	return filepath.Join("web", "template", name+".gohtml")
 }
 
 func (a *Appliance) applianceHandler(w http.ResponseWriter, r *http.Request) {
@@ -33,6 +31,14 @@ func (a *Appliance) applianceHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+func renderTemplate(name string, w io.Writer, data any) error {
+	tmpl, err := template.ParseFS(templateFS, templatePath("layout"), templatePath(name))
+	if err != nil {
+		return errors.Wrapf(err, "rendering template: %s", name)
+	}
+	return tmpl.Execute(w, data)
+}
+
 func (a *Appliance) getSetupHandler(w http.ResponseWriter, r *http.Request) {
 	versions, err := a.getVersions(r.Context())
 	if err != nil {
@@ -45,7 +51,7 @@ func (a *Appliance) getSetupHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	err = setupTmpl.Execute(w, struct {
+	err = renderTemplate("setup", w, struct {
 		Versions []string
 	}{
 		Versions: versions,
diff --git a/internal/appliance/web/template/layout.gohtml b/internal/appliance/web/template/layout.gohtml
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="icon" type="image/svg+xml" href="/static/img/favicon.png" />
+    <link rel="stylesheet" type="text/css" href="/static/css/bootstrap.min.css">
+    <link rel="stylesheet" type="text/css" href="/static/css/custom.css">
+    <script src="/static/script/htmx.min.js"></script>
+    <script src="/static/script/bootstrap.bundle.min.js"></script>
+    <title>{{ block "title" . }}{{ end }}</title>
+</head>
+
+<body hx-boost="true" class="container">
+{{ block "content" . }}{{ end }}
+</body>
+</html>
diff --git a/internal/appliance/web/template/setup.gohtml b/internal/appliance/web/template/setup.gohtml
@@ -1,17 +1,8 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <link rel="icon" type="image/svg+xml" href="/static/img/favicon.png" />
-    <link rel="stylesheet" type="text/css" href="/static/css/bootstrap.min.css">
-    <link rel="stylesheet" type="text/css" href="/static/css/custom.css">
-    <script src="/static/script/htmx.min.js"></script>
-    <script src="/static/script/bootstrap.bundle.min.js"></script>
-    <title>Sourcegraph Appliance - Setup</title>
-</head>
+{{ template "layout.gohtml" }}
 
-<body hx-boost="true" class="container">
+{{ define "title" }}Sourcegraph Appliance - Setup{{ end }}
+
+{{- define "content" }}
 <h1>Sourcegraph Appliance Setup</h1>
 
 <form action="/appliance/setup" method="post">
@@ -155,6 +146,4 @@
     </div>
     <button type="submit" class="btn btn-primary">Start Setup</button>
 </form>
-
-</body>
-</html>
+{{- end }}
