fix(orm): add additional checks on invalid tables (#11387)
## Description Adds checks for two types of errors in table definitions * defining a key on an `optional` field (haven't found a way to test unfortunately because a test case will break the code generator) * defining a trivial unique key, essentially a unique key which contains all the fields in the primary key and is redundant --- ### 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:
@@ -12,7 +12,8 @@ import (
|
||||
"google.golang.org/protobuf/proto"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
|
||||
ormv1alpha1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1alpha1"
|
||||
ormv1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1"
|
||||
|
||||
"github.com/cosmos/cosmos-sdk/orm/encoding/ormkv"
|
||||
"github.com/cosmos/cosmos-sdk/orm/types/ormerrors"
|
||||
)
|
||||
@@ -35,13 +36,13 @@ type Options struct {
|
||||
// with the table. Generally this should be nil and the table descriptor
|
||||
// should be pulled from the table message option. TableDescriptor
|
||||
// cannot be used together with SingletonDescriptor.
|
||||
TableDescriptor *ormv1alpha1.TableDescriptor
|
||||
TableDescriptor *ormv1.TableDescriptor
|
||||
|
||||
// SingletonDescriptor is an optional singleton descriptor to be explicitly used.
|
||||
// Generally this should be nil and the table descriptor
|
||||
// should be pulled from the singleton message option. SingletonDescriptor
|
||||
// cannot be used together with TableDescriptor.
|
||||
SingletonDescriptor *ormv1alpha1.SingletonDescriptor
|
||||
SingletonDescriptor *ormv1.SingletonDescriptor
|
||||
|
||||
// TypeResolver is an optional type resolver to be used when unmarshaling
|
||||
// protobuf messages.
|
||||
@@ -96,12 +97,12 @@ func Build(options Options) (Table, error) {
|
||||
|
||||
tableDesc := options.TableDescriptor
|
||||
if tableDesc == nil {
|
||||
tableDesc = proto.GetExtension(messageDescriptor.Options(), ormv1alpha1.E_Table).(*ormv1alpha1.TableDescriptor)
|
||||
tableDesc = proto.GetExtension(messageDescriptor.Options(), ormv1.E_Table).(*ormv1.TableDescriptor)
|
||||
}
|
||||
|
||||
singletonDesc := options.SingletonDescriptor
|
||||
if singletonDesc == nil {
|
||||
singletonDesc = proto.GetExtension(messageDescriptor.Options(), ormv1alpha1.E_Singleton).(*ormv1alpha1.SingletonDescriptor)
|
||||
singletonDesc = proto.GetExtension(messageDescriptor.Options(), ormv1.E_Singleton).(*ormv1.SingletonDescriptor)
|
||||
}
|
||||
|
||||
switch {
|
||||
|
||||
@@ -5,9 +5,8 @@ import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
|
||||
"google.golang.org/protobuf/proto"
|
||||
|
||||
"google.golang.org/protobuf/encoding/protojson"
|
||||
"google.golang.org/protobuf/proto"
|
||||
)
|
||||
|
||||
// singleton implements a Table instance for singletons.
|
||||
|
||||
Reference in New Issue
Block a user