Update to Mapbox Maps `v10.0.0-rc.8`, Navigation Native `66.0.0` and Common `18.0.0`. by MaximAlien · Pull Request #3342 · mapbox/mapbox-navigation-ios

MaximAlien · 2021-09-08T23:08:44Z

Update Mapbox Navigation to Mapbox Maps v10.0.0-rc.8, Mapbox Navigation Native 66.0.0 and Mapbox Common 18.0.0.

# Conflicts: # CHANGELOG.md # Cartfile # Cartfile.resolved # MapboxCoreNavigation.podspec # MapboxNavigation-Documentation.podspec # MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved # Tests/CocoaPodsTest/PodInstall/Podfile.lock

MaximAlien · 2021-09-16T00:02:28Z


-        locations.forEach { navigator.updateLocation(for: FixLocation($0)) }
+        locations.forEach {
+            navigator.updateLocation(for: FixLocation($0)) { _ in


Not sure that we have to do anything here. Additional logging might be helpful, but if there are a lot of locations it might clutter the output. I also think that this callback should be optional.

bamx23 · 2021-09-16T08:16:49Z

        for location in locations {
-            navigator.updateLocation(for: FixLocation(location))
+            navigator.updateLocation(for: FixLocation(location)) { success in
+                completion?(success)


Should we call completion for every location in the array?

Good point, probably should just call it once. Should it be considered successful only if all the updates succeed, or only if the one of them succeeds?

To be serious I'm not sure what would be better here. Looks like completion only in case when all locations were processed would be preferable, as user might not really care about every location in particular. BTW this method is only called from two places: first one is CLLocationDelegate and we do not use that completion at all there, second one is in PassiveLocationManager.updateLocation(_:completion:) and we provide only one location there, instead of collection.

OK, if we ever do need a PassiveLocationManager.updateLocations(_:completion:), then we can revisit this logic at that time.

… objects before removing them.

MaximAlien · 2021-09-16T20:42:18Z

+ - parameter success: Boolean value, which is set to `true` in case if `RouteLeg` was
+ successfully changed, otherwise `false`.
+ */
+public typealias AdvanceLegCompletionHandler = (_ success: Bool) -> Void


This is a breaking change, which affects both RouteController and LegacyRouteController. I'm also hesitant about introducing it: previously we did not provide any information to the user about success. Now it's available, which might be useful.

Similar to #3342 (comment), it would be helpful to define this completion handler to accept a Result<Error, RouteProgress>. Even though the navigator doesn’t provide us with an Error in the failure case, we can create a basic one on the spot. In the future, if the navigator does start providing more information, we can naturally pass it along without having to break the public API. But if we don’t go through that trouble now, we can introduce a parallel method and completion handler type when the time comes.

Remember to mention the change in the changelog.

UpdateLocationCompletionHandler and AdvanceLegCompletionHandler were modified to use Result instead of Boolean. Error enums are internal, which gives us an opportunity to change them in future.

…tements while creating instance from `MapboxNavigationNative.MatchedRoadObjectLocation`.

….labelCurrentRoadFeature(at:)` for a better type-safety.

…atements while creating instance from `MapboxNavigationNative.RoadObjectDistance`.

…build failures due to deprecated APIs in Navigation Native.

1ec5 · 2021-09-17T00:01:26Z

+ - parameter success: Boolean value, which is set to `true` in case if `RouteLeg` was
+ successfully changed, otherwise `false`.
+ */
+public typealias AdvanceLegCompletionHandler = (_ success: Bool) -> Void


Similar to #3342 (comment), it would be helpful to define this completion handler to accept a Result<Error, RouteProgress>. Even though the navigator doesn’t provide us with an Error in the failure case, we can create a basic one on the spot. In the future, if the navigator does start providing more information, we can naturally pass it along without having to break the public API. But if we don’t go through that trouble now, we can introduce a parallel method and completion handler type when the time comes.

Remember to mention the change in the changelog.

# Conflicts: # Sources/MapboxCoreNavigation/EHorizon/RoadObjectLocation.swift

1ec5 · 2021-09-17T01:51:19Z

These tests are failing on the SPM build:

Failing tests:
	MapboxCoreNavigationTests:
		MapboxCoreNavigationTests.testNewStep()
		NavigationServiceTests.testProactiveRerouting()
		NavigationServiceTests.testReroutingFromALocationSendsEvents()
		RouteControllerTests.testRerouteAfterArrival()

Zeroing in on one:

✗ testProactiveRerouting, Asynchronous wait failed: Exceeded timeout of 10 seconds, with unfulfilled expectations: "Expect notification 'RouteControllerDidReroute' from <MapboxCoreNavigation.RouteController: 0x7fdade1af8f0>".

This test works by setting up a route request from 38.853108, -77.043331 (DCA) to 38.910736, -76.966906 (Arboretum) and running a full trace along that fixture. But the fixture looks pretty weird; I wonder if that is causing a reroute at a different time than expected:

This reminds me of another test fixture generated at around the same time that also took weird jogs: #2412 (comment).

…ProactiveRerouting`.

…dler` to return result instead of boolean value. Update changelog.

1ec5 · 2021-09-17T20:50:24Z

+
+        navigator.changeRouteLeg(forRoute: 0, leg: legIndex) { [weak self] success in


The removal of this synchronous call to MapboxNavigationNative.Navigator.getStatus() completes #2846 and supersedes #3269.

MaximAlien · 2021-09-17T21:03:54Z

    }

-    func testProactiveRerouting() {
+    func disabled_testProactiveRerouting() {


Revival of several disabled tests will be tackled as a tail-work in this ticket: #3375.

Update to Mapbox Maps v10.0.0-rc.8.

30022f4

MaximAlien added the build Issues related to builds and dependency management. label Sep 8, 2021

MaximAlien added this to the v2.0.0 (GA) milestone Sep 8, 2021

MaximAlien requested a review from a team September 8, 2021 23:08

MaximAlien self-assigned this Sep 8, 2021

MaximAlien added 3 commits September 15, 2021 16:27

Update Mapbox Navigation Native to 66.0.0. Fix compilation issues.

f93d216

Adapt code to the latest APIs, which allows to manually change location.

914c85f

MaximAlien changed the title ~~Update to Mapbox Maps v10.0.0-rc.8.~~ Update Mapbox Navigation to Mapbox Maps v10.0.0-rc.8, Mapbox Navigation Native 66.0.0 and Mapbox Common 18.0.0. Sep 16, 2021

MaximAlien changed the title ~~Update Mapbox Navigation to Mapbox Maps v10.0.0-rc.8, Mapbox Navigation Native 66.0.0 and Mapbox Common 18.0.0.~~ Update to Mapbox Maps v10.0.0-rc.8, Navigation Native 66.0.0 and Common 18.0.0. Sep 16, 2021

MaximAlien commented Sep 16, 2021

View reviewed changes

1ec5 reviewed Sep 16, 2021

View reviewed changes

Update MapboxCommon to 18.0.0.

0dbf5c7

bamx23 reviewed Sep 16, 2021

View reviewed changes

1ec5 reviewed Sep 16, 2021

View reviewed changes

Comment thread MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved Outdated

MaximAlien added 4 commits September 16, 2021 11:40

Make sure to check whether there are valid RoadObjectsStoreObserver…

5814035

… objects before removing them.

Improve variable naming.

5564bdc

Update Mapbox Navigation Native to 66.0.1.

fd5b250

Update Router.advanceLegIndex() protocol to use completion handler.

61342f5

MaximAlien commented Sep 16, 2021

View reviewed changes

MaximAlien added 5 commits September 16, 2021 14:40

Update RoadObjectLocation to use switch/case instead of it/else sta…

bf2e9be

…tements while creating instance from `MapboxNavigationNative.MatchedRoadObjectLocation`.

Use switch/case instead of if/else statements in `OrnamentsController…

40ca2d9

….labelCurrentRoadFeature(at:)` for a better type-safety.

Update DistancedRoadObject to use switch/case instead of it/else st…

61fae97

…atements while creating instance from `MapboxNavigationNative.RoadObjectDistance`.

Temporarily allow warnings while running CocoaPods linter to prevent …

9f89bec

…build failures due to deprecated APIs in Navigation Native.

Merge branch 'main' into maxim/update-dependencies

579bf3d

1ec5 mentioned this pull request Sep 16, 2021

Cannot update pod install rc8 for navigate by podfile mapbox/mapbox-maps-ios#678

Closed

1ec5 approved these changes Sep 17, 2021

View reviewed changes

MaximAlien added 2 commits September 16, 2021 17:27

Merge branch 'main' into maxim/update-dependencies

f23a6d6

# Conflicts: # Sources/MapboxCoreNavigation/EHorizon/RoadObjectLocation.swift

Remove deprecated Navigation Native method usage while setting route.

9f74c76

MaximAlien added 6 commits September 16, 2021 21:11

Fix failing testRerouteAfterArrival by providing list of waypoints.

b949109

Fix failing testRerouteAfterArrival.

86f8f18

Attempt to fix testNewStep by increasing time interval.

8efbd08

Temporarily disable testReroutingFromALocationSendsEvents and `test…

229c531

…ProactiveRerouting`.

Modify UpdateLocationCompletionHandler and `AdvanceLegCompletionHan…

246a7e1

…dler` to return result instead of boolean value. Update changelog.

Remove boilerplate code from RouteControllerError.

4642c57

1ec5 approved these changes Sep 17, 2021

View reviewed changes

1ec5 mentioned this pull request Sep 17, 2021

Remove unnecessary Navigator status pulling from updateRouteLeg method #3269

Closed

Update changelog.

c896970

MaximAlien mentioned this pull request Sep 17, 2021

Fix and enable NavigationServiceTests. #3375

Closed

MaximAlien commented Sep 17, 2021

View reviewed changes

MaximAlien merged commit 85f1e22 into main Sep 17, 2021

MaximAlien deleted the maxim/update-dependencies branch September 17, 2021 21:05

1ec5 mentioned this pull request Sep 21, 2021

RouteProgress and NavNative status might get out of sync. #3290

Closed


		navigator.changeRouteLeg(forRoute: 0, leg: legIndex) { [weak self] success in

Conversation

MaximAlien commented Sep 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1ec5 commented Sep 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MaximAlien commented Sep 8, 2021 •

edited

Loading

1ec5 commented Sep 17, 2021 •

edited

Loading