Improve architecture with feature metadata

Author: emyller

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "tests/Engine/EngineTests/EngineTestData"]
 	path = tests/Engine/EngineTests/EngineTestData
 	url = git@github.com:Flagsmith/engine-test-data.git
-	tag = v2.4.0
+	tag = v2.5.0

src/Engine/Engine.php

@@ -57,7 +57,7 @@ public static function getEvaluationResult($context): EvaluationResult
             $segmentResult = new SegmentResult();
             $segmentResult->key = $segment->key;
             $segmentResult->name = $segment->name;
-            $segmentResult->metadata = $segment->metadata ?? null;
+            $segmentResult->metadata = $segment->metadata;
             $evaluatedSegments[] = $segmentResult;
 
             foreach ($segment->overrides as $overrideFeature) {
@@ -152,6 +152,7 @@ private static function getFlagResultFromFeatureContext($feature, $splitKey)
                     $flag->enabled = $feature->enabled;
                     $flag->value = $variant->value;
                     $flag->reason = "SPLIT; weight={$variant->weight}";
+                    $flag->metadata = $feature->metadata;
                     return $flag;
                 }
                 $startPercentage = $limit;
@@ -164,6 +165,7 @@ private static function getFlagResultFromFeatureContext($feature, $splitKey)
         $flag->enabled = $feature->enabled;
         $flag->value = $feature->value;
         $flag->reason = 'DEFAULT';
+        $flag->metadata = $feature->metadata;
         return $flag;
     }
 
@@ -180,6 +182,7 @@ private static function getFlagResultFromSegmentContext($feature, $segment)
         $flag->enabled = $feature->enabled;
         $flag->value = $feature->value;
         $flag->reason = "TARGETING_MATCH; segment={$segment->name}";
+        $flag->metadata = $feature->metadata;
         return $flag;
     }
 

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

@@ -109,6 +109,7 @@ private static function _convertFeatures($jsonFeatures): array
             $feature->enabled = $jsonFeature->enabled;
             $feature->value = $jsonFeature->value;
             $feature->priority = $jsonFeature->priority ?? null;
+            $feature->metadata = (array) ($jsonFeature->metadata ?? []);
             $feature->variants = [];
             foreach ($jsonFeature->variants ?? [] as $jsonVariant) {
                 $variant = new FeatureValue();

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

@@ -24,4 +24,7 @@ class FeatureContext
 
     /** @var array<FeatureValue> */
     public $variants;
+
+    /** @var ?array<string,mixed> */
+    public $metadata;
 }

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

@@ -2,7 +2,7 @@
 
 namespace Flagsmith\Engine\Utils\Types\Result;
 
-class FlagResult
+class FlagResult implements \JsonSerializable
 {
     /** @var string */
     public $feature_key;
@@ -18,4 +18,19 @@ class FlagResult
 
     /** @var ?string */
     public $reason;
+
+    /** @var ?array<string,mixed> */
+    public $metadata;
+
+    public function jsonSerialize(): array
+    {
+        $data = get_object_vars($this);
+
+        // 'metadata' is only added if there is any
+        if (empty($this->metadata)) {
+            unset($data['metadata']);
+        }
+
+        return $data;
+    }
 }

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

@@ -15,14 +15,11 @@ class SegmentResult implements \JsonSerializable
 
     public function jsonSerialize(): array
     {
-        $data = [
-            'key' => $this->key,
-            'name' => $this->name,
-        ];
+        $data = get_object_vars($this);
 
         // 'metadata' is only added if there is any
-        if (!empty($this->metadata)) {
-            $data['metadata'] = $this->metadata;
+        if (empty($this->metadata)) {
+            unset($data['metadata']);
         }
 
         return $data;

src/Models/Flags.php

@@ -96,7 +96,7 @@ public static function fromEvaluationResult(
         foreach ($evaluationResult->flags as $flagResult) {
             $flag = new Flag();
             $flag->feature_name = $flagResult->name;
-            $flag->feature_id = (int) $flagResult->feature_key;
+            $flag->feature_id = $flagResult->metadata['flagsmith_id'];
             $flag->enabled = $flagResult->enabled;
             $flag->value = $flagResult->value;
             $flags[$flagResult->name] = $flag;

src/Utils/Mappers.php

@@ -117,7 +117,7 @@ private static function _mapEnvironmentDocumentFeatureStatesToFeatureContexts($f
             $feature->enabled = $featureState->enabled;
             $feature->value = $featureState->feature_state_value;
             $feature->priority = $featureState->feature_segment?->priority ?? null;
-
+            $feature->metadata = ['flagsmith_id' => $featureState->feature->id];
             $feature->variants = [];
             $multivariateFeatureStateValues = ((array) $featureState->multivariate_feature_state_values) ?? [];
             $multivariateFeatureStateValueUUIDs = array_column($multivariateFeatureStateValues, 'mv_fs_value_uuid');
@@ -187,14 +187,15 @@ private static function _mapIdentityOverridesToSegments($identityOverrides)
 
             $segment->overrides = [];
             foreach (unserialize($serializedOverridesKey) as $overrideKey) {
-                [$featureKey, $featureName, $enabled, $value] = $overrideKey;
+                [$featureId, $featureName, $enabled, $value] = $overrideKey;
                 $feature = new FeatureContext();
                 $feature->key = '';  // Not used in identity overrides
-                $feature->feature_key = $featureKey;
+                $feature->feature_key = (string) $featureId;
                 $feature->name = $featureName;
                 $feature->enabled = $enabled;
                 $feature->value = $value;
                 $feature->priority = Engine::STRONGEST_PRIORITY;
+                $feature->metadata = ['flagsmith_id' => $featureId];
                 $segment->overrides[] = $feature;
             }
 

tests/Engine/EngineTests/EngineTestData

@@ -69,6 +69,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
         $this->assertEquals('some-overridden-value', $context->segments[$overrideKey]->overrides[0]->value);
         $this->assertEquals(-INF, $context->segments[$overrideKey]->overrides[0]->priority);
         $this->assertNull($context->segments[$overrideKey]->overrides[0]->variants);
+        $this->assertEquals(['flagsmith_id' => 1], $context->segments[$overrideKey]->overrides[0]->metadata);
 
         $this->assertCount(3, $context->features);
         $this->assertArrayHasKey('some_feature', $context->features);
@@ -79,6 +80,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
         $this->assertEquals('some-value', $context->features['some_feature']->value);
         $this->assertNull($context->features['some_feature']->priority);
         $this->assertEmpty($context->features['some_feature']->variants);
+        $this->assertEquals(['flagsmith_id' => 1], $context->features['some_feature']->metadata);
 
         // Test multivariate feature with IDs - priority should be based on ID
         $this->assertArrayHasKey('mv_feature_with_ids', $context->features);
@@ -90,6 +92,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
         $this->assertEquals('default_value', $mvFeatureWithIds->value);
         $this->assertNull($mvFeatureWithIds->priority);
         $this->assertCount(2, $mvFeatureWithIds->variants);
+        $this->assertEquals(['flagsmith_id' => 2], $mvFeatureWithIds->metadata);
 
         // First variant: ID=100, should have priority 100
         $this->assertEquals('variant_a', $mvFeatureWithIds->variants[0]->value);
@@ -111,6 +114,7 @@ public function testMapEnvironmentDocumentToContextProducesEvaluationContext():
         $this->assertEquals('fallback_value', $mvFeatureWithoutIds->value);
         $this->assertNull($mvFeatureWithoutIds->priority);
         $this->assertCount(3, $mvFeatureWithoutIds->variants);
+        $this->assertEquals(['flagsmith_id' => 3], $mvFeatureWithoutIds->metadata);
 
         // Variants should be ordered by UUID alphabetically
         $this->assertEquals('option_y', $mvFeatureWithoutIds->variants[0]->value);