fix: embed static directory to serve webpage from cli

Author: sunggun-yu

.goreleaser.yaml

@@ -97,8 +97,6 @@ dockers:
     goos: linux
     goarch: amd64
     dockerfile: Dockerfile.server
-    extra_files:
-      - static
     image_templates:
       - "{{ .Env.REGISTRY }}/{{ .Env.PROJECT_SERVER_NAME }}:{{ .Version }}-amd64"
       - "{{ .Env.REGISTRY }}/{{ .Env.PROJECT_SERVER_NAME }}:latest-amd64"
@@ -113,8 +111,6 @@ dockers:
     goos: linux
     goarch: arm64
     dockerfile: Dockerfile.server
-    extra_files:
-      - static
     image_templates:
       - "{{ .Env.REGISTRY }}/{{ .Env.PROJECT_SERVER_NAME }}:{{ .Version }}-arm64v8"
       - "{{ .Env.REGISTRY }}/{{ .Env.PROJECT_SERVER_NAME }}:latest-arm64v8"

Dockerfile.server

@@ -3,7 +3,6 @@ FROM alpine
 WORKDIR /app
 
 COPY dnsq dnsq
-COPY ./static/ static/
 
 EXPOSE 8080
 

cmd/server.go

@@ -4,10 +4,15 @@ Copyright © 2024 NAME HERE <EMAIL ADDRESS>
 package cmd
 
 import (
+	"embed"
+
 	"github.com/spf13/cobra"
 	"github.com/sunggun-yu/dnsq/internal/server"
 )
 
+// StaticFS is an embed.FS that contains static files from static directory
+var StaticFS embed.FS
+
 // flags struct for server command
 type serverFlags struct {
 	port int
@@ -16,24 +21,29 @@ type serverFlags struct {
 // serverCmd represents the server command
 var serverCmd = serverCommand()
 
+// serverCommand returns a cobra.Command for server
 func serverCommand() *cobra.Command {
 
 	// add flags
 	var flags serverFlags
 
+	// create a new cobra.Command
 	cmd := &cobra.Command{
 		Use:   "server",
 		Short: "A sub command for server",
 		Run: func(cmd *cobra.Command, args []string) {
-			server.Run(flags.port)
+			srv := server.NewServer(flags.port, StaticFS)
+			srv.Run()
 		},
 	}
 
+	// add flags
 	cmd.Flags().IntVarP(&flags.port, "port", "p", 8080, "port number for the server")
 
 	return cmd
 }
 
+// init registers the server command
 func init() {
 	rootCmd.AddCommand(serverCmd)
 }

internal/server/server.go

@@ -1,27 +1,65 @@
 package server
 
 import (
+	"embed"
 	"fmt"
+	"io/fs"
+	"net/http"
+	"path"
 
 	"github.com/gin-gonic/gin"
 	"github.com/sunggun-yu/dnsq/internal/server/handlers"
 )
 
-func Run(port int) {
+type Server struct {
+	Port        int
+	StaticFiles fs.FS
+}
+
+// StripPrefixFS is a custom fs.FS that strips a given prefix from the file paths.
+type StripPrefixFS struct {
+	fs     fs.FS
+	prefix string
+}
+
+// override the Open method to strip the prefix
+func (s *StripPrefixFS) Open(name string) (fs.File, error) {
+	return s.fs.Open(path.Join(s.prefix, name))
+}
+
+// NewServer creates a new server with the given port and static files.
+func NewServer(port int, staticFiles embed.FS) *Server {
+
+	// Create a new fs.FS that strips the "static" prefix
+	strippedFS := &StripPrefixFS{
+		fs:     staticFiles,
+		prefix: "static",
+	}
+
+	return &Server{
+		Port:        port,
+		StaticFiles: strippedFS,
+	}
+}
+
+// Run starts the server and listens on the given port with the given static files.
+func (s *Server) Run() {
+
 	// Create a new Gin router
 	r := gin.Default()
 
 	// Serve static files, such as index.html
-	r.Static("/static", "./static")
+	r.StaticFS("/static", http.FS(s.StaticFiles))
 
 	// API endpoint for DNS lookup
 	r.GET("/api/lookup", handlers.DNSLookupHandler)
 
-	// Serve the index.html at the root
+	// Serve the index.html at the root. do not specify any path to serve the index.html. it will gets too many redirects if you specify the path.
+	// not sure why lol
 	r.NoRoute(func(c *gin.Context) {
-		c.File("./static/index.html")
+		c.FileFromFS("", http.FS(s.StaticFiles))
 	})
 
 	// Run the server on the given port
-	r.Run(fmt.Sprintf(":%d", port))
+	r.Run(fmt.Sprintf(":%d", s.Port))
 }

main.go

@@ -4,6 +4,7 @@ Copyright © 2024 NAME HERE <EMAIL ADDRESS>
 package main
 
 import (
+	"embed"
 	"fmt"
 
 	"github.com/sunggun-yu/dnsq/cmd"
@@ -13,6 +14,9 @@ var (
 	version = "dev"
 	commit  = "none"
 	date    = "unknown"
+
+	//go:embed static
+	staticFS embed.FS
 )
 
 // Version returns version and build information. it will be injected from ldflags(goreleaser)
@@ -22,5 +26,6 @@ func Version() string {
 
 func main() {
 	cmd.SetVersion(Version())
+	cmd.StaticFS = staticFS
 	cmd.Execute()
 }