Skip to content

feat: ensure compatibility on field numbers #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Kybxd wants to merge 4 commits into from
Closed

feat: ensure compatibility on field numbers #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f47a63a
refactor: prepare all tag ids before exporting field
Kybxd Feb 6, 2026
faf0f81
refactor: exporter
Kybxd Feb 9, 2026
0b8ed5f
feat: add option
Kybxd Feb 9, 2026
86a9c5b
feat: also works on exportStruct
Kybxd Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 93 additions & 19 deletions internal/protogen/exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func newBookExporter(protoPackage string, protoFileOptions map[string]string, ou
}

func (x *bookExporter) GetProtoFilePath() string {
return genProtoFilePath(x.wb.Name, x.FilenameSuffix)
return genProtoFilePath(x.wb.GetName(), x.FilenameSuffix)
}

func (x *bookExporter) export(checkProtoFileConflicts bool) error {
Expand Down Expand Up @@ -203,11 +203,17 @@ func (x *sheetExporter) exportStruct() error {
opts := &tableaupb.StructOptions{Name: x.ws.GetOptions().GetName(), Note: x.ws.Note}
x.p.P(" option (tableau.struct) = {", marshalToText(opts), "};")
x.p.P("")

md := x.parseMessagerFromGeneratedProtos(x.ws.Name)
x.addNumberToFields(x.ws.Fields, md)
// generate the fields
depth := 1
for i, field := range x.ws.Fields {
tagid := i + 1
if err := x.exportField(depth, tagid, field, x.ws.Name); err != nil {
for _, field := range x.ws.Fields {
var fd protoreflect.FieldDescriptor
if md != nil {
fd = md.Fields().ByNumber(protoreflect.FieldNumber(field.GetNumber()))
}
if err := x.exportField(depth, field, x.ws.Name, fd); err != nil {
return err
}
}
Expand Down Expand Up @@ -273,16 +279,16 @@ func (x *sheetExporter) exportUnion() error {
x.p.P(" message ", typ, " {")
// generate the fields
depth := 2
tagid := 1
tagid := int32(1)
for _, field := range msgField.Fields {
if err := x.exportField(depth, tagid, field, msgField.Name); err != nil {
field.Number = tagid
cross := max(field.GetOptions().GetProp().GetCross(), 1)
tagid += cross
}
for _, field := range msgField.Fields {
if err := x.exportField(depth, field, msgField.Name, nil); err != nil {
return err
}
cross := int(field.GetOptions().GetProp().GetCross())
if cross < 1 {
cross = 1
}
tagid += cross
}
x.p.P(" }")
}
Expand All @@ -294,6 +300,54 @@ func (x *sheetExporter) exportUnion() error {
return nil
}

func (x *sheetExporter) parseMessagerFromGeneratedProtos(name string) protoreflect.MessageDescriptor {
if !x.be.gen.OutputOpt.PreserveFieldNumbers {
return nil
}
relPath := x.be.GetProtoFilePath()
fd, err := x.be.gen.GeneratedProtoRegistryFiles.FindFileByPath(relPath)
if err != nil {
return nil
}
return fd.Messages().ByName(protoreflect.Name(name))
}

func (*sheetExporter) addNumberToFields(fields []*internalpb.Field, md protoreflect.MessageDescriptor) {
if md == nil {
tagid := int32(1)
for _, field := range fields {
field.Number = tagid
tagid++
}
return
}
fieldNameNumberMap := make(map[string]int32)
fieldNumbers := make(map[int32]bool)
for _, field := range fields {
if fd := md.Fields().ByName(protoreflect.Name(field.Name)); fd != nil {
number := int32(fd.Number())
fieldNameNumberMap[field.Name] = number
fieldNumbers[number] = true
}
}
var missingNumbers []int32
for i := int32(1); len(fieldNumbers)+len(missingNumbers) < len(fields); i++ {
if fieldNumbers[i] {
continue
}
missingNumbers = append(missingNumbers, i)
}
missingNumberIndex := 0
for _, field := range fields {
if number, ok := fieldNameNumberMap[field.Name]; ok {
field.Number = number
} else {
field.Number = missingNumbers[missingNumberIndex]
missingNumberIndex++
}
}
}

func (x *sheetExporter) exportMessager() error {
// log.Debugf("workbook: %s", x.ws.String())
if x.be.messagerPatternRegexp != nil && !x.be.messagerPatternRegexp.MatchString(x.ws.Name) {
Expand All @@ -302,11 +356,17 @@ func (x *sheetExporter) exportMessager() error {
x.p.P("message ", x.ws.Name, " {")
x.p.P(" option (tableau.worksheet) = {", marshalToText(x.ws.Options), "};")
x.p.P("")

md := x.parseMessagerFromGeneratedProtos(x.ws.Name)
x.addNumberToFields(x.ws.Fields, md)
// generate the fields
depth := 1
for i, field := range x.ws.Fields {
tagid := i + 1
if err := x.exportField(depth, tagid, field, x.ws.Name); err != nil {
for _, field := range x.ws.Fields {
var fd protoreflect.FieldDescriptor
if md != nil {
fd = md.Fields().ByNumber(protoreflect.FieldNumber(field.GetNumber()))
}
if err := x.exportField(depth, field, x.ws.Name, fd); err != nil {
return err
}
}
Expand All @@ -317,7 +377,7 @@ func (x *sheetExporter) exportMessager() error {
return nil
}

func (x *sheetExporter) exportField(depth int, tagid int, field *internalpb.Field, prefix string) error {
func (x *sheetExporter) exportField(depth int, field *internalpb.Field, prefix string, fd protoreflect.FieldDescriptor) error {
label := ""
if x.ws.GetOptions().GetFieldPresence() &&
types.IsScalarType(field.FullType) &&
Expand All @@ -328,8 +388,12 @@ func (x *sheetExporter) exportField(depth int, tagid int, field *internalpb.Fiel
if field.Note != "" {
note = " // " + field.Note
}
x.p.P(printer.Indent(depth), label, field.FullType, " ", field.Name, " = ", tagid, " ", genFieldOptionsString(field.Options), ";", note)
x.p.P(printer.Indent(depth), label, field.FullType, " ", field.Name, " = ", field.Number, " ", genFieldOptionsString(field.Options), ";", note)

var md protoreflect.MessageDescriptor
if fd != nil {
md = fd.Message()
}
typeName := field.Type
fullTypeName := field.FullType
if field.ListEntry != nil {
Expand All @@ -339,6 +403,11 @@ func (x *sheetExporter) exportField(depth int, tagid int, field *internalpb.Fiel
if field.MapEntry != nil {
typeName = field.MapEntry.ValueType
fullTypeName = field.MapEntry.ValueFullType
if fd != nil {
if v := fd.MapValue(); v != nil {
md = v.Message()
}
}
}

if types.IsWellKnownMessage(fullTypeName) {
Expand Down Expand Up @@ -377,9 +446,14 @@ func (x *sheetExporter) exportField(depth int, tagid int, field *internalpb.Fiel

// x.g.P("")
x.p.P(printer.Indent(depth), "message ", typeName, " {")
for i, f := range field.Fields {
tagid := i + 1
if err := x.exportField(depth+1, tagid, f, nestedMsgName); err != nil {

x.addNumberToFields(field.Fields, md)
for _, f := range field.Fields {
var nextFd protoreflect.FieldDescriptor
if md != nil {
nextFd = md.Fields().ByNumber(protoreflect.FieldNumber(field.GetNumber()))
}
if err := x.exportField(depth+1, f, nestedMsgName, nextFd); err != nil {
return err
}
}
Expand Down
14 changes: 12 additions & 2 deletions internal/protogen/protogen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"golang.org/x/sync/errgroup"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/reflect/protoregistry"
)

type Generator struct {
Expand All @@ -39,6 +40,8 @@ type Generator struct {
InputOpt *options.ProtoInputOption
OutputOpt *options.ProtoOutputOption

GeneratedProtoRegistryFiles *protoregistry.Files

// internal
typeInfos *xproto.TypeInfos // predefined type infos

Expand Down Expand Up @@ -68,11 +71,12 @@ func NewGeneratorWithOptions(protoPackage, indir, outdir string, opts *options.O

cachedImporters: make(map[string]importer.Importer),
}
gen.GeneratedProtoRegistryFiles, _ = gen.parseProtoRegistryFiles(true)

return gen
}

func (gen *Generator) preprocess(useGeneratedProtos, delExisted bool) error {
func (gen *Generator) parseProtoRegistryFiles(useGeneratedProtos bool) (*protoregistry.Files, error) {
outdir := filepath.Join(gen.OutputDir, gen.OutputOpt.Subdir)
var protoFiles []string
protoFiles = append(protoFiles, gen.InputOpt.ProtoFiles...)
Expand All @@ -84,9 +88,15 @@ func (gen *Generator) preprocess(useGeneratedProtos, delExisted bool) error {
protoFiles = append(protoFiles, xfs.CleanSlashPath(filepath.Join(outdir, "*.proto")))
}
// parse custom imported proto files
protoRegistryFiles, err := protoc.NewFiles(
return protoc.NewFiles(
gen.InputOpt.ProtoPaths,
protoFiles)
}

func (gen *Generator) preprocess(useGeneratedProtos, delExisted bool) error {
outdir := filepath.Join(gen.OutputDir, gen.OutputOpt.Subdir)
// parse custom imported proto files
protoRegistryFiles, err := gen.parseProtoRegistryFiles(useGeneratedProtos)
if err != nil {
return err
}
Expand Down
22 changes: 22 additions & 0 deletions options/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,28 @@ type ProtoOutputOption struct {
//
// Default: false.
EnumValueWithPrefix bool `yaml:"enumValueWithPrefix"`

// Whether converter will preserve field numbers for fields that already
// exists in current protos. For example, if you already have the message
// below in your proto file:
//
// message Item {
// int32 id = 1 [(tableau.field) = { name: "ID" }];
// int32 count = 2 [(tableau.field) = { name: "Count" }];
// }
//
// Then you try to add a string field "Name" between "ID" and "Count", its
// field number will be 3. "ID" and "Count" will preserve their previous
// field number 1 and 2.
//
// message Item {
// int32 id = 1 [(tableau.field) = { name: "ID" }];
// string name = 3 [(tableau.field) = { name: "Name" }];
// int32 count = 2 [(tableau.field) = { name: "Count" }];
// }
//
// Default: false.
PreserveFieldNumbers bool `yaml:"preserveFieldNumbers"`
}

// Options for generating conf files. Only for confgen.
Expand Down
Loading