Fix VisualInstruction.component.lane type mismatch #532
Conversation
| @@ -197,7 +197,7 @@ extension VisualInstruction.Component: Codable { | |||
| case imageURL | |||
| case directions | |||
| case isActive = "active" | |||
| case activeDirection = "active_direction" | |||
| case active_direction | |||
There was a problem hiding this comment.
Is this change strictly necessary? activeDirection would make for a better case in Swift; I’d think the raw value would remain unaffected.
| @@ -217,7 +217,10 @@ extension VisualInstruction.Component: Codable { | |||
| if kind == .lane { | |||
| let indications = try container.decode(LaneIndication.self, forKey: .directions) | |||
| let isUsable = try container.decode(Bool.self, forKey: .isActive) | |||
| let preferredDirection = try container.decodeIfPresent(LaneIndication.self, forKey: .activeDirection) | |||
| var preferredDirection: LaneIndication? = nil | |||
| if let preferredDirectionDescription = try container.decodeIfPresent(String.self, forKey: .active_direction) { | |||
There was a problem hiding this comment.
Ah, this is the same workaround as in #529 (comment) but we needed to apply it to this other field too.
| @@ -69,7 +69,7 @@ class VisualInstructionComponentTests: XCTestCase { | |||
| "type": "lane", | |||
| "active": true, | |||
| "directions": ["right", "straight"], | |||
| "active_direction": ["right"], | |||
| "active_direction": "right", | |||
There was a problem hiding this comment.
This is the kind of error that we often catch through the integration tests that begin with raw JSON fixtures. It’s unfortunate that those fixtures are difficult to maintain though. For now, it’s a reminder to us to double-check these Swift-formatted fixtures against the actual responses coming out of the Directions API.
There was a problem hiding this comment.
Yeah. I wonder if there's a reliable way to use an actual response and just parse for what needs to be tested.
There was a problem hiding this comment.
It is possible, but we’ve chosen not to do that so far, because a dependency on a live network connection can cause a CI job to be unreliable. It would be more appropriate for a CI job that runs on a nightly schedule instead of on every commit or push.
This PR fixes a type mismatch in the encoding/decoding of the
VisualInstruction.Component.lane.preferredDirectionenumeration case as well as the relevant tests.