Hello @kazegusuri! I'm hoping to get some input on the following error which I've encountered while using this project.

I have the following proto message:

syntax = "proto3";

option go_package = "github.com/kashing/goofys/proto";

import "google/protobuf/timestamp.proto";

message NodeMetadata {
  map<string, NodeMetadata> children = 1;
  uint64 size = 2;
  google.protobuf.Timestamp last_modified_at = 3;
  string name = 4;
  bool directory = 5;
  bool root = 6;
}

After generating the ObjectMarshaler interface via the latest version of the plugin, I am left with the following file which generates a compile time error.

// Code generated by protoc-gen-gogo. DO NOT EDIT.
// source: github.com/kashing/goofys/proto/metadata.proto

package proto

import (
	fmt "fmt"
	math "math"
	proto "github.com/golang/protobuf/proto"
	_ "google.golang.org/protobuf/types/known/timestamppb"
	go_uber_org_zap_zapcore "go.uber.org/zap/zapcore"
	github_com_golang_protobuf_ptypes "github.com/golang/protobuf/ptypes"
)

// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
var _ = fmt.Errorf
var _ = math.Inf

func (m *NodeMetadata) MarshalLogObject(enc go_uber_org_zap_zapcore.ObjectEncoder) error {
	var keyName string
	_ = keyName

	if m == nil {
		return nil
	}

	keyName = "children" // field children = 1
	enc.AddObject(keyName, go_uber_org_zap_zapcore.ObjectMarshalerFunc(func(enc go_uber_org_zap_zapcore.ObjectEncoder) error {
		for mk, mv := range m.Children {
			key := mk
			_ = key
			if mv != nil {
				var vv interface{} = mv
				if marshaler, ok := vv.(go_uber_org_zap_zapcore.ObjectMarshaler); ok {
					enc.AddObject(key, marshaler)
				}
			}
		}
		return nil
	}))

	keyName = "size" // field size = 2
	enc.AddUint64(keyName, m.Size_)

	keyName = "last_modified_at" // field last_modified_at = 3
	if t, err := github_com_golang_protobuf_ptypes.Timestamp(m.LastModifiedAt); err == nil {
		enc.AddTime(keyName, t)
	}

	keyName = "name" // field name = 4
	enc.AddString(keyName, m.Name)

	keyName = "directory" // field directory = 5
	enc.AddBool(keyName, m.Directory)

	keyName = "root" // field root = 6
	enc.AddBool(keyName, m.Root)

	return nil
}

The issue is at the following line when the size key is added to the encoder. (m.Size_ is not valid, this should be m.Size)

enc.AddUint64(keyName, m.Size_)

Looking for input on why this might be happening for this proto message alone (I've used to project with great success for many other proto files).

Happy to submit a PR to address this if you can point me in the right direction? I'm not seeing anything obvious after a cursory scan of the codebase (though i'm not terribly familiar working with the protoc compiler plugin interface, so there might be something simple)

Thanks for your work on this excellent project!

Hi,

Do you support https://github.com/namely/docker-protoc ?

This is our dockerfile that wraps the above dockerfile:

FROM namely/protoc-all:1.26_0

RUN apk --update --no-cache add git

I couldn't find a way for both to work together.

Your assistance is greatly appreciated!

Leeran

Hi, thanks for the project.

I noticed that when repeatedly running protoc with zap, the import order in the go code changes, despite nothing changing in the source proto files. It would be nice if it were always generating in the same order that gofmt sets.

For example with this small proto file.

main.proto

syntax = "proto3";

package test;

import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";

If I run it twice, I get a diff like this.

-	_ "google.golang.org/protobuf/types/known/structpb"
-	_ "google.golang.org/protobuf/types/known/timestamppb"
+	_ "google.golang.org/protobuf/types/known/timestamppb"
+	_ "google.golang.org/protobuf/types/known/structpb"

A full log is below.

$ protoc --zap-marshaler_out=. main.proto && cat main.zap.go 
main.proto:5:1: warning: Import google/protobuf/struct.proto is unused.
main.proto:6:1: warning: Import google/protobuf/timestamp.proto is unused.
// Code generated by protoc-gen-gogo. DO NOT EDIT.
// source: main.proto

package test

import (
	fmt "fmt"
	math "math"
	proto "github.com/golang/protobuf/proto"
	_ "google.golang.org/protobuf/types/known/timestamppb"      <<<<---- timestamp first
	_ "google.golang.org/protobuf/types/known/structpb"              <<<<---- structpb second
)

// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
var _ = fmt.Errorf
var _ = math.Inf

$ protoc --zap-marshaler_out=. main.proto && cat main.zap.go
main.proto:5:1: warning: Import google/protobuf/struct.proto is unused.
main.proto:6:1: warning: Import google/protobuf/timestamp.proto is unused.
// Code generated by protoc-gen-gogo. DO NOT EDIT.
// source: main.proto

package test

import (
	fmt "fmt"
	math "math"
	proto "github.com/golang/protobuf/proto"
	_ "google.golang.org/protobuf/types/known/structpb"                <<<<---- structpb first
	_ "google.golang.org/protobuf/types/known/timestamppb"        <<<<---- timestamp second
)

// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
var _ = fmt.Errorf
var _ = math.Inf

Proto3 introduced version 3.12 changelog introduced the optional field label.

However, a message like this:

message Sender { optional string polaris_id = 1; }

generated code like this

`
keyName = "polaris_id" // field polaris_id = 1
if ov, ok := m.GetXPolarisId().(*Sender_PolarisId); ok {
_ = ov
enc.AddString(keyName, ov.PolarisId)
}

`

However, the GetXPolarisId() doesn't exist and creates a compiletime error.