Map events race condition fix (#534)

evil159 · web-flow · commit 61bf343d1e84 · 2024-05-13T10:46:19.000+03:00
* Subscribe to initial map events upon map widget initialization

* Regenerate code
diff --git a/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/EventHandler.kt b/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/EventHandler.kt
@@ -36,7 +36,8 @@ import java.util.Date
 
 class MapboxEventHandler(
   private val eventProvider: Observable,
-  binaryMessenger: BinaryMessenger
+  binaryMessenger: BinaryMessenger,
+  eventTypes: List<Int>
 ) : MethodChannel.MethodCallHandler {
   private val channel: MethodChannel
   private val cancellables = HashSet<Cancelable>()
@@ -48,6 +49,11 @@ class MapboxEventHandler(
   init {
     channel = MethodChannel(binaryMessenger, "com.mapbox.maps.flutter.map_events")
     channel.setMethodCallHandler(this)
+
+    eventTypes
+      .map { _MapEvent.ofRaw(it) }
+      .filterNotNull()
+      .forEach { subscribeToEvent(it) }
   }
 
   override fun onMethodCall(methodCall: MethodCall, result: MethodChannel.Result) {
diff --git a/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapController.kt b/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapController.kt
@@ -38,7 +38,8 @@ class MapboxMapController(
   private val lifecycleProvider: MapboxMapsPlugin.LifecycleProvider,
   messenger: BinaryMessenger,
   channelSuffix: Int,
-  pluginVersion: String
+  pluginVersion: String,
+  eventTypes: List<Int>
 ) : PlatformView,
   DefaultLifecycleObserver,
   MethodChannel.MethodCallHandler {
@@ -122,7 +123,7 @@ class MapboxMapController(
     val mapboxMap = mapView.mapboxMap
     this.mapView = mapView
     this.mapboxMap = mapboxMap
-    eventHandler = MapboxEventHandler(mapboxMap.styleManager, proxyBinaryMessenger)
+    eventHandler = MapboxEventHandler(mapboxMap.styleManager, proxyBinaryMessenger, eventTypes)
     styleController = StyleController(context, mapboxMap)
     cameraController = CameraController(mapboxMap, context)
     projectionController = MapProjectionController(mapboxMap)
diff --git a/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapFactory.kt b/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapFactory.kt
@@ -116,6 +116,8 @@ class MapboxMapFactory(
     val textureView = params["textureView"] as? Boolean ?: false
     val styleUri = params["styleUri"] as? String ?: Style.MAPBOX_STREETS
     val pluginVersion = params["mapboxPluginVersion"] as String
+    val eventTypes: List<Int> = params["eventTypes"] as List<Int>
+
     val mapInitOptions = MapInitOptions(
       context = context,
       mapOptions = mapOptionsBuilder.build(),
@@ -130,6 +132,7 @@ class MapboxMapFactory(
       messenger,
       channelSuffix,
       pluginVersion,
+      eventTypes
     )
   }
 
diff --git a/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/pigeons/SnapshotterMessenger.kt b/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/pigeons/SnapshotterMessenger.kt
@@ -198,7 +198,7 @@ private object _SnapshotterInstanceManagerCodec : StandardMessageCodec() {
 
 /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
 interface _SnapshotterInstanceManager {
-  fun setupSnapshotterForSuffix(suffix: String, options: MapSnapshotOptions)
+  fun setupSnapshotterForSuffix(suffix: String, eventTypes: List<Long>, options: MapSnapshotOptions)
   fun tearDownSnapshotterForSuffix(suffix: String)
 
   companion object {
@@ -216,10 +216,11 @@ interface _SnapshotterInstanceManager {
           channel.setMessageHandler { message, reply ->
             val args = message as List<Any?>
             val suffixArg = args[0] as String
-            val optionsArg = args[1] as MapSnapshotOptions
+            val eventTypesArg = args[1] as List<Long>
+            val optionsArg = args[2] as MapSnapshotOptions
             var wrapped: List<Any?>
             try {
-              api.setupSnapshotterForSuffix(suffixArg, optionsArg)
+              api.setupSnapshotterForSuffix(suffixArg, eventTypesArg, optionsArg)
               wrapped = listOf<Any?>(null)
             } catch (exception: Throwable) {
               wrapped = wrapError(exception)
diff --git a/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/snapshotter/SnapshotterInstanceManager.kt b/android/src/main/kotlin/com/mapbox/maps/mapbox_maps/snapshotter/SnapshotterInstanceManager.kt
@@ -24,15 +24,19 @@ class SnapshotterInstanceManager(
   private var proxyMessengers = HashMap<String, ProxyBinaryMessenger>()
 
   @SuppressLint("RestrictedApi")
-  override fun setupSnapshotterForSuffix(suffix: String, options: MapSnapshotOptions) {
+  override fun setupSnapshotterForSuffix(
+    suffix: String,
+    eventTypes: List<Long>,
+    options: MapSnapshotOptions
+  ) {
     val snapshotter = Snapshotter(
       context,
       options = options.toSnapshotOptions(context),
       overlayOptions = options.toSnapshotOverlayOptions()
     )
     val proxyBinaryMessenger = ProxyBinaryMessenger(messenger, suffix)
     val styleManager: com.mapbox.maps.StyleManager = snapshotter.styleManager() // TODO: expose this on Android
-    val eventHandler = MapboxEventHandler(styleManager, proxyBinaryMessenger)
+    val eventHandler = MapboxEventHandler(styleManager, proxyBinaryMessenger, eventTypes.map { it.toInt() })
     val snapshotterController = SnapshotterController(context, snapshotter, eventHandler)
     val mapboxStyleManager = MapboxStyleManager(
       styleManager,
diff --git a/example/integration_test/snapshotter/snapshotter_test.dart b/example/integration_test/snapshotter/snapshotter_test.dart
@@ -46,10 +46,10 @@ void main() {
       pixelRatio: 1.5,
     );
     final snapshotter = await Snapshotter.create(
-        options: options,
-        onStyleLoadedListener: styleLoaded.complete,
-        onStyleDataLoadedListener: styleDataLoaded.complete,
-        );
+      options: options,
+      onStyleLoadedListener: styleLoaded.complete,
+      onStyleDataLoadedListener: styleDataLoaded.complete,
+    );
 
     await snapshotter.style.setStyleURI(MapboxStyles.LIGHT);
 
@@ -98,8 +98,10 @@ void main() {
       bearing: cameraOptions.bearing,
       pitch: cameraOptions.pitch,
     );
-    expect(camera.center?.coordinates.lat, closeTo(cameraOptions.center!.coordinates.lat, 0.001));
-    expect(camera.center?.coordinates.lng, closeTo(cameraOptions.center!.coordinates.lng, 0.001));
+    expect(camera.center?.coordinates.lat,
+        closeTo(cameraOptions.center!.coordinates.lat, 0.001));
+    expect(camera.center?.coordinates.lng,
+        closeTo(cameraOptions.center!.coordinates.lng, 0.001));
     expect(camera.bearing, closeTo(cameraOptions.bearing!, 0.001));
     expect(camera.pitch, closeTo(cameraOptions.pitch!, 0.001));
 
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -2,15 +2,15 @@ PODS:
   - Flutter (1.0.0)
   - integration_test (0.0.1):
     - Flutter
-  - mapbox_maps_flutter (1.1.0):
+  - mapbox_maps_flutter (2.0.0-beta.1):
     - Flutter
     - MapboxMaps (~> 11.4.0-beta.2)
     - Turf (= 2.8.0)
-  - MapboxCommon (24.4.0-beta.2)
+  - MapboxCommon (24.4.0-beta.3)
   - MapboxCoreMaps (11.4.0-beta.2):
     - MapboxCommon (~> 24.4.0-beta)
-  - MapboxMaps (11.4.0-beta.2):
-    - MapboxCommon (= 24.4.0-beta.2)
+  - MapboxMaps (11.4.0-beta.3):
+    - MapboxCommon (= 24.4.0-beta.3)
     - MapboxCoreMaps (= 11.4.0-beta.2)
     - Turf (= 2.8.0)
   - permission_handler_apple (9.1.1):
@@ -43,10 +43,10 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
   integration_test: 13825b8a9334a850581300559b8839134b124670
-  mapbox_maps_flutter: a5b851d1c13a23e6232400375af26b63307223f4
-  MapboxCommon: 7e0be4c0792c7f037e1a52faada7b9ffec6abdee
+  mapbox_maps_flutter: f749f291a37f900866ee4981e2919b7223364095
+  MapboxCommon: 163268386543eccc75daadf33251e06dad0df25c
   MapboxCoreMaps: 5120129b4c1b46eeccf19dd260f77c83e345e081
-  MapboxMaps: 7111c4812c5a6b4692bd46913db0bcc1b4db8b9f
+  MapboxMaps: 37c72ec739d5fa48b87eb2ba283f6937a61419f9
   permission_handler_apple: e76247795d700c14ea09e3a2d8855d41ee80a2e6
   Turf: aa2ede4298009639d10db36aba1a7ebaad072a5e
 
diff --git a/example/lib/geojson_line.dart b/example/lib/geojson_line.dart
@@ -35,13 +35,13 @@ class DrawGeoJsonLineWidgetState extends State<DrawGeoJsonLineWidget> {
         lineJoin: LineJoin.ROUND,
         lineCap: LineCap.ROUND,
         lineColor: Colors.red.value,
-        lineWidth:  6.0));
+        lineWidth: 6.0));
   }
 
   @override
   Widget build(BuildContext context) {
     return new Scaffold(
-      body: MapWidget(
+        body: MapWidget(
       key: ValueKey("mapWidget"),
       styleUri: MapboxStyles.MAPBOX_STREETS,
       cameraOptions: CameraOptions(
diff --git a/example/lib/snapshotter.dart b/example/lib/snapshotter.dart
@@ -91,7 +91,9 @@ class SnapshotterPageBodyState extends State<SnapshotterPageBody> {
               color: Colors.amber,
             ),
           ),
-          Expanded(key: _snapshotKey, child: snapshotImage ?? ColoredBox(color: Colors.grey)),
+          Expanded(
+              key: _snapshotKey,
+              child: snapshotImage ?? ColoredBox(color: Colors.grey)),
         ],
       ),
     );
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -192,7 +192,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.1.0"
+    version: "2.0.0-beta.1"
   matcher:
     dependency: transitive
     description:
diff --git a/ios/Classes/EventHandler.swift b/ios/Classes/EventHandler.swift
@@ -45,7 +45,7 @@ final class MapboxEventHandler {
     private let channel: FlutterMethodChannel
     private var cancelables = Set<AnyCancelable>()
 
-    init(eventProvider: EventProvider, binaryMessenger: FlutterBinaryMessenger) {
+    init(eventProvider: EventProvider, binaryMessenger: FlutterBinaryMessenger, eventTypes: [Int]) {
         self.eventProvider = eventProvider
         self.binaryMessenger = binaryMessenger
 
@@ -56,6 +56,10 @@ final class MapboxEventHandler {
         channel.setMethodCallHandler { [weak self] methodCall, result in
             self?.handleMethodCall(methodCall, result: result)
         }
+
+        eventTypes
+            .compactMap(_MapEvent.init)
+            .forEach(subscribeToEvent)
     }
 
     private func handleMethodCall(_ methodCall: FlutterMethodCall, result: FlutterResult) {
diff --git a/ios/Classes/Generated/MapInterfaces.swift b/ios/Classes/Generated/MapInterfaces.swift
@@ -4144,7 +4144,7 @@ protocol Projection {
   ///
   /// @param projectedMeters Spherical Mercator ProjectedMeters coordinates for
   /// which to calculate a longitude-latitude pair.
-  /// 
+  ///
   /// @return Returns a longitude-latitude pair.
   func coordinateForProjectedMeters(projectedMeters: ProjectedMeters) throws -> Point
   /// Calculate a point on the map in Mercator Projection for a given
@@ -4224,7 +4224,7 @@ class ProjectionSetup {
     ///
     /// @param projectedMeters Spherical Mercator ProjectedMeters coordinates for
     /// which to calculate a longitude-latitude pair.
-    /// 
+    ///
     /// @return Returns a longitude-latitude pair.
     let coordinateForProjectedMetersChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.mapbox_maps_flutter.Projection.coordinateForProjectedMeters\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec)
     if let api = api {
diff --git a/ios/Classes/Generated/SnapshotterMessenger.swift b/ios/Classes/Generated/SnapshotterMessenger.swift
@@ -223,7 +223,7 @@ class _SnapshotterInstanceManagerCodec: FlutterStandardMessageCodec {
 
 /// Generated protocol from Pigeon that represents a handler of messages from Flutter.
 protocol _SnapshotterInstanceManager {
-  func setupSnapshotterForSuffix(suffix: String, options: MapSnapshotOptions) throws
+  func setupSnapshotterForSuffix(suffix: String, eventTypes: [Int64], options: MapSnapshotOptions) throws
   func tearDownSnapshotterForSuffix(suffix: String) throws
 }
 
@@ -239,9 +239,10 @@ class _SnapshotterInstanceManagerSetup {
       setupSnapshotterForSuffixChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
         let suffixArg = args[0] as! String
-        let optionsArg = args[1] as! MapSnapshotOptions
+        let eventTypesArg = args[1] as! [Int64]
+        let optionsArg = args[2] as! MapSnapshotOptions
         do {
-          try api.setupSnapshotterForSuffix(suffix: suffixArg, options: optionsArg)
+          try api.setupSnapshotterForSuffix(suffix: suffixArg, eventTypes: eventTypesArg, options: optionsArg)
           reply(wrapResult(nil))
         } catch {
           reply(wrapError(error))
diff --git a/ios/Classes/MapboxMapController.swift b/ios/Classes/MapboxMapController.swift
@@ -49,13 +49,15 @@ final class MapboxMapController: NSObject, FlutterPlatformView {
         channelSuffix: Int,
         arguments args: Any?,
         registrar: FlutterPluginRegistrar,
-        pluginVersion: String
+        pluginVersion: String,
+        eventTypes: [Int]
     ) {
         self.proxyBinaryMessenger = ProxyBinaryMessenger(with: registrar.messenger(), channelSuffix: "\(channelSuffix)")
         _ = SettingsServiceFactory.getInstanceFor(.nonPersistent)
             .set(key: "com.mapbox.common.telemetry.internal.custom_user_agent_fragment", value: "FlutterPlugin/\(pluginVersion)")
 
         mapView = MapView(frame: frame, mapInitOptions: mapInitOptions)
+        mapView.debugOptions = [.camera]
         mapboxMap = mapView.mapboxMap
 
         self.registrar = registrar
@@ -64,7 +66,11 @@ final class MapboxMapController: NSObject, FlutterPlatformView {
             name: "plugins.flutter.io",
             binaryMessenger: proxyBinaryMessenger
         )
-        self.eventHandler = MapboxEventHandler(eventProvider: mapboxMap, binaryMessenger: proxyBinaryMessenger)
+        self.eventHandler = MapboxEventHandler(
+            eventProvider: mapboxMap,
+            binaryMessenger: proxyBinaryMessenger,
+            eventTypes: eventTypes
+        )
 
         let styleController = StyleController(styleManager: mapboxMap)
         StyleManagerSetup.setUp(binaryMessenger: proxyBinaryMessenger, api: styleController)
diff --git a/ios/Classes/MapboxMapFactory.swift b/ios/Classes/MapboxMapFactory.swift
@@ -131,7 +131,8 @@ class MapboxMapFactory: NSObject, FlutterPlatformViewFactory {
                 channelSuffix: channelSuffix,
                 arguments: args,
                 registrar: registrar,
-                pluginVersion: pluginVersion
+                pluginVersion: pluginVersion,
+                eventTypes: []
             )
         }
         var styleURI: StyleURI? = .streets
@@ -153,13 +154,16 @@ class MapboxMapFactory: NSObject, FlutterPlatformViewFactory {
             channelSuffix = suffix
         }
 
+        var eventTypes = args["eventTypes"] as? [Int] ?? []
+
         return MapboxMapController(
             withFrame: frame,
             mapInitOptions: mapInitOptions,
             channelSuffix: channelSuffix,
             arguments: args,
             registrar: registrar,
-            pluginVersion: pluginVersion
+            pluginVersion: pluginVersion,
+            eventTypes: eventTypes
         )
     }
 }
diff --git a/ios/Classes/Snapshotter/SnapshotterController.swift b/ios/Classes/Snapshotter/SnapshotterController.swift
@@ -10,10 +10,14 @@ final class SnapshotterController: _SnapshotterMessenger {
     private var snapshotter: Snapshotter!
     private let eventHandler: MapboxEventHandler
 
-    init(snapshotter: Snapshotter, binaryMessenger: FlutterBinaryMessenger) {
+    init(snapshotter: Snapshotter, eventTypes: [Int], binaryMessenger: FlutterBinaryMessenger) {
         self.snapshotter = snapshotter
 
-        eventHandler = MapboxEventHandler(eventProvider: snapshotter, binaryMessenger: binaryMessenger)
+        eventHandler = MapboxEventHandler(
+            eventProvider: snapshotter,
+            binaryMessenger: binaryMessenger,
+            eventTypes: eventTypes
+        )
     }
 
     func getCameraState() throws -> CameraState {
diff --git a/ios/Classes/Snapshotter/SnapshotterInstanceManager.swift b/ios/Classes/Snapshotter/SnapshotterInstanceManager.swift
@@ -10,12 +10,13 @@ final class SnapshotterInstanceManager: _SnapshotterInstanceManager {
         self.binaryMessenger = binaryMessenger
     }
 
-    func setupSnapshotterForSuffix(suffix: String, options: MapSnapshotOptions) throws {
+    func setupSnapshotterForSuffix(suffix: String, eventTypes: [Int64], options: MapSnapshotOptions) throws {
         let snapshotter = Snapshotter(options: options.toMapSnapshotOptions())
 
         let proxyMessenger = ProxyBinaryMessenger(with: binaryMessenger, channelSuffix: suffix)
         let snapshotterController = SnapshotterController(
             snapshotter: snapshotter,
+            eventTypes: eventTypes.map(Int.init),
             binaryMessenger: proxyMessenger
         )
         let snapshotStyleController = StyleController(styleManager: snapshotter)
diff --git a/lib/src/map_events.dart b/lib/src/map_events.dart
diff --git a/lib/src/map_widget.dart b/lib/src/map_widget.dart
diff --git a/lib/src/snapshotter/snapshotter.dart b/lib/src/snapshotter/snapshotter.dart
diff --git a/lib/src/snapshotter/snapshotter_messenger.dart b/lib/src/snapshotter/snapshotter_messenger.dart
diff --git a/lib/src/style/source/rasterarray_source.dart b/lib/src/style/source/rasterarray_source.dart
