Merge pull request #1796 from cloudwego/release-v0.14.0

chore: release v0.14.0

Author: ppzqh

.codecov.yml

@@ -1,2 +1,5 @@
+github_checks:
+  annotations: false
+
 ignore:
   - "tool/**/*.go"

.github/workflows/tests.yml

@@ -4,13 +4,16 @@ on: [ push, pull_request ]
 
 jobs:
   unit-scenario-test:
+    strategy:
+      matrix:
+        go: [ "1.18", "1.24" ]
     runs-on: [ Linux, X64 ]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.24"
+          go-version: ${{ matrix.go }}
           cache: false
       - name: Scenario Tests
         run: |

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/kitex repo.
 5. In your forked repository, make your changes in a new git branch:
     ```
-    git checkout -b my-fix-branch develop
+    git checkout -b my-fix-branch main
     ```
 6. Create your patch, including appropriate test cases. Please refer to [Go-UT](https://pkg.go.dev/testing#pkg-overview) for writing guides. [Go-Mock](https://github.com/golang/mock) is recommended to mock interface, please refer to internal/mocks/readme.md for more details, and [Mockey](https://github.com/bytedance/mockey) is recommended to mock functions, please refer to its readme doc for specific usage.
 7. Follow our [Style Guides](#code-style-guides).
@@ -39,7 +39,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     ```
     git push origin my-fix-branch
     ```
-10. In GitHub, send a pull request to `kitex:develop` with a clear and unambiguous title.
+10. In GitHub, send a pull request to `kitex:main` with a clear and unambiguous title.
 
 ## Contribution Prerequisites
 - Our development environment keeps up with [Go Official](https://golang.org/project/).

client/genericclient/client.go

@@ -20,11 +20,15 @@ package genericclient
 import (
 	"context"
 	"runtime"
+	"sync"
 
 	"github.com/cloudwego/kitex/client"
 	"github.com/cloudwego/kitex/client/callopt"
+	"github.com/cloudwego/kitex/client/callopt/streamcall"
 	"github.com/cloudwego/kitex/pkg/generic"
 	"github.com/cloudwego/kitex/pkg/serviceinfo"
+	"github.com/cloudwego/kitex/pkg/streaming"
+	"github.com/cloudwego/kitex/transport"
 )
 
 var _ Client = &genericServiceClient{}
@@ -40,25 +44,40 @@ func NewClientWithServiceInfo(destService string, g generic.Generic, svcInfo *se
 	var options []client.Option
 	options = append(options, client.WithGeneric(g))
 	options = append(options, client.WithDestService(destService))
+	options = append(options, client.WithTransportProtocol(transport.TTHeaderStreaming))
 	options = append(options, opts...)
 
 	kc, err := client.NewClient(svcInfo, options...)
 	if err != nil {
 		return nil, err
 	}
+	var mp *sync.Map
+	if !generic.HasIDLInfo(g) {
+		mp = &sync.Map{}
+	}
 	cli := &genericServiceClient{
 		svcInfo: svcInfo,
 		kClient: kc,
+		sClient: kc.(client.Streaming),
 		g:       g,
+		modeMap: mp,
 	}
 	runtime.SetFinalizer(cli, (*genericServiceClient).Close)
 
 	svcInfo.GenericMethod = func(name string) serviceinfo.MethodInfo {
-		m := svcInfo.Methods[serviceinfo.GenericMethod]
+		key := serviceinfo.GenericMethod
+		if mp != nil {
+			if mode, ok := mp.Load(name); ok {
+				key = getGenericStreamingMethodInfoKey(mode.(serviceinfo.StreamingMode))
+			}
+			return svcInfo.Methods[key]
+		}
 		n, err := g.GetMethod(nil, name)
 		if err != nil {
-			return m
+			return svcInfo.Methods[key]
 		}
+		key = getGenericStreamingMethodInfoKey(n.StreamingMode)
+		m := svcInfo.Methods[key]
 		return &methodInfo{
 			MethodInfo: m,
 			oneway:     n.Oneway,
@@ -84,12 +103,23 @@ type Client interface {
 
 	// GenericCall generic call
 	GenericCall(ctx context.Context, method string, request interface{}, callOptions ...callopt.Option) (response interface{}, err error)
+	// ClientStreaming creates an implementation of ClientStreamingClient
+	ClientStreaming(ctx context.Context, method string, callOptions ...streamcall.Option) (ClientStreamingClient, error)
+	// ServerStreaming creates an implementation of ServerStreamingClient
+	ServerStreaming(ctx context.Context, method string, req interface{}, callOptions ...streamcall.Option) (ServerStreamingClient, error)
+	// BidirectionalStreaming creates an implementation of BidiStreamingClient
+	BidirectionalStreaming(ctx context.Context, method string, callOptions ...streamcall.Option) (BidiStreamingClient, error)
 }
 
 type genericServiceClient struct {
 	svcInfo *serviceinfo.ServiceInfo
 	kClient client.Client
+	sClient client.Streaming
 	g       generic.Generic
+	// modeMap stores the streaming mode of methods for binary generic
+	// because the streaming mode of a method is not stored in binary generic which doesn't have IDL info
+	// but we can know it when creating different streaming clients
+	modeMap *sync.Map // map[string]serviceinfo.StreamingMode
 }
 
 func (gc *genericServiceClient) GenericCall(ctx context.Context, method string, request interface{}, callOptions ...callopt.Option) (response interface{}, err error) {
@@ -121,3 +151,153 @@ func (gc *genericServiceClient) Close() error {
 	// Notice: don't need to close kClient because finalizer will close it.
 	return gc.g.Close()
 }
+
+func (gc *genericServiceClient) ClientStreaming(ctx context.Context, method string, callOptions ...streamcall.Option) (ClientStreamingClient, error) {
+	ctx = client.NewCtxWithCallOptions(ctx, streamcall.GetCallOptions(callOptions))
+	if gc.modeMap != nil {
+		gc.modeMap.LoadOrStore(method, serviceinfo.StreamingClient)
+	}
+	st, err := gc.sClient.StreamX(ctx, method)
+	if err != nil {
+		return nil, err
+	}
+	return newClientStreamingClient(gc.svcInfo.MethodInfo(method), method, st), nil
+}
+
+func (gc *genericServiceClient) ServerStreaming(ctx context.Context, method string, req interface{}, callOptions ...streamcall.Option) (ServerStreamingClient, error) {
+	ctx = client.NewCtxWithCallOptions(ctx, streamcall.GetCallOptions(callOptions))
+	if gc.modeMap != nil {
+		gc.modeMap.LoadOrStore(method, serviceinfo.StreamingServer)
+	}
+	st, err := gc.sClient.StreamX(ctx, method)
+	if err != nil {
+		return nil, err
+	}
+	stream := newServerStreamingClient(gc.svcInfo.MethodInfo(method), method, st).(*serverStreamingClient)
+
+	args := stream.methodInfo.NewArgs().(*generic.Args)
+	args.Method = stream.method
+	args.Request = req
+	if err := st.SendMsg(ctx, args); err != nil {
+		return nil, err
+	}
+	if err := stream.CloseSend(ctx); err != nil {
+		return nil, err
+	}
+	return stream, nil
+}
+
+func (gc *genericServiceClient) BidirectionalStreaming(ctx context.Context, method string, callOptions ...streamcall.Option) (BidiStreamingClient, error) {
+	ctx = client.NewCtxWithCallOptions(ctx, streamcall.GetCallOptions(callOptions))
+	if gc.modeMap != nil {
+		gc.modeMap.LoadOrStore(method, serviceinfo.StreamingBidirectional)
+	}
+	st, err := gc.sClient.StreamX(ctx, method)
+	if err != nil {
+		return nil, err
+	}
+	return newBidiStreamingClient(gc.svcInfo.MethodInfo(method), method, st), nil
+}
+
+// ClientStreamingClient define client side generic client streaming APIs
+type ClientStreamingClient interface {
+	Send(ctx context.Context, req interface{}) error
+	CloseAndRecv(ctx context.Context) (interface{}, error)
+	streaming.ClientStream
+}
+
+type clientStreamingClient struct {
+	methodInfo serviceinfo.MethodInfo
+	method     string
+	streaming.ClientStream
+}
+
+func newClientStreamingClient(methodInfo serviceinfo.MethodInfo, method string, st streaming.ClientStream) ClientStreamingClient {
+	return &clientStreamingClient{
+		methodInfo:   methodInfo,
+		method:       method,
+		ClientStream: st,
+	}
+}
+
+func (c *clientStreamingClient) Send(ctx context.Context, req interface{}) error {
+	args := c.methodInfo.NewArgs().(*generic.Args)
+	args.Method = c.method
+	args.Request = req
+	return c.ClientStream.SendMsg(ctx, args)
+}
+
+func (c *clientStreamingClient) CloseAndRecv(ctx context.Context) (interface{}, error) {
+	if err := c.ClientStream.CloseSend(ctx); err != nil {
+		return nil, err
+	}
+	res := c.methodInfo.NewResult().(*generic.Result)
+	if err := c.ClientStream.RecvMsg(ctx, res); err != nil {
+		return nil, err
+	}
+	return res.GetSuccess(), nil
+}
+
+// ServerStreamingClient define client side generic server streaming APIs
+type ServerStreamingClient interface {
+	Recv(ctx context.Context) (interface{}, error)
+	streaming.ClientStream
+}
+
+type serverStreamingClient struct {
+	methodInfo serviceinfo.MethodInfo
+	method     string
+	streaming.ClientStream
+}
+
+func newServerStreamingClient(methodInfo serviceinfo.MethodInfo, method string, st streaming.ClientStream) ServerStreamingClient {
+	return &serverStreamingClient{
+		methodInfo:   methodInfo,
+		method:       method,
+		ClientStream: st,
+	}
+}
+
+func (c *serverStreamingClient) Recv(ctx context.Context) (interface{}, error) {
+	res := c.methodInfo.NewResult().(*generic.Result)
+	if err := c.ClientStream.RecvMsg(ctx, res); err != nil {
+		return nil, err
+	}
+	return res.GetSuccess(), nil
+}
+
+// BidiStreamingClient define client side generic bidirectional streaming APIs
+type BidiStreamingClient interface {
+	Send(ctx context.Context, req interface{}) error
+	Recv(ctx context.Context) (interface{}, error)
+	streaming.ClientStream
+}
+
+type bidiStreamingClient struct {
+	methodInfo serviceinfo.MethodInfo
+	method     string
+	streaming.ClientStream
+}
+
+func newBidiStreamingClient(methodInfo serviceinfo.MethodInfo, method string, st streaming.ClientStream) BidiStreamingClient {
+	return &bidiStreamingClient{
+		methodInfo:   methodInfo,
+		method:       method,
+		ClientStream: st,
+	}
+}
+
+func (c *bidiStreamingClient) Send(ctx context.Context, req interface{}) error {
+	args := c.methodInfo.NewArgs().(*generic.Args)
+	args.Method = c.method
+	args.Request = req
+	return c.ClientStream.SendMsg(ctx, args)
+}
+
+func (c *bidiStreamingClient) Recv(ctx context.Context) (interface{}, error) {
+	res := c.methodInfo.NewResult().(*generic.Result)
+	if err := c.ClientStream.RecvMsg(ctx, res); err != nil {
+		return nil, err
+	}
+	return res.GetSuccess(), nil
+}

client/genericclient/generic_stream_service.go

@@ -21,91 +21,7 @@ import (
 	"github.com/cloudwego/kitex/pkg/serviceinfo"
 )
 
+// Deprecated, use generic.ServiceInfoWithGeneric instead
 func StreamingServiceInfo(g generic.Generic) *serviceinfo.ServiceInfo {
-	return newClientStreamingServiceInfo(g)
-}
-
-func newClientStreamingServiceInfo(g generic.Generic) *serviceinfo.ServiceInfo {
-	if g.PayloadCodec() != nil {
-		// TODO: support grpc binary generic
-		panic("binary generic streaming is not supported")
-	}
-
-	methods := map[string]serviceinfo.MethodInfo{
-		serviceinfo.GenericClientStreamingMethod: serviceinfo.NewMethodInfo(
-			nil,
-			func() interface{} {
-				args := &generic.Args{}
-				args.SetCodec(g.MessageReaderWriter())
-				return args
-			},
-			func() interface{} {
-				result := &generic.Result{}
-				result.SetCodec(g.MessageReaderWriter())
-				return result
-			},
-			false,
-			serviceinfo.WithStreamingMode(serviceinfo.StreamingClient),
-		),
-		serviceinfo.GenericServerStreamingMethod: serviceinfo.NewMethodInfo(
-			nil,
-			func() interface{} {
-				args := &generic.Args{}
-				args.SetCodec(g.MessageReaderWriter())
-				return args
-			},
-			func() interface{} {
-				result := &generic.Result{}
-				result.SetCodec(g.MessageReaderWriter())
-				return result
-			},
-			false,
-			serviceinfo.WithStreamingMode(serviceinfo.StreamingServer),
-		),
-		serviceinfo.GenericBidirectionalStreamingMethod: serviceinfo.NewMethodInfo(
-			nil,
-			func() interface{} {
-				args := &generic.Args{}
-				args.SetCodec(g.MessageReaderWriter())
-				return args
-			},
-			func() interface{} {
-				result := &generic.Result{}
-				result.SetCodec(g.MessageReaderWriter())
-				return result
-			},
-			false,
-			serviceinfo.WithStreamingMode(serviceinfo.StreamingBidirectional),
-		),
-		serviceinfo.GenericMethod: serviceinfo.NewMethodInfo(
-			nil,
-			func() interface{} {
-				args := &generic.Args{}
-				args.SetCodec(g.MessageReaderWriter())
-				return args
-			},
-			func() interface{} {
-				result := &generic.Result{}
-				result.SetCodec(g.MessageReaderWriter())
-				return result
-			},
-			false,
-		),
-	}
-	svcInfo := &serviceinfo.ServiceInfo{
-		ServiceName:  g.IDLServiceName(),
-		Methods:      methods,
-		PayloadCodec: g.PayloadCodecType(),
-		Extra:        make(map[string]interface{}),
-	}
-	svcInfo.Extra["generic"] = true
-	if extra, ok := g.(generic.ExtraProvider); ok {
-		if extra.GetExtra(generic.CombineServiceKey) == "true" {
-			svcInfo.Extra["combine_service"] = true
-		}
-		if pkg := extra.GetExtra("PackageName"); pkg != "" {
-			svcInfo.Extra["PackageName"] = pkg
-		}
-	}
-	return svcInfo
+	return generic.ServiceInfoWithGeneric(g)
 }