Skip to content

Do not override options values in NavigationRouteOptions and NavigationMatchOptions initializers #4794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 15, 2025
Merged

Do not override options values in NavigationRouteOptions and NavigationMatchOptions initializers #4794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a028497
Do not override options values in NavigationRouteOptions and Navigati…
kried Sep 11, 2025
ba8c2c2
Update CHANGELOG.md
kried Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changes to the Mapbox Navigation SDK for iOS

## v2.20.3

### Routing

* `NavigationRouteOptions.init(waypoints:profileIdentifier:queryItems:)` and `NavigationMatchOptions.init(waypoints:profileIdentifier:queryItems:)` set the default values for `shapeFormat`, `locale`, `distanceMeasurementSystem`, `routeShapeResolution`, `includesSpokenInstructions`, and `includesVisualInstructions` only if the values were not passed in `queryItems`. ([#4794](https://github.com/mapbox/mapbox-navigation-ios/pull/4794))

## v2.20.2

### Routing
Expand Down
12 changes: 8 additions & 4 deletions MapboxNavigation.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@
2C4093B5292661FD0099FA0E /* RouteParserSpy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C4093B4292661FD0099FA0E /* RouteParserSpy.swift */; };
2C484CDA2979AD6F00EAAE78 /* EventsMetadataProviderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C484CD92979AD6F00EAAE78 /* EventsMetadataProviderTests.swift */; };
2C4D0A2E29F6DC900063BF52 /* NavigationSessionManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C4D0A2D29F6DC900063BF52 /* NavigationSessionManager.swift */; };
2C4FF6842E7324A400B330FF /* NavigationMatchOptionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C4FF6822E7324A400B330FF /* NavigationMatchOptionsTests.swift */; };
2C4FF6852E7324A400B330FF /* NavigationRouteOptionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C4FF6832E7324A400B330FF /* NavigationRouteOptionsTests.swift */; };
2C585157292521C20077A558 /* MapboxCoreNavigation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C5ADFBC91DDCC7840011824B /* MapboxCoreNavigation.framework */; };
2C58515F292523670077A558 /* RouteControllerIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C58515E292523670077A558 /* RouteControllerIntegrationTests.swift */; };
2C585164292530AF0077A558 /* TestHelper.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 35CDA85E2190F2A30072B675 /* TestHelper.framework */; };
Expand Down Expand Up @@ -196,7 +198,6 @@
351BEC0D1E5BCC72006FE110 /* Bundle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC081E5BCC72006FE110 /* Bundle.swift */; };
351BEC291E5BD530006FE110 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 351BEC281E5BD530006FE110 /* Assets.xcassets */; };
3525449D1E663D32004C8F1C /* MapboxCoreNavigation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C5ADFBC91DDCC7840011824B /* MapboxCoreNavigation.framework */; };
352762A4225B751A0015B632 /* OptionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 352762A3225B751A0015B632 /* OptionsTests.swift */; };
352BBC3B1E5E6A0C00703DF1 /* MapboxCoreNavigation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C5ADFBC91DDCC7840011824B /* MapboxCoreNavigation.framework */; };
3531C2701F9E095400D92F9A /* InstructionsBannerView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3531C26F1F9E095400D92F9A /* InstructionsBannerView.swift */; };
353280A11FA72871005175F3 /* InstructionLabel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 353280A01FA72871005175F3 /* InstructionLabel.swift */; };
Expand Down Expand Up @@ -804,6 +805,8 @@
2C4093B4292661FD0099FA0E /* RouteParserSpy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RouteParserSpy.swift; sourceTree = "<group>"; };
2C484CD92979AD6F00EAAE78 /* EventsMetadataProviderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EventsMetadataProviderTests.swift; sourceTree = "<group>"; };
2C4D0A2D29F6DC900063BF52 /* NavigationSessionManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NavigationSessionManager.swift; sourceTree = "<group>"; };
2C4FF6822E7324A400B330FF /* NavigationMatchOptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationMatchOptionsTests.swift; sourceTree = "<group>"; };
2C4FF6832E7324A400B330FF /* NavigationRouteOptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationRouteOptionsTests.swift; sourceTree = "<group>"; };
2C585153292521C20077A558 /* MapboxCoreNavigationIntegrationTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MapboxCoreNavigationIntegrationTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
2C58515E292523670077A558 /* RouteControllerIntegrationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RouteControllerIntegrationTests.swift; sourceTree = "<group>"; };
2C58516229252FE20077A558 /* MapboxCoreNavigationIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MapboxCoreNavigationIntegrationTests.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -892,7 +895,6 @@
351BEC081E5BCC72006FE110 /* Bundle.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Bundle.swift; sourceTree = "<group>"; };
351BEC0B1E5BCC72006FE110 /* DistanceFormatter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DistanceFormatter.swift; sourceTree = "<group>"; };
351BEC281E5BD530006FE110 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Resources/Assets.xcassets; sourceTree = "<group>"; };
352762A3225B751A0015B632 /* OptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OptionsTests.swift; sourceTree = "<group>"; };
352C35BF2134958F00D77796 /* RecentItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RecentItem.swift; sourceTree = "<group>"; };
3531C2691F9DDC6F00D92F9A /* pt-BR */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "pt-BR"; path = "pt-BR.lproj/Navigation.strings"; sourceTree = "<group>"; };
3531C26A1F9DDC6F00D92F9A /* pt-BR */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "pt-BR"; path = "pt-BR.lproj/Localizable.strings"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -2518,6 +2520,8 @@
C5ADFBD61DDCC7840011824B /* MapboxCoreNavigationTests */ = {
isa = PBXGroup;
children = (
2C4FF6822E7324A400B330FF /* NavigationMatchOptionsTests.swift */,
2C4FF6832E7324A400B330FF /* NavigationRouteOptionsTests.swift */,
2CE89C29299E6C17000A2E34 /* EV */,
2C484CD82979AD5C00EAAE78 /* Telemetry */,
2C36D8FC2952256400EE37DF /* Progress */,
Expand All @@ -2542,7 +2546,6 @@
AE8B1B96207D2B2B003050F6 /* TunnelAuthorityTests.swift */,
3573EA70215A5A9F009899D7 /* RouteControllerTests.swift */,
3519D01D21F0842900582FF5 /* CLLocationTests.swift */,
352762A3225B751A0015B632 /* OptionsTests.swift */,
5A43FC8A24B488DC00BF7943 /* PassiveLocationManagerTests.swift */,
E2842797265B907C003F86E4 /* UnimplementedLoggingTests.swift */,
E23D8B6A269D7EE90094CEFA /* TilesetDescriptorFactoryTests.swift */,
Expand Down Expand Up @@ -3648,6 +3651,8 @@
2CA6105429802ACF003E49A7 /* MonitorConnectivityTypeProviderTests.swift in Sources */,
2CEC5C5829F71D9A001B5EC2 /* NavigationSessionManagerTests.swift in Sources */,
2C36D9012952256400EE37DF /* RouteStepProgressTests.swift in Sources */,
2C4FF6842E7324A400B330FF /* NavigationMatchOptionsTests.swift in Sources */,
2C4FF6852E7324A400B330FF /* NavigationRouteOptionsTests.swift in Sources */,
359A8AED1FA78D3000BDB486 /* DistanceFormatterTests.swift in Sources */,
5A43FC8B24B488DC00BF7943 /* PassiveLocationManagerTests.swift in Sources */,
2C9DDBE32934C457007F8CFD /* RouteControllerTests.swift in Sources */,
Expand All @@ -3656,7 +3661,6 @@
E2814D982693412E000AD987 /* BillingHandlerTests.swift in Sources */,
2CC3043529A3DCDE00A3318F /* NavigationStatusTests.swift in Sources */,
C582BA2C2073E77E00647DAA /* StringTests.swift in Sources */,
352762A4225B751A0015B632 /* OptionsTests.swift in Sources */,
DA7A97CF26A7613D001B6A9A /* RouteOptionsTests.swift in Sources */,
2C2880A1291A82630063E5B7 /* RerouteControllerTests.swift in Sources */,
8A9270EA2704F6CC00B606D9 /* BundleAdditionsTests.swift in Sources */,
Expand Down
48 changes: 37 additions & 11 deletions Sources/MapboxCoreNavigation/NavigationRouteOptions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ open class NavigationRouteOptions: RouteOptions, OptimizedForNavigation {
refreshingEnabled = true
}

optimizeForNavigation()
optimizeForNavigation(queryItems: queryItems)
}

/**
Expand Down Expand Up @@ -96,7 +96,7 @@ open class NavigationMatchOptions: MatchOptions, OptimizedForNavigation {
}
}

optimizeForNavigation()
optimizeForNavigation(queryItems: queryItems)
}


Expand All @@ -123,6 +123,16 @@ open class NavigationMatchOptions: MatchOptions, OptimizedForNavigation {
}
}

fileprivate enum OptimizedForNavigationKey: String {
case includesSteps = "steps"
case shapeFormat = "geometries"
case routeShapeResolution = "overview"
case locale = "language"
case includesSpokenInstructions = "voice_instructions"
case distanceMeasurementSystem = "voice_units"
case includesVisualInstructions = "banner_instructions"
}

protocol OptimizedForNavigation: AnyObject {
var includesSteps: Bool { get set }
var routeShapeResolution: RouteShapeResolution { get set }
Expand All @@ -133,17 +143,33 @@ protocol OptimizedForNavigation: AnyObject {
var includesSpokenInstructions: Bool { get set }
var includesVisualInstructions: Bool { get set }

func optimizeForNavigation()
func optimizeForNavigation(queryItems: [URLQueryItem]?)
}

extension OptimizedForNavigation {
func optimizeForNavigation() {
shapeFormat = .polyline6
includesSteps = true
routeShapeResolution = .full
includesSpokenInstructions = true
locale = Locale.nationalizedCurrent
distanceMeasurementSystem = .init(NavigationSettings.shared.distanceUnit)
includesVisualInstructions = true
func optimizeForNavigation(queryItems: [URLQueryItem]?) {
let names = Set(queryItems?.map { $0.name } ?? [])

if !names.contains(OptimizedForNavigationKey.shapeFormat.rawValue) {
shapeFormat = .polyline6
}
if !names.contains(OptimizedForNavigationKey.includesSteps.rawValue) {
includesSteps = true
}
if !names.contains(OptimizedForNavigationKey.routeShapeResolution.rawValue) {
routeShapeResolution = .full
}
if !names.contains(OptimizedForNavigationKey.includesSpokenInstructions.rawValue) {
includesSpokenInstructions = true
}
if !names.contains(OptimizedForNavigationKey.locale.rawValue) {
locale = .nationalizedCurrent
}
if !names.contains(OptimizedForNavigationKey.distanceMeasurementSystem.rawValue) {
distanceMeasurementSystem = .init(NavigationSettings.shared.distanceUnit)
}
if !names.contains(OptimizedForNavigationKey.includesVisualInstructions.rawValue) {
includesVisualInstructions = true
}
}
}
113 changes: 113 additions & 0 deletions Tests/MapboxCoreNavigationTests/NavigationMatchOptionsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
import XCTest
import CoreLocation
import MapboxDirections
import TestHelper
@testable import MapboxCoreNavigation

final class NavigationMatchOptionsTests: XCTestCase {
let coordinates = [
CLLocationCoordinate2D(latitude: 0, longitude: 1),
CLLocationCoordinate2D(latitude: 2, longitude: 3),
]

var waypoints: [Waypoint] {
coordinates.map { Waypoint(coordinate: $0) }
}

func testNavigationMatchOptions() {
let options = NavigationMatchOptions(coordinates: coordinates)
navigationPrerequisitesAssertions(options: options)
}

func navigationPrerequisitesAssertions(options: DirectionsOptions) {
XCTAssertEqual(options.profileIdentifier, .automobileAvoidingTraffic)
XCTAssertEqual(options.routeShapeResolution, .full)
XCTAssertEqual(options.shapeFormat, .polyline6)
XCTAssertEqual(options.attributeOptions, [.numericCongestionLevel, .expectedTravelTime, .maximumSpeedLimit])
XCTAssertTrue(options.includesVisualInstructions)
XCTAssertTrue(options.includesSpokenInstructions)
XCTAssertTrue(options.includesSteps)
XCTAssertEqual(options.locale, Locale.nationalizedCurrent)
}

func testDefaultAttributeOptions() {
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates).attributeOptions,
[.numericCongestionLevel, .expectedTravelTime, .maximumSpeedLimit]
)
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates, profileIdentifier: .automobile).attributeOptions,
[.expectedTravelTime, .maximumSpeedLimit]
)
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates, profileIdentifier: .automobileAvoidingTraffic)
.attributeOptions,
[.numericCongestionLevel, .expectedTravelTime, .maximumSpeedLimit]
)
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates, profileIdentifier: .cycling).attributeOptions,
[.expectedTravelTime]
)
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates, profileIdentifier: .walking).attributeOptions,
[.expectedTravelTime]
)
XCTAssertEqual(
NavigationMatchOptions(coordinates: coordinates, profileIdentifier: .init(rawValue: "mapbox/unicycling"))
.attributeOptions,
[.expectedTravelTime]
)
}

func testSetShapeFormat() {
let queryItems: [URLQueryItem] = [.init(name: "geometries", value: "geojson")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertEqual(options.shapeFormat, .geoJSON)
}

func testSetIncludesSteps() {
let queryItems: [URLQueryItem] = [.init(name: "steps", value: "false")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertFalse(options.includesSteps)
}

func testSetIncludesSpokenInstructions() {
let queryItems: [URLQueryItem] = [.init(name: "voice_instructions", value: "false")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertFalse(options.includesSpokenInstructions)
}

func testSetIncludesVisualInstructions() {
let queryItems: [URLQueryItem] = [.init(name: "banner_instructions", value: "false")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertFalse(options.includesVisualInstructions)
}

func testSetRouteShapeResolution() {
let queryItems: [URLQueryItem] = [.init(name: "overview", value: "low")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertEqual(options.routeShapeResolution, .low)
}

func testSetLocale() {
let queryItems: [URLQueryItem] = [.init(name: "language", value: "ja_JP")]
let options = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems)
XCTAssertEqual(options.locale, .init(identifier: "ja_JP"))
}

func testSetDistanceMeasurementSystem() {
let queryItems1: [URLQueryItem] = [
.init(name: "voice_units", value: "metric"),
.init(name: "language", value: "ja_JP"),
]
let options1 = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems1)
XCTAssertEqual(options1.distanceMeasurementSystem, .metric)

let queryItems2: [URLQueryItem] = [
.init(name: "voice_units", value: "imperial"),
.init(name: "language", value: "ja_JP"),
]
let options2 = NavigationMatchOptions(waypoints: waypoints, queryItems: queryItems2)
XCTAssertEqual(options2.distanceMeasurementSystem, .imperial)
}
}
Loading