public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhance comparison functions in KV storage

Browse Source 
- Updated the CompareKeyExists function to simplify its usage by removing the 'exists' parameter, making it always succeed if the key exists.
- Introduced a new CompareKeyNotExists function to check for non-existent keys.
- Modified transaction tests to utilize the new comparison functions, ensuring accurate behavior for both existing and non-existing keys.
This commit is contained in:
Georges Chaudy
2025-12-04 16:17:43 +01:00
parent c31c1d8e8d
commit 6e39b24b6f
2 changed files with 32 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/storage/unified/resource/kv.go
+10 -11
View File
@@ -54,7 +54,7 @@ const (
)
// Compare represents a single comparison in a transaction.
// Use the constructor functions CompareKeyExists and CompareKeyValue to create comparisons.
// Use the constructor functions CompareKeyExists, CompareKeyNotExists, and CompareKeyValue to create comparisons.
type Compare struct {
Key string
Target CompareTarget
@@ -63,11 +63,14 @@ type Compare struct {
Value []byte // Used when Target == CompareValue
}
// CompareKeyExists creates a comparison that checks if a key exists or not.
// If exists is true, the comparison succeeds if the key exists.
// If exists is false, the comparison succeeds if the key does not exist.
func CompareKeyExists(key string, exists bool) Compare {
return Compare{Key: key, Target: CompareExists, Exists: exists}
// CompareKeyExists creates a comparison that succeeds if the key exists.
func CompareKeyExists(key string) Compare {
return Compare{Key: key, Target: CompareExists, Exists: true}
}
// CompareKeyNotExists creates a comparison that succeeds if the key does not exist.
func CompareKeyNotExists(key string) Compare {
return Compare{Key: key, Target: CompareExists, Exists: false}
}
// CompareKeyValue creates a comparison that compares the value of a key.
@@ -482,7 +485,7 @@ func (k *badgerKV) Txn(ctx context.Context, section string, cmps []Compare, succ
succeeded := true
for _, cmp := range cmps {
keyWithSection := section + "/" + cmp.Key
_, err := txn.Get([]byte(keyWithSection))
item, err := txn.Get([]byte(keyWithSection))
keyExists := err == nil
if err != nil && !errors.Is(err, badger.ErrKeyNotFound) {
return nil, err
@@ -501,10 +504,6 @@ func (k *badgerKV) Txn(ctx context.Context, section string, cmps []Compare, succ
succeeded = false
}
} else {
item, err := txn.Get([]byte(keyWithSection))
if err != nil {
return nil, err
}
itemValue, err := item.ValueCopy(nil)
if err != nil {
return nil, err
pkg/storage/unified/testing/kv.go
+22 -8
View File
@@ -837,13 +837,16 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
t.Run("txn compare exists false for non-existent key", func(t *testing.T) {
// Key doesn't exist, so exists should be false
cmps := []resource.Compare{
resource.CompareKeyExists("non-existent-key", false),
resource.CompareKeyNotExists("non-existent-key"),
}
successOps := []resource.TxnOp{
{Type: resource.TxnOpPut, Key: "created-key", Value: []byte("created-value")},
}
failureOps := []resource.TxnOp{
{Type: resource.TxnOpPut, Key: "non-existent-failure-marker", Value: []byte("failure-executed")},
}
resp, err := kv.Txn(ctx, section, cmps, successOps, nil)
resp, err := kv.Txn(ctx, section, cmps, successOps, failureOps)
require.NoError(t, err)
assert.True(t, resp.Succeeded)
@@ -855,6 +858,10 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
assert.Equal(t, "created-value", string(value))
err = reader.Close()
require.NoError(t, err)
// Verify failure op was not executed
_, err = kv.Get(ctx, section, "non-existent-failure-marker")
assert.Error(t, err)
})
t.Run("txn compare exists true for existing key", func(t *testing.T) {
@@ -863,13 +870,16 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
// Key exists, so exists should be true
cmps := []resource.Compare{
resource.CompareKeyExists("existing-key", true),
resource.CompareKeyExists("existing-key"),
}
successOps := []resource.TxnOp{
{Type: resource.TxnOpPut, Key: "existing-key", Value: []byte("updated-value")},
}
failureOps := []resource.TxnOp{
{Type: resource.TxnOpPut, Key: "existing-failure-marker", Value: []byte("failure-executed")},
}
resp, err := kv.Txn(ctx, section, cmps, successOps, nil)
resp, err := kv.Txn(ctx, section, cmps, successOps, failureOps)
require.NoError(t, err)
assert.True(t, resp.Succeeded)
@@ -881,6 +891,10 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
assert.Equal(t, "updated-value", string(value))
err = reader.Close()
require.NoError(t, err)
// Verify failure op was not executed
_, err = kv.Get(ctx, section, "existing-failure-marker")
assert.Error(t, err)
})
t.Run("txn compare exists fails when key exists but expected not to", func(t *testing.T) {
@@ -889,7 +903,7 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
// Key exists but we expect it not to
cmps := []resource.Compare{
resource.CompareKeyExists("exists-fail-key", false),
resource.CompareKeyNotExists("exists-fail-key"),
}
successOps := []resource.TxnOp{
{Type: resource.TxnOpPut, Key: "exists-fail-result", Value: []byte("should-not-exist")},
@@ -984,7 +998,7 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
saveKVHelper(t, kv, ctx, section, "delete-txn-key", strings.NewReader("to-be-deleted"))
cmps := []resource.Compare{
resource.CompareKeyExists("delete-txn-key", true),
resource.CompareKeyExists("delete-txn-key"),
}
successOps := []resource.TxnOp{
{Type: resource.TxnOpDelete, Key: "delete-txn-key"},
@@ -1053,7 +1067,7 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
t.Run("txn too many comparisons", func(t *testing.T) {
cmps := make([]resource.Compare, resource.MaxTxnCompares+1)
for i := range cmps {
cmps[i] = resource.CompareKeyExists(fmt.Sprintf("key-%d", i), false)
cmps[i] = resource.CompareKeyNotExists(fmt.Sprintf("key-%d", i))
}
_, err := kv.Txn(ctx, section, cmps, nil, nil)
@@ -1132,7 +1146,7 @@ func runTestKVTxn(t *testing.T, kv resource.KV, nsPrefix string) {
saveKVHelper(t, kv, ctx, section, "constructor-key", strings.NewReader("constructor-value"))
cmps := []resource.Compare{
resource.CompareKeyExists("constructor-key", true),
resource.CompareKeyExists("constructor-key"),
}
successOps := []resource.TxnOp{
resource.TxnPut("constructor-new", []byte("new-value")),