rework template rendering, cache parsed templates

adapt error wrapping principle
This commit is contained in:
Johannes 2022-09-24 15:01:33 +02:00
parent 7a1448d6f9
commit f04396809d
21 changed files with 175 additions and 82 deletions

View file

@ -7,6 +7,7 @@ import (
"net/mail"
"officeHours/config"
"officeHours/models"
"officeHours/templating"
"strconv"
"strings"
)
@ -149,7 +150,7 @@ func (b *BaseHandler) AddOfficeHourHandler(w http.ResponseWriter, req *http.Requ
id, err := b.officeHourRepo.Add(officeHour)
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
b.serveTemplate(w, "addFailure", err)
templating.ServeTemplate(w, "addFailure", err)
return
}
officeHour, err = b.officeHourRepo.FindById(id)
@ -160,7 +161,7 @@ func (b *BaseHandler) AddOfficeHourHandler(w http.ResponseWriter, req *http.Requ
if err != nil {
log.Printf("Error adding request: %s", err.Error())
}
b.serveTemplate(w, "addSuccess", nil)
templating.ServeTemplate(w, "addSuccess", nil)
}
}
@ -172,5 +173,5 @@ func (b *BaseHandler) writeAddOfficeHourMask(w http.ResponseWriter, req *http.Re
if len(data.Errors) != 0 {
w.WriteHeader(http.StatusBadRequest)
}
b.serveTemplate(w, "addMask", data)
templating.ServeTemplate(w, "addMask", data)
}

View file

@ -2,6 +2,7 @@ package controllers
import (
"net/http"
"officeHours/templating"
)
func (b *BaseHandler) ConfirmRequestHandler(w http.ResponseWriter, req *http.Request) {
@ -10,16 +11,16 @@ func (b *BaseHandler) ConfirmRequestHandler(w http.ResponseWriter, req *http.Req
if err != nil {
// TODO: header 404
b.serveTemplate(w, "requestNotFound", nil)
templating.ServeTemplate(w, "requestNotFound", nil)
return
}
err = b.requestRepo.Execute(request)
if err != nil {
// TODO: write header 500
b.serveTemplate(w, "executeFailure", err.Error())
templating.ServeTemplate(w, "executeFailure", err.Error())
return
}
b.serveTemplate(w, "executeSuccess", nil)
templating.ServeTemplate(w, "executeSuccess", nil)
}

View file

@ -4,10 +4,13 @@ package controllers
import (
"net/http"
"officeHours/models"
"officeHours/templating"
"strconv"
)
func (b *BaseHandler) DeleteOfficeHourHandler(w http.ResponseWriter, req *http.Request) {
// TODO: error handling here is by no means sufficient, furthermore
// 400 BadRequest is for technically wrong stuff (most promimently GET instead of POST)
if req.FormValue("id") != "" {
id, err := strconv.Atoi(req.FormValue("id"))
if err != nil {
@ -18,7 +21,7 @@ func (b *BaseHandler) DeleteOfficeHourHandler(w http.ResponseWriter, req *http.R
w.WriteHeader(http.StatusBadRequest)
}
_, err = b.requestRepo.Add(officeHour, models.RequestDelete)
b.serveTemplate(w, "deleteSuccess", nil)
templating.ServeTemplate(w, "deleteSuccess", nil)
} else {
officeHours, _ := b.officeHourRepo.GetAll(true)
timetable, slots := b.GetTimetable(officeHours)

View file

@ -5,6 +5,7 @@ import (
"log"
"net/http"
"officeHours/models"
"officeHours/templating"
"strconv"
)
@ -58,5 +59,5 @@ func (b *BaseHandler) writeTimetablePage(w http.ResponseWriter, req *http.Reques
SelectedRoom int
SelectedCourse int
}{courses, rooms, timetable, selectedRoom, selectedCourse}
b.serveTemplate(w, "index", data)
templating.ServeTemplate(w, "index", data)
}

View file

@ -1,60 +0,0 @@
package controllers
import (
"fmt"
"html/template"
"log"
"net/http"
"officeHours/models"
"os"
)
var funcs = template.FuncMap{
"DayName": models.DayName,
"divide": func(i int, j int) int { return i / j },
}
var baseTemplate = template.Must(template.ParseFiles("templates/base.html")).New("base.html").Funcs(funcs)
// Execute a rendered full HTML page.
//
// If you just want to fill a template snippet, use the RawTemplates object.
//
// Parameters:
// - name is the name of the template file inside templates/, without .html suffix.
// - data is passed through to the template
func (b *BaseHandler) serveTemplate(w http.ResponseWriter, name string, data any) {
full_name := "templates/" + name + ".html"
// check that template exists
info, err := os.Stat(full_name)
if (err != nil && os.IsNotExist(err)) || info.IsDir() {
errMsg := fmt.Sprintf("Template %s nicht gefunden", full_name)
log.Println(errMsg)
w.WriteHeader(http.StatusNotFound)
w.Write([]byte(errMsg))
return
}
tmpl, err := baseTemplate.ParseFiles(full_name)
if err != nil {
errMsg := fmt.Sprintf("Template %s konnte nicht geparst werden : %s", full_name, err.Error())
log.Println(errMsg)
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte(errMsg))
return
}
// TODO: cache templates in parsed state, but not executed
err = template.Must(tmpl.Clone()).Execute(w, data)
if err != nil {
errMsg := fmt.Sprintf("Template %s konnte nicht ausgeführt werden : %s", full_name, err.Error())
log.Println(errMsg)
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte(errMsg))
return
}
}
// standalone templates that should not be wrapped into the base.html
var RawTemplates, TemplateError = template.New("").Funcs(funcs).ParseFiles(
"templates/confirmationMail",
"templates/td.html",
"templates/officeHourTable.html")

View file

@ -7,6 +7,7 @@ import (
"html/template"
"log"
"officeHours/models"
"officeHours/templating"
)
func (b *BaseHandler) GetTimetable(officeHours []models.OfficeHour) (timetable map[models.Date]map[int]models.OfficeHour, slots []int) {
@ -85,9 +86,11 @@ func (b *BaseHandler) printTimetable(timetable map[models.Date]map[int]models.Of
MinuteGranularity int
DeleteIcons bool
}{OfficeHour: current, MinuteGranularity: b.config.Date.MinuteGranularity, DeleteIcons: deleteIcons}
templateError := RawTemplates.ExecuteTemplate(&celldata, "td.html", data)
if templateError != nil {
log.Printf("Error executing template td.html: %s", templateError.Error())
err := templating.WriteTemplate(&celldata, "td", data)
if err != nil {
err = fmt.Errorf("writing table cell failed:\n%w", err)
log.Println(err.Error())
// TODO: better error wrapping up to top-level request handler
}
tableBody += celldata.String()
}
@ -120,9 +123,11 @@ func (b *BaseHandler) printTimetable(timetable map[models.Date]map[int]models.Of
slots[4],
template.HTML(tableBody),
}
templateError := RawTemplates.ExecuteTemplate(&table, "officeHourTable.html", tableData)
if templateError != nil {
log.Printf("Error executing template officeHourTable.html: %s", templateError.Error())
err := templating.WriteTemplate(&table, "officeHourTable", tableData)
if err != nil {
err = fmt.Errorf("writing table failed:\n%w", err)
log.Println(err.Error())
// TODO: better error wrapping up to top-level request handler
}
return template.HTML(table.String())
}