Skip to content
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.

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

Migrate response parsing to Turf #216

Open
1ec5 opened this issue Dec 21, 2021 · 0 comments
Open

Migrate response parsing to Turf #216

1ec5 opened this issue Dec 21, 2021 · 0 comments

Comments

@1ec5
Copy link
Contributor

1ec5 commented Dec 21, 2021

This library should add the Swift port of Turf as a dependency. GeocodeResult and much of the Placemark struct’s Codable conformance should be replaced by FeatureCollection.

Rationale

This library has a significant amount of response parsing code. Even parsing something as simple as a set of routable points is a hassle:

if let pointsContainer = try? container.nestedContainer(keyedBy: PointsCodingKeys.self, forKey: .routableLocations),
var coordinatesContainer = try? pointsContainer.nestedUnkeyedContainer(forKey: .points) {
if let routableLocation = try coordinatesContainer.decodeIfPresent(RoutableLocation.self),
let coordinate = routableLocation.coordinate {
routableLocations = [CLLocation(coordinate: coordinate)]
}
}

The existing code is functional, but it requires manual updates any time the Geocoding API changes. Supporting a companion API such as the Japan Search API requires extra care just to get something functional.

As it happens, both APIs’ response formats are valid GeoJSON by design. The Swift port of Turf contains full-fledged, well-tested GeoJSON parsing functionality and model types. MapboxDirections successfully migrated to Turf for its geometry-related needs in mapbox/mapbox-directions-swift#382.

This library would continue to be a lightweight, maintainable wrapper atop the search APIs for use cases that don’t require the full heft of the search SDK or that require specialty endpoints like batch geocoding. Conversions to other standard iOS libraries like Contacts would remain, but the smaller codebase would make it easier to support additional Swift platforms like Linux and Windows with negligible overhead.

Implementation notes

Much of the metadata for each result is stored in GeoJSON foreign members, which are now supported by Turf: mapbox/turf-swift#175.

Turf doesn’t bridge backwards to Objective-C. In order for this library to retain Objective-C support, it would need to wrap any Turf types in Objective-C-compatible classes. That might not be much of a problem in the short term, since the response parsing is mostly an implementation detail. However, to achieve the long-term maintainability gains described above, we may want to limit Objective-C support to the current functionality or even drop it in future versions.

/ref mapbox/MapboxStatic.swift#112
/cc @OttyLab @tsuz

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant