fix: make ArtifactPlan.videoRecordingEnabled optional#40
Open
skylarkdevs wants to merge 1 commit into
Open
Conversation
The Vapi server response no longer includes `videoRecordingEnabled` under `artifactPlan` — the field moved to `transport.videoRecordingEnabled` on the server. The SDK's strict Decodable conformance threw `keyNotFound` on the missing key, which surfaced to consumers as an immediate `.callDidEnd` event with no preceding `.callDidStart` and an unhelpful `decodingError` reason. Every `vapi.start()` call was failing. Declaring it `Bool?` lets the decoder leave it `nil` when the server omits it. The single callsite already uses optional chaining (`response.artifactPlan?.videoRecordingEnabled ?? false` in Vapi.swift:348), so no consumer-facing behavior changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
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.
Problem
Calling
vapi.start(assistantId:)against the current production Vapi server fails immediately with.callDidEnd(no transcript, no audio) because the SDK's strictDecodabledecoder throwskeyNotFound("videoRecordingEnabled")while parsingWebCallResponse.The server response no longer always nests
videoRecordingEnabledunderartifactPlan— it has moved totransport.videoRecordingEnabledfor many calls — so the key is genuinely absent from the JSON the SDK receives.Reproduction:
artifactPlan.videoRecordingEnabled)vapi.start(assistantId: "<id>")vapi.eventPublisheremits.callDidEnd(error: decodingError(keyNotFound("videoRecordingEnabled", ...)))~0.3s after startFix
Make
ArtifactPlan.videoRecordingEnabledan optionalBool?. The only existing reader is inVapi.swift:Swift's optional-chain flattening means the expression's type is unchanged (
Bool?), so this line keeps compiling with no callsite update needed.Impact
vapi.start()for SDK consumers whose backend doesn't echoartifactPlan.videoRecordingEnabledon every web-call response.?? falsepattern.Test plan
vapi.start()against a production assistant now produces.callDidStart+ transcript instead of.callDidEnd(decodingError)