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

feat(collections): add NewSchemaBuilderFromAccessor function (#15271)

Browse Source 
Co-authored-by: testinginprod <testinginprod@somewhere.idk>
This commit is contained in:
testinginprod 2023-03-06 18:07:17 +01:00 committed by GitHub
parent 183dde8d00
commit 3b40a62276
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
collections/go.mod
View File

@ -5,7 +5,6 @@ go 1.20
require (
cosmossdk.io/core v0.6.0
github.com/cosmos/cosmos-db v1.0.0-rc.1
github.com/hashicorp/go-multierror v1.1.1 // TODO: remove with go 1.20 release
github.com/stretchr/testify v1.8.2
pgregory.net/rapid v0.5.5
)
@ -28,7 +27,6 @@ require (
github.com/golang/protobuf v1.5.2 // indirect
github.com/golang/snappy v0.0.4 // indirect
github.com/google/btree v1.1.2 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/klauspost/compress v1.16.0 // indirect
github.com/kr/pretty v0.3.1 // indirect
github.com/kr/text v0.2.0 // indirect

5
collections/go.sum
View File

@ -127,11 +127,6 @@ github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLe
github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=
github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=
github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=

37
collections/schema.go
View File

@ -10,8 +10,6 @@ import (
"cosmossdk.io/core/appmodule"
"cosmossdk.io/core/store"
"github.com/hashicorp/go-multierror"
)
// SchemaBuilder is used for building schemas. The Build method should always
@ -19,20 +17,25 @@ import (
// collections with the builder after initialization will result in panics.
type SchemaBuilder struct {
schema *Schema
err *multierror.Error
err error
}
// NewSchemaBuilderFromAccessor creates a new schema builder from the provided store accessor function.
func NewSchemaBuilderFromAccessor(accessorFunc func(ctx context.Context) store.KVStore) *SchemaBuilder {
return &SchemaBuilder{
schema: &Schema{
storeAccessor: accessorFunc,
collectionsByName: map[string]collection{},
collectionsByPrefix: map[string]collection{},
},
}
}
// NewSchemaBuilder creates a new schema builder from the provided store key.
// Callers should always call the SchemaBuilder.Build method when they are
// done adding collections to the schema.
func NewSchemaBuilder(service store.KVStoreService) *SchemaBuilder {
return &SchemaBuilder{
schema: &Schema{
storeAccessor: service.OpenKVStore,
collectionsByName: map[string]collection{},
collectionsByPrefix: map[string]collection{},
},
}
return NewSchemaBuilderFromAccessor(service.OpenKVStore)
}
// Build should be called after all collections that are part of the schema
@ -86,17 +89,17 @@ func (s *SchemaBuilder) addCollection(collection collection) {
name := collection.getName()
if _, ok := s.schema.collectionsByPrefix[string(prefix)]; ok {
s.err = multierror.Append(s.err, fmt.Errorf("prefix %v already taken within schema", prefix))
s.appendError(fmt.Errorf("prefix %v already taken within schema", prefix))
return
}
if _, ok := s.schema.collectionsByName[name]; ok {
s.err = multierror.Append(s.err, fmt.Errorf("name %s already taken within schema", name))
s.appendError(fmt.Errorf("name %s already taken within schema", name))
return
}
if !nameRegex.MatchString(name) {
s.err = multierror.Append(s.err, fmt.Errorf("name must match regex %s, got %s", NameRegex, name))
s.appendError(fmt.Errorf("name must match regex %s, got %s", NameRegex, name))
return
}
@ -104,6 +107,14 @@ func (s *SchemaBuilder) addCollection(collection collection) {
s.schema.collectionsByName[name] = collection
}
func (s *SchemaBuilder) appendError(err error) {
if s.err == nil {
s.err = err
return
}
s.err = fmt.Errorf("%w\n%w", s.err, err)
}
// NameRegex is the regular expression that all valid collection names must match.
const NameRegex = "[A-Za-z][A-Za-z0-9_]*"