[Bug]: Decoder does not restore the parent value after decoding a child
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
Research direction
Start in XCJSON.Decoder.decode(_:pathComponent:) and inspect how decoder state is saved and restored around child decoding. Add the regression test in Sources/Tests/DecoderStateTests.swift, then run swift test --filter restoresParentValueAfterDecodingChild. Done means the parent remains an object and its keyed container can be reopened after decoding the child.
Written by the indexing model from the issue text.
Description
Describe the bug
In XCJSON.Decoder.decode(_:pathComponent:), oldCurrentValue captures the incoming child value rather than the decoder's existing currentValue:
let oldCurrentValue = value
defer {
currentValue = oldCurrentValue
}
As a result, after decoding a child, currentPath is restored to the parent path, but currentValue still refers to the child.
Observed on main at c132630aabf40f6d6c3f7bb004595d2e5a28ea42.
Steps to reproduce
The following can be added to the existing library test target, which has access to the package-scoped decoder:
import Foundation
import Testing
import XcodeProjectFormat
private struct ParentValueProbe: XCJSON.Decodable {
init(with coder: XCJSON.Decoder) throws {
let container = try coder.openKeyedContainer()
let _: String = try container.decode("name")
#expect(coder.currentNodeType == .object)
_ = try coder.openKeyedContainer()
}
}
@Test func restoresParentValueAfterDecodingChild() throws {
let _: ParentValueProbe = try XCJSON.Decoder.decode(
data: Data(#"{"name":"App"}"#.utf8)
)
}
Save the test as Sources/Tests/DecoderStateTests.swift, then run from the repository root:
swift test --filter restoresParentValueAfterDecodingChild
Expected behavior
If the decoder is intended to restore its parent context after decoding a child, currentNodeType should remain .object, and reopening the parent's keyed container should succeed.
Actual behavior
After decoding name, the current node is a string. Reopening the keyed container throws:
Expected an instance of dictionary but an instance string was specified
Stack trace
N/A — this produces an assertion failure and a thrown error, not a crash.
Environment
- Version: main at c132630aabf40f6d6c3f7bb004595d2e5a28ea42
- OS: macOS 26.6.2 (25G83), Apple silicon (arm64)
- Swift version: Apple Swift 6.4 (swiftlang-6.4.0.34.1)
- Xcode: 27.2 beta (27B5019j)
Additional context
I reproduced this with a standalone probe against the library, but have not found an existing public Project decoding case affected by it. Existing decoding implementations that retain their original container may not encounter the issue.
Is restoring the parent value the intended behavior? If so, changing the saved value to currentValue appears to address it. I would be happy to submit a focused fix with regression tests covering restoration after both successful and throwing child decodes.
- Dominant language
- Swift
- Stars
- 384
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apple/xcode-project-format
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 72/100
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
apple/xcode-project-format#7 · 1 reaction ·
All issues in apple/xcode-project-format
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
type: docs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
googleapis/google-cloud-swift#971 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
bitcoindevkit/bdk-ffi#1125 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mozilla-mobile/firefox-ios#35743 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
manaflow-ai/cmux#13417 ·