refactor(proto)!: move grpc service definition in protodb/v1alpha1

Signed-off-by: Adphi <philippe.adrien.nousse@gmail.com>

Author: Adphi

Makefile

@@ -52,6 +52,7 @@ bin:
 	@go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2
 	@go install github.com/alta/protopatch/cmd/protoc-gen-go-patch
 	@go install github.com/planetscale/vtprotobuf/cmd/protoc-gen-go-vtproto
+	@go install github.com/bufbuild/buf/cmd/buf@v1.45.0
 
 clean:
 	@rm -rf .bin
@@ -63,7 +64,8 @@ proto: gen-proto lint
 
 .PHONY: gen-proto
 gen-proto: protoc-gen-protodb
-	@find $(PROTO_BASE_PATH) -name '*.proto' -type f -exec \
+	@buf generate
+	@find $(PROTO_BASE_PATH)/tests -name '*.proto' -type f -exec \
     	protoc $(INCLUDE_PROTO_PATH) \
     		--go-patch_out=plugin=go,$(PROTO_OPTS):. \
     		--go-patch_out=plugin=go-grpc,$(PROTO_OPTS):. \

buf.gen.yaml

@@ -1,6 +1,39 @@
 version: v2
 plugins:
-- local: protoc-gen-go
+- local: protoc-gen-go-patch
   out: .
   opt:
+  - plugin=go
   - paths=source_relative
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=go-grpc
+  - paths=source_relative
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=defaults
+  - paths=source_relative
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=go-fields
+  - paths=source_relative
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=proxy
+  - paths=source_relative
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=go-vtproto
+  - paths=source_relative
+  - features=marshal+unmarshal+size+clone+equal
+- local: protoc-gen-go-patch
+  out: .
+  opt:
+  - plugin=validate
+  - paths=source_relative
+  - lang=go

buf.lock

@@ -0,0 +1,15 @@
+# Generated by buf. DO NOT EDIT.
+version: v2
+deps:
+  - name: buf.build/envoyproxy/protoc-gen-validate
+    commit: daf171c6cdb54629b5f51e345a79e4dd
+    digest: b5:c745e1521879f43740230b1df673d0729f55704efefdcfc489d4a0a2d40c92a26cacfeab62813403040a8b180142d53b398c7ca784a065e43823605ee49681de
+  - name: buf.build/linka-cloud/protodb
+    commit: bb18e34411f948f69750580fb9d83c8f
+    digest: b5:99edeb77ff47c9001444240f677e4f6ac68a293325a13996e9d91ad5df02838a40503ad38493f1087d3941bd353a23a1788cedfa085c35e7fff80a51ed027783
+  - name: buf.build/linka-cloud/protofilters
+    commit: 5bf1a419b8964a539fe28cb1191c4a98
+    digest: b5:2fae1db1ae748f1a84df3ec74164d546b731ffbeb73d20fba4a56ca69a595ba74d11db79c4b1155a2fedd7513823836fce252e0c69e799fcb39579d86e60e9e4
+  - name: buf.build/linka-cloud/protopatch
+    commit: b5f63439229a460e92dfb918d306f5bf
+    digest: b5:2445ff476340c613ee0fa0ad12a178b6f9d1ad45319c07142839e500d875cc9a652bf9b9529961d3e6ae2282367aa94ad663786cd9fe94c6099690776843f19c

buf.yaml

@@ -11,3 +11,8 @@ lint:
 breaking:
   use:
     - FILE
+deps:
+- buf.build/envoyproxy/protoc-gen-validate
+- buf.build/linka-cloud/protopatch
+- buf.build/linka-cloud/protodb
+- buf.build/linka-cloud/protofilters

cmp.go

@@ -23,11 +23,11 @@ import (
 	"google.golang.org/protobuf/reflect/protoreflect"
 	"google.golang.org/protobuf/types/known/structpb"
 
-	"go.linka.cloud/protodb/pb"
+	"go.linka.cloud/protodb/protodb/v1alpha1"
 )
 
-func cmpField(f protoreflect.FieldDescriptor, v1, v2 protoreflect.Value, prefix string, diffs map[string]*pb.FieldDiff) {
-	diff := &pb.FieldDiff{}
+func cmpField(f protoreflect.FieldDescriptor, v1, v2 protoreflect.Value, prefix string, diffs map[string]*v1alpha1.FieldDiff) {
+	diff := &v1alpha1.FieldDiff{}
 	equals := false
 	switch f.Kind() {
 	case protoreflect.BoolKind:
@@ -114,7 +114,7 @@ func cmpField(f protoreflect.FieldDescriptor, v1, v2 protoreflect.Value, prefix
 		if !f.IsList() {
 			p += string(f.Name())
 		}
-		var mdiff map[string]*pb.FieldDiff
+		var mdiff map[string]*v1alpha1.FieldDiff
 		switch {
 		case v1.IsValid() && v2.IsValid():
 			mdiff = cmp(v1.Message().Interface(), v2.Message().Interface(), p)
@@ -134,11 +134,11 @@ func cmpField(f protoreflect.FieldDescriptor, v1, v2 protoreflect.Value, prefix
 	}
 }
 
-func cmp(m1, m2 proto.Message, prefix string) map[string]*pb.FieldDiff {
+func cmp(m1, m2 proto.Message, prefix string) map[string]*v1alpha1.FieldDiff {
 	if prefix != "" {
 		prefix += "."
 	}
-	diffs := make(map[string]*pb.FieldDiff)
+	diffs := make(map[string]*v1alpha1.FieldDiff)
 	var m proto.Message
 	switch {
 	case m1 != nil:
@@ -217,12 +217,12 @@ func cmp(m1, m2 proto.Message, prefix string) map[string]*pb.FieldDiff {
 	return diffs
 }
 
-func Cmp(m1, m2 proto.Message) (*pb.MessageDiff, error) {
+func Cmp(m1, m2 proto.Message) (*v1alpha1.MessageDiff, error) {
 	if m1 != nil && m2 != nil {
 		if n1, n2 := m1.ProtoReflect().Descriptor().FullName(), m2.ProtoReflect().Descriptor().FullName(); n1 != n2 {
 			return nil, fmt.Errorf("cannot compare two different types: %s and %s", n1, n2)
 		}
 	}
 	diffs := cmp(m1, m2, "")
-	return &pb.MessageDiff{Fields: diffs}, nil
+	return &v1alpha1.MessageDiff{Fields: diffs}, nil
 }

internal/badgerd/replication/gossip/gossip.go

@@ -37,7 +37,7 @@ import (
 	"go.linka.cloud/protodb/internal/badgerd/dns"
 	"go.linka.cloud/protodb/internal/badgerd/replication"
 	pb2 "go.linka.cloud/protodb/internal/badgerd/replication/gossip/pb"
-	"go.linka.cloud/protodb/pb"
+	"go.linka.cloud/protodb/protodb/v1alpha1"
 )
 
 var (
@@ -54,7 +54,7 @@ var defaultOptions = replication.Options{
 
 type Gossip struct {
 	pb2.UnsafeReplicationServiceServer
-	pb.UnsafeProtoDBServer
+	v1alpha1.UnsafeProtoDBServer
 
 	ctx    context.Context
 	cancel context.CancelFunc
@@ -73,7 +73,7 @@ type Gossip struct {
 	nodes   Map[*node]
 
 	svc       service.Service
-	h         pb.ProtoDBServer
+	h         v1alpha1.ProtoDBServer
 	events    chan memberlist.NodeEvent
 	once      sync.Once
 	ready     chan struct{}

internal/badgerd/replication/gossip/nodes.go

@@ -32,7 +32,7 @@ import (
 	"google.golang.org/grpc/credentials/insecure"
 
 	pb2 "go.linka.cloud/protodb/internal/badgerd/replication/gossip/pb"
-	"go.linka.cloud/protodb/pb"
+	"go.linka.cloud/protodb/protodb/v1alpha1"
 )
 
 type node struct {
@@ -41,7 +41,7 @@ type node struct {
 	addr  net.IP
 	cc    *grpc.ClientConn
 	repl  pb2.ReplicationServiceClient
-	proxy pb.ProtoDBServer
+	proxy v1alpha1.ProtoDBServer
 	// elect pb2.ReplicationService_ElectionClient
 }
 
@@ -145,7 +145,7 @@ func (r *Gossip) handleEvent(ctx context.Context, e memberlist.NodeEvent) {
 			meta:  m,
 			cc:    c,
 			repl:  cs,
-			proxy: pb.NewProtoDBProxy(pb.NewProtoDBClient(c)),
+			proxy: v1alpha1.NewProtoDBProxy(v1alpha1.NewProtoDBClient(c)),
 		})
 		log.Infof("connected to %s", e.Node.Name)
 		if e.Node.Name == r.leaderName.Load() {

internal/client/client.go

@@ -36,7 +36,7 @@ import (
 
 	"go.linka.cloud/protodb/internal/anypb"
 	"go.linka.cloud/protodb/internal/protodb"
-	"go.linka.cloud/protodb/pb"
+	"go.linka.cloud/protodb/protodb/v1alpha1"
 )
 
 type Client interface {
@@ -51,35 +51,35 @@ type Client interface {
 }
 
 func NewClient(cc grpc.ClientConnInterface) (Client, error) {
-	return &client{c: pb.NewProtoDBClient(cc)}, nil
+	return &client{c: v1alpha1.NewProtoDBClient(cc)}, nil
 }
 
 type client struct {
-	c     pb.ProtoDBClient
-	locks map[string]grpc.ServerStreamingClient[pb.LockResponse]
+	c     v1alpha1.ProtoDBClient
+	locks map[string]grpc.ServerStreamingClient[v1alpha1.LockResponse]
 	mu    sync.Mutex
 }
 
 func (c *client) RegisterProto(ctx context.Context, file *descriptorpb.FileDescriptorProto) error {
-	_, err := c.c.Register(ctx, &pb.RegisterRequest{File: file})
+	_, err := c.c.Register(ctx, &v1alpha1.RegisterRequest{File: file})
 	return err
 }
 
 func (c *client) Register(ctx context.Context, file protoreflect.FileDescriptor) error {
-	_, err := c.c.Register(ctx, &pb.RegisterRequest{File: protodesc.ToFileDescriptorProto(file)})
+	_, err := c.c.Register(ctx, &v1alpha1.RegisterRequest{File: protodesc.ToFileDescriptorProto(file)})
 	return err
 }
 
 func (c *client) Descriptors(ctx context.Context) ([]*descriptorpb.DescriptorProto, error) {
-	res, err := c.c.Descriptors(ctx, &pb.DescriptorsRequest{})
+	res, err := c.c.Descriptors(ctx, &v1alpha1.DescriptorsRequest{})
 	if err != nil {
 		return nil, err
 	}
 	return res.Results, nil
 }
 
 func (c *client) FileDescriptors(ctx context.Context) ([]*descriptorpb.FileDescriptorProto, error) {
-	res, err := c.c.FileDescriptors(ctx, &pb.FileDescriptorsRequest{})
+	res, err := c.c.FileDescriptors(ctx, &v1alpha1.FileDescriptorsRequest{})
 	if err != nil {
 		return nil, err
 	}
@@ -96,7 +96,7 @@ func (c *client) Get(ctx context.Context, m proto.Message, opts ...protodb.GetOp
 	if o.Filter != nil {
 		f = o.Filter.Expr()
 	}
-	res, err := c.c.Get(ctx, &pb.GetRequest{Search: a, Filter: f, Paging: o.Paging, FieldMask: o.FieldMask, Reverse: o.Reverse, One: o.One, OrderBy: o.OrderBy})
+	res, err := c.c.Get(ctx, &v1alpha1.GetRequest{Search: a, Filter: f, Paging: o.Paging, FieldMask: o.FieldMask, Reverse: o.Reverse, One: o.One, OrderBy: o.OrderBy})
 	if err != nil {
 		return nil, nil, err
 	}
@@ -125,7 +125,7 @@ func (c *client) Set(ctx context.Context, m proto.Message, opts ...protodb.SetOp
 	if o.TTL != 0 {
 		ttl = durationpb.New(o.TTL)
 	}
-	res, err := c.c.Set(ctx, &pb.SetRequest{Payload: a, TTL: ttl, FieldMask: o.FieldMask})
+	res, err := c.c.Set(ctx, &v1alpha1.SetRequest{Payload: a, TTL: ttl, FieldMask: o.FieldMask})
 	if err != nil {
 		return nil, err
 	}
@@ -141,12 +141,12 @@ func (c *client) Delete(ctx context.Context, m proto.Message) error {
 	if err != nil {
 		return err
 	}
-	_, err = c.c.Delete(ctx, &pb.DeleteRequest{Payload: a})
+	_, err = c.c.Delete(ctx, &v1alpha1.DeleteRequest{Payload: a})
 	return err
 }
 
 func (c *client) NextSeq(ctx context.Context, name string) (uint64, error) {
-	res, err := c.c.NextSeq(ctx, &pb.NextSeqRequest{Key: name})
+	res, err := c.c.NextSeq(ctx, &v1alpha1.NextSeqRequest{Key: name})
 	if err != nil {
 		return 0, err
 	}
@@ -158,7 +158,7 @@ func (c *client) Lock(ctx context.Context, key string) error {
 	if err != nil {
 		return err
 	}
-	if err := s.Send(&pb.LockRequest{Key: key}); err != nil {
+	if err := s.Send(&v1alpha1.LockRequest{Key: key}); err != nil {
 		return err
 	}
 	if _, err := s.Recv(); err != nil {
@@ -199,7 +199,7 @@ func (c *client) Watch(ctx context.Context, m proto.Message, opts ...protodb.Get
 	if o.Filter != nil {
 		f = o.Filter.Expr()
 	}
-	w, err := c.c.Watch(ctx, &pb.WatchRequest{Search: a, Filter: f})
+	w, err := c.c.Watch(ctx, &v1alpha1.WatchRequest{Search: a, Filter: f})
 	if err != nil {
 		return nil, err
 	}
@@ -238,7 +238,7 @@ func (c *client) newTx(ctx context.Context, opts ...protodb.TxOption) (protodb.T
 		opt(&o)
 	}
 	if o.ReadOnly {
-		ctx = metadata.AppendToOutgoingContext(ctx, pb.ReadOnlyTxKey, "true")
+		ctx = metadata.AppendToOutgoingContext(ctx, v1alpha1.ReadOnlyTxKey, "true")
 	}
 	txn, err := c.c.Tx(ctx)
 	if err != nil {
@@ -249,7 +249,7 @@ func (c *client) newTx(ctx context.Context, opts ...protodb.TxOption) (protodb.T
 
 type txc struct {
 	ctx context.Context
-	txn pb.ProtoDB_TxClient
+	txn v1alpha1.ProtoDB_TxClient
 }
 
 func (t *txc) Get(ctx context.Context, m proto.Message, opts ...protodb.GetOption) ([]proto.Message, *protodb.PagingInfo, error) {
@@ -262,9 +262,9 @@ func (t *txc) Get(ctx context.Context, m proto.Message, opts ...protodb.GetOptio
 	if o.Filter != nil {
 		f = o.Filter.Expr()
 	}
-	if err := t.txn.Send(&pb.TxRequest{
-		Request: &pb.TxRequest_Get{
-			Get: &pb.GetRequest{Search: a, Filter: f, Paging: o.Paging, FieldMask: o.FieldMask, Reverse: o.Reverse, One: o.One, OrderBy: o.OrderBy},
+	if err := t.txn.Send(&v1alpha1.TxRequest{
+		Request: &v1alpha1.TxRequest_Get{
+			Get: &v1alpha1.GetRequest{Search: a, Filter: f, Paging: o.Paging, FieldMask: o.FieldMask, Reverse: o.Reverse, One: o.One, OrderBy: o.OrderBy},
 		},
 	}); err != nil {
 		return nil, nil, err
@@ -301,9 +301,9 @@ func (t *txc) Set(ctx context.Context, m proto.Message, opts ...protodb.SetOptio
 	if o.TTL != 0 {
 		ttl = durationpb.New(o.TTL)
 	}
-	if err := t.txn.Send(&pb.TxRequest{
-		Request: &pb.TxRequest_Set{
-			Set: &pb.SetRequest{Payload: a, TTL: ttl, FieldMask: o.FieldMask},
+	if err := t.txn.Send(&v1alpha1.TxRequest{
+		Request: &v1alpha1.TxRequest_Set{
+			Set: &v1alpha1.SetRequest{Payload: a, TTL: ttl, FieldMask: o.FieldMask},
 		},
 	}); err != nil {
 		return nil, err
@@ -327,9 +327,9 @@ func (t *txc) Delete(ctx context.Context, m proto.Message) error {
 	if err != nil {
 		return err
 	}
-	if err := t.txn.Send(&pb.TxRequest{
-		Request: &pb.TxRequest_Delete{
-			Delete: &pb.DeleteRequest{Payload: a},
+	if err := t.txn.Send(&v1alpha1.TxRequest{
+		Request: &v1alpha1.TxRequest_Delete{
+			Delete: &v1alpha1.DeleteRequest{Payload: a},
 		},
 	}); err != nil {
 		return err
@@ -345,7 +345,7 @@ func (t *txc) Delete(ctx context.Context, m proto.Message) error {
 }
 
 func (t *txc) Commit(ctx context.Context) error {
-	if err := t.txn.Send(&pb.TxRequest{Request: &pb.TxRequest_Commit{Commit: wrapperspb.Bool(true)}}); err != nil {
+	if err := t.txn.Send(&v1alpha1.TxRequest{Request: &v1alpha1.TxRequest_Commit{Commit: wrapperspb.Bool(true)}}); err != nil {
 		return err
 	}
 	res, err := t.txn.Recv()
@@ -374,7 +374,7 @@ type eventc struct {
 	err error
 }
 
-func newEvent(e *pb.WatchEvent, err error) *eventc {
+func newEvent(e *v1alpha1.WatchEvent, err error) *eventc {
 	ev := &eventc{typ: e.Type, err: err}
 	if e.Old != nil {
 		m, err := anypb.UnmarshalNew(e.Old)