change frontend

Author: zhufuyi

.github/RELEASE.md

@@ -1,4 +1,3 @@
 ## Change log
 
-- Fix the permissions problem when installing sponge for linux normal users. [#13](https://github.com/zhufuyi/sponge/issues/13)
-- Embedded front-end static files in gin library.
+- Modify sponge ui.

internal/model/init.go

@@ -2,11 +2,12 @@
 package model
 
 import (
+	"context"
+	"database/sql"
 	"sync"
 	"time"
 
 	"github.com/zhufuyi/sponge/internal/config"
-
 	"github.com/zhufuyi/sponge/pkg/goredis"
 	"github.com/zhufuyi/sponge/pkg/logger"
 	"github.com/zhufuyi/sponge/pkg/mysql"
@@ -90,10 +91,24 @@ func CloseMysql() error {
 	if err != nil {
 		return err
 	}
-	if sqlDB != nil {
-		return sqlDB.Close()
+
+	checkInUse(sqlDB, time.Second*5)
+
+	return sqlDB.Close()
+}
+
+func checkInUse(sqlDB *sql.DB, duration time.Duration) {
+	ctx, _ := context.WithTimeout(context.Background(), duration) //nolint
+	for {
+		select {
+		case <-time.After(time.Millisecond * 500):
+			if v := sqlDB.Stats().InUse; v == 0 {
+				return
+			}
+		case <-ctx.Done():
+			return
+		}
 	}
-	return nil
 }
 
 // ------------------------------------------------------------------------------------------

pkg/gin/frontend/README.md

@@ -6,27 +6,28 @@ Embed front-end web static files in gin and add routing.
 
 ### Example of use
 
-```go1
+```go
 import "github.com/zhufuyi/sponge/pkg/gin/frontend"
 
 //go:embed user
 var staticFS embed.FS
 
 func setFrontendRouter(r *gin.Engine) error {
 	var (
-		// index.html file path, also the routing of access
-		htmlPath        = "user/home"
-		// file setting
-		addrConfigFile = "user/home/config.js"
-
-		// addr setting, the set address is in the addrConfigFile file
-		defaultAddr    = "http://localhost:8080"
-		// if cross-service is required, fill in the address of the server where the service is deployed here, e.g. http://192.168.3.37:8080
-		customAddr     = ""
+		isUseEmbedFS   = true
+		htmlDir        = "user/home"
+		configFile     = "user/home/config.js"
+		modifyConfigFn = func(content []byte) []byte {
+			// modify config code
+			return content
+		}
 	)
 
-	return frontend.New(htmlPath, defaultAddr, customAddr, addrConfigFile, staticFS).SetRouter(r)
+	err := frontend.New(staticFS, isUseEmbedFs, htmlDir, configFile, modifyConfigFn).SetRouter(r)
+	if err != nil {
+		panic(err)
+	}
 }
 ```
 
-Note: in the above example, `user` is the directory where the front-end is located, the static file index.html is in the `user/home` directory, if customAddr is empty and the default address is `http://localhost:8080`, then the access to the index.html routing address is `http:// localhost:8080/user/home`. If you set customAddr to `http://192.168.3.37:8080`, the index.html routing address will be `http://192.168.3.37:8080/user/home`.
+Note: in the above example, `user` is the directory where the front-end is located, the static file index.html is in the `user/home` directory. If isUseEmbedFS is false and apiBaseUrl is set in the configuration file, cross-host access is supported.

pkg/gin/frontend/frontend.go

@@ -2,7 +2,6 @@
 package frontend
 
 import (
-	"bytes"
 	"embed"
 	"fmt"
 	"io/fs"
@@ -24,48 +23,40 @@ var targetDir = "frontend"
 
 // FrontEnd is the frontend router configuration
 type FrontEnd struct {
-	// directory where index.html is located, e.g. web/html.
-	htmlDir string
-	// defaultAddr is the default address of the back-end api request, e.g. http://localhost:8080.
-
-	defaultAddr string
-	// custom address，the default is defaultAddr, which is used to configure whether cross-host access is possible.
-	customAddr string
-	// configuration file in which js requests the address of the back-end api request, e.g. config.js.
-	addrConfigFile string
-
 	// embed.FS static resources.
 	staticFS embed.FS
+	// must be set to false if cross-host access is required, otherwise true
+	isUseEmbedFS bool
+	// directory where index.html is located, e.g. web/html
+	htmlDir string
+	// configuration file in which js requests the address of the back-end api request, e.g. config.js
+	configFile string
+	// modify config
+	modifyConfigFn func(content []byte) []byte
 }
 
 // New create a new frontend
-func New(htmlDir string, defaultAddr string, customAddr string, addrConfigFile string, staticFS embed.FS) *FrontEnd {
-	if defaultAddr == "" {
-		panic("default address cannot be empty")
-	}
-	if customAddr == "" {
-		customAddr = defaultAddr
-	}
+func New(staticFS embed.FS, isUseEmbedFS bool, htmlDir string, configFile string, modifyConfigFn func(content []byte) []byte) *FrontEnd {
 	htmlDir = strings.Trim(htmlDir, "/")
 	return &FrontEnd{
-		htmlDir:        htmlDir,
-		defaultAddr:    defaultAddr,
-		customAddr:     customAddr,
-		addrConfigFile: addrConfigFile,
 		staticFS:       staticFS,
+		isUseEmbedFS:   isUseEmbedFS,
+		htmlDir:        htmlDir,
+		configFile:     configFile,
+		modifyConfigFn: modifyConfigFn,
 	}
 }
 
 // SetRouter set frontend router
 func (f *FrontEnd) SetRouter(r *gin.Engine) error {
-	routerPath := fmt.Sprintf("/%s/index.html", f.htmlDir)
+	routerPath := fmt.Sprintf("%s/index.html", f.htmlDir)
 	// solve vue using history route 404 problem
 	r.NoRoute(browserRefreshFS(f.staticFS, routerPath))
 
 	relativePath := fmt.Sprintf("/%s/*filepath", f.htmlDir)
 
 	// use embed file
-	if f.isUseEmbedFS() {
+	if f.isUseEmbedFS {
 		r.GET(relativePath, func(c *gin.Context) {
 			staticServer := http.FileServer(http.FS(f.staticFS))
 			staticServer.ServeHTTP(c.Writer, c.Request)
@@ -87,10 +78,6 @@ func (f *FrontEnd) SetRouter(r *gin.Engine) error {
 	return nil
 }
 
-func (f *FrontEnd) isUseEmbedFS() bool {
-	return f.defaultAddr == f.customAddr
-}
-
 func (f *FrontEnd) saveFSToLocal() error {
 	_ = os.RemoveAll(filepath.Join(targetDir, f.htmlDir))
 	time.Sleep(time.Millisecond * 10)
@@ -116,8 +103,8 @@ func (f *FrontEnd) saveFSToLocal() error {
 			}
 
 			// replace config address
-			if path == f.addrConfigFile {
-				content = bytes.ReplaceAll(content, []byte(f.defaultAddr), []byte(f.customAddr))
+			if path == f.configFile {
+				content = f.modifyConfigFn(content)
 			}
 
 			// Save the content to the local file

pkg/gin/frontend/frontend_test.go

@@ -14,25 +14,26 @@ var staticFS embed.FS
 
 func TestFrontEnd_SetRouter(t *testing.T) {
 	var (
-		htmlPath       = "user/home"
-		addrConfigFile = "user/home/config.js"
-
-		defaultAddr = "http://localhost:8080"
-		customAddr  = ""
+		isUseEmbedFS   = true
+		htmlDir        = "user/home"
+		configFile     = "user/home/config.js"
+		modifyConfigFn = func(content []byte) []byte {
+			return content
+		}
 	)
 
 	r := gin.New()
 	gin.SetMode(gin.ReleaseMode)
-	err := New(htmlPath, defaultAddr, customAddr, addrConfigFile, staticFS).SetRouter(r)
+	err := New(staticFS, isUseEmbedFS, htmlDir, configFile, modifyConfigFn).SetRouter(r)
 	if err != nil {
 		t.Error(err)
 	}
 	time.Sleep(time.Millisecond * 100)
 
-	customAddr = "http://127.0.0.1:8080"
 	r = gin.New()
 	gin.SetMode(gin.ReleaseMode)
-	err = New(htmlPath, defaultAddr, customAddr, addrConfigFile, staticFS).SetRouter(r)
+	isUseEmbedFS = false
+	err = New(staticFS, isUseEmbedFS, htmlDir, configFile, modifyConfigFn).SetRouter(r)
 	if err != nil {
 		t.Error(err)
 	}

pkg/gin/middleware/README.md

@@ -80,7 +80,7 @@ func main() {
 
     r.POST("/user/login", Login)
     r.GET("/user/:id", middleware.Auth(), h.GetByID) // no verify field
-    // r.GET("/user/:id", middleware.Auth(middleware.WithVerify(adminVerify)), userFun) // with verify field
+    // r.GET("/user/:id", middleware.Auth(middleware.WithVerify(adminVerify)), h.GetByID) // with verify field
 
     r.Run(serverAddr)
 }
@@ -115,7 +115,7 @@ func main() {
     r := gin.Default()
 
     r.POST("/user/login", Login)
-    r.GET("/user/:id", middleware.AuthCustom(verify), userFun)
+    r.GET("/user/:id", middleware.AuthCustom(verify), h.GetByID)
 
     r.Run(serverAddr)
 }