2151427b5e
## Description This starts the implementation of approach (C) in #11774 by generating `_query.proto` files for `.proto` files which have ORM definitions. It does this using a new protoc plugin called `protoc-gen-go-cosmos-orm-proto`. Please review `bank_query.proto` and `test_schema_query.proto` as these are the outputs of the codegen. The approach taken does not attempt to do any sort of logical queries as discussed in #11774 and instead provides direct index access in the most simple and complete way that we can easily implement now. More advanced things in #11774 could be implemented later, but this should be possible to deliver relatively quickly and should allow developers to completely skip writing gRPC queries manually if they use ORM. Note that the implementation of these queries can provide merkle proofs because the mapping to state is well known. I did need to disable pulsar codegen in this PR because it doesn't support proto3 optionals which are needed here (depends on https://github.com/cosmos/cosmos-proto/issues/12). Fortunately, pulsar is 100% compatible with the official google codegen and there is no problem running ORM tests against the official codegen. --- ### 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/main/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/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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)
299 lines
11 KiB
Go
299 lines
11 KiB
Go
package codegen
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"google.golang.org/protobuf/compiler/protogen"
|
|
"google.golang.org/protobuf/reflect/protoreflect"
|
|
"google.golang.org/protobuf/types/dynamicpb"
|
|
|
|
ormv1 "cosmossdk.io/api/cosmos/orm/v1"
|
|
|
|
"github.com/cosmos/cosmos-sdk/orm/internal/fieldnames"
|
|
"github.com/cosmos/cosmos-sdk/orm/model/ormtable"
|
|
)
|
|
|
|
type tableGen struct {
|
|
fileGen
|
|
msg *protogen.Message
|
|
table *ormv1.TableDescriptor
|
|
primaryKeyFields fieldnames.FieldNames
|
|
fields map[protoreflect.Name]*protogen.Field
|
|
uniqueIndexes []*ormv1.SecondaryIndexDescriptor
|
|
ormTable ormtable.Table
|
|
}
|
|
|
|
const notFoundDocs = " returns nil and an error which responds true to ormerrors.IsNotFound() if the record was not found."
|
|
|
|
func newTableGen(fileGen fileGen, msg *protogen.Message, table *ormv1.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 {
|
|
t.fields[field.Desc.Name()] = field
|
|
}
|
|
uniqIndexes := make([]*ormv1.SecondaryIndexDescriptor, 0)
|
|
for _, idx := range t.table.Index {
|
|
if idx.Unique {
|
|
uniqIndexes = append(uniqIndexes, idx)
|
|
}
|
|
}
|
|
t.uniqueIndexes = uniqIndexes
|
|
var err error
|
|
t.ormTable, err = ormtable.Build(ormtable.Options{
|
|
MessageType: dynamicpb.NewMessageType(msg.Desc),
|
|
TableDescriptor: table,
|
|
})
|
|
return t, err
|
|
}
|
|
|
|
func (t tableGen) gen() {
|
|
t.getTableInterface()
|
|
t.genIterator()
|
|
t.genIndexKeys()
|
|
t.genStruct()
|
|
t.genTableImpl()
|
|
t.genTableImplGuard()
|
|
t.genConstructor()
|
|
}
|
|
|
|
func (t tableGen) getTableInterface() {
|
|
t.P("type ", t.messageTableInterfaceName(t.msg), " interface {")
|
|
t.P("Insert(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
|
|
if t.table.PrimaryKey.AutoIncrement {
|
|
t.P("InsertReturning", fieldsToCamelCase(t.table.PrimaryKey.Fields), "(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") (uint64, error)")
|
|
}
|
|
t.P("Update(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
|
|
t.P("Save(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
|
|
t.P("Delete(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
|
|
t.P("Has(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (found bool, err error)")
|
|
t.P("// Get", notFoundDocs)
|
|
t.P("Get(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (*", t.QualifiedGoIdent(t.msg.GoIdent), ", error)")
|
|
|
|
for _, idx := range t.uniqueIndexes {
|
|
t.genUniqueIndexSig(idx)
|
|
}
|
|
t.P("List(ctx ", contextPkg.Ident("Context"), ", prefixKey ", t.indexKeyInterfaceName(), ", opts ...", ormListPkg.Ident("Option"), ") ", "(", t.iteratorName(), ", error)")
|
|
t.P("ListRange(ctx ", contextPkg.Ident("Context"), ", from, to ", t.indexKeyInterfaceName(), ", opts ...", ormListPkg.Ident("Option"), ") ", "(", t.iteratorName(), ", error)")
|
|
t.P("DeleteBy(ctx ", contextPkg.Ident("Context"), ", prefixKey ", t.indexKeyInterfaceName(), ") error")
|
|
t.P("DeleteRange(ctx ", contextPkg.Ident("Context"), ", from, to ", t.indexKeyInterfaceName(), ") error")
|
|
t.P()
|
|
t.P("doNotImplement()")
|
|
t.P("}")
|
|
t.P()
|
|
}
|
|
|
|
// returns the has and get (in that order) function signature for unique indexes.
|
|
func (t tableGen) uniqueIndexSig(idxFields string) (string, string, string) {
|
|
fieldsSlc := strings.Split(idxFields, ",")
|
|
camelFields := fieldsToCamelCase(idxFields)
|
|
|
|
hasFuncName := "HasBy" + camelFields
|
|
getFuncName := "GetBy" + camelFields
|
|
args := t.fieldArgsFromStringSlice(fieldsSlc)
|
|
|
|
hasFuncSig := fmt.Sprintf("%s (ctx context.Context, %s) (found bool, err error)", hasFuncName, args)
|
|
getFuncSig := fmt.Sprintf("%s (ctx context.Context, %s) (*%s, error)", getFuncName, args, t.msg.GoIdent.GoName)
|
|
return hasFuncSig, getFuncSig, getFuncName
|
|
}
|
|
|
|
func (t tableGen) genUniqueIndexSig(idx *ormv1.SecondaryIndexDescriptor) {
|
|
hasSig, getSig, getFuncName := t.uniqueIndexSig(idx.Fields)
|
|
t.P(hasSig)
|
|
t.P("// ", getFuncName, notFoundDocs)
|
|
t.P(getSig)
|
|
}
|
|
|
|
func (t tableGen) iteratorName() string {
|
|
return t.msg.GoIdent.GoName + "Iterator"
|
|
}
|
|
|
|
func (t tableGen) getSig() string {
|
|
res := "Get" + t.msg.GoIdent.GoName + "("
|
|
res += t.fieldsArgs(t.primaryKeyFields.Names())
|
|
res += ") (*" + t.QualifiedGoIdent(t.msg.GoIdent) + ", error)"
|
|
return res
|
|
}
|
|
|
|
func (t tableGen) hasSig() string {
|
|
t.P("Has(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (found bool, err error)")
|
|
return ""
|
|
}
|
|
|
|
func (t tableGen) listSig() string {
|
|
res := "List" + t.msg.GoIdent.GoName + "("
|
|
res += t.indexKeyInterfaceName()
|
|
res += ") ("
|
|
res += t.iteratorName()
|
|
res += ", error)"
|
|
return res
|
|
}
|
|
|
|
func (t tableGen) fieldArgsFromStringSlice(names []string) string {
|
|
args := make([]string, len(names))
|
|
for i, name := range names {
|
|
args[i] = t.fieldArg(protoreflect.Name(name))
|
|
}
|
|
return strings.Join(args, ",")
|
|
}
|
|
|
|
func (t tableGen) fieldsArgs(names []protoreflect.Name) string {
|
|
var params []string
|
|
for _, name := range names {
|
|
params = append(params, t.fieldArg(name))
|
|
}
|
|
return strings.Join(params, ",")
|
|
}
|
|
|
|
func (t tableGen) fieldArg(name protoreflect.Name) string {
|
|
typ, pointer := t.GeneratedFile.FieldGoType(t.fields[name])
|
|
if pointer {
|
|
typ = "*" + typ
|
|
}
|
|
return string(name) + " " + typ
|
|
}
|
|
|
|
func (t tableGen) genStruct() {
|
|
t.P("type ", t.messageTableReceiverName(t.msg), " struct {")
|
|
if t.table.PrimaryKey.AutoIncrement {
|
|
t.P("table ", ormTablePkg.Ident("AutoIncrementTable"))
|
|
} else {
|
|
t.P("table ", ormTablePkg.Ident("Table"))
|
|
}
|
|
t.P("}")
|
|
t.storeStructName()
|
|
}
|
|
|
|
func (t tableGen) genTableImpl() {
|
|
receiverVar := "this"
|
|
receiver := fmt.Sprintf("func (%s %s) ", receiverVar, t.messageTableReceiverName(t.msg))
|
|
varName := t.param(t.msg.GoIdent.GoName)
|
|
varTypeName := t.QualifiedGoIdent(t.msg.GoIdent)
|
|
|
|
// these methods all have the same impl sans their names. so we can just loop and replace.
|
|
methods := []string{"Insert", "Update", "Save", "Delete"}
|
|
for _, method := range methods {
|
|
t.P(receiver, method, "(ctx ", contextPkg.Ident("Context"), ", ", varName, " *", varTypeName, ") error {")
|
|
t.P("return ", receiverVar, ".table.", method, "(ctx, ", varName, ")")
|
|
t.P("}")
|
|
t.P()
|
|
}
|
|
|
|
if t.table.PrimaryKey.AutoIncrement {
|
|
t.P(receiver, "InsertReturning", fieldsToCamelCase(t.table.PrimaryKey.Fields), "(ctx ", contextPkg.Ident("Context"), ", ", varName, " *", varTypeName, ") (uint64, error) {")
|
|
t.P("return ", receiverVar, ".table.InsertReturningPKey(ctx, ", varName, ")")
|
|
t.P("}")
|
|
t.P()
|
|
}
|
|
|
|
// Has
|
|
t.P(receiver, "Has(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (found bool, err error) {")
|
|
t.P("return ", receiverVar, ".table.PrimaryKey().Has(ctx, ", t.primaryKeyFields.String(), ")")
|
|
t.P("}")
|
|
t.P()
|
|
|
|
// Get
|
|
t.P(receiver, "Get(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (*", varTypeName, ", error) {")
|
|
t.P("var ", varName, " ", varTypeName)
|
|
t.P("found, err := ", receiverVar, ".table.PrimaryKey().Get(ctx, &", varName, ", ", t.primaryKeyFields.String(), ")")
|
|
t.P("if err != nil {")
|
|
t.P("return nil, err")
|
|
t.P("}")
|
|
t.P("if !found {")
|
|
t.P("return nil, ", ormErrPkg.Ident("NotFound"))
|
|
t.P("}")
|
|
t.P("return &", varName, ", nil")
|
|
t.P("}")
|
|
t.P()
|
|
|
|
for _, idx := range t.uniqueIndexes {
|
|
fields := strings.Split(idx.Fields, ",")
|
|
hasName, getName, _ := t.uniqueIndexSig(idx.Fields)
|
|
|
|
// has
|
|
t.P("func (", receiverVar, " ", t.messageTableReceiverName(t.msg), ") ", hasName, "{")
|
|
t.P("return ", receiverVar, ".table.GetIndexByID(", idx.Id, ").(",
|
|
ormTablePkg.Ident("UniqueIndex"), ").Has(ctx,")
|
|
for _, field := range fields {
|
|
t.P(field, ",")
|
|
}
|
|
t.P(")")
|
|
t.P("}")
|
|
t.P()
|
|
|
|
// get
|
|
varName := t.param(t.msg.GoIdent.GoName)
|
|
varTypeName := t.msg.GoIdent.GoName
|
|
t.P("func (", receiverVar, " ", t.messageTableReceiverName(t.msg), ") ", getName, "{")
|
|
t.P("var ", varName, " ", varTypeName)
|
|
t.P("found, err := ", receiverVar, ".table.GetIndexByID(", idx.Id, ").(",
|
|
ormTablePkg.Ident("UniqueIndex"), ").Get(ctx, &", varName, ",")
|
|
for _, field := range fields {
|
|
t.P(field, ",")
|
|
}
|
|
t.P(")")
|
|
t.P("if err != nil {")
|
|
t.P("return nil, err")
|
|
t.P("}")
|
|
t.P("if !found {")
|
|
t.P("return nil, ", ormErrPkg.Ident("NotFound"))
|
|
t.P("}")
|
|
t.P("return &", varName, ", nil")
|
|
t.P("}")
|
|
t.P()
|
|
}
|
|
|
|
// List
|
|
t.P(receiver, "List(ctx ", contextPkg.Ident("Context"), ", prefixKey ", t.indexKeyInterfaceName(), ", opts ...", ormListPkg.Ident("Option"), ") (", t.iteratorName(), ", error) {")
|
|
t.P("it, err := ", receiverVar, ".table.GetIndexByID(prefixKey.id()).List(ctx, prefixKey.values(), opts...)")
|
|
t.P("return ", t.iteratorName(), "{it}, err")
|
|
t.P("}")
|
|
t.P()
|
|
|
|
// ListRange
|
|
t.P(receiver, "ListRange(ctx ", contextPkg.Ident("Context"), ", from, to ", t.indexKeyInterfaceName(), ", opts ...", ormListPkg.Ident("Option"), ") (", t.iteratorName(), ", error) {")
|
|
t.P("it, err := ", receiverVar, ".table.GetIndexByID(from.id()).ListRange(ctx, from.values(), to.values(), opts...)")
|
|
t.P("return ", t.iteratorName(), "{it}, err")
|
|
t.P("}")
|
|
t.P()
|
|
|
|
// DeleteBy
|
|
t.P(receiver, "DeleteBy(ctx ", contextPkg.Ident("Context"), ", prefixKey ", t.indexKeyInterfaceName(), ") error {")
|
|
t.P("return ", receiverVar, ".table.GetIndexByID(prefixKey.id()).DeleteBy(ctx, prefixKey.values()...)")
|
|
t.P("}")
|
|
t.P()
|
|
t.P()
|
|
|
|
// DeleteRange
|
|
t.P(receiver, "DeleteRange(ctx ", contextPkg.Ident("Context"), ", from, to ", t.indexKeyInterfaceName(), ") error {")
|
|
t.P("return ", receiverVar, ".table.GetIndexByID(from.id()).DeleteRange(ctx, from.values(), to.values())")
|
|
t.P("}")
|
|
t.P()
|
|
t.P()
|
|
|
|
t.P(receiver, "doNotImplement() {}")
|
|
t.P()
|
|
}
|
|
|
|
func (t tableGen) genTableImplGuard() {
|
|
t.P("var _ ", t.messageTableInterfaceName(t.msg), " = ", t.messageTableReceiverName(t.msg), "{}")
|
|
}
|
|
|
|
func (t tableGen) genConstructor() {
|
|
iface := t.messageTableInterfaceName(t.msg)
|
|
t.P("func New", iface, "(db ", ormTablePkg.Ident("Schema"), ") (", iface, ", error) {")
|
|
t.P("table := db.GetTable(&", t.msg.GoIdent.GoName, "{})")
|
|
t.P("if table == nil {")
|
|
t.P("return nil,", ormErrPkg.Ident("TableNotFound.Wrap"), "(string((&", t.msg.GoIdent.GoName, "{}).ProtoReflect().Descriptor().FullName()))")
|
|
t.P("}")
|
|
if t.table.PrimaryKey.AutoIncrement {
|
|
t.P(
|
|
"return ", t.messageTableReceiverName(t.msg), "{table.(",
|
|
ormTablePkg.Ident("AutoIncrementTable"), ")}, nil",
|
|
)
|
|
} else {
|
|
t.P("return ", t.messageTableReceiverName(t.msg), "{table}, nil")
|
|
}
|
|
t.P("}")
|
|
}
|