support setting Flag.featureId via metadata

Author: khvn26

src/main/java/com/flagsmith/mappers/EngineMappers.java

@@ -7,13 +7,16 @@
 import com.flagsmith.flagengine.EvaluationContext;
 import com.flagsmith.flagengine.FeatureContext;
 import com.flagsmith.flagengine.FeatureValue;
+import com.flagsmith.flagengine.FlagResult;
 import com.flagsmith.flagengine.IdentityContext;
 import com.flagsmith.flagengine.SegmentCondition;
 import com.flagsmith.flagengine.SegmentContext;
 import com.flagsmith.flagengine.SegmentRule;
 import com.flagsmith.flagengine.Segments;
 import com.flagsmith.flagengine.Traits;
 import com.flagsmith.flagengine.segments.constants.SegmentConditions;
+import com.flagsmith.models.FeatureMetadata;
+import com.flagsmith.models.Flag;
 import com.flagsmith.models.SegmentMetadata;
 import com.flagsmith.models.environments.EnvironmentModel;
 import com.flagsmith.models.features.FeatureModel;
@@ -37,6 +40,33 @@
  * <p>Utility class for mapping JSON data to flag engine context objects.
  */
 public class EngineMappers {
+  /**
+   * Maps FlagResult to Flag.
+   * Returns null if metadata is missing or invalid.
+   *
+   * @param flagResult the flag result
+   * @return the mapped flag or null
+   */
+  public static Flag mapFlagResultToFlag(
+      FlagResult flagResult
+  ) {
+    FeatureMetadata metadata;
+
+    metadata = MapperFactory.getMapper()
+        .convertValue(flagResult.getMetadata(), FeatureMetadata.class);
+    
+    if (metadata == null || metadata.getFlagsmithId() == null) {
+      return null;
+    }
+
+    Flag flag = new Flag();
+    flag.setFeatureId(metadata.getFlagsmithId());
+    flag.setFeatureName(flagResult.getName());
+    flag.setValue(flagResult.getValue());
+    flag.setEnabled(flagResult.getEnabled());
+    return flag;
+  }
+
   /**
    * Maps context and identity data to evaluation context.
    *
@@ -178,7 +208,8 @@ private static Map<String, SegmentContext> mapIdentityOverridesToSegments(
             .withName(feature.getName())
             .withEnabled(featureState.getEnabled())
             .withValue(featureState.getValue())
-            .withPriority(EngineConstants.STRONGEST_PRIORITY);
+            .withPriority(EngineConstants.STRONGEST_PRIORITY)
+            .withMetadata(mapFeatureStateToFeatureMetadata(featureState));
         overridesKey.add(featureContext);
       }
 
@@ -332,7 +363,8 @@ private static FeatureContext mapFeatureStateToFeatureContext(FeatureStateModel
         .withFeatureKey(String.valueOf(featureState.getFeature().getId()))
         .withName(featureState.getFeature().getName())
         .withEnabled(featureState.getEnabled())
-        .withValue(featureState.getValue());
+        .withValue(featureState.getValue())
+        .withMetadata(mapFeatureStateToFeatureMetadata(featureState));
 
     // Handle multivariate feature state values
     List<FeatureValue> variants = new ArrayList<>();
@@ -358,6 +390,15 @@ private static FeatureContext mapFeatureStateToFeatureContext(FeatureStateModel
     return featureContext;
   }
 
+  private static Map<String, Object> mapFeatureStateToFeatureMetadata(
+      FeatureStateModel featureState) {
+    FeatureMetadata metadata = new FeatureMetadata();
+    metadata.setFlagsmithId(featureState.getFeature().getId());
+    return MapperFactory.getMapper().convertValue(metadata,
+        new com.fasterxml.jackson.core.type.TypeReference<Map<String, Object>>() {
+        });
+  }
+
   /**
    * Maps a segment to segment context.
    *

src/main/java/com/flagsmith/models/FeatureMetadata.java

@@ -0,0 +1,31 @@
+package com.flagsmith.models;
+
+/**
+ * FeatureMetadata
+ * 
+ * <p>Additional metadata associated with a feature.
+ * 
+ */
+public class FeatureMetadata {
+  private Integer flagsmithId;
+
+  /*
+   * FlagsmithId
+   * <p>The internal Flagsmith ID for the feature.
+   * 
+   * @return The flagsmithId
+   */
+  public Integer getFlagsmithId() {
+    return flagsmithId;
+  }
+
+  /*
+   * FlagsmithId
+   * <p>The internal Flagsmith ID for the segment.
+   * 
+   * @param flagsmithId The flagsmithId
+   */
+  public void setFlagsmithId(Integer flagsmithId) {
+    this.flagsmithId = flagsmithId;
+  }
+}

src/main/java/com/flagsmith/models/Flags.java

@@ -7,6 +7,7 @@
 import com.flagsmith.flagengine.EvaluationResult;
 import com.flagsmith.flagengine.FlagResult;
 import com.flagsmith.interfaces.DefaultFlagHandler;
+import com.flagsmith.mappers.EngineMappers;
 import com.flagsmith.models.features.FeatureStateModel;
 import com.flagsmith.threads.AnalyticsProcessor;
 import java.util.HashMap;
@@ -127,21 +128,14 @@ public static Flags fromEvaluationResult(
       EvaluationResult evaluationResult,
       AnalyticsProcessor analyticsProcessor,
       DefaultFlagHandler defaultFlagHandler) {
-    Map<String, BaseFlag> flagMap = evaluationResult.getFlags().getAdditionalProperties()
-        .entrySet()
-        .stream()
-        .collect(
-            Collectors.toMap(
-                Entry::getKey,
-                entry -> {
-                  FlagResult flagResult = entry.getValue();
-                  Flag flag = new Flag();
-                  flag.setFeatureName(flagResult.getName());
-                  flag.setValue(flagResult.getValue());
-                  flag.setEnabled(flagResult.getEnabled());
-                  return flag;
-                }));
-
+    Map<String, BaseFlag> flagMap = new HashMap<>();
+    evaluationResult.getFlags().getAdditionalProperties().forEach((featureName, flagResult) -> {
+      Flag flag = EngineMappers.mapFlagResultToFlag(flagResult);
+      if (flag != null) {
+        flagMap.put(featureName, flag);
+      }
+    });
+    
     Flags flags = new Flags();
     flags.setFlags(flagMap);
     flags.setAnalyticsProcessor(analyticsProcessor);

src/test/java/com/flagsmith/flagengine/models/FlagsTest.java

@@ -0,0 +1,44 @@
+package com.flagsmith.flagengine.models;
+
+import com.flagsmith.exceptions.FlagsmithClientError;
+import com.flagsmith.flagengine.EvaluationResult;
+import com.flagsmith.models.Flags;
+import com.flagsmith.models.Flag;
+import com.flagsmith.flagengine.FlagResult;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.Map;
+
+public class FlagsTest {
+  @Test
+  public void testFromEvaluationResult__metadata__expected() throws FlagsmithClientError {
+    com.flagsmith.flagengine.Flags flagResults = new com.flagsmith.flagengine.Flags()
+      .withAdditionalProperty("feature_1", new FlagResult()
+        .withEnabled(true)
+        .withFeatureKey("feature_1")
+        .withName("Feature 1")
+        .withValue("value_1")
+        .withReason("DEFAULT")
+        .withMetadata(Map.of("flagsmithId", 1)))
+      .withAdditionalProperty("feature_2", new FlagResult()
+        .withEnabled(false)
+        .withFeatureKey("feature_2")
+        .withName("Feature 2")
+        .withValue(null)
+        .withReason("DEFAULT")
+      );
+    EvaluationResult evaluationResult = new EvaluationResult()
+      .withFlags(flagResults);
+
+    Flags flags = Flags.fromEvaluationResult(evaluationResult, null, null);
+    Flag flag = (Flag) flags.getFlag("feature_1");
+
+    assertEquals(1, flags.getFlags().size());
+    assertEquals(true, flag.getEnabled());
+    assertEquals("value_1", flag.getValue());
+    assertEquals("Feature 1", flag.getFeatureName());
+    assertEquals(1, flag.getFeatureId().intValue());
+  }
+}