Skip to content

fix!: Throw error on invalid JSON in response #984

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.

Sign up for GitHub

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

fix!: Throw error on invalid JSON in response #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6489caa
fix: Throw error on invalid JSON in response
jbelkins Oct 22, 2025
7c431b8
Fix ClientRuntime tests that use JSON fragments
jbelkins Oct 22, 2025
2513cb6
Merge branch 'main' into jbe/invalid_json_fix
jbelkins Oct 24, 2025
f9fdfe8
Merge branch 'main' into jbe/invalid_json_fix
jbelkins Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Sources/SmithyJSON/Reader/Reader+JSONDeserialization.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@
//

import struct Foundation.Data
import class Foundation.NSError
import class Foundation.JSONSerialization
import class Foundation.NSNull

extension Reader {

public static func from(data: Data) throws -> Reader {
// Empty bodies are allowed. When the body is empty,
// return a reader with no JSON content.
guard !data.isEmpty else { return Reader(nodeInfo: "", parent: nil) }
do {
let jsonObject = try JSONSerialization.jsonObject(with: data, options: [.fragmentsAllowed])
return try Reader(nodeInfo: "", jsonObject: jsonObject)
} catch let error as NSError where error.domain == "NSCocoaErrorDomain" && error.code == 3840 {
return try Reader(nodeInfo: "", jsonObject: [:])
}

// Attempt to parse JSON from the non-empty body.
// Throw an error if JSON is invalid.
// (Determine whether to wrap this error)
let jsonObject = try JSONSerialization.jsonObject(with: data)
return try Reader(nodeInfo: "", jsonObject: jsonObject)
}
}
10 changes: 6 additions & 4 deletions Tests/ClientRuntimeTests/OrchestratorTests/OrchestratorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,19 +223,20 @@ class OrchestratorTests: XCTestCase {
.attributes(attributes)
.serialize({ input, builder, _ in
Copy link
Contributor Author

@jbelkins jbelkins Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests below used JSON fragments (i.e. a JSON string only) for serde since fragments were allowed and it kept the test setup simpler. Tests now serialize JSON objects.

trace.append("serialize")
let data = try JSONEncoder().encode(["foo": input.foo])
builder.withMethod(.get)
.withPath("/")
.withHost("localhost")
.withBody(.data(try! JSONEncoder().encode(input.foo)))
.withBody(.data(data))
})
.deserialize({ response, _ in
trace.append("deserialize")
if (200..<300).contains(response.statusCode.rawValue) {
guard case let .data(data) = response.body else {
return TestOutput(bar: "")
}
let bar = try! JSONDecoder().decode(String.self, from: data!)
return TestOutput(bar: bar)
let object = try! JSONDecoder().decode([String: String].self, from: data!)
return TestOutput(bar: object["foo"]!)
} else {
let responseReader = try SmithyJSON.Reader.from(data: try await response.data())
let baseError = try TestBaseError(httpResponse: response, responseReader: responseReader, noErrorWrapping: true)
Expand Down Expand Up @@ -1373,7 +1374,8 @@ class OrchestratorTests: XCTestCase {
let orchestrator = traceOrchestrator(trace: trace)
.retryStrategy(DefaultRetryStrategy(options: RetryStrategyOptions(backoffStrategy: ImmediateBackoffStrategy())))
.serialize({ (input: TestInput, builder: HTTPRequestBuilder, context) in
builder.withBody(.data(Data("\"\(input.foo)\"".utf8)))
let data = try JSONEncoder().encode(["foo": input.foo])
builder.withBody(.data(data))
})
.executeRequest(executeRequest)
let result = await asyncResult {
Expand Down
Loading