Navigation Service, Part 1 #1602

JThramer · 2018-08-13T22:54:12Z

Part 1 of the "Nav To The Future" initiative.

To-Do:

/cc @mapbox/navigation-ios @mcwhittemore

…onService)

…g location source out)

akitchen · 2018-08-13T22:58:35Z

MapboxCoreNavigation/NavigationService.swift

+    var directionsService: Directions
+    public var router: Router
+    public var eventsManager: EventsManager
+    public var delegate: NavigationServiceDelegate?


Should this be weak?

akitchen · 2018-08-13T22:59:37Z

MapboxNavigation/NavigationViewController.swift

        }
    }
+//    @objc public var route: Route! {


What's happening here? I'd rather not bring commented-out code into master

Apologies, that shouldn't of made it into the PR. 😅

akitchen · 2018-08-13T23:00:13Z

MapboxNavigation/NavigationViewController.swift


-        let mapViewController = RouteMapViewController(routeController: self.routeController, delegate: self)
+//        self.routeController = RouteController(along: route, directions: directions, locationManager: locationManager ?? NavigationLocationManager())


Is this block of commented-out code still needed? Would rather not merge this in.

Ugh, this shouldn't of made it in either. Sourcetree is being difficult today.

akitchen · 2018-08-13T23:00:42Z

MapboxNavigation/NavigationViewController.swift

    public func tunnelIntersectionManager(_ manager: TunnelIntersectionManager, willEnableAnimationAt location: CLLocation) {
-        routeController.tunnelIntersectionManager(manager, willEnableAnimationAt: location)
+//        routeController.tunnelIntersectionManager(manager, willEnableAnimationAt: location)


This seems like a TODO

akitchen · 2018-08-13T23:00:51Z

MapboxNavigation/NavigationViewController.swift

        styleManager.applyStyle(type: .night)
    }

    public func tunnelIntersectionManager(_ manager: TunnelIntersectionManager, willDisableAnimationAt location: CLLocation) {
-        routeController.tunnelIntersectionManager(manager, willDisableAnimationAt: location)
+//        routeController.tunnelIntersectionManager(manager, willDisableAnimationAt: location)


Another TODO ?

akitchen · 2018-08-13T23:04:50Z

Get tests working

Please focus here next. Refactoring without test coverage is 👎

1ec5 · 2018-08-14T16:58:51Z

MapboxNavigation/NavigationViewController.swift

            NavigationSettings.shared.distanceUnit = route.routeOptions.locale.usesMetric ? .kilometer : .mile
-            mapViewController?.notifyDidReroute(route: route)
+                        mapViewController?.notifyDidReroute(route: route)


Nit: funky indentation.

1ec5 · 2018-08-14T17:01:34Z

Examples/Swift/ViewController.swift

-            navigationViewController.routeController.routeProgress.legIndex += 1
-            navigationViewController.routeController.resume()
+            guard let navigationViewController = self.presentedViewController as? NavigationViewController,
+                  let navService = navigationViewController.navigationService else { return }


This PR introduces some significant new concepts that will affect most non-trivial usage of the navigation SDK. So we’ll need an update to the changelog that enumerates the publicly visible changes (or links to a PR description that does so).

1ec5 · 2018-08-14T17:17:23Z

MapboxCoreNavigation/NavigationService.swift

+import CoreLocation
+import MapboxDirections
+
+@objc public protocol NavigationServiceDelegate: RouterDelegate, TunnelIntersectionManagerDelegate {}


Using protocol composition as a substitute for explicitly plumbing through delegate methods normally has one major flaw: since the umbrella protocol is just a passthrough for other protocols, it can’t give the delegate any additional context in the form of method arguments.

In this case, the delegate has no clue which NavigationService is calling the delegate methods, only the router or tunnel intersection manager. This makes a many-to-one (delegate-to-delegator) relationship impractical. The delegate would have to compare routeController to navigationService.router if it already has a reference to navigationService. Otherwise, it would have to rely on a backpointer (!) from RouteController to NavigationService, which itself could violate a many-to-one (navigation service–to–router) relationship.

In other words, suppose I registered to be the delegate for (at least one) navigation service. When I get delegate methods back, I should know which of the navigation services is messaging me. I shouldn’t have to infer it based on the identity of some navigation service’s router.

The classical approach would be to plumb delegate methods through the implementer of this protocol, adding a navigationService argument. If that is undesirable, then make NavigationServiceDelegate a type alias, remove NavigationService.delegate, and make application code talk directly to NavigationService’s router and tunnel intersection manager. I took the latter approach in #1601 in order to more loosely couple the map and navigation SDKs, but it does come at the cost of exposing implementation details.

This may not be a practical concern. For all I know, there may be only one relevant navigation service and the application may never need to talk to both simultaneously. But there’s nothing in the public interface that allows the developer to rely on that fact.

@1ec5 You're totally right here, and NavigationService is only composed as-is for purposes of convenience. I am planning on doing exactly that you suggested as part of the refactor delegation protocols task.

Examples/Objective-C/ViewController.m

JThramer · 2018-08-15T00:28:58Z

MapboxCoreNavigationTests/MapboxCoreNavigationTests.swift

-
-        navigation.reroute(from: CLLocation(latitude: 0, longitude: 0), along: navigation.routeProgress)
-        directionsClientSpy.fireLastCalculateCompletion(with: nil, routes: nil, error: NSError())
+        let routeController = navigation.router as! RouteController


If reroute(from:along) stays public, this forced-cast is unnecessary.

JThramer · 2018-08-15T22:36:17Z

MapboxNavigationTests/NavigationViewControllerTests.swift

        UIApplication.shared.delegate!.window!!.addSubview(navigationViewController.view)

        let service = dependencies.navigationService

        // Identify a location without a custom road name.
        let fultonStreetLocation = dependencies.poi[2]
-//        let fultonStreetLocation = service.router.route.legs.first!.steps[5].intersections!.first!.location
+

        navigationViewController.mapViewController!.labelRoadNameCompletionHandler = { (defaultRaodNameAssigned) in


defaultRaodNameAssigned

frederoni · 2018-08-20T11:47:35Z

MapboxCoreNavigation/EventDetails.swift

-            locationEngine = nil
-            locationManagerDesiredAccuracy = nil
-        }
+        locationEngine = dataSource.locationSource.description


Use the name of the class instead. LocationSource.description only supports simulation or device but you can also simulate on a device, or replay using the simulator, or use a custom location source. This information is useful when debugging events.

frederoni · 2018-08-20T14:06:40Z

MapboxCoreNavigation/NavigationLocationManager.swift

@@ -15,6 +15,14 @@ import UIKit
 open class NavigationLocationManager: CLLocationManager {

    var lastKnownLocation: CLLocation?
+    override open var delegate: CLLocationManagerDelegate? {


nit: no need to override the default implementation for delegate with the same implementation as the superclass already provides.

…o use that delegate protocol. Also changed `RouteControllerDelegate` into `RouterDelegate`.

# Conflicts: # MapboxCoreNavigation/RouteController.swift

frederoni · 2018-08-29T16:23:23Z

❌  /Users/distiller/project/MapboxCoreNavigationTests/TunnelAuthorityTests.swift:5:18: module 'MapboxDirections' was not compiled for testing

@testable import MapboxDirections

This happens because I changed Carthage dependecies to build Release instead of Debug.
Please change that back to Debug if we need testable imports here:

mapbox-navigation-ios/circle.yml

Line 56 in a139f89

    
           command: carthage bootstrap --platform ios --cache-builds --configuration Release --no-use-binaries

Instead of directions being memoized within the NavigationViewController, it is now a computed property, based off of the navigationService. Also cleaning up some unused cruft.

# Conflicts: # Examples/Objective-C/ViewController.m # MapboxNavigation/NavigationViewController.swift # MapboxNavigationTests/LeaksSpec.swift # MapboxNavigationTests/NavigationViewControllerTests.swift

# Conflicts: # Cartfile.resolved # Examples/Objective-C/ViewController.m # Examples/Swift/CustomViewController.swift # MapboxCoreNavigation/EventDetails.swift # MapboxCoreNavigation/EventsManager.swift # MapboxCoreNavigation/RouteController.swift # MapboxCoreNavigationTests/MapboxCoreNavigationTests.swift # MapboxCoreNavigationTests/RouteControllerTests.swift # MapboxCoreNavigationTests/TunnelIntersectionManagerTests.swift # MapboxNavigation.xcodeproj/project.pbxproj # MapboxNavigation/FeedbackViewController.swift # MapboxNavigation/NavigationViewController.swift # MapboxNavigation/RouteMapViewController.swift # MapboxNavigationTests/LaneTests.swift # MapboxNavigationTests/LeaksSpec.swift # MapboxNavigationTests/NavigationViewControllerTests.swift # MapboxNavigationTests/StepsViewControllerTests.swift

…dn't get a progress update" related

…vigation tests.

…eing passed through on carplay

…vents manager

# Conflicts: # MapboxCoreNavigation/SimulatedLocationManager.swift

Jerrad Thramer added 3 commits August 9, 2018 17:06

WIP: Building out scaffolding for MapboxNavigationService

57ed105

WIP: It compiles! (Completed building out scaffolding around Navigati…

ef09aac

…onService)

WIP: It's Aliiiiive! (Hooking NavigationService up to consumer, movin…

23818fc

…g location source out)

JThramer added ⚠️ DO NOT MERGE PR should not be merged! op-ex Refactoring, Tech Debt or any other operational excellence work. epic feature New feature request. topic: telemetry labels Aug 13, 2018

akitchen reviewed Aug 13, 2018

View reviewed changes

WIP: PR Comments

a9611d1

1ec5 reviewed Aug 14, 2018

View reviewed changes

Update all the tests!

8f47670

JThramer force-pushed the jerrad/146-navigation-service branch from ffcaf54 to 8f47670 Compare August 14, 2018 22:34

JThramer commented Aug 15, 2018

View reviewed changes

Examples/Objective-C/ViewController.m Show resolved Hide resolved

JThramer commented Aug 15, 2018

View reviewed changes

Jerrad Thramer added 2 commits August 14, 2018 18:33

Cleaning up after myself

099ddc4

Merge branch 'master' into jerrad/146-navigation-service

b24c8bf

JThramer commented Aug 15, 2018

View reviewed changes

Jerrad Thramer added 2 commits August 16, 2018 16:18

Decoupling EventsManager from RouteController

518a89e

Merge branch 'master' into jerrad/146-navigation-service

8e44849

frederoni reviewed Aug 20, 2018

View reviewed changes

WIP: Temporarily disabling TunnelIntersectionTests for refactor

d169b06

Jerrad Thramer added 5 commits August 27, 2018 15:24

Adding new NavigationServiceDelegate type and plumbing everything t…

8a8fc79

…o use that delegate protocol. Also changed `RouteControllerDelegate` into `RouterDelegate`.

Merge branch 'master' into jerrad/146-navigation-service

7b8ed23

# Conflicts: # MapboxCoreNavigation/RouteController.swift

Hooking up example

e454202

cleanup, random comment fix

45795e4

Merge branch 'master' into jerrad/146-navigation-service

a139f89

Jerrad Thramer added 3 commits August 29, 2018 11:43

Fixing tests.

4fc2e2a

Consolidating directions reference into a single-point-of-truth.

297f7b4

Instead of directions being memoized within the NavigationViewController, it is now a computed property, based off of the navigationService. Also cleaning up some unused cruft.

Merge branch 'master' into jerrad/146-navigation-service

ee3cd30

# Conflicts: # Examples/Objective-C/ViewController.m # MapboxNavigation/NavigationViewController.swift # MapboxNavigationTests/LeaksSpec.swift # MapboxNavigationTests/NavigationViewControllerTests.swift

JThramer changed the base branch from master to epic/nav-native September 7, 2018 22:39

JThramer added ✓ ready for review and removed ⚠️ DO NOT MERGE PR should not be merged! labels Sep 7, 2018

Jerrad Thramer and others added 2 commits September 7, 2018 16:47

Fixing merge clobber

cec16b6

akitchen mentioned this pull request Sep 21, 2018

Mapbox Navigation iOS Architecture Plan #1432

Closed

5 tasks

Jerrad Thramer added 10 commits September 24, 2018 16:22

WIP: Trying to fix test failures

fdcb350

WIP: Fixed crash, now working on the actual failures, which is "we di…

9c7c9f9

…dn't get a progress update" related

Fixed issue where wrong type of location manager was used for core na…

2049a30

…vigation tests.

Fixing remaining tests

41265b1

Final polish -- fixing issue where speed multiplier changes weren't b…

89c73cf

…eing passed through on carplay

Fixing test cruft where testing type is no longer extant on stubbed e…

2e161df

…vents manager

Reverting removal of ostensibly redundant XCTest availability macros

6bccfd6

Merge branch 'epic/nav-native' into jerrad/146-navigation-service

edbb56d

# Conflicts: # MapboxCoreNavigation/SimulatedLocationManager.swift

Forgot this one

0994b2b

Fixing some post-merge testing issues

e9a7781

JThramer merged commit 8b67898 into epic/nav-native Sep 26, 2018

1ec5 mentioned this pull request Sep 27, 2018

Add obsoleted stubs for pre-NavigationService symbols #1746

Closed

1ec5 added a commit that referenced this pull request Sep 27, 2018

Updated changelog for #1602

4236280

1ec5 mentioned this pull request Aug 30, 2019

Determine user agent based on presence of MapboxNavigation #2221

Merged

1ec5 deleted the jerrad/146-navigation-service branch December 5, 2019 18:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Navigation Service, Part 1 #1602

Navigation Service, Part 1 #1602

JThramer commented Aug 13, 2018 •

edited

akitchen Aug 13, 2018

akitchen Aug 13, 2018

JThramer Aug 13, 2018

akitchen Aug 13, 2018

JThramer Aug 13, 2018 •

edited

akitchen Aug 13, 2018

akitchen Aug 13, 2018

akitchen commented Aug 13, 2018 •

edited

1ec5 Aug 14, 2018

JThramer Aug 14, 2018

1ec5 Aug 14, 2018

1ec5 Aug 14, 2018

JThramer Aug 14, 2018

JThramer Aug 15, 2018

JThramer Aug 15, 2018

frederoni Aug 20, 2018 •

edited

frederoni Aug 20, 2018

frederoni commented Aug 29, 2018


		let mapViewController = RouteMapViewController(routeController: self.routeController, delegate: self)
		// self.routeController = RouteController(along: route, directions: directions, locationManager: locationManager ?? NavigationLocationManager())

Navigation Service, Part 1 #1602

Navigation Service, Part 1 #1602

Conversation

JThramer commented Aug 13, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JThramer Aug 13, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akitchen commented Aug 13, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frederoni Aug 20, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frederoni commented Aug 29, 2018

JThramer commented Aug 13, 2018 •

edited

JThramer Aug 13, 2018 •

edited

akitchen commented Aug 13, 2018 •

edited

frederoni Aug 20, 2018 •

edited