Support expressions in PromoteId (#2975)

evil159 · jush · web-flow · commit 79abcf57c879 · 2025-02-27T17:22:07.000+02:00
* Support expressions in `PromoteId`

* lint

* add missing docs

* Update CHANGELOG.md

Co-authored-by: Ramon &lt;ramon.sadornilrivera@mapbox.com&gt;

* Improve documentation

* Clarify docs, remove extra constructors

* Add missing parameter to PromoteIdValue expression constructor

* Revert to old naming

* Add expression support on top of existing field

* lint

* Add JvmOverloads for compatibility

* Support expressions without source layer id

---------

Co-authored-by: Ramon &lt;ramon.sadornilrivera@mapbox.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,8 @@
 Mapbox welcomes participation and contributions from everyone.
 
 # main
-
+## Features ✨ and improvements 🏁
+* Support expression input for `PromoteId`.
 
 # 11.10.2 February 25, 2025
 ## Bug fixes 🐞
diff --git a/extension-compose/api/Release/metalava.txt b/extension-compose/api/Release/metalava.txt
@@ -4299,6 +4299,7 @@ package com.mapbox.maps.extension.compose.style.sources {
   @androidx.compose.runtime.Immutable public final class PromoteIdValue {
     ctor public PromoteIdValue(com.mapbox.bindgen.Value value);
     ctor public PromoteIdValue(String propertyName, String? sourceId = null);
+    ctor public PromoteIdValue(com.mapbox.maps.extension.style.expressions.generated.Expression expression, String? sourceId = null);
     ctor public PromoteIdValue(com.mapbox.maps.extension.style.expressions.generated.Expression expression);
     method public com.mapbox.bindgen.Value component1();
     method public com.mapbox.maps.extension.compose.style.sources.PromoteIdValue copy(com.mapbox.bindgen.Value value);
diff --git a/extension-compose/api/extension-compose.api b/extension-compose/api/extension-compose.api
@@ -3669,6 +3669,8 @@ public final class com/mapbox/maps/extension/compose/style/sources/PromoteIdValu
 	public static final field DEFAULT Lcom/mapbox/maps/extension/compose/style/sources/PromoteIdValue;
 	public fun <init> (Lcom/mapbox/bindgen/Value;)V
 	public fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;)V
+	public fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;Ljava/lang/String;)V
+	public synthetic fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
 	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Lcom/mapbox/bindgen/Value;
diff --git a/extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/internal/ComposeTypeUtils.kt b/extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/internal/ComposeTypeUtils.kt
@@ -33,10 +33,11 @@ internal object ComposeTypeUtils {
         )
       )
       is PromoteId -> with(value) {
-        val propertyNameValue = Value(propertyName)
+        val promoteIdValue = Value.fromJson(propertyName).getValueOrElse { Value.valueOf(propertyName) }
         sourceId?.let {
-          Value(hashMapOf(sourceId to propertyNameValue))
-        } ?: propertyNameValue
+          Value(hashMapOf(sourceId to promoteIdValue))
+        }
+        promoteIdValue
       }
       is TextWritingMode -> {
         value.value
diff --git a/extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/sources/PropertyTypes.kt b/extension-compose/src/main/java/com/mapbox/maps/extension/compose/style/sources/PropertyTypes.kt
@@ -190,7 +190,12 @@ public data class PromoteIdValue(public val value: Value) {
   /**
    * Construct the PromoteId with [Mapbox Expression](https://docs.mapbox.com/style-spec/reference/expressions/).
    */
-  public constructor(expression: Expression) : this(expression as Value)
+  @JvmOverloads
+  public constructor(expression: Expression, sourceId: String? = null) : this(
+    ComposeTypeUtils.wrapToValue(
+      com.mapbox.maps.extension.style.types.PromoteId(expression, sourceId)
+    )
+  )
 
   /**
    * True if the this value is not [INITIAL]
diff --git a/extension-style/api/Release/metalava.txt b/extension-style/api/Release/metalava.txt
@@ -7696,11 +7696,15 @@ package com.mapbox.maps.extension.style.types {
   @Keep public final class PromoteId {
     ctor public PromoteId(String propertyName, String? sourceId = null);
     ctor public PromoteId(String propertyName);
+    ctor public PromoteId(com.mapbox.maps.extension.style.expressions.generated.Expression expression, String? sourceId = null);
+    ctor public PromoteId(com.mapbox.maps.extension.style.expressions.generated.Expression expression);
     method public String component1();
     method public String? component2();
     method public com.mapbox.maps.extension.style.types.PromoteId copy(String propertyName, String? sourceId);
+    method public com.mapbox.maps.extension.style.expressions.generated.Expression? getExpression();
     method public String getPropertyName();
     method public String? getSourceId();
+    property public final com.mapbox.maps.extension.style.expressions.generated.Expression? expression;
     property public final String propertyName;
     property public final String? sourceId;
     field public static final com.mapbox.maps.extension.style.types.PromoteId.Companion Companion;
diff --git a/extension-style/api/extension-style.api b/extension-style/api/extension-style.api
@@ -6566,6 +6566,9 @@ public abstract interface annotation class com/mapbox/maps/extension/style/types
 
 public final class com/mapbox/maps/extension/style/types/PromoteId {
 	public static final field Companion Lcom/mapbox/maps/extension/style/types/PromoteId$Companion;
+	public fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;)V
+	public fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;Ljava/lang/String;)V
+	public synthetic fun <init> (Lcom/mapbox/maps/extension/style/expressions/generated/Expression;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
 	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -6574,6 +6577,7 @@ public final class com/mapbox/maps/extension/style/types/PromoteId {
 	public final fun copy (Ljava/lang/String;Ljava/lang/String;)Lcom/mapbox/maps/extension/style/types/PromoteId;
 	public static synthetic fun copy$default (Lcom/mapbox/maps/extension/style/types/PromoteId;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lcom/mapbox/maps/extension/style/types/PromoteId;
 	public fun equals (Ljava/lang/Object;)Z
+	public final fun getExpression ()Lcom/mapbox/maps/extension/style/expressions/generated/Expression;
 	public final fun getPropertyName ()Ljava/lang/String;
 	public final fun getSourceId ()Ljava/lang/String;
 	public fun hashCode ()I
diff --git a/extension-style/src/main/java/com/mapbox/maps/extension/style/types/PromoteId.kt b/extension-style/src/main/java/com/mapbox/maps/extension/style/types/PromoteId.kt
@@ -2,27 +2,65 @@ package com.mapbox.maps.extension.style.types
 
 import androidx.annotation.Keep
 import com.mapbox.bindgen.Value
-import com.mapbox.maps.extension.style.sources.generated.GeoJsonSource
+import com.mapbox.maps.extension.style.expressions.generated.Expression
 import com.mapbox.maps.extension.style.sources.generated.VectorSource
+import com.mapbox.maps.extension.style.utils.TypeUtils
+import com.mapbox.maps.extension.style.utils.unwrapToExpression
 
 /**
  * Holds a property type to promote a specific feature for feature state API.
  *
- * @param sourceId source layer id of the feature, either source [GeoJsonSource] or [VectorSource].
- * @param propertyName feature property name.
+ * @param propertyName promote id value.
+ * @param sourceId source layer in [VectorSource] to which the feature ID override applies.
+ *
+ * If not provided the override will be applied to all layers of the source.
  *
  * For more information see [The online documentation](https://docs.mapbox.com/mapbox-gl-js/style-spec/types/#promoteId).
  */
 @Keep
 data class PromoteId @JvmOverloads constructor(
+  /*
+   * Feature property name.
+   */
   val propertyName: String,
+
+  /*
+   * The source layer in [VectorSource] to which the feature ID override applies.
+   *
+   * If not provided the override will be applied to all layers of the source.
+   */
   val sourceId: String? = null
 ) {
+
+  /**
+   * Expression to promote.
+   */
+  val expression: Expression? = try {
+    Value.fromJson(propertyName).value?.unwrapToExpression()
+  } catch (_: Throwable) {
+    null
+  }
+
+  /**
+   * Construct a [PromoteId] object from an [Expression].
+   *
+   * @param expression expression to promote.
+   * @param sourceId source layer in [VectorSource] to which the feature ID override applies.
+   *
+   * If not provided the override will be applied to all layers of the source.
+   */
+  @JvmOverloads
+  constructor(expression: Expression, sourceId: String? = null) : this(
+    expression.toJson(),
+    sourceId
+  )
+
   internal fun toValue(): Value {
+    val promoteIdValue = Value.fromJson(propertyName).getValueOrElse { Value.valueOf(propertyName) }
     sourceId?.let {
-      return Value(hashMapOf(sourceId to Value(propertyName)))
+      return Value(hashMapOf(sourceId to promoteIdValue))
     }
-    return Value(propertyName)
+    return promoteIdValue
   }
 
   /**
@@ -37,23 +75,27 @@ data class PromoteId @JvmOverloads constructor(
      * Throws [RuntimeException] exception if couldn't construct to [PromoteId].
      */
     internal fun fromProperty(propertyName: Any) = when (propertyName) {
-      is String -> {
-        PromoteId(propertyName)
-      }
+      is String -> PromoteId(propertyName)
+      is List<*> -> PromoteId(TypeUtils.wrapToValue(propertyName).unwrapToExpression())
       is HashMap<*, *> -> {
         @Suppress("UNCHECKED_CAST")
         try {
-          val propertyMap = propertyName as HashMap<String, String>
+          val propertyMap = propertyName as HashMap<String, *>
           if (propertyMap.keys.isNotEmpty()) {
             val key = propertyMap.keys.iterator().next()
-            PromoteId(propertyMap[key] ?: "", key)
+            when (val value = propertyMap[key]) {
+              is String? -> PromoteId(value ?: "", key)
+              is List<*> -> PromoteId(TypeUtils.wrapToValue(value).unwrapToExpression(), key)
+              else -> throw RuntimeException("PromoteId value should be either String or Expression")
+            }
           } else {
             PromoteId("")
           }
         } catch (e: RuntimeException) {
-          throw IllegalArgumentException("$propertyName must be in the format HashMap<String,String>")
+          throw IllegalArgumentException("$propertyName must be in the format HashMap<String,String> or HashMap<String,Expression>")
         }
       }
+
       else -> throw UnsupportedOperationException("Wrapping ${propertyName::class.java.simpleName} to PromoteId is not supported.")
     }
   }
diff --git a/extension-style/src/test/java/com/mapbox/maps/extension/style/utils/PromoteIdTest.kt b/extension-style/src/test/java/com/mapbox/maps/extension/style/utils/PromoteIdTest.kt
@@ -1,5 +1,6 @@
 package com.mapbox.maps.extension.style.utils
 
+import com.mapbox.maps.extension.style.expressions.dsl.generated.coalesce
 import com.mapbox.maps.extension.style.types.PromoteId
 import org.junit.Assert.assertEquals
 import org.junit.Test
@@ -60,5 +61,42 @@ class PromoteIdTest {
     PromoteId.fromProperty(hashMapOf(1 to 2))
   }
 
+  @Test
+  fun fromProperty_Expression() {
+    val expected = PromoteId(
+      coalesce {
+        get { literal("building_id") }
+        id()
+      },
+      "building"
+    )
+    val actual = PromoteId.fromProperty(
+      hashMapOf(
+        "building" to listOf(
+          "coalesce", listOf("get", "building_id"), listOf("id")
+        )
+      )
+    )
+
+    assertEquals(expected, actual)
+  }
+
+  @Test
+  fun fromProperty_ExpressionNullSource() {
+    val expected = PromoteId(
+      coalesce {
+        get { literal("building_id") }
+        id()
+      },
+    )
+    val actual = PromoteId.fromProperty(
+      listOf(
+        "coalesce", listOf("get", "building_id"), listOf("id")
+      )
+    )
+
+    assertEquals(expected, actual)
+  }
+
   private data class MockType(val a: String, val b: String)
 }

Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,11 @@ internal object ComposeTypeUtils {`
`33`	`33`	`)`
`34`	`34`	`)`
`35`	`35`	`is PromoteId -> with(value) {`
`36`		`- val propertyNameValue = Value(propertyName)`
	`36`	`+ val promoteIdValue = Value.fromJson(propertyName).getValueOrElse { Value.valueOf(propertyName) }`
`37`	`37`	`sourceId?.let {`
`38`		`- Value(hashMapOf(sourceId to propertyNameValue))`
`39`		`- } ?: propertyNameValue`
	`38`	`+ Value(hashMapOf(sourceId to promoteIdValue))`
	`39`	`+ }`
	`40`	`+ promoteIdValue`
`40`	`41`	`}`
`41`	`42`	`is TextWritingMode -> {`
`42`	`43`	`value.value`