feat!: switch to TLHC mode to fix rendering issues on Android (#340)

* feat: switch from PlatformViewLink to AndroidView (TLHC)
* fix: update mapview invalidation to work better with new map renderer

Author: jokerttu

android/src/main/kotlin/com/google/maps/flutter/navigation/FrameDelayHandler.kt

@@ -51,7 +51,6 @@ internal constructor(
       imageRegistry.mapViewInitializationComplete()
       mapReady()
       mapOptions.padding?.let { setPadding(it) }
-      invalidateViewAfterMapLoad()
     }
   }
 

android/src/main/kotlin/com/google/maps/flutter/navigation/GoogleMapView.kt

@@ -38,7 +38,6 @@ internal constructor(
     imageRegistry.mapViewInitializationComplete()
     viewRegistry.registerAndroidAutoView(this)
     mapReady()
-    invalidateViewAfterMapLoad()
   }
 
   // Handled by AndroidAutoBaseScreen.

android/src/main/kotlin/com/google/maps/flutter/navigation/GoogleMapsAutoMapView.kt

@@ -19,8 +19,11 @@ package com.google.maps.flutter.navigation
 import android.annotation.SuppressLint
 import android.content.res.Resources
 import android.graphics.Point
+import android.graphics.SurfaceTexture
 import android.location.Location
+import android.view.TextureView
 import android.view.View
+import android.view.ViewGroup
 import com.google.android.gms.maps.CameraUpdate
 import com.google.android.gms.maps.CameraUpdateFactory
 import com.google.android.gms.maps.GoogleMap
@@ -34,19 +37,13 @@ import com.google.android.gms.maps.model.MapStyleOptions
 import com.google.android.gms.maps.model.Marker
 import com.google.android.gms.maps.model.Polygon
 import com.google.android.gms.maps.model.Polyline
-import com.google.android.libraries.navigation.NavigationView
 
 abstract class GoogleMapsBaseMapView(
   protected val viewId: Int?,
   mapOptions: MapOptions,
   protected val viewEventApi: ViewEventApi?,
   private val imageRegistry: ImageRegistry,
 ) {
-  companion object {
-    const val INVALIDATION_FRAME_SKIP_AMOUNT = 4 // Amount of skip frames before invalidation
-  }
-
-  private val _frameDelayHandler = FrameDelayHandler(INVALIDATION_FRAME_SKIP_AMOUNT)
   private var _map: GoogleMap? = null
   private val _markers = mutableListOf<MarkerController>()
   private val _polygons = mutableListOf<PolygonController>()
@@ -107,6 +104,9 @@ abstract class GoogleMapsBaseMapView(
   }
 
   protected fun mapReady() {
+    // Install custom invalidator for the map view.
+    installInvalidator()
+
     // Call and clear view ready callback if available.
     _mapReadyCallback?.let { callback ->
       callback(Result.success(Unit))
@@ -214,27 +214,55 @@ abstract class GoogleMapsBaseMapView(
       )
   }
 
-  /**
-   * Workaround for map view not showing added or edited map objects immediately after add/edit.
-   * Schedules [NavigationView.invalidate] call after a certain amount of frames are drawn. In
-   * marker updates short delay is not enough, [doubleInvalidate] is set to true.
-   *
-   * @param doubleInvalidate if true, schedules another invalidate event after the first one.
-   */
-  protected fun invalidateViewAfterMapLoad(doubleInvalidate: Boolean = false) {
-    if (_loadedCallbackPending) {
+  // Installs a custom invalidator for the map view.
+  private fun installInvalidator() {
+    if (getView() == null) {
+      // This should only happen in tests.
+      return
+    }
+    val textureView = findTextureView(getView()!!)
+    if (textureView == null) {
       return
     }
-    _loadedCallbackPending = true
-    getMap().setOnMapLoadedCallback {
-      _loadedCallbackPending = false
-      _frameDelayHandler.scheduleActionWithFrameDelay {
-        getView().invalidate()
-        if (doubleInvalidate) {
-          _frameDelayHandler.scheduleActionWithFrameDelay { getView().invalidate() }
+    val internalListener = textureView.surfaceTextureListener
+
+    // Override the Maps internal SurfaceTextureListener with one that invalidates mapview on
+    // texture update.
+    textureView.surfaceTextureListener =
+      object : TextureView.SurfaceTextureListener {
+        override fun onSurfaceTextureAvailable(surface: SurfaceTexture, width: Int, height: Int) {
+          internalListener?.onSurfaceTextureAvailable(surface, width, height)
+        }
+
+        override fun onSurfaceTextureDestroyed(surface: SurfaceTexture): Boolean {
+          return internalListener?.onSurfaceTextureDestroyed(surface) ?: true
+        }
+
+        override fun onSurfaceTextureSizeChanged(surface: SurfaceTexture, width: Int, height: Int) {
+          internalListener?.onSurfaceTextureSizeChanged(surface, width, height)
+        }
+
+        override fun onSurfaceTextureUpdated(surface: SurfaceTexture) {
+          internalListener?.onSurfaceTextureUpdated(surface)
+          // Invalidate the view to ensure it is redrawn.
+          getView()?.invalidate()
+        }
+      }
+  }
+
+  // Returns the first TextureView found in the view hierarchy.
+  private fun findTextureView(view: View): TextureView? {
+    if (view is TextureView) {
+      return view
+    }
+    if (view is ViewGroup) {
+      for (i in 0 until view.childCount) {
+        findTextureView(view.getChildAt(i))?.let {
+          return it
         }
       }
     }
+    return null
   }
 
   @Throws(FlutterError::class)
@@ -304,22 +332,18 @@ abstract class GoogleMapsBaseMapView(
 
   @SuppressLint("MissingPermission")
   fun setMyLocationEnabled(enabled: Boolean) {
-    invalidateViewAfterMapLoad()
     getMap().isMyLocationEnabled = enabled
   }
 
   fun setMyLocationButtonEnabled(enabled: Boolean) {
-    invalidateViewAfterMapLoad()
     getMap().uiSettings.isMyLocationButtonEnabled = enabled
   }
 
   fun setZoomGesturesEnabled(enabled: Boolean) {
-    invalidateViewAfterMapLoad()
     getMap().uiSettings.isZoomGesturesEnabled = enabled
   }
 
   fun setZoomControlsEnabled(enabled: Boolean) {
-    invalidateViewAfterMapLoad()
     getMap().uiSettings.isZoomControlsEnabled = enabled
   }
 
@@ -364,7 +388,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun setCompassEnabled(enabled: Boolean) {
-    invalidateViewAfterMapLoad()
     getMap().uiSettings.isCompassEnabled = enabled
   }
 
@@ -576,20 +599,17 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun setMapType(mapType: Int) {
-    invalidateViewAfterMapLoad()
     getMap().mapType = mapType
   }
 
   fun setMapStyle(styleJson: String) {
-    invalidateViewAfterMapLoad()
     if (!getMap().setMapStyle(MapStyleOptions(styleJson))) {
       throw FlutterError("mapStyleError", "Failed to set map style")
     }
   }
 
   @SuppressLint("MissingPermission")
   fun followMyLocation(perspective: Int, zoomLevel: Double?) {
-    invalidateViewAfterMapLoad()
     getMap().followMyLocation(perspective)
     if (zoomLevel != null) {
       val options: FollowMyLocationOptions =
@@ -657,9 +677,6 @@ abstract class GoogleMapsBaseMapView(
         result.add(it)
       }
     }
-    // Double invalidate map view. Marker icon updates seem to take extra
-    // time and some times icon did not update properly after single invalidate.
-    invalidateViewAfterMapLoad(true)
     return result
   }
 
@@ -677,15 +694,11 @@ abstract class GoogleMapsBaseMapView(
         }
     }
     error?.let { throw error as Throwable }
-    // Double invalidate map view. Marker icon updates seem to take extra
-    // time and some times icon did not update properly after single invalidate.
-    invalidateViewAfterMapLoad(true)
     return result
   }
 
   @Throws(FlutterError::class)
   fun removeMarkers(markers: List<MarkerDto>) {
-    invalidateViewAfterMapLoad()
     var error: Throwable? = null
     markers.forEach {
       findMarkerController(it.markerId)?.let { controller ->
@@ -700,7 +713,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun clearMarkers() {
-    invalidateViewAfterMapLoad()
     _markers.forEach { controller -> controller.remove() }
     _markers.clear()
   }
@@ -722,7 +734,6 @@ abstract class GoogleMapsBaseMapView(
 
   fun addPolygons(polygons: List<PolygonDto>): List<PolygonDto> {
     val density = Resources.getSystem().displayMetrics.density
-    invalidateViewAfterMapLoad()
     val result = mutableListOf<PolygonDto>()
     polygons.forEach {
       val builder = PolygonBuilder()
@@ -739,7 +750,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun updatePolygons(polygons: List<PolygonDto>): List<PolygonDto> {
-    invalidateViewAfterMapLoad()
     var error: Throwable? = null
     val result = mutableListOf<PolygonDto>()
     val density = Resources.getSystem().displayMetrics.density
@@ -759,7 +769,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun removePolygons(polygons: List<PolygonDto>) {
-    invalidateViewAfterMapLoad()
     var error: Throwable? = null
     polygons.forEach {
       findPolygonController(it.polygonId)?.let { controller ->
@@ -775,7 +784,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun clearPolygons() {
-    invalidateViewAfterMapLoad()
     _polygons.forEach { controller -> controller.remove() }
     _polygons.clear()
   }
@@ -789,7 +797,6 @@ abstract class GoogleMapsBaseMapView(
 
   fun addPolylines(polylines: List<PolylineDto>): List<PolylineDto> {
     val density = Resources.getSystem().displayMetrics.density
-    invalidateViewAfterMapLoad()
     val result = mutableListOf<PolylineDto>()
     polylines.forEach {
       val builder = PolylineBuilder()
@@ -808,7 +815,6 @@ abstract class GoogleMapsBaseMapView(
   fun updatePolylines(polylines: List<PolylineDto>): List<PolylineDto> {
     var error: Throwable? = null
     val density = Resources.getSystem().displayMetrics.density
-    invalidateViewAfterMapLoad()
     val result = mutableListOf<PolylineDto>()
     polylines.forEach {
       findPolylineController(it.polylineId)?.let { controller ->
@@ -825,7 +831,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun removePolylines(polylines: List<PolylineDto>) {
-    invalidateViewAfterMapLoad()
     var error: Throwable? = null
     polylines.forEach {
       findPolylineController(it.polylineId)?.let { controller ->
@@ -841,7 +846,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun clearPolylines() {
-    invalidateViewAfterMapLoad()
     _polylines.forEach { controller -> controller.remove() }
     _polylines.clear()
   }
@@ -855,7 +859,6 @@ abstract class GoogleMapsBaseMapView(
 
   fun addCircles(circles: List<CircleDto>): List<CircleDto> {
     val density = Resources.getSystem().displayMetrics.density
-    invalidateViewAfterMapLoad()
     val result = mutableListOf<CircleDto>()
     circles.forEach {
       val builder = CircleBuilder()
@@ -873,7 +876,6 @@ abstract class GoogleMapsBaseMapView(
 
   fun updateCircles(circles: List<CircleDto>): List<CircleDto> {
     val density = Resources.getSystem().displayMetrics.density
-    invalidateViewAfterMapLoad()
     val result = mutableListOf<CircleDto>()
     var error: Throwable? = null
     circles.forEach {
@@ -890,7 +892,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun removeCircles(circles: List<CircleDto>) {
-    invalidateViewAfterMapLoad()
     var error: Throwable? = null
     circles.forEach {
       findCircleController(it.circleId)?.let { controller ->
@@ -905,7 +906,6 @@ abstract class GoogleMapsBaseMapView(
   }
 
   fun clearCircles() {
-    invalidateViewAfterMapLoad()
     _circles.forEach { controller -> controller.remove() }
     _circles.clear()
   }