Search code examples
swiftgoogle-maps-sdk-iosgmsmapviewgoogle-maps-ios-utils

Random KVO block crashes when allocating mapView, happens only when open/close screen several times

App is crashing on a map screen when it open and close several times. (Mostly on 6th attempt)

Class that inherits from GMSMapView

class AirportMapView: GMSMapView , AirportMapViewProtocol{

weak var airportMapViewModuleDelegate: AirportMapViewModuleProtocol?

required init?(coder aDecoder: NSCoder) {
    super.init(coder: aDecoder)
 }
override init(frame: CGRect) {
    super.init(frame: frame)
 }
convenience init(from frame: CGRect, with cameraPosition: GMSCameraPosition) {
    self.init(frame: frame)
    self.camera = cameraPosition
 }
  func setCluster() {

    let algorithm = CustomGoogleMapsClusteringAlgorithm.init();
    mapIconGenerator = VJAirportIconGrayClusterGenerator.init()
    let renderer = VJGoogleMapsClusterRenderer(mapView: self,
                                               clusterIconGenerator: mapIconGenerator!)
    clusterManager = GMUClusterManager.init(map: self, algorithm: algorithm, renderer: renderer)
    clusterManager?.setDelegate(self, mapDelegate: self)

 }
}

In ViewController viewDidLoad I am calling init method of mapView 

self.mapView = [[AirportMapView alloc] initFrom:frame with:camera];
self.mapView.myLocationEnabled = YES;
self.mapView.settings.compassButton = YES;
self.mapView.settings.zoomGestures = YES;
self.mapView.airportMapViewModuleDelegate = self;

Backtrace of the crash and console logs attached

enter image description here

enter image description here

Backtrace of the crash

Observation:

  • GMUClusterManager initWithMap method if I remove addObserver code app is not crashing
Solution

  • After inspecting the Google-Maps-iOS-Utils source code, it turns out that the GMSClusterManager class did not maintain a strong reference to the GMSMapView that it observed via KVO. This could potentially cause crashes if the GMSMapView object ever deallocated before the removeObserver:forKeyPath: method could be called from dealloc.

    Per Apple documentation, strong references should be maintained for objects observed via KVO:

    Note: The key-value observing addObserver:forKeyPath:options:context: method does not maintain strong references to the observing object, the observed objects, or the context. You should ensure that you maintain strong references to the observing, and observed, objects, and the context as necessary.

    See this pull request (which is now merged) for more details.