Expose experimental styleGlyphURL (#2782)

* Expose experimental styleGlyphURL

* PR fixes

* Try another Samsung

* Try another Samsung

* Revert FB device

* Remove broken Firebase device

* Try another Pixel

* Revert all FB devices again

Author: kiryldz

CHANGELOG.md

@@ -4,6 +4,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 # main
 ## Features ✨ and improvements 🏁
+* Introduce experimental `getStyleGlyphURL` / `setStyleGlyphURL` functions for `MapboxMap` and `Style`.
 * Introduce `OnClusterClickListener` and `OnClusterLongClickListener` for `CircleAnnotationManager` and `PointAnnotationManager`. These callbacks receive the clicked cluster represented by a `ClusterFeature`.
 * [compose] Deprecate all `Annotation` and `AnnotationGroup` composables that take `onClick` parameter. Now all annotation interactions could be set with appropriate `AnnotationInteractionsState` or `AnnotationGroupInteractionsState` stored in `AnnotationGroupState`.
 * [compose] Introduce `AnnotationInteractionsState` and `AnnotationGroupInteractionsState` states that allow to set callbacks for annotation interactions via `onClicked()` and `onLongClicked()`.`PointAnnotationGroupInteractionsState` and `CircleAnnotationGroupInteractionsState` also provide ability to set callbacks for interactions with clusters via `onClusterClicked` and `onClusterLongClicked`.

LICENSE.md

@@ -264,6 +264,12 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens
 
 ===========================================================================
 
+Mapbox Maps Android uses portions of the Cronet.
+
+License: [Chromium and built-in dependencies](https://storage.cloud.google.com/chromium-cronet/android/119.0.6045.31/Release/cronet/LICENSE)
+
+===========================================================================
+
 Mapbox Maps Android uses portions of the Experimental annotation.
 
 URL: [https://developer.android.com/jetpack/androidx/releases/annotation#1.3.0](https://developer.android.com/jetpack/androidx/releases/annotation#1.3.0)
@@ -420,6 +426,30 @@ License: [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENS
 
 ===========================================================================
 
+Mapbox Maps Android uses portions of the play-services-base.
+
+License: [Android Software Development Kit License](https://developer.android.com/studio/terms.html)
+
+===========================================================================
+
+Mapbox Maps Android uses portions of the play-services-basement.
+
+License: [Android Software Development Kit License](https://developer.android.com/studio/terms.html)
+
+===========================================================================
+
+Mapbox Maps Android uses portions of the play-services-cronet.
+
+License: [Android Software Development Kit License](https://developer.android.com/studio/terms.html)
+
+===========================================================================
+
+Mapbox Maps Android uses portions of the play-services-tasks.
+
+License: [Android Software Development Kit License](https://developer.android.com/studio/terms.html)
+
+===========================================================================
+
 Mapbox Maps Android uses portions of the Saved State.
 
 URL: [https://developer.android.com/jetpack/androidx/releases/savedstate#1.2.0](https://developer.android.com/jetpack/androidx/releases/savedstate#1.2.0)
@@ -444,13 +474,13 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens
 
 ===========================================================================
 
-### MapboxCoreMaps,11.7.0,Mapbox ToS,Mapbox,https://www.mapbox.com/
+### MapboxCoreMaps,11.8.0-SNAPSHOT,Mapbox ToS,Mapbox,https://www.mapbox.com/
 
 ```
-Mapbox Core Maps version 10.0
+Mapbox Core Maps version 11.0
 Mapbox Core Maps SDK
 
-Copyright (c) 2021 Mapbox
+Copyright (c) 2024 Mapbox
 
 All rights reserved.
 
@@ -1183,7 +1213,7 @@ DEALINGS IN THE SOFTWARE.
 
 ---
 
-### vector-tile,1.0.4,ISC,Mapbox,https://github.com/mapbox/vector-tile
+### vector-tile-internal,1.0.4,ISC,Mapbox,https://github.com/mapbox/vector-tile-internal
 
 ```
 Copyright (c) 2016, Mapbox
@@ -1767,7 +1797,7 @@ For more information, please see
 
 ---
 
-### mapbox-base-internal,dev,BSD-3-Clause,Mapbox,https://github.com/mapbox/mapbox-base-internal
+### mapbox-base-internal,dev,BSD-3-Clause,Mapbox,https://www.mapbox.com/
 
 ```
 Copyright (c) MapBox
@@ -2067,7 +2097,7 @@ DEALINGS IN THE SOFTWARE.
 
 ---
 
-### mapbox-common,dev,Mapbox ToS,Mapbox,https://github.com/mapbox/mapbox-sdk-common
+### mapbox-common,dev,Mapbox ToS,Mapbox,https://www.mapbox.com/
 
 ```
 Mapbox Common SDK

gradle/libs.versions.toml

@@ -34,8 +34,8 @@ japicmp = "0.4.1"
 # Dependencies
 
 # GlNative and Common are used by the convention plugin
-mapboxGlNative = "11.7.0"
-mapboxCommon = "24.7.0"
+mapboxGlNative = "11.8.0-SNAPSHOT.1007T0604Z.9abe2f8"
+mapboxCommon = "24.8.0-SNAPSHOT.1007T0604Z.9abe2f8"
 
 mapboxBase = "0.11.0"
 mapboxGestures = "0.8.0"

sdk-base/api/Release/metalava.txt

@@ -152,6 +152,7 @@ package com.mapbox.maps {
     method public final float getPixelRatio();
     method @CallSuper @MainThread public com.mapbox.maps.StylePropertyValue getStyleAtmosphereProperty(String property);
     method @CallSuper @MainThread public com.mapbox.maps.CameraOptions getStyleDefaultCamera();
+    method @CallSuper @MainThread @com.mapbox.maps.MapboxExperimental public String getStyleGlyphURL();
     method @CallSuper @MainThread public com.mapbox.maps.Image? getStyleImage(String imageId);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,java.util.HashMap<java.lang.String,com.mapbox.maps.StylePropertyValue>> getStyleImportConfigProperties(String importId);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.maps.StylePropertyValue> getStyleImportConfigProperty(String importId, String config);
@@ -192,6 +193,7 @@ package com.mapbox.maps {
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleCustomGeometrySourceTileData(String sourceId, com.mapbox.maps.CanonicalTileID tileId, java.util.List<com.mapbox.geojson.Feature> featureCollection);
     method @CallSuper @MainThread @com.mapbox.maps.MapboxExperimental public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleCustomRasterSourceTileData(String sourceId, java.util.List<com.mapbox.maps.CustomRasterSourceTileData> tiles);
     method @AnyThread @CallSuper public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleGeoJSONSourceData(String sourceId, String dataId, com.mapbox.maps.GeoJSONSourceData data);
+    method @CallSuper @MainThread @com.mapbox.maps.MapboxExperimental public void setStyleGlyphURL(String url);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleImportConfigProperties(String importId, java.util.HashMap<java.lang.String,com.mapbox.bindgen.Value> configs);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleImportConfigProperty(String importId, String config, com.mapbox.bindgen.Value value);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleLayerProperties(String layerId, com.mapbox.bindgen.Value properties);

sdk-base/api/sdk-base.api

@@ -175,6 +175,7 @@ public class com/mapbox/maps/MapboxStyleManager {
 	public final fun getPixelRatio ()F
 	public fun getStyleAtmosphereProperty (Ljava/lang/String;)Lcom/mapbox/maps/StylePropertyValue;
 	public fun getStyleDefaultCamera ()Lcom/mapbox/maps/CameraOptions;
+	public fun getStyleGlyphURL ()Ljava/lang/String;
 	public fun getStyleImage (Ljava/lang/String;)Lcom/mapbox/maps/Image;
 	public fun getStyleImportConfigProperties (Ljava/lang/String;)Lcom/mapbox/bindgen/Expected;
 	public fun getStyleImportConfigProperty (Ljava/lang/String;Ljava/lang/String;)Lcom/mapbox/bindgen/Expected;
@@ -215,6 +216,7 @@ public class com/mapbox/maps/MapboxStyleManager {
 	public fun setStyleCustomGeometrySourceTileData (Ljava/lang/String;Lcom/mapbox/maps/CanonicalTileID;Ljava/util/List;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleCustomRasterSourceTileData (Ljava/lang/String;Ljava/util/List;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleGeoJSONSourceData (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/GeoJSONSourceData;)Lcom/mapbox/bindgen/Expected;
+	public fun setStyleGlyphURL (Ljava/lang/String;)V
 	public fun setStyleImportConfigProperties (Ljava/lang/String;Ljava/util/HashMap;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleImportConfigProperty (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleLayerProperties (Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;

sdk-base/src/main/java/com/mapbox/maps/MapboxStyleManager.kt

@@ -115,6 +115,32 @@ open class MapboxStyleManager @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
       return styleManager.styleSources
     }
 
+  /**
+   * Get the glyph URL of the current style in use.
+   *
+   * @return A string containing a glyph URI.
+   */
+  @MapboxExperimental
+  @CallSuper
+  @MainThread
+  open fun getStyleGlyphURL(): String {
+    ThreadChecker.throwIfNotMainThread()
+    return styleManager.styleGlyphURL
+  }
+
+  /**
+   * Load the style glyphs from a provided URL.
+   *
+   * @param url URL where the glyphs should be loaded from.
+   */
+  @MapboxExperimental
+  @CallSuper
+  @MainThread
+  open fun setStyleGlyphURL(url: String) {
+    ThreadChecker.throwIfNotMainThread()
+    styleManager.styleGlyphURL = url
+  }
+
   /**
    * Returns the map style's transition options. By default, the style parser will attempt
    * to read the style default transition options, if any, fallback-ing to an immediate transition

sdk/api/sdk.api

@@ -491,6 +491,7 @@ public final class com/mapbox/maps/Style : com/mapbox/maps/MapboxStyleManager {
 	public fun addStyleSource (Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun getStyleAtmosphereProperty (Ljava/lang/String;)Lcom/mapbox/maps/StylePropertyValue;
 	public fun getStyleDefaultCamera ()Lcom/mapbox/maps/CameraOptions;
+	public fun getStyleGlyphURL ()Ljava/lang/String;
 	public fun getStyleImage (Ljava/lang/String;)Lcom/mapbox/maps/Image;
 	public fun getStyleImportConfigProperties (Ljava/lang/String;)Lcom/mapbox/bindgen/Expected;
 	public fun getStyleImportConfigProperty (Ljava/lang/String;Ljava/lang/String;)Lcom/mapbox/bindgen/Expected;
@@ -530,6 +531,7 @@ public final class com/mapbox/maps/Style : com/mapbox/maps/MapboxStyleManager {
 	public fun setStyleCustomGeometrySourceTileData (Ljava/lang/String;Lcom/mapbox/maps/CanonicalTileID;Ljava/util/List;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleCustomRasterSourceTileData (Ljava/lang/String;Ljava/util/List;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleGeoJSONSourceData (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/GeoJSONSourceData;)Lcom/mapbox/bindgen/Expected;
+	public fun setStyleGlyphURL (Ljava/lang/String;)V
 	public fun setStyleImportConfigProperties (Ljava/lang/String;Ljava/util/HashMap;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleImportConfigProperty (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleLayerProperties (Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;

sdk/src/main/java/com/mapbox/maps/Style.kt

@@ -1044,6 +1044,28 @@ class Style internal constructor(
       return super.styleLayers
     }
 
+  /**
+   * Get the glyph URL of the current style in use.
+   *
+   * @return A string containing a glyph URI.
+   */
+  @MapboxExperimental
+  override fun getStyleGlyphURL(): String {
+    checkNativeStyle("getStyleGlyphURL")
+    return super.getStyleGlyphURL()
+  }
+
+  /**
+   * Load the style glyphs from a provided URL.
+   *
+   * @param url URL where the glyphs should be loaded from.
+   */
+  @MapboxExperimental
+  override fun setStyleGlyphURL(url: String) {
+    checkNativeStyle("setStyleGlyphURL")
+    super.setStyleGlyphURL(url)
+  }
+
   /**
    * Gets style source parameters.
    * In order to convert returned value to a json string please take a look at [Value.toJson].

sdk/src/test/java/com/mapbox/maps/StyleTest.kt

@@ -4,6 +4,7 @@ import android.graphics.Bitmap
 import com.mapbox.bindgen.DataRef
 import com.mapbox.bindgen.Value
 import com.mapbox.geojson.Feature
+import com.mapbox.verifyOnce
 import io.mockk.Runs
 import io.mockk.every
 import io.mockk.just
@@ -13,6 +14,7 @@ import io.mockk.spyk
 import io.mockk.unmockkStatic
 import io.mockk.verify
 import org.junit.After
+import org.junit.Assert.assertEquals
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
 import org.junit.Before
@@ -620,4 +622,18 @@ class StyleTest {
     style.setStyleCustomRasterSourceTileData(sourceId, tileData)
     verify { styleManager.setStyleCustomRasterSourceTileData(sourceId, tileData) }
   }
+
+  @Test
+  fun getStyleGlyphURL() {
+    every { styleManager.styleGlyphURL } returns "url"
+    val url = style.getStyleGlyphURL()
+    verifyOnce { styleManager.styleGlyphURL }
+    assertEquals("url", url)
+  }
+
+  @Test
+  fun setStyleGlyphURL() {
+    style.setStyleGlyphURL("url")
+    verifyOnce { styleManager.styleGlyphURL = "url" }
+  }
 }