Add delegate methods for tapping route duration. (#4133)

Author: ShanMa1991

CHANGELOG.md

@@ -16,6 +16,7 @@
 ### Map
 
 * `NavigationMapView.removeAlternativeRoutes()` and `NavigationMapView.removeContinuousAlternativeRoutesDurations()` were made public to provide a way to remove previously shown alternative routes and alternative routes duration annotations, respectively. ([#4134](https://github.com/mapbox/mapbox-navigation-ios/pull/4134))
+* Fixed an issue where tapping on a route duration annotation that overlaps a different route would cause the wrong route to be passed into `NavigationMapViewDelegate.navigationMapView(_:didSelect:)` or `NavigationMapViewDelegate.navigationMapView(_:didSelect:)`. ([#4133](https://github.com/mapbox/mapbox-navigation-ios/pull/4133))
 
 ### Banners and guidance instructions
 

Example/ViewController.swift

@@ -744,7 +744,8 @@ extension ViewController: NavigationMapViewDelegate {
     }
 
     func navigationMapView(_ mapView: NavigationMapView, didSelect route: Route) {
-        guard let index = routes?.firstIndex(where: { $0 === route }) else { return }
+        guard let index = routes?.firstIndex(where: { $0 === route }),
+              index != indexedRouteResponse?.routeIndex else { return }
         indexedRouteResponse?.routeIndex = index
     }
 

Sources/MapboxNavigation/NavigationMapView.swift

@@ -1323,6 +1323,7 @@ open class NavigationMapView: UIView {
             "text": .string(labelText),
             "imageName": .string(imageName),
             "sortOrder": .number(Double(isSelected ? index : -index)),
+            "routeIndex": .number(Double(index))
         ]
 
         return feature
@@ -2120,12 +2121,59 @@ open class NavigationMapView: UIView {
         if let selected = waypointTest?.first {
             delegate?.navigationMapView(self, didSelect: selected)
             return
-        } else if let routes = self.routes(closeTo: tapPoint),
-                  let selectedRoute = routes.first {
-            delegate?.navigationMapView(self, didSelect: selectedRoute)
-        } else if let alternativeRoutes = self.continuousAlternativeRoutes(closeTo: tapPoint),
-                  let selectedRoute = alternativeRoutes.first {
-            delegate?.navigationMapView(self, didSelect: selectedRoute)
+        }
+        
+        route(at: tapPoint)  { [weak self] (routeFoundByPoint) in
+            guard !routeFoundByPoint, let self = self else { return }
+            if let routes = self.routes(closeTo: tapPoint),
+               let selectedRoute = routes.first {
+                self.delegate?.navigationMapView(self, didSelect: selectedRoute)
+            } else if let alternativeRoutes = self.continuousAlternativeRoutes(closeTo: tapPoint),
+                      let selectedRoute = alternativeRoutes.first {
+                self.delegate?.navigationMapView(self, didSelect: selectedRoute)
+            }
+        }
+    }
+    
+    func route(at point: CGPoint, completion: @escaping (Bool) -> Void) {
+        let group = DispatchGroup()
+        var routeFoundByPoint: Bool = false
+        let layerIds: [String] = [
+            LayerIdentifier.routeDurationAnnotationsLayer,
+            LayerIdentifier.continuousAlternativeRoutesDurationAnnotationsLayer]
+    
+        for layerId in layerIds {
+            group.enter()
+            let options = RenderedQueryOptions(layerIds: [layerId], filter: nil)
+            routeIndexFromMapQuery(with: options, at: point) { [weak self] (routeIndex) in
+                defer { group.leave() }
+                guard let self = self, let routeIndex = routeIndex else { return }
+                if layerId == layerIds.first {
+                    if let route = self.routes?[safe: routeIndex] {
+                        routeFoundByPoint = true
+                        self.delegate?.navigationMapView(self, didSelect: route)
+                    }
+                } else if let alternativeRoute = self.continuousAlternatives?[safe: routeIndex] {
+                    routeFoundByPoint = true
+                    self.delegate?.navigationMapView(self, didSelect: alternativeRoute)
+                }
+            }
+        }
+        
+        group.notify(queue: DispatchQueue.main) {
+            completion(routeFoundByPoint)
+        }
+    }
+    
+    func routeIndexFromMapQuery(with options: RenderedQueryOptions, at point: CGPoint, completion: @escaping (Int?) -> Void) {
+        mapView.mapboxMap.queryRenderedFeatures(with: [point], options: options) { result in
+            if case .success(let queriedFeatures) = result,
+               let indexValue = queriedFeatures.first?.feature.properties?["routeIndex"] as? JSONValue,
+               case .number(let routeIndex) = indexValue {
+                completion(Int(routeIndex))
+            } else {
+                completion(nil)
+            }
         }
     }