Skip to content

Commit

Permalink
fix(orm): bad error messages (#11059)
Browse files Browse the repository at this point in the history
## Description

I've tested this locally running codegen and this PR changes this error message:
```
panic: nil field: unsupported key field

goroutine 1 [running]:
github.com/cosmos/cosmos-sdk/orm/internal/codegen.newTableGen({0xc00000d938, 0xc0003c4100}, 0xc0003c0c60, 0xc0002d4c80)
        /Users/arc/go/pkg/mod/github.com/cosmos/cosmos-sdk/orm@v1.0.0-alpha.3/internal/codegen/table.go:47 +0x3e5
github.com/cosmos/cosmos-sdk/orm/internal/codegen.fileGen.gen({0xc00000d938, 0xc0003c4100})
        /Users/arc/go/pkg/mod/github.com/cosmos/cosmos-sdk/orm@v1.0.0-alpha.3/internal/codegen/file.go:32 +0x205
github.com/cosmos/cosmos-sdk/orm/internal/codegen.PluginRunner(0xc000137cc0)
        /Users/arc/go/pkg/mod/github.com/cosmos/cosmos-sdk/orm@v1.0.0-alpha.3/internal/codegen/codegen.go:40 +0x159
google.golang.org/protobuf/compiler/protogen.run({0x0, 0x0}, 0x143b8f0)
        /Users/arc/go/pkg/mod/google.golang.org/protobuf@v1.27.1/compiler/protogen/protogen.go:74 +0x142
google.golang.org/protobuf/compiler/protogen.Options.Run({0x0, 0x0}, 0xc0000001a0)
        /Users/arc/go/pkg/mod/google.golang.org/protobuf@v1.27.1/compiler/protogen/protogen.go:52 +0x2a
main.main()
        /Users/arc/go/pkg/mod/github.com/cosmos/cosmos-sdk/orm@v1.0.0-alpha.3/cmd/protoc-gen-go-cosmos-orm/main.go:10 +0x25
Failure: plugin go-cosmos-orm: exit status 2; context canceled; exit status 2; signal: killed; signal: killed; context canceled
```

into this:
```
Failure: plugin go-cosmos-orm: field id on regen.ecocredit.v1beta1.BatchSupply: field not found
```




---

### 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)
  • Loading branch information
aaronc committed Jan 28, 2022
1 parent 627748d commit 2251739
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 16 deletions.
3 changes: 3 additions & 0 deletions orm/encoding/ormkv/key_codec.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ func NewKeyCodec(prefix []byte, messageType protoreflect.MessageType, fieldNames
for i := 0; i < n; i++ {
nonTerminal := i != n-1
field := messageFields.ByName(fieldNames[i])
if field == nil {
return nil, ormerrors.FieldNotFound.Wrapf("field %s on %s", fieldNames[i], messageType.Descriptor().FullName())
}
cdc, err := ormfield.GetCodec(field, nonTerminal)
if err != nil {
return nil, err
Expand Down
12 changes: 10 additions & 2 deletions orm/internal/codegen/file.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,20 @@ func (f fileGen) gen() error {
for _, msg := range f.file.Messages {
tableDesc := proto.GetExtension(msg.Desc.Options(), v1alpha1.E_Table).(*v1alpha1.TableDescriptor)
if tableDesc != nil {
newTableGen(f, msg, tableDesc).gen()
tableGen, err := newTableGen(f, msg, tableDesc)
if err != nil {
return err
}
tableGen.gen()
}
singletonDesc := proto.GetExtension(msg.Desc.Options(), v1alpha1.E_Singleton).(*v1alpha1.SingletonDescriptor)
if singletonDesc != nil {
// do some singleton magic
newSingletonGen(f, msg, singletonDesc).gen()
singletonGen, err := newSingletonGen(f, msg, singletonDesc)
if err != nil {
return err
}
singletonGen.gen()
}

if tableDesc != nil || singletonDesc != nil { // message is one of the tables,
Expand Down
17 changes: 8 additions & 9 deletions orm/internal/codegen/singleton.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ package codegen

import (
"fmt"
ormv1alpha1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1alpha1"
"github.com/cosmos/cosmos-sdk/orm/model/ormtable"

"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/types/dynamicpb"

ormv1alpha1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1alpha1"
"github.com/cosmos/cosmos-sdk/orm/model/ormtable"
)

type singletonGen struct {
Expand All @@ -15,17 +17,14 @@ type singletonGen struct {
ormTable ormtable.Table
}

func newSingletonGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.SingletonDescriptor) *singletonGen {
func newSingletonGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.SingletonDescriptor) (*singletonGen, error) {
s := &singletonGen{fileGen: fileGen, msg: msg, table: table}
ot, err := ormtable.Build(ormtable.Options{
var err error
s.ormTable, err = ormtable.Build(ormtable.Options{
MessageType: dynamicpb.NewMessageType(msg.Desc),
SingletonDescriptor: table,
})
if err != nil {
panic(err)
}
s.ormTable = ot
return s
return s, err
}

func (s singletonGen) gen() {
Expand Down
7 changes: 2 additions & 5 deletions orm/internal/codegen/table.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type tableGen struct {
ormTable ormtable.Table
}

func newTableGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.TableDescriptor) *tableGen {
func newTableGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.TableDescriptor) (*tableGen, error) {
t := &tableGen{fileGen: fileGen, msg: msg, table: table, fields: map[protoreflect.Name]*protogen.Field{}}
t.primaryKeyFields = fieldnames.CommaSeparatedFieldNames(table.PrimaryKey.Fields)
for _, field := range msg.Fields {
Expand All @@ -43,10 +43,7 @@ func newTableGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.Tabl
MessageType: dynamicpb.NewMessageType(msg.Desc),
TableDescriptor: table,
})
if err != nil {
panic(err)
}
return t
return t, err
}

func (t tableGen) gen() {
Expand Down

0 comments on commit 2251739

Please sign in to comment.