feat(ui): package zui within zot binary (#1161)

(cherry picked from commit d557da0baba819b7cd7e6b5941528776e125ac6d)

build(ui): fix stacker builds


(cherry picked from commit ba25daf02b4a9bc7ee1cb6f84b7a6b096ca7d61f)

build(ui): various fixes

- Fix metrics endpoint
- Fix unit tests unit tests
- Make the ui build optional in the makefile
before the linter lint runs in the golangci-lint workflow
- Do not attempt to include UI routes if search is enabled
- Fix authorization for search endpoint



fix: use zot tag in ui make target


(cherry picked from commit 2a6882fa23f06b2d68c6c299773a6ff50bf90e78)

Signed-off-by: Ramkumar Chinchani <rchincha@cisco.com>
Signed-off-by: Catalin Hofnar <catalin.hofnar@gmail.com>
Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
Co-authored-by: Ramkumar Chinchani <rchincha@cisco.com>

pkg/extensions/config/config.go

@@ -17,6 +17,7 @@ type ExtensionConfig struct {
 	Metrics *MetricsConfig
 	Scrub   *ScrubConfig
 	Lint    *LintConfig
+	UI      *UIConfig
 }
 
 type LintConfig struct {
@@ -52,3 +53,7 @@ type ScrubConfig struct {
 	BaseConfig `mapstructure:",squash"`
 	Interval   time.Duration
 }
+
+type UIConfig struct {
+	BaseConfig `mapstructure:",squash"`
+}

pkg/extensions/extension-ui-disabled.go

@@ -0,0 +1,19 @@
+//go:build !search || !ui
+// +build !search !ui
+
+package extensions
+
+import (
+	"github.com/gorilla/mux"
+
+	"zotregistry.io/zot/pkg/api/config"
+	"zotregistry.io/zot/pkg/log"
+	"zotregistry.io/zot/pkg/storage"
+)
+
+func SetupUIRoutes(config *config.Config, router *mux.Router, storeController storage.StoreController,
+	log log.Logger,
+) {
+	log.Warn().Msg("skipping setting up ui routes because given zot binary doesn't include this feature," +
+		"please build a binary that does so")
+}

pkg/extensions/extension-ui.go

@@ -0,0 +1,51 @@
+//go:build search && ui
+// +build search,ui
+
+package extensions
+
+import (
+	"embed"
+	"io/fs"
+	"net/http"
+
+	"github.com/gorilla/mux"
+
+	"zotregistry.io/zot/pkg/api/config"
+	"zotregistry.io/zot/pkg/log"
+	"zotregistry.io/zot/pkg/storage"
+)
+
+// content is our static web server content.
+//
+//go:embed build/*
+var content embed.FS
+
+type uiHandler struct {
+	log log.Logger
+}
+
+func (uih uiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	buf, _ := content.ReadFile("build/index.html")
+
+	_, err := w.Write(buf)
+	if err != nil {
+		uih.log.Error().Err(err).Msg("unable to serve index.html")
+	}
+}
+
+func SetupUIRoutes(config *config.Config, router *mux.Router, storeController storage.StoreController,
+	log log.Logger,
+) {
+	if config.Extensions.UI != nil {
+		fsub, _ := fs.Sub(content, "build")
+		uih := uiHandler{log: log}
+
+		router.PathPrefix("/login").Handler(uih)
+		router.PathPrefix("/home").Handler(uih)
+		router.PathPrefix("/explore").Handler(uih)
+		router.PathPrefix("/image").Handler(uih)
+		router.PathPrefix("/").Handler(http.FileServer(http.FS(fsub)))
+
+		log.Info().Msg("setting up ui routes")
+	}
+}

pkg/extensions/extension_metrics.go

@@ -27,12 +27,13 @@ func EnableMetricsExtension(config *config.Config, log log.Logger, rootDir strin
 }
 
 func SetupMetricsRoutes(config *config.Config, router *mux.Router, storeController storage.StoreController,
-	log log.Logger,
+	authFunc mux.MiddlewareFunc, log log.Logger,
 ) {
 	log.Info().Msg("setting up metrics routes")
 
 	if config.Extensions.Metrics != nil && *config.Extensions.Metrics.Enable {
-		router.PathPrefix(config.Extensions.Metrics.Prometheus.Path).
-			Handler(promhttp.Handler())
+		extRouter := router.PathPrefix(config.Extensions.Metrics.Prometheus.Path).Subrouter()
+		extRouter.Use(authFunc)
+		extRouter.Methods("GET").Handler(promhttp.Handler())
 	}
 }

pkg/extensions/extension_metrics_disabled.go

@@ -19,7 +19,7 @@ func EnableMetricsExtension(config *config.Config, log log.Logger, rootDir strin
 
 // SetupMetricsRoutes ...
 func SetupMetricsRoutes(conf *config.Config, router *mux.Router,
-	storeController storage.StoreController, log log.Logger,
+	storeController storage.StoreController, authFunc mux.MiddlewareFunc, log log.Logger,
 ) {
 	log.Warn().Msg("skipping setting up metrics routes because given zot binary doesn't include this feature," +
 		"please build a binary that does so")

pkg/extensions/extension_search.go

@@ -84,8 +84,9 @@ func SetupSearchRoutes(config *config.Config, router *mux.Router, storeControlle
 	if config.Extensions.Search != nil && *config.Extensions.Search.Enable {
 		resConfig := search.GetResolverConfig(log, storeController, repoDB, cveInfo)
 
-		graphqlPrefix := router.PathPrefix(constants.FullSearchPrefix).Methods("OPTIONS", "GET", "POST")
-		graphqlPrefix.Handler(gqlHandler.NewDefaultServer(gql_generated.NewExecutableSchema(resConfig)))
+		extRouter := router.PathPrefix(constants.ExtSearchPrefix).Subrouter()
+		extRouter.Methods("GET", "POST", "OPTIONS").
+			Handler(gqlHandler.NewDefaultServer(gql_generated.NewExecutableSchema(resConfig)))
 	}
 }