Fix JSON encoding of proto3 optional non-nil defaults (#359)

Co-authored-by: Andrea Leopardi <[email protected]>

Author: zookzook

lib/protobuf/json/encode.ex

@@ -162,11 +162,19 @@ defmodule Protobuf.JSON.Encode do
   defp encode_regular_fields(struct, %{field_props: field_props}, opts) do
     for {_field_num, %{name_atom: name, oneof: nil} = prop} <- field_props,
         %{^name => value} = struct,
-        opts[:emit_unpopulated] || !default?(prop, value) do
+        emit?(prop, value) || opts[:emit_unpopulated] do
       encode_field(prop, value, opts)
     end
   end
 
+  defp emit?(_prop, nil) do
+    false
+  end
+
+  defp emit?(prop, value) do
+    if default?(prop, value), do: prop.proto3_optional?, else: true
+  end
+
   defp encode_oneof_fields(struct, message_props, opts) do
     %{field_tags: field_tags, field_props: field_props, oneof: oneofs} = message_props
 

test/protobuf/json/decode_test.exs

@@ -653,6 +653,26 @@ defmodule Protobuf.JSON.DecodeTest do
              %ContainsTransformModule{field: nil}
   end
 
+  test "decodes nil for proto3" do
+    data = %{
+      "b" => "A"
+    }
+
+    assert decode(data, TestMsg.Proto3Optional) ==
+             {:ok, %TestMsg.Proto3Optional{a: nil, b: "A", c: nil}}
+  end
+
+  test "decodes default values for proto3 optional" do
+    data = %{
+      "a" => 0,
+      "b" => "A",
+      "c" => "UNKNOWN"
+    }
+
+    assert decode(data, TestMsg.Proto3Optional) ==
+             {:ok, %TestMsg.Proto3Optional{a: 0, b: "A", c: :UNKNOWN}}
+  end
+
   describe "Google types" do
     test "Google.Protobuf.Empty" do
       data = %{}

test/protobuf/json/encode_test.exs

@@ -14,6 +14,16 @@ defmodule Protobuf.JSON.EncodeTest do
     Scalars
   }
 
+  test "encodes proto3 optional fields zero values" do
+    message = %TestMsg.Proto3Optional{a: 0, c: :UNKNOWN}
+    assert encode(message) == %{"a" => 0, "c" => :UNKNOWN}
+  end
+
+  test "skips a proto3 optional field with a nil value" do
+    message = %TestMsg.Proto3Optional{a: nil, c: nil}
+    assert encode(message) == %{}
+  end
+
   test "encodes strings and booleans as they are" do
     message = %Scalars{string: "エリクサー", bool: true}
     assert encode(message) == %{"string" => "エリクサー", "bool" => true}