Workaround for disposal crash with flutter3

README.md

@@ -251,6 +251,9 @@ xml ...
 
 [Recommended](https://docs.mapbox.com/help/tutorials/first-steps-ios-sdk/#display-the-users-location)  explanation about "Shows your location on the map and helps improve the map".
 
+## Flutter 3.x.x issues and experimental workarounds
+Since Flutter 3.x.x was introduced, it exposed some race conditions resulting in occasional crashes upon map disposal. The parameter `useDelayedDisposal` was introduced as a workaround for this issue until Flutter and/or Mapbox fix this issue properly. Use with caution - this is not yet production ready since several users still report crashes after using this workaround.
+
 ## Running the example code
 See the [documentation about this topic](doc/RUNNING_EXAMPLE_CODE.md)
 

example/lib/line.dart

@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import 'dart:async';
-// ignore: unnecessary_import
 import 'dart:typed_data';
 
 import 'package:flutter/material.dart';

example/lib/place_fill.dart

@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import 'dart:async';
-// ignore: unnecessary_import
 import 'dart:typed_data';
 
 import 'package:flutter/material.dart';

example/lib/place_source.dart

@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import 'dart:async';
-// ignore: unnecessary_import
 import 'dart:typed_data';
 
 import 'package:flutter/material.dart';

example/lib/place_symbol.dart

@@ -5,7 +5,6 @@
 import 'dart:async'; // ignore: unnecessary_import
 import 'dart:core';
 import 'dart:math';
-// ignore: unnecessary_import
 import 'dart:typed_data';
 
 import 'package:flutter/material.dart';

lib/src/mapbox_map.dart

@@ -55,6 +55,8 @@ class MapboxMap extends StatefulWidget {
       AnnotationType.line,
       AnnotationType.circle,
     ],
+    this.useDelayedDisposal,
+    this.useHybridCompositionOverride,
   })  : assert(annotationOrder.length <= 4),
         assert(annotationConsumeTapEvents.length > 0),
         super(key: key);
@@ -222,6 +224,13 @@ class MapboxMap extends StatefulWidget {
   /// * All fade/transition animations have completed
   final OnMapIdleCallback? onMapIdle;
 
+  /// Use delayed disposal of Android View Controller to avoid flutter 3.x.x crashes
+  /// Use with caution - this is not yet production ready since several users still report crashes after using this workaround
+  final bool? useDelayedDisposal;
+
+  /// Override hybrid mode per map instance
+  final bool? useHybridCompositionOverride;
+
   /// Set `MapboxMap.useHybridComposition` to `false` in order use Virtual-Display
   /// (better for Android 9 and below but may result in errors on Android 12)
   /// or leave it `true` (default) to use Hybrid composition (Slower on Android 9 and below).
@@ -251,7 +260,9 @@ class _MapboxMapState extends State<MapboxMap> {
       'options': _MapboxMapOptions.fromWidget(widget).toMap(),
       'accessToken': widget.accessToken,
       'onAttributionClickOverride': widget.onAttributionClick != null,
-      'dragEnabled': widget.dragEnabled
+      'dragEnabled': widget.dragEnabled,
+      'useDelayedDisposal': widget.useDelayedDisposal,
+      'useHybridCompositionOverride': widget.useHybridCompositionOverride,
     };
     return _mapboxGlPlatform.buildView(
         creationParams, onPlatformViewCreated, widget.gestureRecognizers);

mapbox_gl_platform_interface/lib/mapbox_gl_platform_interface.dart

@@ -11,6 +11,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/rendering.dart';
 import 'package:flutter/services.dart';
 
+part 'src/view_wrappers.dart';
 part 'src/annotation.dart';
 part 'src/callbacks.dart';
 part 'src/camera.dart';

mapbox_gl_platform_interface/lib/src/method_channel_mapbox_gl.dart

@@ -141,7 +141,12 @@ class MethodChannelMapboxGl extends MapboxGlPlatform {
       OnPlatformViewCreatedCallback onPlatformViewCreated,
       Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers) {
     if (defaultTargetPlatform == TargetPlatform.android) {
-      if (useHybridComposition) {
+      final useDelayedDisposalParam =
+          (creationParams['useDelayedDisposal'] ?? false) as bool;
+      final useHybridCompositionParam =
+          (creationParams['useHybridCompositionOverride'] ??
+              useHybridComposition) as bool;
+      if (useHybridCompositionParam) {
         return PlatformViewLink(
           viewType: 'plugins.flutter.io/mapbox_gl',
           surfaceFactory: (
@@ -156,15 +161,26 @@ class MethodChannelMapboxGl extends MapboxGlPlatform {
             );
           },
           onCreatePlatformView: (PlatformViewCreationParams params) {
-            final SurfaceAndroidViewController controller =
-                PlatformViewsService.initSurfaceAndroidView(
-              id: params.id,
-              viewType: 'plugins.flutter.io/mapbox_gl',
-              layoutDirection: TextDirection.ltr,
-              creationParams: creationParams,
-              creationParamsCodec: const StandardMessageCodec(),
-              onFocus: () => params.onFocusChanged(true),
-            );
+            late AndroidViewController controller;
+            if (useDelayedDisposalParam) {
+              controller = WrappedPlatformViewsService.initAndroidView(
+                id: params.id,
+                viewType: 'plugins.flutter.io/mapbox_gl',
+                layoutDirection: TextDirection.ltr,
+                creationParams: creationParams,
+                creationParamsCodec: const StandardMessageCodec(),
+                onFocus: () => params.onFocusChanged(true),
+              );
+            } else {
+              controller = PlatformViewsService.initAndroidView(
+                id: params.id,
+                viewType: 'plugins.flutter.io/mapbox_gl',
+                layoutDirection: TextDirection.ltr,
+                creationParams: creationParams,
+                creationParamsCodec: const StandardMessageCodec(),
+                onFocus: () => params.onFocusChanged(true),
+              );
+            }
             controller.addOnPlatformViewCreatedListener(
               params.onPlatformViewCreated,
             );
@@ -177,6 +193,15 @@ class MethodChannelMapboxGl extends MapboxGlPlatform {
           },
         );
       } else {
+        if (useDelayedDisposalParam) {
+          return AndroidViewWithWrappedController(
+            viewType: 'plugins.flutter.io/mapbox_gl',
+            onPlatformViewCreated: onPlatformViewCreated,
+            gestureRecognizers: gestureRecognizers,
+            creationParams: creationParams,
+            creationParamsCodec: const StandardMessageCodec(),
+          );
+        }
         return AndroidView(
           viewType: 'plugins.flutter.io/mapbox_gl',
           onPlatformViewCreated: onPlatformViewCreated,