Add config option to print 64-bit integers in JSON as unquoted ints if they can be losslessly converted into a 64-bit float.

PiperOrigin-RevId: 516625978

Author: protobuf-github-bot

src/google/protobuf/json/internal/unparser.cc

@@ -31,13 +31,15 @@
 #include "google/protobuf/json/internal/unparser.h"
 
 #include <cfloat>
+#include <cmath>
 #include <complex>
 #include <cstdint>
 #include <cstring>
 #include <limits>
 #include <memory>
 #include <sstream>
 #include <string>
+#include <type_traits>
 #include <utility>
 
 #include "google/protobuf/descriptor.h"
@@ -104,6 +106,33 @@ void WriteEnum(JsonWriter& writer, Field<Traits> field, int32_t value,
   }
 }
 
+// Returns true if x round-trips through being cast to a double, i.e., if
+// x is represenable exactly as a double. This is a slightly weaker condition
+// than x < 2^52.
+template <typename Int>
+bool RoundTripsThroughDouble(Int x) {
+  auto d = static_cast<double>(x);
+  // d has guaranteed to be finite with no fractional part, because it came from
+  // an integer, so we only need to check that it is not outside of the
+  // representable range of `int`. The way to do this is somewhat not obvious:
+  // UINT64_MAX isn't representable, and what it gets rounded to when we go
+  // int->double is unspecified!
+  //
+  // Thus, we have to go through ldexp.
+  double min = 0;
+  double max_plus_one = std::ldexp(1.0, sizeof(Int) * 8);
+  if (std::is_signed<Int>::value) {
+    max_plus_one /= 2;
+    min = -max_plus_one;
+  }
+
+  if (d < min || d >= max_plus_one) {
+    return false;
+  }
+
+  return static_cast<Int>(d) == x;
+}
+
 // Mutually recursive with functions that follow.
 template <typename Traits>
 absl::Status WriteMessage(JsonWriter& writer, const Msg<Traits>& msg,
@@ -143,14 +172,24 @@ absl::Status WriteSingular(JsonWriter& writer, Field<Traits> field,
     case FieldDescriptor::TYPE_INT64: {
       auto x = Traits::GetInt64(field, std::forward<Args>(args)...);
       RETURN_IF_ERROR(x.status());
-      writer.Write(MakeQuoted(*x));
+      if (writer.options().unquote_int64_if_possible &&
+          RoundTripsThroughDouble(*x)) {
+        writer.Write(*x);
+      } else {
+        writer.Write(MakeQuoted(*x));
+      }
       break;
     }
     case FieldDescriptor::TYPE_FIXED64:
     case FieldDescriptor::TYPE_UINT64: {
       auto x = Traits::GetUInt64(field, std::forward<Args>(args)...);
       RETURN_IF_ERROR(x.status());
-      writer.Write(MakeQuoted(*x));
+      if (writer.options().unquote_int64_if_possible &&
+          RoundTripsThroughDouble(*x)) {
+        writer.Write(*x);
+      } else {
+        writer.Write(MakeQuoted(*x));
+      }
       break;
     }
     case FieldDescriptor::TYPE_SFIXED32:

src/google/protobuf/json/internal/writer.h

@@ -69,6 +69,9 @@ struct WriterOptions {
   bool always_print_enums_as_ints = false;
   // Whether to preserve proto field names
   bool preserve_proto_field_names = false;
+  // If set, int64 values that can be represented exactly as a double are
+  // printed without quotes.
+  bool unquote_int64_if_possible = false;
   // The original parser used by json_util2 accepted a number of non-standard
   // options. Setting this flag enables them.
   //
@@ -153,8 +156,19 @@ class JsonWriter {
     Write(view);
   }
 
-  void Write(int64_t) = delete;
-  void Write(uint64_t) = delete;
+  void Write(int64_t val) {
+    char buf[22];
+    int len = absl::SNPrintF(buf, sizeof(buf), "%d", val);
+    absl::string_view view(buf, static_cast<size_t>(len));
+    Write(view);
+  }
+
+  void Write(uint64_t val) {
+    char buf[22];
+    int len = absl::SNPrintF(buf, sizeof(buf), "%d", val);
+    absl::string_view view(buf, static_cast<size_t>(len));
+    Write(view);
+  }
 
   template <typename... Ts>
   void Write(Quoted<Ts...> val) {
@@ -206,20 +220,6 @@ class JsonWriter {
 
   void WriteQuoted(absl::string_view val) { WriteEscapedUtf8(val); }
 
-  void WriteQuoted(int64_t val) {
-    char buf[22];
-    int len = absl::SNPrintF(buf, sizeof(buf), "%d", val);
-    absl::string_view view(buf, static_cast<size_t>(len));
-    Write(view);
-  }
-
-  void WriteQuoted(uint64_t val) {
-    char buf[22];
-    int len = absl::SNPrintF(buf, sizeof(buf), "%d", val);
-    absl::string_view view(buf, static_cast<size_t>(len));
-    Write(view);
-  }
-
   // Tries to write a non-finite double if necessary; returns false if
   // nothing was written.
   bool MaybeWriteSpecialFp(double val);

src/google/protobuf/json/json.cc

@@ -57,6 +57,7 @@ absl::Status BinaryToJsonStream(google::protobuf::util::TypeResolver* resolver,
   opts.preserve_proto_field_names = options.preserve_proto_field_names;
   opts.always_print_enums_as_ints = options.always_print_enums_as_ints;
   opts.always_print_primitive_fields = options.always_print_primitive_fields;
+  opts.unquote_int64_if_possible = options.unquote_int64_if_possible;
 
   // TODO(b/234868512): Drop this setting.
   opts.allow_legacy_syntax = true;
@@ -110,6 +111,7 @@ absl::Status MessageToJsonString(const Message& message, std::string* output,
   opts.preserve_proto_field_names = options.preserve_proto_field_names;
   opts.always_print_enums_as_ints = options.always_print_enums_as_ints;
   opts.always_print_primitive_fields = options.always_print_primitive_fields;
+  opts.unquote_int64_if_possible = options.unquote_int64_if_possible;
 
   // TODO(b/234868512): Drop this setting.
   opts.allow_legacy_syntax = true;

src/google/protobuf/json/json.h

@@ -56,9 +56,6 @@ struct ParseOptions {
   // this option. If your enum needs to support different casing, consider using
   // allow_alias instead.
   bool case_insensitive_enum_parsing = false;
-
-  ParseOptions()
-      : ignore_unknown_fields(false), case_insensitive_enum_parsing(false) {}
 };
 
 struct PrintOptions {
@@ -75,12 +72,9 @@ struct PrintOptions {
   bool always_print_enums_as_ints = false;
   // Whether to preserve proto field names
   bool preserve_proto_field_names = false;
-
-  PrintOptions()
-      : add_whitespace(false),
-        always_print_primitive_fields(false),
-        always_print_enums_as_ints(false),
-        preserve_proto_field_names(false) {}
+  // If set, int64 values that can be represented exactly as a double are
+  // printed without quotes.
+  bool unquote_int64_if_possible = false;
 };
 
 // Converts from protobuf message to JSON and appends it to |output|. This is a

src/google/protobuf/json/json_test.cc

@@ -315,6 +315,28 @@ TEST_P(JsonTest, EvilString) {
   EXPECT_EQ(m->string_value(), "\n\r\b\f\1\2\3");
 }
 
+TEST_P(JsonTest, Unquoted64) {
+  TestMessage m;
+  m.add_repeated_int64_value(0);
+  m.add_repeated_int64_value(42);
+  m.add_repeated_int64_value(-((int64_t{1} << 60) + 1));
+  m.add_repeated_int64_value(INT64_MAX);
+  // This is a power of two and is therefore representable.
+  m.add_repeated_int64_value(INT64_MIN);
+  m.add_repeated_uint64_value(0);
+  m.add_repeated_uint64_value(42);
+  m.add_repeated_uint64_value((uint64_t{1} << 60) + 1);
+  // This will be UB without the min/max check in RoundTripsThroughDouble().
+  m.add_repeated_uint64_value(UINT64_MAX);
+
+  PrintOptions opts;
+  opts.unquote_int64_if_possible = true;
+  EXPECT_THAT(
+      ToJson(m, opts),
+      R"({"repeatedInt64Value":[0,42,"-1152921504606846977","9223372036854775807",-9223372036854775808],)"
+      R"("repeatedUint64Value":[0,42,"1152921504606846977","18446744073709551615"]})");
+}
+
 TEST_P(JsonTest, TestAlwaysPrintEnumsAsInts) {
   TestMessage orig;
   orig.set_enum_value(proto3::BAR);