Skip to content

Commit

Permalink
UI etag embedded content
Browse files Browse the repository at this point in the history
Scan embedded content on startup and serve etag header to FileServer.
FileServer will use the Etag and provide no content change if needed.

This will allow cache all static resources, which allow better
performance after the first load, in the web ui.
  • Loading branch information
nopcoder committed Dec 9, 2023
1 parent 17a5305 commit eb83523
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 3 deletions.
77 changes: 77 additions & 0 deletions pkg/api/etag_middleware.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
package api

import (
"crypto/md5"

Check failure on line 4 in pkg/api/etag_middleware.go

View workflow job for this annotation

GitHub Actions / Run Linters and Checkers

G501: Blocklisted import crypto/md5: weak cryptographic primitive (gosec)
"encoding/hex"
"io"
"io/fs"
"net/http"
"path"
"strings"
)

// EtagMiddleware returns a new Etag middleware handler.
// It designs to work on embedded FS, where the content doesn't change.
// It calculates the Etag for each file on startup and serves it on each request.
func EtagMiddleware(root fs.FS, next http.Handler) http.Handler {
etags, err := scanFSEtags(root)
if err != nil {
panic(err)
}
return &etagHandler{
root: root,
next: next,
etags: etags,
}
}

type etagHandler struct {
root fs.FS
next http.Handler
etags map[string]string
}

func (e *etagHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
upath := r.URL.Path
if !strings.HasPrefix(upath, "/") {
upath = "/" + upath
}
upath = path.Clean(upath)
if strings.HasSuffix(upath, "/") {
upath += "index.html"
}
etag, ok := e.etags[upath]
if ok {
w.Header().Set("Etag", "\""+etag+"\"")
}
e.next.ServeHTTP(w, r)
}

func scanFSEtags(fSys fs.FS) (map[string]string, error) {
etags := make(map[string]string)
err := fs.WalkDir(fSys, ".", func(fpath string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
if d.IsDir() {
return nil
}

f, err := fSys.Open(fpath)
if err != nil {
return err
}
defer func() { _ = f.Close() }()

h := md5.New()

Check failure on line 66 in pkg/api/etag_middleware.go

View workflow job for this annotation

GitHub Actions / Run Linters and Checkers

G401: Use of weak cryptographic primitive (gosec)
if _, err := io.Copy(h, f); err != nil {
return err
}
etags["/"+fpath] = hex.EncodeToString(h.Sum(nil))
return nil
})
if err != nil {
return nil, err
}
return etags, nil
}
5 changes: 2 additions & 3 deletions pkg/api/ui_handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"strings"

gomime "github.com/cubewise-code/go-mime"
"github.com/go-chi/chi/v5/middleware"
"github.com/treeverse/lakefs/pkg/api/params"
gwerrors "github.com/treeverse/lakefs/pkg/gateway/errors"
"github.com/treeverse/lakefs/pkg/gateway/operations"
Expand All @@ -34,7 +33,7 @@ func NewUIHandler(gatewayDomains []string, snippets []params.CodeSnippet) http.H
panic(err)
}
fileSystem := http.FS(injectedContent)
nocacheContent := middleware.NoCache(http.StripPrefix("/", http.FileServer(fileSystem)))
nocacheContent := EtagMiddleware(injectedContent, http.StripPrefix("/", http.FileServer(fileSystem)))
return NewHandlerWithDefault(fileSystem, nocacheContent, gatewayDomains)
}

Expand All @@ -45,7 +44,7 @@ func NewS3GatewayEndpointErrorHandler(gatewayDomains []string) http.Handler {
return
}

// For other requests, return generic not found error
// For other requests, return generic "not found" error
w.WriteHeader(http.StatusNotFound)
})
}
Expand Down

0 comments on commit eb83523

Please sign in to comment.