LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

feat(orm): add module db (#10991)

Browse Source 
## Description

This PR adds a `ModuleDB` interface which can be used directly by Cosmos SDK modules. A simplified bank example with Mint/Send/Burn functionality against Balance and Supply tables is included in the tests.

This PR also:
* adds simplified `Get` and `Has` methods to `Table` which use the primary key values in the message instead of `...interface{}`
* adds a stable deterministic proto JSON marshaler and updates the `Entry.String` methods to use it because the golden tests are not deterministic without this. This code is currently internal but can be extracted to a public `codec` or `cosmos-proto` package eventually.

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
This commit is contained in:
Aaron Craelius
2022-01-22 03:13:43 +00:00
committed by GitHub
parent 87bb06c9fc
commit 6ea2049944
21 changed files with 2346 additions and 323 deletions
Download Patch File Download Diff File Expand all files Collapse all files
orm/model/ormtable/primary_key.go
+17 -13
View File
@@ -33,18 +33,22 @@ func (p primaryKeyIndex) Iterator(ctx context.Context, options ...ormlist.Option
func (p primaryKeyIndex) doNotImplement() {}
func (p primaryKeyIndex) Has(context context.Context, key ...interface{}) (found bool, err error) {
ctx, err := p.getReadBackend(context)
func (p primaryKeyIndex) Has(ctx context.Context, key ...interface{}) (found bool, err error) {
backend, err := p.getReadBackend(ctx)
if err != nil {
return false, err
}
keyBz, err := p.EncodeKey(encodeutil.ValuesOf(key...))
return p.has(backend, encodeutil.ValuesOf(key...))
}
func (p primaryKeyIndex) has(backend ReadBackend, values []protoreflect.Value) (found bool, err error) {
keyBz, err := p.EncodeKey(values)
if err != nil {
return false, err
}
return ctx.CommitmentStoreReader().Has(keyBz)
return backend.CommitmentStoreReader().Has(keyBz)
}
func (p primaryKeyIndex) Get(ctx context.Context, message proto.Message, values ...interface{}) (found bool, err error) {
@@ -56,6 +60,15 @@ func (p primaryKeyIndex) Get(ctx context.Context, message proto.Message, values
return p.get(backend, message, encodeutil.ValuesOf(values...))
}
func (p primaryKeyIndex) get(backend ReadBackend, message proto.Message, values []protoreflect.Value) (found bool, err error) {
key, err := p.EncodeKey(values)
if err != nil {
return false, err
}
return p.getByKeyBytes(backend, key, values, message)
}
func (t primaryKeyIndex) DeleteByKey(ctx context.Context, primaryKeyValues ...interface{}) error {
return t.doDeleteByKey(ctx, encodeutil.ValuesOf(primaryKeyValues...))
}
@@ -109,15 +122,6 @@ func (t primaryKeyIndex) doDeleteByKey(ctx context.Context, primaryKeyValues []p
return writer.Write()
}
func (p primaryKeyIndex) get(backend ReadBackend, message proto.Message, values []protoreflect.Value) (found bool, err error) {
key, err := p.EncodeKey(values)
if err != nil {
return false, err
}
return p.getByKeyBytes(backend, key, values, message)
}
func (p primaryKeyIndex) getByKeyBytes(store ReadBackend, key []byte, keyValues []protoreflect.Value, message proto.Message) (found bool, err error) {
bz, err := store.CommitmentStoreReader().Get(key)
if err != nil {
orm/model/ormtable/singleton_test.go
+2 -2
View File
@@ -22,11 +22,11 @@ func TestSingleton(t *testing.T) {
assert.NilError(t, err)
store := ormtable.WrapContextDefault(testkv.NewSplitMemBackend())
found, err := singleton.Has(store)
found, err := singleton.Has(store, val)
assert.NilError(t, err)
assert.Assert(t, !found)
assert.NilError(t, singleton.Save(store, val))
found, err = singleton.Has(store)
found, err = singleton.Has(store, val)
assert.NilError(t, err)
assert.Assert(t, found)
orm/model/ormtable/table.go
+17 -5
View File
@@ -17,7 +17,17 @@ import (
// systems, for instance to enable backwards compatibility when a major
// migration needs to be performed.
type View interface {
UniqueIndex
Index
// Has returns true if there is an entity in the table with the same
// primary key as message. Other fields besides the primary key fields will not
// be used for retrieval.
Has(ctx context.Context, message proto.Message) (found bool, err error)
// Get retrieves the message if one exists for the primary key fields
// set on the message. Other fields besides the primary key fields will not
// be used for retrieval.
Get(ctx context.Context, message proto.Message) (found bool, err error)
// GetIndex returns the index referenced by the provided fields if
// one exists or nil. Note that some concrete indexes can be retrieved by
@@ -54,14 +64,16 @@ type Table interface {
// Insert inserts the provided entry in the store and fails if there is
// an unique key violation. See Save for more details on behavior.
Insert(context context.Context, message proto.Message) error
Insert(ctx context.Context, message proto.Message) error
// Update updates the provided entry in the store and fails if an entry
// with a matching primary key does not exist. See Save for more details
// on behavior.
Update(context context.Context, message proto.Message) error
Update(ctx context.Context, message proto.Message) error
// Delete deletes the entry with the provided primary key from the store.
// Delete deletes the entry with the with primary key fields set on message
// if one exists. Other fields besides the primary key fields will not
// be used for retrieval.
//
// If store implement the Hooks interface, the OnDelete hook method will
// be called.
@@ -69,7 +81,7 @@ type Table interface {
// Delete attempts to be atomic with respect to the underlying store,
// meaning that either the full save operation is written or the store is
// left unchanged, unless there is an error with the underlying store.
Delete(context context.Context, message proto.Message) error
Delete(ctx context.Context, message proto.Message) error
// DefaultJSON returns default JSON that can be used as a template for
// genesis files.
orm/model/ormtable/table_impl.go
+23
View File
@@ -364,6 +364,29 @@ func (t tableImpl) ID() uint32 {
return t.tableId
}
func (t tableImpl) Has(ctx context.Context, message proto.Message) (found bool, err error) {
backend, err := t.getReadBackend(ctx)
if err != nil {
return false, err
}
keyValues := t.primaryKeyIndex.PrimaryKeyCodec.GetKeyValues(message.ProtoReflect())
return t.primaryKeyIndex.has(backend, keyValues)
}
// Get retrieves the message if one exists for the primary key fields
// set on the message. Other fields besides the primary key fields will not
// be used for retrieval.
func (t tableImpl) Get(ctx context.Context, message proto.Message) (found bool, err error) {
backend, err := t.getReadBackend(ctx)
if err != nil {
return false, err
}
keyValues := t.primaryKeyIndex.PrimaryKeyCodec.GetKeyValues(message.ProtoReflect())
return t.primaryKeyIndex.get(backend, message, keyValues)
}
var _ Table = &tableImpl{}
type saveMode int
orm/model/ormtable/table_test.go
+5 -4
View File
@@ -371,14 +371,15 @@ func runTestScenario(t *testing.T, table ormtable.Table, backend ormtable.Backen
data = append(data, &testpb.ExampleTable{U32: 9})
err = table.Save(ctx, data[10])
assert.NilError(t, err)
found, err = table.Get(ctx, &a, uint32(9), int64(0), "")
pkIndex := table.GetUniqueIndex("u32,i64,str")
found, err = pkIndex.Get(ctx, &a, uint32(9), int64(0), "")
assert.NilError(t, err)
assert.Assert(t, found)
assert.DeepEqual(t, data[10], &a, protocmp.Transform())
// and update it
data[10].B = true
assert.NilError(t, table.Save(ctx, data[10]))
found, err = table.Get(ctx, &a, uint32(9), int64(0), "")
found, err = pkIndex.Get(ctx, &a, uint32(9), int64(0), "")
assert.NilError(t, err)
assert.Assert(t, found)
assert.DeepEqual(t, data[10], &a, protocmp.Transform())
@@ -401,10 +402,10 @@ func runTestScenario(t *testing.T, table ormtable.Table, backend ormtable.Backen
// let's delete item 5
key5 := []interface{}{uint32(7), int64(-2), "abe"}
err = table.DeleteByKey(ctx, key5...)
err = pkIndex.DeleteByKey(ctx, key5...)
assert.NilError(t, err)
// it should be gone
found, err = table.Has(ctx, key5...)
found, err = pkIndex.Has(ctx, key5...)
assert.NilError(t, err)
assert.Assert(t, !found)
// and missing from the iterator
orm/model/ormtable/testdata/test_auto_inc.golden
Vendored
+8 -8
View File
@@ -1,31 +1,31 @@
GET 03000000000000000005
PK testpb.ExampleAutoIncrementTable 5 -> id:5
PK testpb.ExampleAutoIncrementTable 5 -> {"id":5}
GET 03808002
SEQ testpb.ExampleAutoIncrementTable 0
GET 03000000000000000001
PK testpb.ExampleAutoIncrementTable 1 -> id:1
ORM INSERT testpb.ExampleAutoIncrementTable id:1 x:"foo" y:5
PK testpb.ExampleAutoIncrementTable 1 -> {"id":1}
ORM INSERT testpb.ExampleAutoIncrementTable {"id":1,"x":"foo","y":5}
HAS 0301666f6f
ERR:EOF
SET 03000000000000000001 1203666f6f1805
PK testpb.ExampleAutoIncrementTable 1 -> id:1 x:"foo" y:5
PK testpb.ExampleAutoIncrementTable 1 -> {"id":1,"x":"foo","y":5}
SET 03808002 01
SEQ testpb.ExampleAutoIncrementTable 1
SET 0301666f6f 0000000000000001
UNIQ testpb.ExampleAutoIncrementTable x : "foo" -> 1
UNIQ testpb.ExampleAutoIncrementTable x : foo -> 1
GET 03808002 01
SEQ testpb.ExampleAutoIncrementTable 1
ITERATOR 0300 -> 0301
VALID true
KEY 03000000000000000001 1203666f6f1805
PK testpb.ExampleAutoIncrementTable 1 -> id:1 x:"foo" y:5
PK testpb.ExampleAutoIncrementTable 1 -> {"id":1,"x":"foo","y":5}
NEXT
VALID false
ITERATOR 0300 -> 0301
VALID true
KEY 03000000000000000001 1203666f6f1805
PK testpb.ExampleAutoIncrementTable 1 -> id:1 x:"foo" y:5
PK testpb.ExampleAutoIncrementTable 1 -> {"id":1,"x":"foo","y":5}
KEY 03000000000000000001 1203666f6f1805
PK testpb.ExampleAutoIncrementTable 1 -> id:1 x:"foo" y:5
PK testpb.ExampleAutoIncrementTable 1 -> {"id":1,"x":"foo","y":5}
NEXT
VALID false
orm/model/ormtable/testdata/test_scenario.golden
Vendored
+261 -261
View File
File diff suppressed because it is too large Load Diff