From 6d6856700b0035bfc42f8018235de807ec6ce9b3 Mon Sep 17 00:00:00 2001 From: rramiachraf <51409801+rramiachraf@users.noreply.github.com> Date: Fri, 3 May 2024 14:47:57 +0100 Subject: [PATCH] feat: embed static files into binary --- Dockerfile | 1 - handlers/album_test.go | 2 +- handlers/annotations_test.go | 2 +- handlers/handler.go | 27 ++----------------------- handlers/handler_test.go | 13 ++++++++++++ handlers/instances_test.go | 2 +- handlers/lyrics_test.go | 2 +- handlers/proxy.go | 2 +- handlers/proxy_test.go | 2 +- handlers/search_test.go | 2 +- handlers/static.go | 38 ++++++++++++++++++++++++++++++++++++ main.go | 14 +++++++------ utils/logger.go | 6 ++++++ 13 files changed, 74 insertions(+), 39 deletions(-) create mode 100644 handlers/handler_test.go create mode 100644 handlers/static.go diff --git a/Dockerfile b/Dockerfile index 7a3887f..861844f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,7 +20,6 @@ LABEL org.opencontainers.image.licenses="MIT" LABEL org.opencontainers.image.description="Private alternative front-end for Genius." COPY --from=build /code/dumb . -COPY --from=build /code/static static COPY --from=build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ EXPOSE 5555/tcp diff --git a/handlers/album_test.go b/handlers/album_test.go index 78f1edc..d106368 100644 --- a/handlers/album_test.go +++ b/handlers/album_test.go @@ -22,7 +22,7 @@ func TestAlbum(t *testing.T) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) diff --git a/handlers/annotations_test.go b/handlers/annotations_test.go index 69a913a..4a34d07 100644 --- a/handlers/annotations_test.go +++ b/handlers/annotations_test.go @@ -20,7 +20,7 @@ func TestAnnotations(t *testing.T) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) diff --git a/handlers/handler.go b/handlers/handler.go index 91d8c97..738bf7e 100644 --- a/handlers/handler.go +++ b/handlers/handler.go @@ -2,12 +2,7 @@ package handlers import ( "context" - "io" - "mime" "net/http" - "os" - "path" - "strings" "github.com/a-h/templ" gorillaHandlers "github.com/gorilla/handlers" @@ -16,7 +11,7 @@ import ( "github.com/rramiachraf/dumb/views" ) -func New(logger *utils.Logger) *mux.Router { +func New(logger *utils.Logger, staticFiles static) *mux.Router { r := mux.NewRouter() r.Use(utils.MustHeaders) @@ -31,25 +26,7 @@ func New(logger *utils.Logger) *mux.Router { r.HandleFunc("/search", search(logger)).Methods("GET") r.HandleFunc("/{annotation-id}/{artist-song}/{verse}/annotations", annotations(logger)).Methods("GET") r.HandleFunc("/instances.json", instances(logger)).Methods("GET") - r.PathPrefix("/static/").HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - url := strings.Replace(r.URL.Path, "/static", "static", 1) - f, err := os.Open(url) - if err != nil { - w.WriteHeader(http.StatusNotFound) - views.ErrorPage(http.StatusNotFound, "page not found") - return - } - - defer f.Close() - - mimeType := mime.TypeByExtension(path.Ext(r.URL.Path)) - w.Header().Set("content-type", mimeType) - - if _, err := io.Copy(w, f); err != nil { - logger.Error(err.Error()) - } - - }) + r.PathPrefix("/static/").HandlerFunc(staticAssets(logger, staticFiles)) r.PathPrefix("/{annotation-id}/{artist-song}-lyrics").HandlerFunc(lyrics(logger)).Methods("GET") r.PathPrefix("/{annotation-id}/{artist-song}").HandlerFunc(lyrics(logger)).Methods("GET") r.PathPrefix("/{annotation-id}").HandlerFunc(lyrics(logger)).Methods("GET") diff --git a/handlers/handler_test.go b/handlers/handler_test.go new file mode 100644 index 0000000..878b00f --- /dev/null +++ b/handlers/handler_test.go @@ -0,0 +1,13 @@ +package handlers + +import ( + "io/fs" + "os" + "path" +) + +type assets struct{} + +func (assets) Open(p string) (fs.File, error) { + return os.Open(path.Join("./", p)) +} diff --git a/handlers/instances_test.go b/handlers/instances_test.go index caf41c0..c7ab927 100644 --- a/handlers/instances_test.go +++ b/handlers/instances_test.go @@ -19,7 +19,7 @@ func TestInstancesList(t *testing.T) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) c := rr.Result().Header.Get("content-type") diff --git a/handlers/lyrics_test.go b/handlers/lyrics_test.go index 0f4c010..67a3f5d 100644 --- a/handlers/lyrics_test.go +++ b/handlers/lyrics_test.go @@ -33,7 +33,7 @@ func testLyrics(t *testing.T, url string) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) diff --git a/handlers/proxy.go b/handlers/proxy.go index f56aba6..cec3b11 100644 --- a/handlers/proxy.go +++ b/handlers/proxy.go @@ -53,7 +53,7 @@ func imageProxy(l *utils.Logger) http.HandlerFunc { return } - w.Header().Add("Content-type", mime.TypeByExtension("."+ext)) + w.Header().Set("Content-type", mime.TypeByExtension("."+ext)) w.Header().Add("Cache-Control", "max-age=1296000") if _, err = io.Copy(w, res.Body); err != nil { l.Error("unable to write image, %s", err.Error()) diff --git a/handlers/proxy_test.go b/handlers/proxy_test.go index eb200c5..2c712d6 100644 --- a/handlers/proxy_test.go +++ b/handlers/proxy_test.go @@ -20,7 +20,7 @@ func TestImageProxy(t *testing.T) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) diff --git a/handlers/search_test.go b/handlers/search_test.go index 47db9e4..240310d 100644 --- a/handlers/search_test.go +++ b/handlers/search_test.go @@ -21,7 +21,7 @@ func TestSearch(t *testing.T) { rr := httptest.NewRecorder() l := utils.NewLogger(os.Stdout) - m := New(l) + m := New(l, &assets{}) m.ServeHTTP(rr, r) diff --git a/handlers/static.go b/handlers/static.go new file mode 100644 index 0000000..f420717 --- /dev/null +++ b/handlers/static.go @@ -0,0 +1,38 @@ +package handlers + +import ( + "io" + "io/fs" + "mime" + "net/http" + "path" + "strings" + + "github.com/rramiachraf/dumb/utils" + "github.com/rramiachraf/dumb/views" +) + +type static interface { + Open(string) (fs.File, error) +} + +func staticAssets(logger *utils.Logger, embededFiles static) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + url := strings.Replace(r.URL.Path, "/static", "static", 1) + f, err := embededFiles.Open(url) + if err != nil { + w.WriteHeader(http.StatusNotFound) + views.ErrorPage(http.StatusNotFound, "page not found") + return + } + + defer f.Close() + + mimeType := mime.TypeByExtension(path.Ext(r.URL.Path)) + w.Header().Set("content-type", mimeType) + + if _, err := io.Copy(w, f); err != nil { + logger.Error(err.Error()) + } + } +} diff --git a/main.go b/main.go index 3c4ccd5..872745f 100644 --- a/main.go +++ b/main.go @@ -1,6 +1,7 @@ package main import ( + "embed" "fmt" "net" "net/http" @@ -13,11 +14,14 @@ import ( "github.com/rramiachraf/dumb/utils" ) +//go:embed static +var staticFiles embed.FS + func main() { logger := utils.NewLogger(os.Stdout) server := &http.Server{ - Handler: handlers.New(logger), + Handler: handlers.New(logger, staticFiles), WriteTimeout: 25 * time.Second, ReadTimeout: 25 * time.Second, } @@ -25,8 +29,7 @@ func main() { PROXY_ENV := os.Getenv("PROXY") if PROXY_ENV != "" { if _, err := url.ParseRequestURI(PROXY_ENV); err != nil { - logger.Error("invalid proxy") - os.Exit(1) + logger.Fatal("invalid proxy") } logger.Info("using a custom proxy for requests") @@ -41,13 +44,12 @@ func main() { l, err := net.Listen("tcp", fmt.Sprintf(":%d", port)) if err != nil { - logger.Error(err.Error()) + logger.Fatal(err.Error()) } logger.Info("server is listening on port %d", port) if err := server.Serve(l); err != nil { - logger.Error(err.Error()) - os.Exit(1) + logger.Fatal(err.Error()) } } diff --git a/utils/logger.go b/utils/logger.go index baed2e7..1d190f5 100644 --- a/utils/logger.go +++ b/utils/logger.go @@ -4,6 +4,7 @@ import ( "fmt" "io" "log/slog" + "os" ) type Logger struct { @@ -24,3 +25,8 @@ func (l *Logger) Error(f string, args ...any) { func (l *Logger) Info(f string, args ...any) { l.slog.Info(fmt.Sprintf(f, args...)) } + +func (l *Logger) Fatal(f string, args ...any) { + l.Error(f, args...) + os.Exit(1) +}