chore: release v0.6.2 (#717)

.github/workflows/tests.yml

@@ -1,13 +1,30 @@
 name: Tests
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
+  compat-test:
+    strategy:
+      matrix:
+        version: ["1.16", "1.17"]
+    runs-on: [self-hosted, X64]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.version }}
+
+      # Just build tests without running them
+      - name: Build Test
+        run: go test -run=nope ./...
+
   lint-and-ut:
     strategy:
       matrix:
-        version: [ '1.18', '1.19', '1.20' ]
-    runs-on: [ self-hosted, X64 ]
+        version: ["1.18", "1.19", "1.20"]
+    runs-on: [self-hosted, X64]
     steps:
       - uses: actions/checkout@v3
 
@@ -31,7 +48,7 @@ jobs:
   ut-windows:
     strategy:
       matrix:
-        version: [ '1.18', '1.19', '1.20' ]
+        version: ["1.18", "1.19", "1.20"]
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v3
@@ -43,3 +60,65 @@ jobs:
 
       - name: Unit Test
         run: go test -race -covermode=atomic  ./...
+
+  hz-test-unix:
+    strategy:
+      matrix:
+        version: [ '1.20' ]
+    runs-on: [ self-hosted, X64 ]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.version }}
+
+      - name: Setup Environment
+        run: |
+          echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v35
+
+      - name: Hz Test
+        if: contains(steps.changed-files.outputs.all_changed_files, 'cmd/hz')
+        run: |
+          cd cmd/hz
+          sh test_hz_unix.sh
+
+
+  hz-test-windows:
+    strategy:
+      matrix:
+        version: [ '1.20']
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.version }}
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v35
+
+      - name: Install Protobuf
+        shell: pwsh
+        run: |
+          Invoke-WebRequest https://github.com/protocolbuffers/protobuf/releases/download/v3.19.4/protoc-3.19.4-win64.zip -OutFile protoc-3.19.4-win64.zip
+          Expand-Archive protoc-3.19.4-win64.zip -DestinationPath protoc-3.19.4-win64
+          $GOPATH=go env GOPATH
+          Copy-Item -Path protoc-3.19.4-win64\bin\protoc.exe -Destination $GOPATH\bin
+          Copy-Item -Path protoc-3.19.4-win64\include\* -Destination cmd\hz\testdata\include\google -Recurse
+          protoc --version
+
+      - name: Hz Test
+        if: contains(steps.changed-files.outputs.all_changed_files, 'cmd/hz')
+        run: |
+          cd cmd/hz
+          sh test_hz_windows.sh

cmd/hz/config/argument.go

@@ -68,6 +68,7 @@ type Argument struct {
 	NoRecurse            bool
 	HandlerByMethod      bool
 	ForceNew             bool
+	SnakeStyleMiddleware bool
 
 	CustomizeLayout     string
 	CustomizeLayoutData string

cmd/hz/generator/package.go

@@ -46,22 +46,25 @@ type Service struct {
 	BaseDomain    string         // base domain for client code
 }
 
+// HttpPackageGenerator is used to record the configuration related to generating hertz http code.
 type HttpPackageGenerator struct {
-	ConfigPath      string
-	Backend         meta.Backend
-	Options         []Option
-	CmdType         string
-	ProjPackage     string
-	HandlerDir      string
-	RouterDir       string
-	ModelDir        string
-	UseDir          string
-	ClientDir       string
-	IdlClientDir    string
-	ForceClientDir  string
-	NeedModel       bool
-	HandlerByMethod bool
-	BaseDomain      string
+	ConfigPath     string       // package template path
+	Backend        meta.Backend // model template
+	Options        []Option
+	CmdType        string
+	ProjPackage    string // go module for project
+	HandlerDir     string
+	RouterDir      string
+	ModelDir       string
+	UseDir         string // model dir for third repo
+	ClientDir      string // client dir for "new"/"update" command
+	IdlClientDir   string // client dir for "client" command
+	ForceClientDir string // client dir without namespace for "client" command
+	BaseDomain     string // request domain for "client" command
+
+	NeedModel            bool
+	HandlerByMethod      bool // generate handler files with method dimension
+	SnakeStyleMiddleware bool // use snake name style for middleware
 
 	loadedBackend   Backend
 	curModel        *model.Model

cmd/hz/generator/package_tpl.go

@@ -120,10 +120,10 @@ import (
 
 {{define "G"}}
 {{- if ne .Handler ""}}
-	{{- .GroupName}}.{{.HttpMethod}}("{{.Path}}", append({{.MiddleWare}}Mw(), {{.Handler}})...)
+	{{- .GroupName}}.{{.HttpMethod}}("{{.Path}}", append({{.HandlerMiddleware}}Mw(), {{.Handler}})...)
 {{- end}}
 {{- if ne (len .Children) 0}}
-{{.MiddleWare}} := {{template "g" .}}.Group("{{.Path}}", {{.MiddleWare}}Mw()...)
+{{.MiddleWare}} := {{template "g" .}}.Group("{{.Path}}", {{.GroupMiddleware}}Mw()...)
 {{- end}}
 {{- range $_, $router := .Children}}
 {{- if ne .Handler ""}}
@@ -177,10 +177,18 @@ import (
 )
 
 {{define "M"}}
-func {{.MiddleWare}}Mw() []app.HandlerFunc {
+{{- if ne .Children.Len 0}}
+func {{.GroupMiddleware}}Mw() []app.HandlerFunc {
 	// your code...
 	return nil
 }
+{{end}}
+{{- if ne .Handler ""}}
+func {{.HandlerMiddleware}}Mw() []app.HandlerFunc {
+	// your code...
+	return nil
+}
+{{end}}
 {{range $_, $router := $.Children}}{{template "M" $router}}{{end}}
 {{- end}}
 

cmd/hz/generator/router.go

@@ -36,10 +36,14 @@ type Router struct {
 }
 
 type RouterNode struct {
-	GroupName  string
-	MiddleWare string
+	GroupName         string // current group name(the parent middleware name), used to register route. example: {{.GroupName}}.{{HttpMethod}}
+	MiddleWare        string // current node middleware, used to be group name for children.
+	HandlerMiddleware string
+	GroupMiddleware   string
+	PathPrefix        string
 
 	Path     string
+	Parent   *RouterNode
 	Children childrenRouterInfo
 
 	Handler             string // {{HandlerPackage}}.{{HandlerName}}
@@ -57,9 +61,11 @@ type RegisterInfo struct {
 // NewRouterTree contains "/" as root node
 func NewRouterTree() *RouterNode {
 	return &RouterNode{
-		GroupName:  "root",
-		MiddleWare: "root",
-		Path:       "/",
+		GroupName:       "root",
+		MiddleWare:      "root",
+		GroupMiddleware: "root",
+		Path:            "/",
+		Parent:          nil,
 	}
 }
 
@@ -85,8 +91,15 @@ func (routerNode *RouterNode) Update(method *HttpMethod, handlerType, handlerPkg
 	return nil
 }
 
-// DyeGroupName traverses the routing tree in depth and names the middleware for each node.
-func (routerNode *RouterNode) DyeGroupName() error {
+func (routerNode *RouterNode) RawHandlerName() string {
+	parts := strings.Split(routerNode.Handler, ".")
+	handlerName := parts[len(parts)-1]
+	return handlerName
+}
+
+// DyeGroupName traverses the routing tree in depth and names the handler/group middleware for each node.
+// If snakeStyleMiddleware is set to true, the name style of the middleware will use snake name style.
+func (routerNode *RouterNode) DyeGroupName(snakeStyleMiddleware bool) error {
 	groups := []string{"root"}
 
 	hook := func(layer int, node *RouterNode) error {
@@ -96,18 +109,56 @@ func (routerNode *RouterNode) DyeGroupName() error {
 			if len(pname) > 1 && pname[0] == '/' {
 				pname = pname[1:]
 			}
-			if len(node.Children) == 0 && node.Handler != "" {
-				handleName := strings.Split(node.Handler, ".")
-				pname = handleName[len(handleName)-1]
+
+			if node.Parent != nil {
+				node.PathPrefix = node.Parent.PathPrefix + "_" + util.ToGoFuncName(pname)
+			} else {
+				node.PathPrefix = "_" + util.ToGoFuncName(pname)
 			}
-			pname = util.ToVarName([]string{pname})
-			// The tolow operation is placed here, unifying the middleware raw name
-			pname = strings.ToLower(pname)
-			pname, err := util.GetMiddlewareUniqueName(pname)
-			if err != nil {
-				return fmt.Errorf("get unique name for middleware '%s' failed, err: %v", pname, err)
+
+			handlerMiddlewareName := ""
+			isLeafNode := false
+			if len(node.Handler) != 0 {
+				handlerMiddlewareName = node.RawHandlerName()
+				// If it is a leaf node, then "group middleware name" and "handler middleware name" are the same
+				if len(node.Children) == 0 {
+					pname = handlerMiddlewareName
+					isLeafNode = true
+				}
+			}
+
+			pname = convertToMiddlewareName(pname)
+			handlerMiddlewareName = convertToMiddlewareName(handlerMiddlewareName)
+
+			if isLeafNode {
+				name, err := util.GetMiddlewareUniqueName(pname)
+				if err != nil {
+					return fmt.Errorf("get unique name for middleware '%s' failed, err: %v", name, err)
+				}
+				pname = name
+				handlerMiddlewareName = name
+			} else {
+				var err error
+				pname, err = util.GetMiddlewareUniqueName(pname)
+				if err != nil {
+					return fmt.Errorf("get unique name for middleware '%s' failed, err: %v", pname, err)
+				}
+				handlerMiddlewareName, err = util.GetMiddlewareUniqueName(handlerMiddlewareName)
+				if err != nil {
+					return fmt.Errorf("get unique name for middleware '%s' failed, err: %v", handlerMiddlewareName, err)
+				}
 			}
 			node.MiddleWare = "_" + pname
+			if len(node.Handler) != 0 {
+				node.HandlerMiddleware = "_" + handlerMiddlewareName
+				if snakeStyleMiddleware {
+					node.HandlerMiddleware = "_" + node.RawHandlerName()
+				}
+			}
+			node.GroupMiddleware = node.MiddleWare
+			if snakeStyleMiddleware {
+				node.GroupMiddleware = node.PathPrefix
+			}
 		}
 		if layer >= len(groups)-1 {
 			groups = append(groups, node.MiddleWare)
@@ -145,7 +196,8 @@ func (routerNode *RouterNode) Insert(name string, method *HttpMethod, handlerTyp
 	cur := routerNode
 	for i, p := range paths {
 		c := &RouterNode{
-			Path: "/" + p,
+			Path:   "/" + p,
+			Parent: cur,
 		}
 		if i == len(paths)-1 {
 			// generate handler by method
@@ -285,7 +337,7 @@ func (pkgGen *HttpPackageGenerator) updateRegister(pkg, rDir, pkgName string) er
 }
 
 func (pkgGen *HttpPackageGenerator) genRouter(pkg *HttpPackage, root *RouterNode, handlerPackage, routerDir, routerPackage string) error {
-	err := root.DyeGroupName()
+	err := root.DyeGroupName(pkgGen.SnakeStyleMiddleware)
 	if err != nil {
 		return err
 	}
@@ -334,10 +386,16 @@ func (pkgGen *HttpPackageGenerator) updateMiddlewareReg(router interface{}, midd
 	if !isExist {
 		return pkgGen.TemplateGenerator.Generate(router, middlewareTpl, filePath, false)
 	}
-	middlewareList := make([]string, 1)
+	var middlewareList []string
 
 	_ = router.(Router).Router.DFS(0, func(layer int, node *RouterNode) error {
-		middlewareList = append(middlewareList, node.MiddleWare)
+		// non-leaf node will generate group middleware
+		if node.Children.Len() > 0 && len(node.GroupMiddleware) > 0 {
+			middlewareList = append(middlewareList, node.GroupMiddleware)
+		}
+		if len(node.HandlerMiddleware) > 0 {
+			middlewareList = append(middlewareList, node.HandlerMiddleware)
+		}
 		return nil
 	})
 
@@ -347,7 +405,7 @@ func (pkgGen *HttpPackageGenerator) updateMiddlewareReg(router interface{}, midd
 	}
 
 	for _, mw := range middlewareList {
-		if bytes.Contains(file, []byte(mw+"Mw")) {
+		if bytes.Contains(file, []byte(mw)) {
 			continue
 		}
 		middlewareSingleTpl := pkgGen.tpls[middlewareSingleTplName]
@@ -378,3 +436,10 @@ func (pkgGen *HttpPackageGenerator) updateMiddlewareReg(router interface{}, midd
 
 	return nil
 }
+
+// convertToMiddlewareName converts a route path to a middleware name
+func convertToMiddlewareName(path string) string {
+	path = util.ToVarName([]string{path})
+	path = strings.ToLower(path)
+	return path
+}

cmd/hz/meta/const.go

@@ -19,7 +19,7 @@ package meta
 import "runtime"
 
 // Version hz version
-const Version = "v0.6.1"
+const Version = "v0.6.2"
 
 // Mode hz run modes
 type Mode int

cmd/hz/meta/manifest.go

@@ -61,12 +61,12 @@ func (manifest *Manifest) InitAndValidate(dir string) error {
 	return nil
 }
 
-const hzTitle = "// Code generated by hz. DO NOT EDIT.\n"
+const hzTitle = "// Code generated by hz. DO NOT EDIT."
 
 func (manifest *Manifest) String() string {
 	conf, _ := yaml.Marshal(*manifest)
 
-	return hzTitle + "\n" +
+	return hzTitle + "\n\n" +
 		string(conf)
 }