Problem with reflection for methods with many enums

[GoNextGroup]

Hello, Marc.

I try to use reflection in my project, but got problem with enums.

I have service with request record:

    [ProtoContract]
    public record GenerateTokenRequest
    {
        [ProtoMember(1)]
        public Guid UserId { get; init; }
        [ProtoMember(2)]
        public Roles Role { get; init; }
        [ProtoMember(3)]
        public ClientTypes ClientType { get; init; }
        [ProtoMember(4)]
        public TokenType TokenType { get; init; }
    }

The proto file was generated:

syntax = "proto3";
package SharedInterfaces.TokenService.SecurityInterfaces.Token;
import "protobuf-net/bcl.proto"; // schema for protobuf-net's handling of core .NET types

enum ClientTypes {
   ZERO = 0; // proto3 requires a zero value as the first item (it can be named anything)
   Dealer = 1;
   Executor = 2;
}
message GenerateTokenRequest {
   .bcl.Guid UserId = 1; // default value could not be applied: 00000000-0000-0000-0000-000000000000
   Roles Role = 2;
   ClientTypes ClientType = 3;
   TokenType TokenType = 4;
}
enum Roles {
   User = 0;
   Worker = 1;
   Setter = 2;
   Customer = 3;
   ManagerOP = 4;
   Manager = 5;
   Employee = 998;
   LegalEntity = 999;
}
enum TokenType {
   ZERO = 0; // proto3 requires a zero value as the first item (it can be named anything)
   Temporary = 1;
   Persistent = 2;
}
message UserToken {
   string AuthenticationType = 1;
   string Token = 2;
   .bcl.DateTime Expiration = 3;
   int64 ExpirationUnixTime = 4;
   ClientTypes ClientType = 5;
   Roles Role = 6;
}
service TokenGeneration {
   rpc Generate (GenerateTokenRequest) returns (UserToken);
}

So, when I try to use command docker run fullstorydev/grpcurl -plaintext -use-reflection 172.23.17.107:50029 describe SharedInterfaces.TokenService.SecurityInterfaces.Token.TokenGeneration

I got a message
Failed to resolve symbol "SharedInterfaces.TokenService.SecurityInterfaces.Token.TokenGeneration": proto: descriptor "SharedInterfaces.TokenService.SecurityInterfaces.Token.ZERO" already declared

I've tried to find solution in the internet/SO/tg chats, but without any success. Could you help me to fix this problem? Or is there no way just only change enum elements order starting not from 1, but from 0?

[mgravell]

I think this comes down to name collisions; we should add a mode that optionally includes the enum name as a prefix in all enum names (including zero), so we generate TokenType_Zero, TokenType_Temporary, etc

unrelated: you might want to look at https://protobuf-net.github.io/protobuf-net/compatibilitylevel re the data and guid

[GoNextGroup]

Thank you for your answer. Currently, I'll try to change ordering of elements starting from 0. Is it possible in future releases to change enum members generation style? Because the same collision can be in cases when 2 enums contain elements with same names.

[mgravell]

Is it possible in future releases to change enum members generation style? Because the same collision can be in cases when 2 enums contain elements with same names.

Yes, that is what I was proposing - sorry if that was unclear.

[GoNextGroup]

Thank you! I'll wait for new release)))

[menaheme]

Why is this closed?

[GoNextGroup]

Why is this closed?

Sorry, my bad.

[erichiller]

I encountered this issue as well. To work around it globally for now I am using:

// model can be any or the default ProtoBuf.Meta.RuntimeTypeModel.Default;
model.AfterApplyDefaultBehaviour += ( obj, evt ) => {
    if ( evt.Type.IsEnum
      && evt.MetaType.GetEnumValues().None( static v => v.Value is 0 )
      && evt.MetaType.GetEnumValues().FirstOrDefault().Value switch {
             long  => false,
             ulong => false,
             uint  => false,
             _     => true
         } ) {
        evt.MetaType.SetEnumValues( [ new EnumMember( ( byte )0, $"{evt.MetaType.GetSchemaTypeName()}__ZERO__DOES_NOT_EXIST" ), ..evt.MetaType.GetEnumValues() ] );
    }
};

[shokurov]

I faced the problem described, now with two unrelated enums, having same element "Deleted".

The minimal repro code is below:

[DataContract(Name = nameof(ClientHistoryInfoTypeActionCode2))]
public enum ClientHistoryInfoTypeActionCode2
{
    Inserted,
    Updated,
    Deleted,
}

[DataContract(Name = nameof(ClientStatusIdType2))]
public enum ClientStatusIdType2
{
    Activated,
    Created,
    Deactivated,
    Blocked,
    Deleted,
}

[DataContract]
public class ClientHistoryInfoType2
{
    [DataMember(Order = 1)]
    public ClientStatusIdType2 ClientStatusId { get; set; }

    [DataMember(Order = 2)]
    public ClientHistoryInfoTypeActionCode2 ActionCode { get; set; }
}

[Service]
public interface IGrpcProcessingService
{
    Task<ClientHistoryInfoType2> ExportClientHistoryAsync();
}

then invocation of:

grpcurl -plaintext -vv localhost:5051 describe

gives

Failed to resolve symbol "RapidSoft.Loyalty.Mediation.ApiInternal.GrpcService.GrpcProcessingService": proto: descriptor "RapidSoft.Loyalty.Mediation.ApiInternal.GrpcService.Deleted" already declared

[shokurov]

Here's the updated work-around, thanks @erichiller for idea:

/// <summary>
/// This is work around for https://github.com/protobuf-net/protobuf-net.Grpc/issues/323
/// </summary>
public static class ProtobufModelDuplicateEnumFixer
{
    private static readonly HashSet<string> s_enumMemberNames = new();

    public static void FixProtobufEnumDuplicates(this RuntimeTypeModel runtimeTypeModel)
    {
        runtimeTypeModel.AfterApplyDefaultBehaviour += (_, eventArgs) =>
        {
            if (!eventArgs.Type.IsEnum)
            {
                return;
            }
            // When we have multiple enums with the same name, we need to make sure that the names are unique
            var uniqueValues = eventArgs
                .MetaType.GetEnumValues()
                .Select(value =>
                    s_enumMemberNames.Add(value.Name)
                        ? value
                        : value.WithName($"{eventArgs.MetaType.GetSchemaTypeName()}_{value.Name}")
                )
                .ToArray();
            // If we don't have a zero value, protobuf-net.Grpc will add one with name 'ZERO', so we should
            // add a special name to avoid conflicts
            if (
                !uniqueValues.Any(static v => v.Value is 0)
                && uniqueValues.FirstOrDefault().Value switch
                {
                    long => false,
                    ulong => false,
                    uint => false,
                    _ => true,
                }
            )
                uniqueValues =
                [
                    new EnumMember(
                        (byte)0,
                        $"{eventArgs.MetaType.GetSchemaTypeName()}__ZERO__DOES_NOT_EXIST"
                    ),
                    .. uniqueValues,
                ];
            eventArgs.MetaType.SetEnumValues(uniqueValues);
        };
    }
}