Serialize protobuf enums as integer

src/Contrib/Otlp/ProtobufSerializer.php

@@ -8,10 +8,23 @@
 use function base64_decode;
 use function bin2hex;
 use Exception;
+use function get_class;
+use Google\Protobuf\Descriptor;
+use Google\Protobuf\DescriptorPool;
+use Google\Protobuf\FieldDescriptor;
+use Google\Protobuf\Internal\GPBLabel;
+use Google\Protobuf\Internal\GPBType;
 use Google\Protobuf\Internal\Message;
 use InvalidArgumentException;
+use function json_decode;
+use function json_encode;
+use const JSON_UNESCAPED_SLASHES;
+use const JSON_UNESCAPED_UNICODE;
+use function lcfirst;
 use OpenTelemetry\SDK\Common\Export\TransportInterface;
+use function property_exists;
 use function sprintf;
+use function ucwords;
 
 /**
  * @internal
@@ -83,10 +96,9 @@ public function serialize(Message $message): string
             case self::PROTOBUF:
                 return $message->serializeToString();
             case self::JSON:
-                //@todo https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding
-                return $message->serializeToJsonString();
+                return self::postProcessJsonEnumValues($message, $message->serializeToJsonString());
             case self::NDJSON:
-                return $message->serializeToJsonString() . "\n";
+                return self::postProcessJsonEnumValues($message, $message->serializeToJsonString()) . "\n";
             default:
                 throw new AssertionError();
         }
@@ -112,4 +124,69 @@ public function hydrate(Message $message, string $payload): void
                 throw new AssertionError();
         }
     }
+
+    /**
+     * Workaround until protobuf exposes `FormatEnumsAsIntegers` option.
+     *
+     * [JSON Protobuf Encoding](https://opentelemetry.io/docs/specs/otlp/#json-protobuf-encoding):
+     * > Values of enum fields MUST be encoded as integer values.
+     *
+     * @see https://github.com/open-telemetry/opentelemetry-php/issues/978
+     * @see https://github.com/protocolbuffers/protobuf/pull/12707
+     */
+    private static function postProcessJsonEnumValues(Message $message, string $payload): string
+    {
+        $pool = DescriptorPool::getGeneratedPool();
+        $desc = $pool->getDescriptorByClassName(get_class($message));
+        if (!$desc instanceof Descriptor) {
+            return $payload;
+        }
+
+        $data = json_decode($payload);
+        unset($payload);
+        self::traverseDescriptor($data, $desc);
+
+        return json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+    }
+
+    private static function traverseDescriptor(object $data, Descriptor $desc): void
+    {
+        for ($i = 0, $n = $desc->getFieldCount(); $i < $n; $i++) {
+            // @phan-suppress-next-line PhanParamTooManyInternal
+            $field = $desc->getField($i);
+            $name = lcfirst(strtr(ucwords($field->getName(), '_'), ['_' => '']));
+            if (!property_exists($data, $name)) {
+                continue;
+            }
+
+            if ($field->getLabel() === GPBLabel::REPEATED) {
+                foreach ($data->$name as $key => $value) {
+                    $data->$name[$key] = self::traverseFieldDescriptor($value, $field);
+                }
+            } else {
+                $data->$name = self::traverseFieldDescriptor($data->$name, $field);
+            }
+        }
+    }
+
+    private static function traverseFieldDescriptor($data, FieldDescriptor $field)
+    {
+        switch ($field->getType()) {
+            case GPBType::MESSAGE:
+                self::traverseDescriptor($data, $field->getMessageType());
+
+                break;
+            case GPBType::ENUM:
+                $enum = $field->getEnumType();
+                for ($i = 0, $n = $enum->getValueCount(); $i < $n; $i++) {
+                    if ($data === $enum->getValue($i)->getName()) {
+                        return $enum->getValue($i)->getNumber();
+                    }
+                }
+
+                break;
+        }
+
+        return $data;
+    }
 }

tests/Unit/Contrib/Otlp/MetricExporterTest.php

@@ -50,7 +50,7 @@ public function test_exporter_writes_metrics_in_otlp_json_format_with_trailing_n
 
         fseek($this->stream, 0);
         $this->assertSame(<<<METRICS
-            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"17","timeUnixNano":"42","asInt":"5"}],"aggregationTemporality":"AGGREGATION_TEMPORALITY_DELTA"}}]}]}]}
+            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"17","timeUnixNano":"42","asInt":"5"}],"aggregationTemporality":1}}]}]}]}
 
             METRICS, stream_get_contents($this->stream));
     }
@@ -84,8 +84,8 @@ public function test_exporter_appends_metrics(): void
 
         fseek($this->stream, 0);
         $this->assertSame(<<<METRICS
-            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"17","timeUnixNano":"42","asInt":"5"}],"aggregationTemporality":"AGGREGATION_TEMPORALITY_DELTA"}}]}]}]}
-            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"42","timeUnixNano":"57","asInt":"7"}],"aggregationTemporality":"AGGREGATION_TEMPORALITY_DELTA"}}]}]}]}
+            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"17","timeUnixNano":"42","asInt":"5"}],"aggregationTemporality":1}}]}]}]}
+            {"resourceMetrics":[{"resource":{},"scopeMetrics":[{"scope":{"name":"test"},"metrics":[{"name":"test","sum":{"dataPoints":[{"startTimeUnixNano":"42","timeUnixNano":"57","asInt":"7"}],"aggregationTemporality":1}}]}]}]}
 
             METRICS, stream_get_contents($this->stream));
     }

tests/Unit/Contrib/Otlp/SpanExporterTest.php

@@ -91,7 +91,7 @@ public function test_json_span_and_trace_id_hex_format(): void
                                         "traceId": "0af7651916cd43dd8448eb211c80319c",
                                         "spanId": "b7ad6b7169203331",
                                         "name": "test-span-data",
-                                        "kind": "SPAN_KIND_INTERNAL",
+                                        "kind": 1,
                                         "startTimeUnixNano": "1505855794194009601",
                                         "endTimeUnixNano": "1505855799465726528",
                                         "status": {}