Feature/chore refactoring

cb_metadata.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"log"
+	"strconv"
 	"time"
 
 	"github.com/Trendyol/go-dcp-client/helpers"
@@ -17,7 +18,7 @@ type cbMetadata struct {
 	config helpers.Config
 }
 
-func (s *cbMetadata) upsertXattrs(ctx context.Context, id string, path string, xattrs interface{}) error {
+func (s *cbMetadata) upsertXattrs(ctx context.Context, id []byte, path string, xattrs interface{}) error {
 	opm := NewAsyncOp(ctx)
 
 	deadline, _ := ctx.Deadline()
@@ -27,7 +28,7 @@ func (s *cbMetadata) upsertXattrs(ctx context.Context, id string, path string, x
 	ch := make(chan error)
 
 	op, err := s.agent.MutateIn(gocbcore.MutateInOptions{
-		Key: []byte(id),
+		Key: id,
 		Ops: []gocbcore.SubDocOp{
 			{
 				Op:    memd.SubDocOpDictSet,
@@ -54,15 +55,15 @@ func (s *cbMetadata) upsertXattrs(ctx context.Context, id string, path string, x
 	return err
 }
 
-func (s *cbMetadata) deleteDocument(ctx context.Context, id string) {
+func (s *cbMetadata) deleteDocument(ctx context.Context, id []byte) {
 	opm := NewAsyncOp(ctx)
 
 	deadline, _ := ctx.Deadline()
 
 	ch := make(chan error)
 
 	op, err := s.agent.Delete(gocbcore.DeleteOptions{
-		Key:      []byte(id),
+		Key:      id,
 		Deadline: deadline,
 	}, func(result *gocbcore.DeleteResult, err error) {
 		opm.Resolve()
@@ -83,7 +84,7 @@ func (s *cbMetadata) deleteDocument(ctx context.Context, id string) {
 	}
 }
 
-func (s *cbMetadata) getXattrs(ctx context.Context, id string, path string, bucketUUID string) (CheckpointDocument, error) {
+func (s *cbMetadata) getXattrs(ctx context.Context, id []byte, path string, bucketUUID string) (CheckpointDocument, error) {
 	opm := NewAsyncOp(context.Background())
 
 	deadline, _ := ctx.Deadline()
@@ -92,7 +93,7 @@ func (s *cbMetadata) getXattrs(ctx context.Context, id string, path string, buck
 	documentCh := make(chan CheckpointDocument)
 
 	op, err := s.agent.LookupIn(gocbcore.LookupInOptions{
-		Key: []byte(id),
+		Key: id,
 		Ops: []gocbcore.SubDocOp{
 			{
 				Op:    memd.SubDocOpGet,
@@ -132,15 +133,15 @@ func (s *cbMetadata) getXattrs(ctx context.Context, id string, path string, buck
 	return document, err
 }
 
-func (s *cbMetadata) createEmptyDocument(ctx context.Context, id string) error {
+func (s *cbMetadata) createEmptyDocument(ctx context.Context, id []byte) error {
 	opm := NewAsyncOp(ctx)
 
 	deadline, _ := ctx.Deadline()
 
 	ch := make(chan error)
 
 	op, err := s.agent.Set(gocbcore.SetOptions{
-		Key:      []byte(id),
+		Key:      id,
 		Value:    []byte{},
 		Flags:    50333696,
 		Deadline: deadline,
@@ -164,7 +165,7 @@ func (s *cbMetadata) Save(state map[uint16]CheckpointDocument, _ string) {
 	defer cancel()
 
 	for vbID, checkpointDocument := range state {
-		id := helpers.GetCheckpointID(vbID, s.config.Dcp.Group.Name)
+		id := getCheckpointID(vbID, s.config.Dcp.Group.Name)
 		err := s.upsertXattrs(ctx, id, helpers.Name, checkpointDocument)
 
 		var kvErr *gocbcore.KeyValueError
@@ -190,7 +191,7 @@ func (s *cbMetadata) Load(vbIds []uint16, bucketUUID string) map[uint16]Checkpoi
 	state := map[uint16]CheckpointDocument{}
 
 	for _, vbID := range vbIds {
-		id := helpers.GetCheckpointID(vbID, s.config.Dcp.Group.Name)
+		id := getCheckpointID(vbID, s.config.Dcp.Group.Name)
 
 		data, err := s.getXattrs(ctx, id, helpers.Name, bucketUUID)
 
@@ -210,7 +211,7 @@ func (s *cbMetadata) Clear(vbIds []uint16) {
 	defer cancel()
 
 	for _, vbID := range vbIds {
-		id := helpers.GetCheckpointID(vbID, s.config.Dcp.Group.Name)
+		id := getCheckpointID(vbID, s.config.Dcp.Group.Name)
 
 		s.deleteDocument(ctx, id)
 	}
@@ -222,3 +223,8 @@ func NewCBMetadata(agent *gocbcore.Agent, config helpers.Config) Metadata {
 		config: config,
 	}
 }
+
+func getCheckpointID(vbID uint16, groupName string) []byte {
+	// _connector:cbgo:groupName:stdout-listener:checkpoint:vbId
+	return []byte(helpers.Prefix + groupName + ":checkpoint:" + strconv.Itoa(int(vbID)))
+}

checkpoint.go

@@ -61,6 +61,7 @@ type checkpoint struct {
 }
 
 func (s *checkpoint) Save(fromSchedule bool) {
+	//TODO review
 	s.saveLock.Lock()
 	defer s.saveLock.Unlock()
 
@@ -119,12 +120,9 @@ func (s *checkpoint) Clear() {
 func (s *checkpoint) StartSchedule() {
 	go func() {
 		s.schedule = time.NewTicker(10 * time.Second)
-		go func() {
-			time.Sleep(10 * time.Second)
-			for range s.schedule.C {
-				s.Save(true)
-			}
-		}()
+		for range s.schedule.C {
+			s.Save(true)
+		}
 	}()
 	log.Printf("started checkpoint schedule")
 }

dcp.go

@@ -2,15 +2,14 @@ package godcpclient
 
 import (
 	"fmt"
+	"github.com/Trendyol/go-dcp-client/identity"
 	"os"
 	"os/signal"
 	"syscall"
 
 	"github.com/Trendyol/go-dcp-client/helpers"
 	"github.com/Trendyol/go-dcp-client/kubernetes"
-	klem "github.com/Trendyol/go-dcp-client/kubernetes/leaderelector/model"
 	"github.com/Trendyol/go-dcp-client/membership/info"
-	"github.com/Trendyol/go-dcp-client/model"
 	"github.com/Trendyol/go-dcp-client/servicediscovery"
 )
 
@@ -30,15 +29,15 @@ type dcp struct {
 	vBucketDiscovery VBucketDiscovery
 	serviceDiscovery servicediscovery.ServiceDiscovery
 	kubernetesClient kubernetes.Client
-	myIdentity       *model.Identity
+	myIdentity       *identity.Identity
 }
 
 func (s *dcp) Start() {
 	infoHandler := info.NewHandler()
 
 	if s.config.LeaderElection.Enabled {
 		if s.config.LeaderElection.Type == helpers.KubernetesLeaderElectionType {
-			s.myIdentity = klem.NewIdentityFromEnv()
+			s.myIdentity = identity.NewIdentityFromEnv()
 
 			if namespace, exist := s.config.LeaderElection.Config["leaseLockNamespace"]; exist {
 				s.kubernetesClient = kubernetes.NewClient(s.myIdentity, namespace)

dcp_test.go

@@ -1,14 +1,14 @@
 package godcpclient
 
 import (
+	"bytes"
 	"context"
 	"crypto/rand"
 	"fmt"
 	"log"
 	"math"
 	"math/big"
 	"os"
-	"strings"
 	"sync"
 	"testing"
 	"time"
@@ -170,8 +170,8 @@ func TestDcp(t *testing.T) {
 			counter++
 			lock.Unlock()
 
-			assert.True(t, strings.HasPrefix(string(event.Key), "my_key"))
-			assert.True(t, strings.HasPrefix(string(event.Value), "my_value"))
+			assert.True(t, bytes.HasPrefix(event.Key, []byte("my_key")))
+			assert.True(t, bytes.HasPrefix(event.Value, []byte("my_value")))
 
 			if counter == mockDataSize {
 				dcp.Close()

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/ansrivas/fiberprometheus/v2 v2.4.1
 	github.com/avast/retry-go/v4 v4.3.1
 	github.com/couchbase/gocbcore/v10 v10.2.0
+	github.com/go-logr/logr v1.2.2
 	github.com/gofiber/fiber/v2 v2.39.0
 	github.com/google/uuid v1.3.0
 	github.com/gookit/config/v2 v2.1.7
@@ -32,7 +33,6 @@ require (
 	github.com/docker/docker v20.10.17+incompatible // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
-	github.com/go-logr/logr v1.2.2 // indirect
 	github.com/gofiber/adaptor/v2 v2.1.25 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect

helpers/utils.go

@@ -3,33 +3,22 @@ package helpers
 import (
 	"bytes"
 	"fmt"
-	"reflect"
-	"strconv"
-
 	"github.com/google/uuid"
+	"reflect"
 )
 
-func GetCheckpointID(vbID uint16, groupName string) string {
-	// _connector:cbgo:groupName:stdout-listener:checkpoint:vbId
-	return Prefix + groupName + ":checkpoint:" + strconv.Itoa(int(vbID))
-}
-
 func GetDcpStreamName(groupName string) string {
 	streamName := fmt.Sprintf("%s_%s", groupName, uuid.New().String())
 	return streamName
 }
 
 func IsMetadata(data interface{}) bool {
-	t := reflect.TypeOf(data)
-
-	_, exist := t.FieldByName("Key")
-
-	if exist {
-		key := reflect.ValueOf(data).FieldByName("Key").Bytes()
-		return bytes.HasPrefix(key, []byte(Prefix))
+	value := reflect.ValueOf(data).FieldByName("Key")
+	if !value.IsValid() {
+		return false
 	}
 
-	return false
+	return bytes.HasPrefix(value.Bytes(), []byte(Prefix))
 }
 
 func ChunkSlice[T any](slice []T, chunks int) [][]T {

helpers/utils_test.go

@@ -0,0 +1,30 @@
+package helpers
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestIsMetadata_ReturnsTrue_WhenStructHasKeyPrefix(t *testing.T) {
+	type ts struct {
+		Key []byte
+	}
+
+	testData := ts{
+		Key: []byte(Prefix + "test"),
+	}
+
+	assert.True(t, IsMetadata(testData))
+}
+
+func TestIsMetadata_ReturnsFalse_WhenStructHasNoKeyPrefix(t *testing.T) {
+	type ts struct {
+		X []byte
+	}
+
+	testData := ts{
+		X: []byte(Prefix + "test"),
+	}
+
+	assert.False(t, IsMetadata(testData))
+}

model/identity.go → identity/identity.go

@@ -1,6 +1,9 @@
-package model
+package identity
 
-import "encoding/json"
+import (
+	"encoding/json"
+	"os"
+)
 
 type Identity struct {
 	IP   string
@@ -16,20 +19,24 @@ func (k *Identity) String() string {
 	return string(str)
 }
 
-func (k *Identity) LoadFromString(str string) {
-	err := json.Unmarshal([]byte(str), k)
-	if err != nil {
-		panic(err)
-	}
-}
-
 func (k *Identity) Equal(other *Identity) bool {
 	return k.IP == other.IP && k.Name == other.Name
 }
 
 func NewIdentityFromStr(str string) *Identity {
-	identity := &Identity{}
-	identity.LoadFromString(str)
+	var identity Identity
+
+	err := json.Unmarshal([]byte(str), &identity)
+	if err != nil {
+		panic(err)
+	}
 
-	return identity
+	return &identity
+}
+
+func NewIdentityFromEnv() *Identity {
+	return &Identity{
+		IP:   os.Getenv("POD_IP"),
+		Name: os.Getenv("POD_NAME"),
+	}
 }

kubernetes/client.go

@@ -2,8 +2,8 @@ package kubernetes
 
 import (
 	"context"
+	dcpModel "github.com/Trendyol/go-dcp-client/identity"
 
-	dcpModel "github.com/Trendyol/go-dcp-client/model"
 	"github.com/go-logr/logr"
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"

kubernetes/leaderelector/leader_elector.go

@@ -3,22 +3,31 @@ package leaderelector
 import (
 	"context"
 	"fmt"
+	dcpModel "github.com/Trendyol/go-dcp-client/identity"
 	"log"
 	"time"
 
 	"github.com/Trendyol/go-dcp-client/helpers"
 	"github.com/Trendyol/go-dcp-client/kubernetes"
-	godcpclient "github.com/Trendyol/go-dcp-client/leaderelector"
-	dcpModel "github.com/Trendyol/go-dcp-client/model"
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/leaderelection"
 	"k8s.io/client-go/tools/leaderelection/resourcelock"
 )
 
+type LeaderElector interface {
+	Run(ctx context.Context)
+}
+
+type Handler interface {
+	OnBecomeLeader()
+	OnResignLeader()
+	OnBecomeFollower(leaderIdentity *dcpModel.Identity)
+}
+
 type leaderElector struct {
 	client             kubernetes.Client
 	myIdentity         *dcpModel.Identity
-	handler            godcpclient.Handler
+	handler            Handler
 	leaseLockName      string
 	leaseLockNamespace string
 }
@@ -79,8 +88,8 @@ func NewLeaderElector(
 	client kubernetes.Client,
 	config helpers.ConfigLeaderElection,
 	myIdentity *dcpModel.Identity,
-	handler godcpclient.Handler,
-) godcpclient.LeaderElector {
+	handler Handler,
+) LeaderElector {
 	var leaseLockName string
 	var leaseLockNamespace string