Merge pull request #1750 from cloudwego/release-v0.13.1

chore: release v0.13.1

Author: DMwangnima

pkg/remote/trans/nphttp2/grpc/http2_client.go

@@ -115,7 +115,8 @@ type http2Client struct {
 	// variable.
 	kpDormant bool
 	onGoAway  func(GoAwayReason)
-	onClose   func()
+	// Important: when onClose is invoked, the http2Client.mu is held
+	onClose func()
 
 	bufferPool *bufferPool
 }

pkg/remote/trans/nphttp2/grpc/http2_server.go

@@ -37,11 +37,12 @@ import (
 	"github.com/cloudwego/kitex/pkg/remote/codec/protobuf/encoding"
 	"github.com/cloudwego/kitex/pkg/remote/transmeta"
 
-	"github.com/cloudwego/netpoll"
 	"golang.org/x/net/http2"
 	"golang.org/x/net/http2/hpack"
 	"google.golang.org/protobuf/proto"
 
+	"github.com/cloudwego/netpoll"
+
 	"github.com/cloudwego/kitex/pkg/gofunc"
 	"github.com/cloudwego/kitex/pkg/klog"
 	"github.com/cloudwego/kitex/pkg/remote/trans/nphttp2/codes"

pkg/remote/trans/nphttp2/grpc/transport_test.go

@@ -37,10 +37,11 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cloudwego/netpoll"
 	"golang.org/x/net/http2"
 	"golang.org/x/net/http2/hpack"
 
+	"github.com/cloudwego/netpoll"
+
 	"github.com/cloudwego/kitex/internal/test"
 	"github.com/cloudwego/kitex/pkg/remote/trans/nphttp2/codes"
 	"github.com/cloudwego/kitex/pkg/remote/trans/nphttp2/grpc/grpcframe"

pkg/utils/sharedticker.go

@@ -108,11 +108,17 @@ func (t *SharedTicker) Tick(interval time.Duration) {
 }
 
 func (t *SharedTicker) syncExec() {
+	var todoTasks []TickerTask
 	t.Lock()
+	todoTasks = make([]TickerTask, 0, len(t.tasks))
 	for task := range t.tasks {
-		task.Tick()
+		todoTasks = append(todoTasks, task)
 	}
 	t.Unlock()
+
+	for _, task := range todoTasks {
+		task.Tick()
+	}
 }
 
 func (t *SharedTicker) asyncExec() {

pkg/utils/sharedticker_test.go

@@ -88,3 +88,28 @@ func TestSharedTickerTick(t *testing.T) {
 		time.Sleep(150 * time.Millisecond)
 	}
 }
+
+type concurrentTask struct {
+	st       *SharedTicker
+	finishCh chan struct{}
+}
+
+func (ct *concurrentTask) Tick() {
+	// when Tick is invoked, SharedTicker.mu should not be hold
+	ct.st.Lock()
+	// prevents Tick from being executed multiple times due to goroutine scheduling.
+	select {
+	case ct.finishCh <- struct{}{}:
+	default:
+	}
+	ct.st.Unlock()
+}
+
+func TestSyncSharedTickerConcurrent(t *testing.T) {
+	duration := 100 * time.Millisecond
+	st := NewSyncSharedTicker(duration)
+	finishCh := make(chan struct{}, 1)
+	st.Add(&concurrentTask{st: st, finishCh: finishCh})
+	time.Sleep(150 * time.Millisecond)
+	<-finishCh
+}

tool/internal_pkg/prutal/prutal.go

@@ -21,6 +21,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"regexp"
 	"strings"
 
 	"github.com/cloudwego/kitex/tool/internal_pkg/generator"
@@ -68,7 +69,7 @@ func (pg *PrutalGen) generateClientServerFiles(f *prutalgen.Proto, p *generator.
 			return err
 		}
 		for _, f := range fs {
-			writeGoFile(f.Name, []byte(f.Content))
+			writeFile(f.Name, []byte(f.Content))
 		}
 	}
 	return nil
@@ -134,7 +135,7 @@ func (pg *PrutalGen) Process() error {
 			return err
 		}
 		for _, f := range fs {
-			writeGoFile(f.Name, []byte(f.Content))
+			writeFile(f.Name, []byte(f.Content))
 		}
 	}
 
@@ -148,7 +149,7 @@ func (pg *PrutalGen) Process() error {
 			return err
 		}
 		for _, f := range fs {
-			writeGoFile(f.Name, []byte(f.Content))
+			writeFile(f.Name, []byte(f.Content))
 		}
 	}
 	return nil
@@ -280,7 +281,7 @@ func genStructsAndKitexInterfaces(f *prutalgen.Proto, c *generator.Config, dir s
 	fn := strings.TrimSuffix(path.Base(f.ProtoFile), ".proto") + ".pb.go"
 	out := filepath.Join(dir, fn)
 	f.Infof("generating %s", out)
-	writeGoFile(out, w.Bytes())
+	writeFile(out, w.Bytes())
 }
 
 func genKitexServiceInterface(f *prutalgen.Proto, w *prutalgen.CodeWriter, streamx bool) {
@@ -338,17 +339,43 @@ func getImportPath(pkg, module, prefix string) (string, bool) {
 	return path.Join(prefix, pkg), true
 }
 
-func writeGoFile(fn string, data []byte) {
-	formatted, err := format.Source(data)
-	if err != nil {
-		log.Errorf("format file %q err: %s", fn, err)
-		formatted = data
+func writeFile(fn string, data []byte) {
+	if strings.HasSuffix(fn, ".go") {
+		formatted, err := format.Source(data)
+		if err != nil {
+			log.Errorf("format file %q err: %s", fn, err)
+		} else {
+			data = formatted
+		}
+		truncateFastPBFile(fn)
 	}
-	err = os.MkdirAll(filepath.Dir(fn), 0o755)
+	err := os.MkdirAll(filepath.Dir(fn), 0o755)
 	if err == nil {
-		err = os.WriteFile(fn, formatted, 0o644)
+		err = os.WriteFile(fn, data, 0o644)
 	}
 	if err != nil {
 		log.Errorf("write file %q err: %s", fn, err)
 	}
 }
+
+var packageRE = regexp.MustCompile(`package\s+([a-zA-Z0-9_]+)`)
+
+// truncateFastPBFile truncates xxx.pb.fast.go to avoid using FastWrite/FastRead methods.
+//
+// NOTE: or we can remove the file directly?
+// since *.pb.fast.go files possibly maintained by git, modifying it would be better?
+func truncateFastPBFile(fn string) {
+	if !strings.HasSuffix(fn, ".pb.go") {
+		return
+	}
+	fn = strings.TrimSuffix(fn, ".pb.go") + ".pb.fast.go"
+	content, err := os.ReadFile(fn)
+	if err != nil {
+		// not exists?
+		return
+	}
+	b := []byte("// This file was generated by Fastpb, and it's deprecated by Kitex. Free to delete.\n\n")
+	b = append(b, packageRE.Find(content)...)
+	b = append(b, '\n')
+	os.WriteFile(fn, b, 0o644)
+}

tool/internal_pkg/prutal/prutal_test.go

@@ -19,6 +19,7 @@ package prutal
 import (
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/cloudwego/kitex/internal/test"
@@ -67,17 +68,27 @@ service ServiceC {
 }
 	`), 0o644)
 
+	fastpbFile := filepath.Join(dir, "kitex_gen/test/test.pb.fast.go")
+	err := os.MkdirAll(filepath.Dir(fastpbFile), 0o755)
+	test.Assert(t, err == nil, err)
+	err = os.WriteFile(fastpbFile, []byte("package test"), 0o644)
+	test.Assert(t, err == nil, err)
+
 	c := generator.Config{IDL: fn}
 	c.GenerateMain = true
 	c.CombineService = true
 	c.PackagePrefix = "github.com/cloudwego/kitex/tool/internal_pkg/prutal/kitex_gen"
 	c.OutputPath = dir
 	c.GenPath = "kitex_gen"
 	p := NewPrutalGen(c)
-	err := p.Process()
+	err = p.Process()
 	test.Assert(t, err == nil, err)
 
 	b, err := os.ReadFile(filepath.Join(dir, "kitex_gen/test/test.pb.go"))
 	test.Assert(t, err == nil, err)
 	t.Log(string(b))
+
+	b, err = os.ReadFile(fastpbFile)
+	test.Assert(t, err == nil, err)
+	test.Assert(t, strings.Contains(string(b), "deprecated"), string(b))
 }

version.go

@@ -19,5 +19,5 @@ package kitex
 // Name and Version info of this framework, used for statistics and debug
 const (
 	Name    = "Kitex"
-	Version = "v0.13.0"
+	Version = "v0.13.1"
 )