Remove RouteOptions NSCopying conformance #3484
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Formalized usage of JSONEncoder and JSONDecoder to copy a RouteOptions for consistency with other clients of MapboxDirections.
1ec5
added
op-ex
S2Ler
approved these changes
Oct 14, 2021
bamx23
approved these changes
Oct 15, 2021
| do { | ||
| copy = try self.copy() | ||
| } catch { | ||
| copy = self |
There was a problem hiding this comment.
Should we add an assertion here? So that we can acknowledge the issue in tests if something is broken in this copy method.
There was a problem hiding this comment.
The impact is minimal and only affects incorrectly implemented subclasses of RouteOptions, so I’m inclined to omit the assertion.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RouteOptions no longer conforms to NSCopying via an extension in MapboxCoreNavigation. Instead, the workaround for mapbox/mapbox-directions-swift#564 that was introduced in #3192 has been isolated into an internal, throwable method that
RouteOptions.without(_:)andRouteProgress.reroutingOptions(with:)use to get a copy round-tripped through JSON. If the instance of RouteOptions (or a developer-defined subclass) fails to round-trip, these methods mutate the waypoints on the original object, as a last resort, to limit the fallout in the API.Fixes #3478.
/cc @mapbox/navigation-ios