Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: support HSET in redis #3768

Merged
merged 20 commits into from
Aug 30, 2023
Merged

feat: support HSET in redis #3768

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9d696e3
feat: support hset in redis
debanjan97 Aug 3, 2023
abd20ac
chore: handles hash field updates in a separate function
debanjan97 Aug 7, 2023
4807867
chore: renames vars
debanjan97 Aug 7, 2023
7ea0bec
Merge branch 'master' of github.com:rudderlabs/rudder-server into PRO…
debanjan97 Aug 21, 2023
bd3e3d3
Merge branch 'master' into PRO-633
debanjan97 Aug 22, 2023
87bc649
chore: renames vars
debanjan97 Aug 22, 2023
a53e4d1
Merge branch 'PRO-633' of github.com:rudderlabs/rudder-server into PR…
debanjan97 Aug 22, 2023
d4a8bb1
fix: update HSET criteria
debanjan97 Aug 22, 2023
cbde9a8
fix: update HSET criteria 2
debanjan97 Aug 22, 2023
6773e1f
adds test
debanjan97 Aug 23, 2023
00c4a95
mocks
debanjan97 Aug 23, 2023
44f4b17
code smells
debanjan97 Aug 23, 2023
194682d
Merge branch 'master' into PRO-633
debanjan97 Aug 23, 2023
08ddb4e
adds comments | renames variables+functions
debanjan97 Aug 23, 2023
9c98d8f
chore: rename vars
debanjan97 Aug 23, 2023
f52188c
chore: reuse vars for `IsHSETCompatibleEvent`
debanjan97 Aug 24, 2023
d6e5ae6
change from var to const
debanjan97 Aug 24, 2023
9b8191c
Merge branch 'master' of github.com:rudderlabs/rudder-server into PRO…
debanjan97 Aug 28, 2023
189e91a
chore: optimise tests
debanjan97 Aug 28, 2023
9a9cf61
Merge branch 'master' into PRO-633
debanjan97 Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions mocks/services/kvstoremanager/mock_kvstoremanager.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 10 additions & 2 deletions router/customdestinationmanager/customdestinationmanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,17 @@ func (customManager *CustomManagerT) send(jsonData json.RawMessage, client inter
streamProducer, _ := client.(common.StreamProducer)
statusCode, _, respBody = streamProducer.Produce(jsonData, config)
case KV:
var err error
kvManager, _ := client.(kvstoremanager.KVStoreManager)
key, fields := kvstoremanager.EventToKeyValue(jsonData)
err := kvManager.HMSet(key, fields)
// if the event supports HSET operation then use HSET
if kvstoremanager.IsHSETCompatibleEvent(jsonData) {
hash, key, value := kvstoremanager.ExtractHashKeyValueFromEvent(jsonData)
err = kvManager.HSet(hash, key, value)
} else {
key, fields := kvstoremanager.EventToKeyValue(jsonData)
err = kvManager.HMSet(key, fields)
}

statusCode = kvManager.StatusCode(err)
if err != nil {
respBody = err.Error()
Expand Down
60 changes: 60 additions & 0 deletions router/customdestinationmanager/customdestinationmanager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/rudderlabs/rudder-go-kit/config"
"github.com/rudderlabs/rudder-go-kit/logger"
backendconfig "github.com/rudderlabs/rudder-server/backend-config"
mock_kvstoremanager "github.com/rudderlabs/rudder-server/mocks/services/kvstoremanager"
mock_streammanager "github.com/rudderlabs/rudder-server/mocks/services/streammanager/common"
"github.com/rudderlabs/rudder-server/services/streammanager/kafka"
"github.com/rudderlabs/rudder-server/services/streammanager/lambda"
Expand Down Expand Up @@ -144,3 +145,62 @@ func TestSendDataWithStreamDestination(t *testing.T) {
mockProducer.EXPECT().Produce(event, someDestination.Config).Times(1)
customManager.SendData(event, someDestination.ID)
}

func TestKVManagerHSETInvocation(t *testing.T) {
initCustomerManager()
customManager := New("REDIS", Opts{}).(*CustomManagerT)
someDestination := backendconfig.DestinationT{
ID: "someDestinationID1",
DestinationDefinition: backendconfig.DestinationDefinitionT{
Name: "REDIS",
},
}
err := customManager.onNewDestination(someDestination)
assert.Nil(t, err)

event := json.RawMessage(`{
"message": {
"key": "someKey",
"value" : "someValue",
"hash": "someHash"
}
}
`)
ctrl := gomock.NewController(t)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HSet("someHash", "someKey", "someValue").Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
}

func TestKVManagerHMSETInvocation(t *testing.T) {
initCustomerManager()
customManager := New("REDIS", Opts{}).(*CustomManagerT)
someDestination := backendconfig.DestinationT{
ID: "someDestinationID1",
DestinationDefinition: backendconfig.DestinationDefinitionT{
Name: "REDIS",
},
}
err := customManager.onNewDestination(someDestination)
assert.Nil(t, err)

event := json.RawMessage(`{
"message": {
"key": "someKey",
"fields" : {
"field1": "value1",
"field2": "value2"
}
}
}
`)
ctrl := gomock.NewController(t)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HMSet("someKey", map[string]interface{}{
"field1": "value1",
"field2": "value2",
}).Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Optional] Maybe we can remove duplicate code and compact these tests?

Suggested change
func TestKVManagerHSETInvocation(t *testing.T) {
initCustomerManager()
customManager := New("REDIS", Opts{}).(*CustomManagerT)
someDestination := backendconfig.DestinationT{
ID: "someDestinationID1",
DestinationDefinition: backendconfig.DestinationDefinitionT{
Name: "REDIS",
},
}
err := customManager.onNewDestination(someDestination)
assert.Nil(t, err)
event := json.RawMessage(`{
"message": {
"key": "someKey",
"value" : "someValue",
"hash": "someHash"
}
}
`)
ctrl := gomock.NewController(t)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HSet("someHash", "someKey", "someValue").Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
}
func TestKVManagerHMSETInvocation(t *testing.T) {
initCustomerManager()
customManager := New("REDIS", Opts{}).(*CustomManagerT)
someDestination := backendconfig.DestinationT{
ID: "someDestinationID1",
DestinationDefinition: backendconfig.DestinationDefinitionT{
Name: "REDIS",
},
}
err := customManager.onNewDestination(someDestination)
assert.Nil(t, err)
event := json.RawMessage(`{
"message": {
"key": "someKey",
"fields" : {
"field1": "value1",
"field2": "value2"
}
}
}
`)
ctrl := gomock.NewController(t)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HMSet("someKey", map[string]interface{}{
"field1": "value1",
"field2": "value2",
}).Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
}
func TestKVManagerInvocation(t *testing.T) {
initCustomerManager()
customManager := New("REDIS", Opts{}).(*CustomManagerT)
someDestination := backendconfig.DestinationT{
ID: "someDestinationID1",
DestinationDefinition: backendconfig.DestinationDefinitionT{
Name: "REDIS",
},
}
err := customManager.onNewDestination(someDestination)
assert.Nil(t, err)
ctrl := gomock.NewController(t)
defer ctrl.Finish()
t.Run("HSET", func(t *testing.T) {
event := json.RawMessage(`{
"message": {
"key": "someKey",
"value" : "someValue",
"hash": "someHash"
}
}
`)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HSet("someHash", "someKey", "someValue").Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
})
t.Run("HMSET", func(t *testing.T) {
event := json.RawMessage(`{
"message": {
"key": "someKey",
"fields" : {
"field1": "value1",
"field2": "value2"
}
}
}
`)
mockKVStoreManager := mock_kvstoremanager.NewMockKVStoreManager(ctrl)
mockKVStoreManager.EXPECT().HMSet("someKey", map[string]interface{}{
"field1": "value1",
"field2": "value2",
}).Times(1)
mockKVStoreManager.EXPECT().StatusCode(nil).Times(1)
customManager.send(event, mockKVStoreManager, someDestination.Config)
})
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

25 changes: 25 additions & 0 deletions services/kvstoremanager/kvstoremanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ type KVStoreManager interface {
Connect()
Close() error
HMSet(key string, fields map[string]interface{}) error
HSet(key, field string, value interface{}) error
StatusCode(err error) int
DeleteKey(key string) (err error)
HMGet(key string, fields ...string) (result []interface{}, err error)
Expand All @@ -21,6 +22,12 @@ type SettingsT struct {
Config map[string]interface{}
}

const (
hashPath = "message.hash"
keyPath = "message.key"
valuePath = "message.value"
)

func New(provider string, config map[string]interface{}) (m KVStoreManager) {
return newManager(SettingsT{
Provider: provider,
Expand Down Expand Up @@ -49,3 +56,21 @@ func EventToKeyValue(jsonData json.RawMessage) (string, map[string]interface{})

return key, fields
}

// IsHSETCompatibleEvent identifies if the event supports HSET operation
// To support HSET, the event must have the following fields:
// - message.key
// - message.value
// - message.hash
// It doesn't account for the value of the fields.
func IsHSETCompatibleEvent(jsonData json.RawMessage) bool {
return gjson.GetBytes(jsonData, hashPath).Exists() && gjson.GetBytes(jsonData, keyPath).Exists() && gjson.GetBytes(jsonData, valuePath).Exists()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid the extensive and repeated usage of gjson.

Using a go struct

type HSetEvent struct {
   Hash string `json:"<hash_path>"`
   Key string `json:"<key_path>"`
   Value string `json:"<value_path>"`
}

It would be safer and faster (assuming fastjson library is used)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if I understand faster (assuming fastjson library is used) completely.

I can use fastjson's Exists but that doesn't require a go struct to unmarshal to.
Unless we somehow use fastjson while unmarshalling, using CustomUnmarshal, or I might be completely missing the point here.

}

func ExtractHashKeyValueFromEvent(jsonData json.RawMessage) (hash, key, value string) {
hash = gjson.GetBytes(jsonData, hashPath).String()
key = gjson.GetBytes(jsonData, keyPath).String()
value = gjson.GetBytes(jsonData, valuePath).String()

return hash, key, value
}
9 changes: 9 additions & 0 deletions services/kvstoremanager/redis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,12 @@ func (m *redisManagerT) HGetAll(key string) (result map[string]string, err error
}
return result, err
}

func (m *redisManagerT) HSet(hash, key string, value interface{}) (err error) {
if m.clusterMode {
_, err = m.clusterClient.HSet(hash, key, value).Result()
} else {
_, err = m.client.HSet(hash, key, value).Result()
}
return err
}
Loading