Carry segment metadata around

Author: emyller

src/Engine/Engine.php

@@ -56,6 +56,7 @@ public static function getEvaluationResult($context): EvaluationResult
             $segmentResult = new SegmentResult();
             $segmentResult->key = $segment->key;
             $segmentResult->name = $segment->name;
+            $segmentResult->metadata = $segment->metadata ?? null;
             $evaluatedSegments[] = $segmentResult;
 
             foreach ($segment->overrides as $overrideFeature) {

src/Engine/Utils/Types/Context/EvaluationContext.php

@@ -42,6 +42,7 @@ public static function fromJsonObject($jsonContext)
             $segment->name = $jsonSegment->name;
             $segment->rules = self::_convertRules($jsonSegment->rules ?? []);
             $segment->overrides = array_values(self::_convertFeatures($jsonSegment->overrides ?? []));
+            $segment->metadata = (array) ($jsonSegment->metadata ?? []);
             $context->segments[$segment->key] = $segment;
         }
 

src/Engine/Utils/Types/Context/SegmentContext.php

@@ -15,4 +15,7 @@ class SegmentContext
 
     /** @var array<FeatureContext> */
     public $overrides;
+
+    /** @var ?array<string,mixed> */
+    public $metadata;
 }

src/Engine/Utils/Types/Result/SegmentResult.php

@@ -2,11 +2,29 @@
 
 namespace Flagsmith\Engine\Utils\Types\Result;
 
-class SegmentResult
+class SegmentResult implements \JsonSerializable
 {
     /** @var string */
     public $key;
 
     /** @var string */
     public $name;
+
+    /** @var ?array<string,mixed> */
+    public $metadata;
+
+    public function jsonSerialize(): array
+    {
+        $data = [
+            'key' => $this->key,
+            'name' => $this->name,
+        ];
+
+        // 'metadata' is only added if there is any
+        if (!empty($this->metadata)) {
+            $data['metadata'] = $this->metadata;
+        }
+
+        return $data;
+    }
 }