Reset LocationProducer when changing provider (#1172)

mapbox · Mar 4, 2022 · 7994b03 · 7994b03
1 parent 629a94c
commit 7994b03
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,8 @@ Mapbox welcomes participation and contributions from everyone.
 
 * Update to MapboxCoreMaps 10.4.0-rc.1 and MapboxCommon 21.2.0-rc.1. ([#1158](https://github.com/mapbox/mapbox-maps-ios/pull/1158))
 * Enable explicit drawing behavior for metal view(call `draw()` explicitly instead of `setNeedsDisplay` when view's content need to be redrawn).([#1157](https://github.com/mapbox/mapbox-maps-ios/pull/1157))
-* Restore cancellation of animations on single tap. ([#1166](https://github.com/mapbox/mapbox-maps-ios/pull/1166)) 
+* Restore cancellation of animations on single tap. ([#1166](https://github.com/mapbox/mapbox-maps-ios/pull/1166))
+* Fix issue where invalid locations could be emitted when setting a custom location provider. ([#1172](https://github.com/mapbox/mapbox-maps-ios/pull/1172))
 
 ## 10.4.0-beta.1 - February 23, 2022
 

diff --git a/Sources/MapboxMaps/Location/LocationProducer.swift b/Sources/MapboxMaps/Location/LocationProducer.swift
@@ -101,6 +101,10 @@ internal final class LocationProducer: LocationProducerProtocol {
             locationProvider.setDelegate(EmptyLocationProviderDelegate())
         }
         didSet {
+            // reinitialize latest values to mimic setup in init
+            latestCLLocation = nil
+            latestHeading = nil
+            latestAccuracyAuthorization = locationProvider.accuracyAuthorization
             locationProvider.setDelegate(self)
             syncIsUpdating()
         }
@@ -137,6 +141,9 @@ internal final class LocationProducer: LocationProducerProtocol {
     }
 
     private func notifyConsumers() {
+        guard isUpdating else {
+            return
+        }
         if let latestLocation = latestLocation {
             for consumer in _consumers.allObjects {
                 consumer.locationUpdate(newLocation: latestLocation)

diff --git a/Tests/MapboxMapsTests/Location/LocationProducerTests.swift b/Tests/MapboxMapsTests/Location/LocationProducerTests.swift
@@ -224,18 +224,50 @@ final class LocationProducerTests: XCTestCase {
     }
 
     func testSetLocationProviderWithConsumers() {
-        let otherProvider = MockLocationProvider()
-        otherProvider.authorizationStatus = .notDetermined
+        // populate location, heading, and accuracy authorization from the original location provider
+        let oldHeading = MockHeading()
+        locationProducer.locationProvider(locationProvider, didUpdateHeading: oldHeading)
+        let oldLocation = CLLocation.random()
+        locationProducer.locationProvider(locationProvider, didUpdateLocations: [oldLocation])
+        locationProvider.accuracyAuthorization = CLAccuracyAuthorization.reducedAccuracy
+        locationProducer.locationProviderDidChangeAuthorization(locationProvider)
+
+        // add a consumer
         locationProducer.add(consumer)
 
+        // set up the new provider
+        let otherProvider = MockLocationProvider()
+        otherProvider.authorizationStatus = .notDetermined
+        otherProvider.accuracyAuthorization = .random()
         locationProducer.locationProvider = otherProvider
 
+        // verify that the producer stops the old provider
         XCTAssertEqual(locationProvider.stopUpdatingLocationStub.invocations.count, 1)
         XCTAssertEqual(locationProvider.stopUpdatingHeadingStub.invocations.count, 1)
 
+        // verify that the producer starts the new provider
         XCTAssertEqual(otherProvider.requestWhenInUseAuthorizationStub.invocations.count, 1)
         XCTAssertEqual(otherProvider.startUpdatingLocationStub.invocations.count, 1)
         XCTAssertEqual(otherProvider.startUpdatingHeadingStub.invocations.count, 1)
+
+        // send a heading update from the new provider and verify that observers
+        // are not notified since the new provider has not yet produced a
+        // location
+        let newHeading = MockHeading()
+        locationProducer.locationProvider(locationProvider, didUpdateHeading: newHeading)
+
+        XCTAssertTrue(consumer.locationUpdateStub.invocations.isEmpty)
+
+        // send a location update and verify that the observers are notified
+        // with the correct value
+        let newLocation = CLLocation.random()
+        locationProducer.locationProvider(locationProvider, didUpdateLocations: [newLocation])
+
+        XCTAssertEqual(consumer.locationUpdateStub.invocations.count, 1)
+        let location = consumer.locationUpdateStub.invocations.first?.parameters
+        XCTAssertIdentical(location?.location, newLocation)
+        XCTAssertIdentical(location?.heading, newHeading)
+        XCTAssertEqual(location?.accuracyAuthorization, otherProvider.accuracyAuthorization)
     }
 
     func testSetLocationProviderWithRecentlyDeinitedConsumers() {