Fixing memory leaks (#706)

* Fix optionals in location requests * Make sure onStyleLoaded callback is invoked when map is loaded and ready * Update iOS SDK * Clear and dispose everything that could be holding references * Clear more of the platform argument callbacks * Clear method channel handler * Dispose leaking MapboxGLPlatform * Merge in #704 simplifying platform usage Dispose all potential leaks: platform channel, platform callbacks, controller and any callbacks that could be set from outside * Bring back final modifiers to variables Co-authored-by: stanlry <[email protected]> Co-authored-by: Tobrun <[email protected]>
flutter-mapbox-gl · Nov 13, 2021 · 3c252ba · 3c252ba
1 parent 3b46c2c
commit 3c252ba
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 5 deletions.
diff --git a/ios/mapbox_gl.podspec b/ios/mapbox_gl.podspec
@@ -16,7 +16,7 @@ A new Flutter plugin.
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
   s.dependency 'MapboxAnnotationExtension', '~> 0.0.1-beta.1'
-  s.dependency 'Mapbox-iOS-SDK', '~> 6.3.0'
+  s.dependency 'Mapbox-iOS-SDK', '~> 6.4.0'
   s.swift_version = '4.2'
   s.ios.deployment_target = '9.0'
 end

diff --git a/lib/src/controller.dart b/lib/src/controller.dart
@@ -158,7 +158,6 @@ class MapboxMapController extends ChangeNotifier {
   }
 
   final OnStyleLoadedCallback? onStyleLoadedCallback;
-
   final OnMapClickCallback? onMapClick;
   final OnMapLongClickCallback? onMapLongClick;
 
@@ -977,4 +976,10 @@ class MapboxMapController extends ChangeNotifier {
   Future<double> getMetersPerPixelAtLatitude(double latitude) async {
     return _mapboxGlPlatform.getMetersPerPixelAtLatitude(latitude);
   }
+
+  @override
+  void dispose() {
+    super.dispose();
+    _mapboxGlPlatform.dispose();
+  }
 }
diff --git a/lib/src/mapbox_map.dart b/lib/src/mapbox_map.dart
@@ -239,6 +239,15 @@ class _MapboxMapState extends State<MapboxMap> {
     _mapboxMapOptions = _MapboxMapOptions.fromWidget(widget);
   }
 
+  @override
+  void dispose() async {
+    super.dispose();
+    if (_controller.isCompleted) {
+        final controller = await _controller.future;
+        controller.dispose();
+    }
+  }
+
   @override
   void didUpdateWidget(MapboxMap oldWidget) {
     super.didUpdateWidget(oldWidget);

diff --git a/mapbox_gl_platform_interface/lib/src/mapbox_gl_platform_interface.dart b/mapbox_gl_platform_interface/lib/src/mapbox_gl_platform_interface.dart
@@ -276,7 +276,7 @@ abstract class MapboxGlPlatform {
     throw UnimplementedError(
         'getMetersPerPixelAtLatitude() has not been implemented.');
   }
-
+  
   Future<void> addGeoJsonSource(
       String sourceId, Map<String, dynamic> geojson) async {
     throw UnimplementedError('addGeoJsonSource() has not been implemented.');
@@ -314,4 +314,8 @@ abstract class MapboxGlPlatform {
       {String? belowLayerId}) async {
     throw UnimplementedError('addFillLayer() has not been implemented.');
   }
-}
+
+  void dispose() {
+
+  }
+}
diff --git a/mapbox_gl_platform_interface/lib/src/method_channel_mapbox_gl.dart b/mapbox_gl_platform_interface/lib/src/method_channel_mapbox_gl.dart
@@ -797,4 +797,10 @@ class MethodChannelMapboxGl extends MapboxGlPlatform {
           .map((key, value) => MapEntry<String, String>(key, jsonEncode(value)))
     });
   }
-}
+
+  @override
+  void dispose() {
+    super.dispose();
+    _channel.setMethodCallHandler(null);
+  }
+}