Skip to content

Bare minimum [U]Int128 support for JSON encode/decode #767

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

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Bare minimum [U]Int128 support for JSON encode/decode #767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97d1cdc
Bare minimum [U]Int128 support for JSON encode/decode
stephentyrone Jul 25, 2024
e0ad697
Switch to if #available check for Int128 tests
stephentyrone Jul 26, 2024
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
30 changes: 30 additions & 0 deletions Sources/FoundationEssentials/JSON/JSONDecoder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,11 @@ extension JSONDecoderImpl : SingleValueDecodingContainer {
func decode(_: Int64.Type) throws -> Int64 {
try decodeFixedWidthInteger()
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
Copy link
Contributor

Choose a reason for hiding this comment

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

In other places in the project, we use availability like FoundationPreview 0.4 (which "back deploys" to macOS 13.3) or FoundationPredicateRegex 0.4 (which has macOS 15 aligned availability). Is it worth using/creating a FoundationPreview-based availability specifier for this, or should we just explicitly write out the availability here like it is now?

Copy link
Contributor

Choose a reason for hiding this comment

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

Another benefit of using the FoundationPreview macro is that it is defined to be the min deployment target when building the package, making it possible to test this implementation on older OSes instead of requiring a host OS of macOS 15.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think in this case we likely do need a host OS of macOS 15 since I don't think UInt128 will be present on macOS <15, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, that's why you mentioned the Predicate-specific availability here. I was hoping those wouldn't proliferate too much, but maybe we don't have a choice...

Copy link
Contributor Author

@stephentyrone stephentyrone Jul 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah, we need to match the availability of Int128, so I think it's fine to write these out explicitly. There's not too much value in making these into a macro, since they are not going to change.

func decode(_: Int128.Type) throws -> Int128 {
try decodeFixedWidthInteger()
}

func decode(_: UInt.Type) throws -> UInt {
try decodeFixedWidthInteger()
Expand All @@ -1148,6 +1153,11 @@ extension JSONDecoderImpl : SingleValueDecodingContainer {
func decode(_: UInt64.Type) throws -> UInt64 {
try decodeFixedWidthInteger()
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
func decode(_: UInt128.Type) throws -> UInt128 {
try decodeFixedWidthInteger()
}

func decode<T: Decodable>(_ type: T.Type) throws -> T {
try self.unwrap(self.topValue, as: type, for: codingPathNode, _CodingKey?.none)
Expand Down Expand Up @@ -1274,6 +1284,11 @@ extension JSONDecoderImpl {
func decode(_: Int64.Type, forKey key: K) throws -> Int64 {
try decodeFixedWidthInteger(key: key)
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
func decode(_: Int128.Type, forKey key: K) throws -> Int128 {
try decodeFixedWidthInteger(key: key)
}

func decode(_: UInt.Type, forKey key: K) throws -> UInt {
try decodeFixedWidthInteger(key: key)
Expand All @@ -1294,6 +1309,11 @@ extension JSONDecoderImpl {
func decode(_: UInt64.Type, forKey key: K) throws -> UInt64 {
try decodeFixedWidthInteger(key: key)
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
func decode(_: UInt128.Type, forKey key: K) throws -> UInt128 {
try decodeFixedWidthInteger(key: key)
}

func decode<T: Decodable>(_ type: T.Type, forKey key: K) throws -> T {
try self.impl.unwrap(try getValue(forKey: key), as: type, for: codingPathNode, key)
Expand Down Expand Up @@ -1456,6 +1476,11 @@ extension JSONDecoderImpl {
mutating func decode(_: Int64.Type) throws -> Int64 {
try decodeFixedWidthInteger()
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
mutating func decode(_: Int128.Type) throws -> Int128 {
try decodeFixedWidthInteger()
}

mutating func decode(_: UInt.Type) throws -> UInt {
try decodeFixedWidthInteger()
Expand All @@ -1476,6 +1501,11 @@ extension JSONDecoderImpl {
mutating func decode(_: UInt64.Type) throws -> UInt64 {
try decodeFixedWidthInteger()
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
mutating func decode(_: UInt128.Type) throws -> UInt128 {
try decodeFixedWidthInteger()
}

mutating func decode<T: Decodable>(_ type: T.Type) throws -> T {
let value = try self.peekNextValue(ofType: type)
Expand Down
32 changes: 32 additions & 0 deletions Sources/FoundationEssentials/JSON/JSONEncoder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,6 +712,10 @@ private struct _JSONKeyedEncodingContainer<K : CodingKey> : KeyedEncodingContain
public mutating func encode(_ value: Int64, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: Int128, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
Expand All @@ -727,6 +731,10 @@ private struct _JSONKeyedEncodingContainer<K : CodingKey> : KeyedEncodingContain
public mutating func encode(_ value: UInt64, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: UInt128, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: String, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
Expand Down Expand Up @@ -827,11 +835,15 @@ private struct _JSONUnkeyedEncodingContainer : UnkeyedEncodingContainer {
public mutating func encode(_ value: Int16) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int32) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int64) throws { self.reference.insert(self.encoder.wrap(value)) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: Int128) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt8) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt16) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt32) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt64) throws { self.reference.insert(self.encoder.wrap(value)) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: UInt128) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: String) throws { self.reference.insert(self.encoder.wrap(value)) }

public mutating func encode(_ value: Float) throws {
Expand Down Expand Up @@ -908,6 +920,12 @@ extension __JSONEncoder : SingleValueEncodingContainer {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public func encode(_ value: Int128) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}

public func encode(_ value: UInt) throws {
assertCanEncodeNewValue()
Expand All @@ -933,6 +951,12 @@ extension __JSONEncoder : SingleValueEncodingContainer {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}

@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public func encode(_ value: UInt128) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}

public func encode(_ value: String) throws {
assertCanEncodeNewValue()
Expand Down Expand Up @@ -967,11 +991,15 @@ private extension __JSONEncoder {
@inline(__always) func wrap(_ value: Int16) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int32) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int64) -> JSONReference { .number(from: value) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
@inline(__always) func wrap(_ value: Int128) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt8) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt16) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt32) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt64) -> JSONReference { .number(from: value) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
@inline(__always) func wrap(_ value: UInt128) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: String) -> JSONReference { .string(value) }

@inline(__always)
Expand Down Expand Up @@ -1302,11 +1330,15 @@ extension Int8 : _JSONSimpleValueArrayElement { }
extension Int16 : _JSONSimpleValueArrayElement { }
extension Int32 : _JSONSimpleValueArrayElement { }
extension Int64 : _JSONSimpleValueArrayElement { }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension Int128 : _JSONSimpleValueArrayElement { }
extension UInt : _JSONSimpleValueArrayElement { }
extension UInt8 : _JSONSimpleValueArrayElement { }
extension UInt16 : _JSONSimpleValueArrayElement { }
extension UInt32 : _JSONSimpleValueArrayElement { }
extension UInt64 : _JSONSimpleValueArrayElement { }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension UInt128 : _JSONSimpleValueArrayElement { }
extension String: _JSONSimpleValueArrayElement {
fileprivate func jsonRepresentation(options: JSONEncoder._Options) -> String {
self.serializedForJSON(withoutEscapingSlashes: options.outputFormatting.contains(.withoutEscapingSlashes))
Expand Down
91 changes: 91 additions & 0 deletions Tests/FoundationEssentialsTests/JSONEncoderTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,9 @@ final class JSONEncoderTests : XCTestCase {
_testRoundTripTypeCoercionFailure(of: [0, 1] as [UInt16], as: [Bool].self)
_testRoundTripTypeCoercionFailure(of: [0, 1] as [UInt32], as: [Bool].self)
_testRoundTripTypeCoercionFailure(of: [0, 1] as [UInt64], as: [Bool].self)
if #available(macOS 15.0, *) {
_testRoundTripTypeCoercionFailure(of: [0, 1] as [UInt128], as: [Bool].self)
}
_testRoundTripTypeCoercionFailure(of: [0.0, 1.0] as [Float], as: [Bool].self)
_testRoundTripTypeCoercionFailure(of: [0.0, 1.0] as [Double], as: [Bool].self)
}
Expand Down Expand Up @@ -1323,6 +1326,94 @@ final class JSONEncoderTests : XCTestCase {
let testValue = Numbers(floats: [.greatestFiniteMagnitude, .leastNormalMagnitude], doubles: [.greatestFiniteMagnitude, .leastNormalMagnitude])
_testRoundTrip(of: testValue)
}

func test_roundTrippingInt128() {
if #available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *) {
let values = [
Int128.min,
Int128.min + 1,
-0x1_0000_0000_0000_0000,
0x0_8000_0000_0000_0000,
-1,
0,
0x7fff_ffff_ffff_ffff,
0x8000_0000_0000_0000,
0xffff_ffff_ffff_ffff,
0x1_0000_0000_0000_0000,
.max
]
for i128 in values {
_testRoundTrip(of: i128)
}
}
}

func test_Int128SlowPath() {
if #available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *) {
let decoder = JSONDecoder()
let work: [Int128] = [18446744073709551615, -18446744073709551615]
for value in work {
// force the slow-path by appending ".0"
let json = "\(value).0".data(using: String._Encoding.utf8)!
XCTAssertEqual(value, try? decoder.decode(Int128.self, from: json))
}
// These should work, but making them do so probably requires
// rewriting the slow path to use a dedicated parser. For now,
// we ensure that they throw instead of returning some bogus
// result.
let shouldWorkButDontYet: [Int128] = [
.min, -18446744073709551616, 18446744073709551616, .max
]
for value in shouldWorkButDontYet {
// force the slow-path by appending ".0"
let json = "\(value).0".data(using: String._Encoding.utf8)!
XCTAssertThrowsError(try decoder.decode(Int128.self, from: json))
}
}
}

func test_roundTrippingUInt128() {
if #available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *) {
let values = [
UInt128.zero,
1,
0x0000_0000_0000_0000_7fff_ffff_ffff_ffff,
0x0000_0000_0000_0000_8000_0000_0000_0000,
0x0000_0000_0000_0000_ffff_ffff_ffff_ffff,
0x0000_0000_0000_0001_0000_0000_0000_0000,
0x7fff_ffff_ffff_ffff_ffff_ffff_ffff_ffff,
0x8000_0000_0000_0000_0000_0000_0000_0000,
.max
]
for u128 in values {
_testRoundTrip(of: u128)
}
}
}

func test_UInt128SlowPath() {
if #available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *) {
let decoder = JSONDecoder()
let work: [UInt128] = [18446744073709551615]
for value in work {
// force the slow-path by appending ".0"
let json = "\(value).0".data(using: String._Encoding.utf8)!
XCTAssertEqual(value, try? decoder.decode(UInt128.self, from: json))
}
// These should work, but making them do so probably requires
// rewriting the slow path to use a dedicated parser. For now,
// we ensure that they throw instead of returning some bogus
// result.
let shouldWorkButDontYet: [UInt128] = [
18446744073709551616, .max
]
for value in shouldWorkButDontYet {
// force the slow-path by appending ".0"
let json = "\(value).0".data(using: String._Encoding.utf8)!
XCTAssertThrowsError(try decoder.decode(UInt128.self, from: json))
}
}
}

func test_roundTrippingDoubleValues() {
struct Numbers : Codable, Equatable {
Expand Down