Merge pull request #16 from dadav/feat_ui

feat: Add basic web ui

Author: dadav

README.md

@@ -105,6 +105,7 @@ Flags:
       --port int                  the port to listen to (default 8080)
       --tls-cert string           path to tls cert file
       --tls-key string            path to tls key file
+      --ui                        enables the web ui
       --user string               give control to this user or uid (requires root)
 
 Global Flags:
@@ -151,6 +152,8 @@ Via file (`$HOME/.config/gorge.yaml` or `./gorge.yaml`):
 
 ```yaml
 ---
+# Enable basic web ui
+ui: false
 # Set uid of process to this users uid
 user: ""
 # Set gid of process to this groups gid
@@ -196,6 +199,7 @@ tls-key: ""
 Via environment:
 
 ```bash
+GORGE_UI=false
 GORGE_USER=""
 GORGE_GROUP=""
 GORGE_API_VERSION=v3

cmd/serve.go

@@ -38,11 +38,11 @@ import (
 	"github.com/dadav/gorge/internal/utils"
 	v3 "github.com/dadav/gorge/internal/v3/api"
 	backend "github.com/dadav/gorge/internal/v3/backend"
+	"github.com/dadav/gorge/internal/v3/ui"
 	openapi "github.com/dadav/gorge/pkg/gen/v3/openapi"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/chi/v5/middleware"
 	"github.com/go-chi/cors"
-	"github.com/go-chi/jwtauth/v5"
 	"github.com/go-chi/stampede"
 	"github.com/spf13/cobra"
 	"golang.org/x/sync/errgroup"
@@ -127,34 +127,20 @@ You can also enable the caching functionality to speed things up.`,
 			r := chi.NewRouter()
 
 			// Logger should come before any middleware that modifies the response
-			// r.Use(middleware.Logger)
+			r.Use(middleware.Logger)
 			// Recoverer should also be pretty high in the middleware stack
 			r.Use(middleware.Recoverer)
 			r.Use(middleware.RealIP)
 			r.Use(customMiddleware.RequireUserAgent)
+			x := customMiddleware.NewStatistics()
+			r.Use(customMiddleware.StatisticsMiddleware(x))
 			r.Use(cors.Handler(cors.Options{
 				AllowedOrigins:   strings.Split(config.CORSOrigins, ","),
 				AllowedMethods:   []string{"GET", "POST", "DELETE", "PATCH"},
 				AllowedHeaders:   []string{"Accept", "Content-Type"},
 				AllowCredentials: false,
 				MaxAge:           300,
 			}))
-
-			if !config.Dev {
-				tokenAuth := jwtauth.New("HS256", []byte(config.JwtSecret), nil)
-				r.Use(customMiddleware.AuthMiddleware(tokenAuth, func(r *http.Request) bool {
-					// Everything but GET is protected and requires a jwt token
-					return r.Method != "GET"
-				}))
-
-				_, tokenString, _ := tokenAuth.Encode(map[string]interface{}{"user": "admin"})
-				err = os.WriteFile(config.JwtTokenPath, []byte(tokenString), 0400)
-				if err != nil {
-					log.Log.Fatal(err)
-				}
-				log.Log.Infof("JWT token was written to %s", config.JwtTokenPath)
-			}
-
 			if !config.NoCache {
 				customKeyFunc := func(r *http.Request) uint64 {
 					token := r.Header.Get("Authorization")
@@ -164,45 +150,58 @@ You can also enable the caching functionality to speed things up.`,
 				r.Use(cachedMiddleware)
 			}
 
-			if config.FallbackProxyUrl != "" {
-				proxies := strings.Split(config.FallbackProxyUrl, ",")
-				slices.Reverse(proxies)
-
-				for _, proxy := range proxies {
-					r.Use(customMiddleware.ProxyFallback(proxy, func(status int) bool {
-						return status == http.StatusNotFound
-					},
-						func(r *http.Response) {
-							if config.ImportProxiedReleases && strings.HasPrefix(r.Request.URL.Path, "/v3/files/") && r.StatusCode == http.StatusOK {
-								body, err := io.ReadAll(r.Body)
-								if err != nil {
-									log.Log.Error(err)
-									return
-								}
+			if config.UI {
+				r.Group(func(r chi.Router) {
+					r.HandleFunc("/", ui.IndexHandler)
+					r.HandleFunc("/search", ui.SearchHandler)
+					r.HandleFunc("/modules/{module}", ui.ModuleHandler)
+					r.HandleFunc("/modules/{module}/{version}", ui.ReleaseHandler)
+					r.HandleFunc("/authors/{author}", ui.AuthorHandler)
+					r.HandleFunc("/statistics", ui.StatisticsHandler(x))
+					r.Handle("/assets/*", ui.HandleAssets())
+				})
+			}
 
-								// restore the body
-								r.Body = io.NopCloser(bytes.NewBuffer(body))
+			r.Group(func(r chi.Router) {
+				if config.FallbackProxyUrl != "" {
+					proxies := strings.Split(config.FallbackProxyUrl, ",")
+					slices.Reverse(proxies)
 
-								release, err := backend.ConfiguredBackend.AddRelease(body)
-								if err != nil {
-									log.Log.Error(err)
-									return
-								}
-								log.Log.Infof("Imported release %s\n", release.Slug)
-							}
+					for _, proxy := range proxies {
+						r.Use(customMiddleware.ProxyFallback(proxy, func(status int) bool {
+							return status == http.StatusNotFound
 						},
-					))
+							func(r *http.Response) {
+								if config.ImportProxiedReleases && strings.HasPrefix(r.Request.URL.Path, "/v3/files/") && r.StatusCode == http.StatusOK {
+									body, err := io.ReadAll(r.Body)
+									if err != nil {
+										log.Log.Error(err)
+										return
+									}
+
+									// restore the body
+									r.Body = io.NopCloser(bytes.NewBuffer(body))
+
+									release, err := backend.ConfiguredBackend.AddRelease(body)
+									if err != nil {
+										log.Log.Error(err)
+										return
+									}
+									log.Log.Infof("Imported release %s\n", release.Slug)
+								}
+							},
+						))
+					}
 				}
-			}
-
-			apiRouter := openapi.NewRouter(
-				openapi.NewModuleOperationsAPIController(moduleService),
-				openapi.NewReleaseOperationsAPIController(releaseService),
-				openapi.NewSearchFilterOperationsAPIController(searchFilterService),
-				openapi.NewUserOperationsAPIController(userService),
-			)
-
-			r.Mount("/", apiRouter)
+				apiRouter := openapi.NewRouter(
+					openapi.NewModuleOperationsAPIController(moduleService),
+					openapi.NewReleaseOperationsAPIController(releaseService),
+					openapi.NewSearchFilterOperationsAPIController(searchFilterService),
+					openapi.NewUserOperationsAPIController(userService),
+				)
+
+				r.Mount("/v3", apiRouter)
+			})
 
 			r.Get("/readyz", func(w http.ResponseWriter, r *http.Request) {
 				w.Header().Set("Content-Type", "application/json")
@@ -325,6 +324,7 @@ func init() {
 	serveCmd.Flags().StringVar(&config.FallbackProxyUrl, "fallback-proxy", "", "optional comma separated list of fallback upstream proxy urls")
 	serveCmd.Flags().BoolVar(&config.Dev, "dev", false, "enables dev mode")
 	serveCmd.Flags().BoolVar(&config.DropPrivileges, "drop-privileges", false, "drops privileges to the given user/group")
+	serveCmd.Flags().BoolVar(&config.UI, "ui", false, "enables the web ui")
 	serveCmd.Flags().StringVar(&config.CachePrefixes, "cache-prefixes", "/v3/files", "url prefixes to cache")
 	serveCmd.Flags().StringVar(&config.JwtSecret, "jwt-secret", "changeme", "jwt secret")
 	serveCmd.Flags().StringVar(&config.JwtTokenPath, "jwt-token-path", "~/.gorge/token", "jwt token path")

go.mod

@@ -3,6 +3,7 @@ module github.com/dadav/gorge
 go 1.22.0
 
 require (
+	github.com/a-h/templ v0.2.747
 	github.com/go-chi/chi/v5 v5.0.12
 	github.com/go-chi/cors v1.2.1
 	github.com/go-chi/jwtauth/v5 v5.3.1

go.sum

@@ -1,3 +1,5 @@
+github.com/a-h/templ v0.2.747 h1:D0dQ2lxC3W7Dxl6fxQ/1zZHBQslSkTSvl5FxP/CfdKg=
+github.com/a-h/templ v0.2.747/go.mod h1:69ObQIbrcuwPCU32ohNaWce3Cb7qM5GMiqN1K+2yop4=
 github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=

internal/config/config.go

@@ -8,6 +8,7 @@ var (
 	Bind                  string
 	Dev                   bool
 	DropPrivileges        bool
+	UI                    bool
 	ModulesDir            string
 	ModulesScanSec        int
 	Backend               string

internal/middleware/stats.go

@@ -0,0 +1,50 @@
+package middleware
+
+import (
+	"net/http"
+	"sync"
+	"time"
+)
+
+type Statistics struct {
+	ActiveConnections       int
+	TotalConnections        int
+	TotalResponseTime       time.Duration
+	ConnectionsPerEndpoint  map[string]int
+	ResponseTimePerEndpoint map[string]time.Duration
+	Mutex                   sync.Mutex
+}
+
+func NewStatistics() *Statistics {
+	return &Statistics{
+		ActiveConnections:       0,
+		TotalConnections:        0,
+		TotalResponseTime:       0,
+		ConnectionsPerEndpoint:  make(map[string]int),
+		ResponseTimePerEndpoint: make(map[string]time.Duration),
+	}
+}
+
+func StatisticsMiddleware(stats *Statistics) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			start := time.Now()
+			stats.Mutex.Lock()
+			stats.ActiveConnections++
+			stats.TotalConnections++
+			stats.ConnectionsPerEndpoint[r.URL.Path]++
+			stats.Mutex.Unlock()
+
+			defer func() {
+				duration := time.Since(start)
+				stats.Mutex.Lock()
+				stats.ActiveConnections--
+				stats.TotalResponseTime += duration
+				stats.ResponseTimePerEndpoint[r.URL.Path] += duration
+				stats.Mutex.Unlock()
+			}()
+
+			next.ServeHTTP(w, r)
+		})
+	}
+}

internal/v3/ui/assets.go

@@ -0,0 +1,13 @@
+package ui
+
+import (
+	"embed"
+	"net/http"
+)
+
+//go:embed all:assets
+var assets embed.FS
+
+func HandleAssets() http.Handler {
+	return http.FileServer(http.FS(assets))
+}