feat: Using subcommands to optimize template usability

.github/workflows/release-check.yml

@@ -0,0 +1,25 @@
+name: Release Check
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check Source Branch
+        run: python2 -c "exit(0 if '${{ github.head_ref }}'.startswith('release') or '${{ github.head_ref }}'.startswith('hotfix') else 1)"
+
+      - name: Check Version
+        run: |
+          # get version code, runner not support grep -E here
+          SOURCE_VERSION=`grep 'Version\s*=\s*\"v[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}\"' *.go | awk -F '\"' '{print $(NF-1)}'`
+          git checkout main
+          MASTER_VERSION=`grep 'Version\s*=\s*\"v[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}\"' *.go | awk -F '\"' '{print $(NF-1)}'`
+          git checkout ${{Head.SHA}}
+          # check version update
+          python2 -c "exit(0 if list(map(int,'${SOURCE_VERSION#v}'.split('.')[:3])) > list(map(int,'${MASTER_VERSION#v}'.split('.')[:3])) else 1)"

internal/generic/proto/json.go

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package proto
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/cloudwego/dynamicgo/conv"
+	dconvj2p "github.com/cloudwego/dynamicgo/conv/j2p"
+	dconvp2j "github.com/cloudwego/dynamicgo/conv/p2j"
+	dproto "github.com/cloudwego/dynamicgo/proto"
+
+	"github.com/cloudwego/kitex/pkg/remote/codec/perrors"
+	"github.com/cloudwego/kitex/pkg/utils"
+)
+
+type JSONReaderWriter struct {
+	*ReadJSON
+	*WriteJSON
+}
+
+func NewJsonReaderWriter(svc *dproto.ServiceDescriptor, convOpts *conv.Options) *JSONReaderWriter {
+	return &JSONReaderWriter{ReadJSON: NewReadJSON(svc, convOpts), WriteJSON: NewWriteJSON(svc, convOpts)}
+}
+
+// NewWriteJSON build WriteJSON according to ServiceDescriptor
+func NewWriteJSON(svc *dproto.ServiceDescriptor, convOpts *conv.Options) *WriteJSON {
+	return &WriteJSON{
+		svcDsc:            svc,
+		dynamicgoConvOpts: convOpts,
+	}
+}
+
+// WriteJSON implement of MessageWriter
+type WriteJSON struct {
+	svcDsc            *dproto.ServiceDescriptor
+	dynamicgoConvOpts *conv.Options
+}
+
+var _ MessageWriter = (*WriteJSON)(nil)
+
+// Write converts msg to protobuf wire format and returns an output bytebuffer
+func (m *WriteJSON) Write(ctx context.Context, msg interface{}, method string, isClient bool) (interface{}, error) {
+	var s string
+	if msg == nil {
+		s = "{}"
+	} else {
+		// msg is string
+		var ok bool
+		s, ok = msg.(string)
+		if !ok {
+			return nil, perrors.NewProtocolErrorWithType(perrors.InvalidData, "decode msg failed, is not string")
+		}
+	}
+
+	cv := dconvj2p.NewBinaryConv(*m.dynamicgoConvOpts)
+
+	fnDsc := m.svcDsc.LookupMethodByName(method)
+	if fnDsc == nil {
+		return nil, fmt.Errorf("missing method: %s in service: %s", method, m.svcDsc.Name())
+	}
+
+	// from the proto.ServiceDescriptor, get the TypeDescriptor
+	typeDsc := fnDsc.Input()
+	if !isClient {
+		typeDsc = fnDsc.Output()
+	}
+
+	// get protobuf-encode bytes
+	actualMsgBuf, err := cv.Do(ctx, typeDsc, utils.StringToSliceByte(s))
+	if err != nil {
+		return nil, perrors.NewProtocolErrorWithErrMsg(err, fmt.Sprintf("protobuf marshal message failed: %s", err.Error()))
+	}
+	return actualMsgBuf, nil
+}
+
+// NewReadJSON build ReadJSON according to ServiceDescriptor
+func NewReadJSON(svc *dproto.ServiceDescriptor, convOpts *conv.Options) *ReadJSON {
+	// extract svc to be used to convert later
+	return &ReadJSON{
+		dynamicgoConvOpts: convOpts,
+		dynamicgoSvcDsc:   svc,
+	}
+}
+
+// ReadJSON implement of MessageReaderWithMethod
+type ReadJSON struct {
+	dynamicgoConvOpts *conv.Options
+	dynamicgoSvcDsc   *dproto.ServiceDescriptor
+}
+
+var _ MessageReader = (*ReadJSON)(nil)
+
+// Read reads data from actualMsgBuf and convert to json string
+func (m *ReadJSON) Read(ctx context.Context, method string, isClient bool, actualMsgBuf []byte) (interface{}, error) {
+	// create dynamic message here, once method string has been extracted
+	fnDsc := m.dynamicgoSvcDsc.LookupMethodByName(method)
+	if fnDsc == nil {
+		return nil, fmt.Errorf("missing method: %s in service: %s", method, m.dynamicgoSvcDsc.Name())
+	}
+
+	// from the dproto.ServiceDescriptor, get the TypeDescriptor
+	typeDescriptor := fnDsc.Output()
+	if !isClient {
+		typeDescriptor = fnDsc.Input()
+	}
+
+	cv := dconvp2j.NewBinaryConv(*m.dynamicgoConvOpts)
+	out, err := cv.Do(context.Background(), typeDescriptor, actualMsgBuf)
+	if err != nil {
+		return nil, err
+	}
+
+	return string(out), nil
+}

internal/generic/proto/json_test.go

@@ -0,0 +1,146 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package proto
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+	"reflect"
+	"testing"
+
+	"github.com/cloudwego/dynamicgo/conv"
+	"github.com/cloudwego/dynamicgo/proto"
+	"github.com/cloudwego/dynamicgo/testdata/kitex_gen/pb/example2"
+	goprotowire "google.golang.org/protobuf/encoding/protowire"
+
+	"github.com/cloudwego/kitex/internal/test"
+)
+
+var (
+	example2IDLPath   = "../../../pkg/generic/jsonpb_test/idl/example2.proto"
+	example2ProtoPath = "../../../pkg/generic/jsonpb_test/data/example2_pb.bin"
+)
+
+func TestRun(t *testing.T) {
+	t.Run("TestWrite", TestWrite)
+	t.Run("TestRead", TestRead)
+}
+
+// Check NewWriteJSON converting JSON to protobuf wire format
+func TestWrite(t *testing.T) {
+	method := "ExampleMethod"
+
+	opts := proto.Options{}
+	svc, err := opts.NewDescriptorFromPath(context.Background(), example2IDLPath)
+	test.Assert(t, err == nil)
+
+	msg := getExampleReq()
+
+	// get expected json struct
+	exp := &example2.ExampleReq{}
+	json.Unmarshal([]byte(msg), exp)
+
+	// marshal json string into protobuf wire format using Write
+	wm := NewWriteJSON(svc, &conv.Options{})
+	out, err := wm.Write(context.Background(), msg, method, true)
+	test.Assert(t, err == nil)
+	buf, ok := out.([]byte)
+	test.Assert(t, ok)
+
+	// read into struct using fastread
+	act := &example2.ExampleReq{}
+	l := 0
+	// fmt.Print(out)
+	dataLen := len(buf)
+	// fastRead to get target struct
+	for l < dataLen {
+		id, wtyp, tagLen := goprotowire.ConsumeTag(buf)
+		if tagLen < 0 {
+			t.Fatal("test failed")
+		}
+		l += tagLen
+		buf = buf[tagLen:]
+		offset, err := act.FastRead(buf, int8(wtyp), int32(id))
+		test.Assert(t, err == nil)
+		buf = buf[offset:]
+		l += offset
+	}
+	test.Assert(t, err == nil)
+	// compare exp and act struct
+	test.Assert(t, reflect.DeepEqual(exp, act))
+}
+
+// Check NewReadJSON converting protobuf wire format to JSON
+func TestRead(t *testing.T) {
+	// get protobuf wire format data
+	in := readExampleReqProtoBufData()
+	method := "ExampleMethod"
+
+	opts := proto.Options{}
+	svc, err := opts.NewDescriptorFromPath(context.Background(), example2IDLPath)
+	test.Assert(t, err == nil)
+
+	// unmarshal protobuf wire format into json string using Read
+	rm := NewReadJSON(svc, &conv.Options{})
+	out, err := rm.Read(context.Background(), method, false, in)
+	test.Assert(t, err == nil)
+
+	// get expected json struct
+	exp := &example2.ExampleReq{}
+
+	l := 0
+	dataLen := len(in)
+	for l < dataLen {
+		id, wtyp, tagLen := goprotowire.ConsumeTag(in)
+		if tagLen < 0 {
+			t.Fatal("proto data error format")
+		}
+		l += tagLen
+		in = in[tagLen:]
+		offset, err := exp.FastRead(in, int8(wtyp), int32(id))
+		test.Assert(t, err == nil)
+		in = in[offset:]
+		l += offset
+	}
+	if len(in) != 0 {
+		t.Fatal("proto data error format")
+	}
+	test.Assert(t, err == nil)
+
+	act := &example2.ExampleReq{}
+	str, ok := out.(string)
+	test.Assert(t, ok)
+	json.Unmarshal([]byte(str), &act)
+	// compare exp and act struct
+	test.Assert(t, reflect.DeepEqual(exp, act))
+}
+
+// helper methods
+// comes from https://github.com/cloudwego/dynamicgo/blob/main/testdata/data/example2req.json
+func getExampleReq() string {
+	return `{"Msg":"hello","A":25,"InnerBase2":{"Bool":true,"Uint32":123,"Uint64":123,"Int32":123,"SInt64":123,"Double":22.3,"String":"hello_inner","ListInt32":[12,13,14,15,16,17],"MapStringString":{"m1":"aaa","m2":"bbb"},"ListSInt64":[200,201,202,203,204,205],"MapInt32String":{"1":"aaa","2":"bbb","3":"ccc","4":"ddd"},"Binary":"AQIDBA==","MapUint32String":{"1":"u32aa","2":"u32bb","3":"u32cc","4":"u32dd"},"MapUint64String":{"1":"u64aa","2":"u64bb","3":"u64cc","4":"u64dd"},"MapInt64String":{"1":"64aaa","2":"64bbb","3":"64ccc","4":"64ddd"},"MapInt64Base":{"1":{"LogID":"logId","Caller":"caller","Addr":"addr","Client":"client","TrafficEnv":{"Env":"env"},"Extra":{"1a":"aaa","2a":"bbb","3a":"ccc","4a":"ddd"}},"2":{"LogID":"logId2","Caller":"caller2","Addr":"addr2","Client":"client2","TrafficEnv":{"Open":true,"Env":"env2"},"Extra":{"1a":"aaa2","2a":"bbb2","3a":"ccc2","4a":"ddd2"}}},"MapStringBase":{"1":{"LogID":"logId","Caller":"caller","Addr":"addr","Client":"client","TrafficEnv":{"Env":"env"},"Extra":{"1a":"aaa","2a":"bbb","3a":"ccc","4a":"ddd"}},"2":{"LogID":"logId2","Caller":"caller2","Addr":"addr2","Client":"client2","TrafficEnv":{"Open":true,"Env":"env2"},"Extra":{"1a":"aaa2","2a":"bbb2","3a":"ccc2","4a":"ddd2"}}},"ListBase":[{"LogID":"logId","Caller":"caller","Addr":"addr","Client":"client","TrafficEnv":{"Env":"env"},"Extra":{"1a":"aaa","2a":"bbb","3a":"ccc","4a":"ddd"}},{"LogID":"logId2","Caller":"caller2","Addr":"addr2","Client":"client2","TrafficEnv":{"Open":true,"Env":"env2"},"Extra":{"1a":"aaa2","2a":"bbb2","3a":"ccc2","4a":"ddd2"}}],"ListString":["111","222","333","44","51","6"],"Base":{"LogID":"logId","Caller":"caller","Addr":"addr","Client":"client","TrafficEnv":{"Env":"env"},"Extra":{"1b":"aaa","2b":"bbb","3b":"ccc","4b":"ddd"}}}}`
+}
+
+// read ProtoBuf's data in binary format from exampleProtoPath
+func readExampleReqProtoBufData() []byte {
+	out, err := os.ReadFile(example2ProtoPath)
+	if err != nil {
+		panic(err)
+	}
+	return out
+}

internal/generic/proto/protobuf.go

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package proto
+
+import (
+	"context"
+)
+
+// MessageReader read from ActualMsgBuf with method and returns a string
+type MessageReader interface {
+	Read(ctx context.Context, method string, isClient bool, actualMsgBuf []byte) (interface{}, error)
+}
+
+// MessageWriter writes to a converts json to protobufs wireformat and returns an output bytebuffer
+type MessageWriter interface {
+	Write(ctx context.Context, msg interface{}, method string, isClient bool) (interface{}, error)
+}

internal/generic/thrift/binary.go

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package thrift
+
+import (
+	"context"
+
+	"github.com/cloudwego/gopkg/bufiox"
+	"github.com/cloudwego/gopkg/protocol/thrift/base"
+)
+
+// WriteBinary implement of MessageWriter
+type WriteBinary struct{}
+
+func NewWriteBinary() *WriteBinary {
+	return &WriteBinary{}
+}
+
+func (w *WriteBinary) Write(ctx context.Context, out bufiox.Writer, msg interface{}, method string, isClient bool, requestBase *base.Base) error {
+	return nil
+}