vikunja/vikunja
5
49
Fork 89
Code Issues 132 Pull Requests 32 Packages Releases 37 Activity

feat: cache header and etag generation

Browse Source
This commit is contained in:
kolaente 2024-02-08 22:58:08 +01:00
parent 81455242ae
commit 9c45d9ca15
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
3 changed files with 127 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
go.mod
View File

@ -120,6 +120,7 @@ require (
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/hhsnopek/etag v0.0.0-20171206181245-aea95f647346 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect

2
go.sum
View File

@ -219,6 +219,8 @@ github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mO
github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
github.com/hhsnopek/etag v0.0.0-20171206181245-aea95f647346 h1:Odeq5rB6OZSkib5gqTG+EM1iF0bUVjYYd33XB1ULv00=
github.com/hhsnopek/etag v0.0.0-20171206181245-aea95f647346/go.mod h1:4ggHM2qnyyZjenBb7RpwVzIj+JMsu9kHCVxMjB30hGs=
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
github.com/iancoleman/strcase v0.3.0 h1:nTXanmYxhfFAMjZL34Ov6gkzEsSJZ5DbhxWjvSASxEI=
github.com/iancoleman/strcase v0.3.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=

206
pkg/routes/static.go
View File

@ -1,42 +1,48 @@
package routes
import (
"code.vikunja.io/api/frontend"
"github.com/labstack/echo/v4/middleware"
"bytes"
"errors"
"fmt"
"io"
"mime"
"net/http"
"net/url"
"os"
"path"
"path/filepath"
"strings"
"sync"
"code.vikunja.io/api/frontend"
etaggenerator "github.com/hhsnopek/etag"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
)
func staticWithConfig() echo.MiddlewareFunc {
// Defaults
if config.Root == "" {
config.Root = "." // For security we want to restrict to CWD.
}
if config.Skipper == nil {
config.Skipper = DefaultStaticConfig.Skipper
}
if config.Index == "" {
config.Index = DefaultStaticConfig.Index
}
if config.Filesystem == nil {
config.Filesystem = http.Dir(config.Root)
config.Root = "."
}
const (
indexFile = `index.html`
rootPath = `dist/`
cacheControlMax = `max-age=315360000, public, max-age=31536000, s-maxage=31536000, immutable`
)
// Index template
t, tErr := template.New("index").Parse(html)
if tErr != nil {
panic(fmt.Errorf("echo: %w", tErr))
}
// Because the files are embedded into the final binary, we can be absolutely sure the etag will never change
// and we can cache its generation pretty heavily.
var etagCache map[string]string
var etagLock sync.Mutex
func init() {
etagCache = make(map[string]string)
etagLock = sync.Mutex{}
}
// Copied from echo's middleware.StaticWithConfig simplified and adjusted for caching
func static() echo.MiddlewareFunc {
assetFs := http.FS(frontend.Files)
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) (err error) {
if config.Skipper(c) {
return next(c)
}
p := c.Request().URL.Path
if strings.HasSuffix(c.Path(), "*") { // When serving from a group, e.g. `/static*`.
p = c.Param("*")
@ -45,20 +51,11 @@ func staticWithConfig() echo.MiddlewareFunc {
if err != nil {
return
}
name := path.Join(config.Root, path.Clean("/"+p)) // "/"+ for security
name := path.Join(rootPath, path.Clean("/"+p)) // "/"+ for security
if config.IgnoreBase {
routePath := path.Base(strings.TrimRight(c.Path(), "/*"))
baseURLPath := path.Base(p)
if baseURLPath == routePath {
i := strings.LastIndex(name, routePath)
name = name[:i] + strings.Replace(name[i:], routePath, "", 1)
}
}
file, err := config.Filesystem.Open(name)
file, err := assetFs.Open(name)
if err != nil {
if !isIgnorableOpenFileError(err) {
if !os.IsNotExist(err) {
return err
}
@ -69,11 +66,11 @@ func staticWithConfig() echo.MiddlewareFunc {
}
var he *echo.HTTPError
if !(errors.As(err, &he) && config.HTML5 && he.Code == http.StatusNotFound) {
if !(errors.As(err, &he) && he.Code == http.StatusNotFound) {
return err
}
file, err = config.Filesystem.Open(path.Join(config.Root, config.Index))
file, err = assetFs.Open(path.Join(rootPath, indexFile))
if err != nil {
return err
}
@ -87,12 +84,8 @@ func staticWithConfig() echo.MiddlewareFunc {
}
if info.IsDir() {
index, err := config.Filesystem.Open(path.Join(name, config.Index))
index, err := assetFs.Open(path.Join(name, indexFile))
if err != nil {
if config.Browse {
return listDir(t, name, file, c.Response())
}
return next(c)
}
@ -103,14 +96,97 @@ func staticWithConfig() echo.MiddlewareFunc {
return err
}
return serveFile(c, index, info)
etag, err := generateEtag(index, name)
if err != nil {
return err
}
return serveFile(c, index, info, etag)
}
return serveFile(c, file, info)
etag, err := generateEtag(file, name)
if err != nil {
return err
}
return serveFile(c, file, info, etag)
}
}
}
func generateEtag(file http.File, name string) (etag string, err error) {
etagLock.Lock()
defer etagLock.Unlock()
etag, has := etagCache[name]
if !has {
buf := bytes.Buffer{}
_, err = buf.ReadFrom(file)
if err != nil {
return "", err
}
etag = etaggenerator.Generate(buf.Bytes(), true)
etagCache[name] = etag
}
return etag, nil
}
// copied from http.serveContent
func getMimeType(c echo.Context, name string, file http.File) (mimeType string, err error) {
var ctype string
ctype = c.Response().Header().Get("Content-Type")
if ctype == "" {
ctype = mime.TypeByExtension(filepath.Ext(name))
if ctype == "" {
// read a chunk to decide between utf-8 text and binary
var buf [512]byte
n, _ := io.ReadFull(file, buf[:])
ctype = http.DetectContentType(buf[:n])
_, err := file.Seek(0, io.SeekStart) // rewind to output whole file
if err != nil {
return "", fmt.Errorf("seeker can't seek")
}
}
}
return ctype, nil
}
func serveFile(c echo.Context, file http.File, info os.FileInfo, etag string) error {
c.Response().Header().Set("Server", "Vikunja")
c.Response().Header().Set("Vary", "Accept-Encoding")
c.Response().Header().Set("Etag", etag)
contentType, err := getMimeType(c, info.Name(), file)
if err != nil {
return err
}
var cacheControl = "public, max-age=0, s-maxage=0, must-revalidate"
if strings.HasPrefix(contentType, "image/") ||
strings.HasPrefix(contentType, "font/") ||
strings.HasPrefix(contentType, "~images/") ||
strings.HasPrefix(contentType, "~font/") ||
contentType == "text/css" ||
contentType == "application/javascript" ||
contentType == "text/javascript" ||
contentType == "application/vnd.ms-fontobject" ||
contentType == "application/x-font-ttf" ||
contentType == "font/opentype" ||
contentType == "font/woff2" ||
contentType == "image/svg+xml" ||
contentType == "image/x-icon" ||
contentType == "audio/wav" {
cacheControl = cacheControlMax
}
c.Response().Header().Set("Cache-Control", cacheControl)
http.ServeContent(c.Response(), c.Request(), info.Name(), info.ModTime(), file)
return nil
}
func setupStaticFrontendFilesHandler(e *echo.Echo) {
e.Use(middleware.GzipWithConfig(middleware.GzipConfig{
Level: 6,
@ -120,39 +196,5 @@ func setupStaticFrontendFilesHandler(e *echo.Echo) {
},
}))
e.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
if strings.HasPrefix(c.Path(), "/api/") {
return next(c)
}
c.Response().Header().Set("Server", "Vikunja")
c.Response().Header().Set("Vary", "Accept-Encoding")
// TODO how to get last modified and etag header?
// Cache-Control: https://www.rfc-editor.org/rfc/rfc9111#section-5.2
/*
nginx returns these headers:
--content-encoding: gzip
--content-type: text/html; charset=utf-8
--date: Thu, 08 Feb 2024 15:53:23 GMT
etag: W/"65c39587-bf7"
--last-modified: Wed, 07 Feb 2024 14:36:55 GMT
--server: nginx
--vary: Accept-Encoding
cache-control: public, max-age=0, s-maxage=0, must-revalidate
*/
return next(c)
}
})
e.Use(middleware.StaticWithConfig(middleware.StaticConfig{
Filesystem: http.FS(frontend.Files),
HTML5: true,
Root: "dist/",
}))
e.Use(static())
}