Expose flag names in metadata (#850)

Author: gthea

api/src/main/java/io/split/android/client/events/SdkUpdateMetadata.java

@@ -19,12 +19,16 @@ public final class SdkUpdateMetadata {
     public enum Type {
         /**
          * Feature flags were updated.
+         * <p>
+         * {@link #getNames()} returns the list of flag names that changed.
          */
         FLAGS_UPDATE,
 
         /**
-         * Rule-based segments were updated.
+         * Segments were updated (rule-based segments, memberships, or large segments).
          * <p>
+         * Note: {@link #getNames()} always returns an empty list for this type.
+         * Segment names are not included in the metadata.
          */
         SEGMENTS_UPDATE
     }
@@ -59,10 +63,10 @@ public Type getType() {
     /**
      * Returns the list of entity names that changed in this update.
      * <p>
-     * For {@link Type#FLAGS_UPDATE}, this contains flag names.
-     * For {@link Type#SEGMENTS_UPDATE}, this contains rule-based segment names.
+     * For {@link Type#FLAGS_UPDATE}, this contains flag names that were updated.
+     * For {@link Type#SEGMENTS_UPDATE}, this is always an empty list (segment names are not included).
      *
-     * @return the list of updated entity names, never null (empty list if none)
+     * @return the list of updated entity names, never null (empty list for SEGMENTS_UPDATE or if none)
      */
     @NonNull
     public List<String> getNames() {

build.gradle

@@ -19,7 +19,7 @@ apply plugin: 'com.vanniktech.maven.publish'
 apply from: "$rootDir/gradle/jacoco-root.gradle"
 
 ext {
-    splitVersion = '5.5.0-rc5'
+    splitVersion = '5.5.0-rc6'
     jacocoVersion = '0.8.8'
 }
 

events-domain/src/main/java/io/split/android/client/events/metadata/EventMetadataHelpers.java

@@ -3,6 +3,7 @@
 import androidx.annotation.Nullable;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 
@@ -31,15 +32,16 @@ public static EventMetadata createUpdatedFlagsMetadata(List<String> updatedFlagN
     }
 
     /**
-     * Creates metadata for SDK_UPDATE events when rule-based segments are updated.
+     * Creates metadata for SDK_UPDATE events when segments are updated.
+     * <p>
+     * SEGMENTS_UPDATE always has empty names - segment names are not included in the metadata.
      *
-     * @param updatedSegmentNames the list of rule-based segment names that were updated
-     * @return the event metadata with TYPE=SEGMENTS_UPDATE and NAMES containing the segment names
+     * @return the event metadata with TYPE=SEGMENTS_UPDATE and empty NAMES list
      */
-    public static EventMetadata createUpdatedSegmentsMetadata(List<String> updatedSegmentNames) {
+    public static EventMetadata createUpdatedSegmentsMetadata() {
         return new EventMetadataBuilder()
                 .put(MetadataKeys.TYPE, MetadataKeys.TYPE_SEGMENTS_UPDATE)
-                .put(MetadataKeys.NAMES, new ArrayList<>(new HashSet<>(updatedSegmentNames)))
+                .put(MetadataKeys.NAMES, Collections.emptyList())
                 .build();
     }
 

events-domain/src/test/java/io/split/android/client/events/TypedTaskConversionTest.java

@@ -36,17 +36,15 @@ public void convertForSdkUpdateConvertsFlagsMetadataCorrectly() {
 
     @Test
     public void convertForSdkUpdateConvertsSegmentsMetadataCorrectly() {
-        List<String> expectedSegments = Arrays.asList("segment1", "segment2");
-
-        EventMetadata eventMetadata = EventMetadataHelpers.createUpdatedSegmentsMetadata(expectedSegments);
+        // SEGMENTS_UPDATE always has empty names
+        EventMetadata eventMetadata = EventMetadataHelpers.createUpdatedSegmentsMetadata();
 
         // Call conversion method
         SdkUpdateMetadata converted = TypedTaskConverter.convertForSdkUpdate(eventMetadata);
 
         assertNotNull(converted);
         assertEquals(SdkUpdateMetadata.Type.SEGMENTS_UPDATE, converted.getType());
-        assertEquals(expectedSegments.size(), converted.getNames().size());
-        assertTrue(converted.getNames().containsAll(expectedSegments));
+        assertTrue("Names should be empty for SEGMENTS_UPDATE", converted.getNames().isEmpty());
     }
 
     @Test

events-domain/src/test/java/io/split/android/client/events/metadata/EventMetadataHelpersTest.java

@@ -33,19 +33,16 @@ public void createUpdatedFlagsMetadataContainsTypeAndNames() {
     // Tests for createUpdatedSegmentsMetadata
     @Test
     @SuppressWarnings("unchecked")
-    public void createUpdatedSegmentsMetadataContainsTypeAndNames() {
-        List<String> segments = Arrays.asList("segment1", "segment2");
-        EventMetadata metadata = EventMetadataHelpers.createUpdatedSegmentsMetadata(segments);
+    public void createUpdatedSegmentsMetadataContainsTypeAndEmptyNames() {
+        EventMetadata metadata = EventMetadataHelpers.createUpdatedSegmentsMetadata();
 
         assertTrue(metadata.containsKey(MetadataKeys.TYPE));
         assertEquals(MetadataKeys.TYPE_SEGMENTS_UPDATE, metadata.get(MetadataKeys.TYPE));
 
-        // Check names
+        // Check names - should always be empty
         assertTrue(metadata.containsKey(MetadataKeys.NAMES));
         List<String> result = (List<String>) metadata.get(MetadataKeys.NAMES);
-        assertEquals(2, result.size());
-        assertTrue(result.contains("segment1"));
-        assertTrue(result.contains("segment2"));
+        assertTrue("Names should be empty for SEGMENTS_UPDATE", result.isEmpty());
     }
 
     // Tests for createReadyMetadata