Skip to content

SR-5640: JSONEncoder misrepresents UInt.max #1173

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 1 commit into from
Aug 30, 2017
Merged

SR-5640: JSONEncoder misrepresents UInt.max #1173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion Foundation/JSONSerialization.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,9 +577,12 @@ private struct JSONWriter {
writer(" ")
}
}

//[SR-2151] https://bugs.swift.org/browse/SR-2151
private mutating func _serializationString(for number: NSNumber) -> String {
if !CFNumberIsFloatType(number._cfObject) {
return number.stringValue
}
return CFNumberFormatterCreateStringWithNumber(nil, _numberformatter, number._cfObject)._swiftObject
}
}
Expand Down
20 changes: 16 additions & 4 deletions Foundation/NSNumber.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ open class NSNumber : NSValue {
fatalError("unsupported CFNumberType: '\(numberType)'")
}
}

deinit {
_CFDeinit(self)
}
Expand Down Expand Up @@ -536,13 +536,25 @@ open class NSNumber : NSValue {
}
}

private static let _numberFormatterForNilLocale: CFNumberFormatter = {
let formatter: CFNumberFormatter
formatter = CFNumberFormatterCreate(nil, CFLocaleCopyCurrent(), kCFNumberFormatterNoStyle)
CFNumberFormatterSetProperty(formatter, kCFNumberFormatterMaxFractionDigits, 15._bridgeToObjectiveC())
return formatter
}()

open func description(withLocale locale: Locale?) -> String {
// CFNumberFormatterCreateStringWithNumber() does not like numbers of type
// SInt128Type, as it loses the type when looking it up and treats it as
// an SInt64Type, so special case them.
if _CFNumberGetType2(_cfObject) == kCFNumberSInt128Type {
return String(format: "%@", unsafeBitCast(_cfObject, to: UnsafePointer<CFNumber>.self))
}

let aLocale = locale
let formatter: CFNumberFormatter
if (aLocale == nil) {
formatter = CFNumberFormatterCreate(nil, CFLocaleCopyCurrent(), kCFNumberFormatterNoStyle)
CFNumberFormatterSetProperty(formatter, kCFNumberFormatterMaxFractionDigits, 15._bridgeToObjectiveC())

formatter = NSNumber._numberFormatterForNilLocale
} else {
formatter = CFNumberFormatterCreate(nil, aLocale?._cfObject, kCFNumberFormatterDecimalStyle)
}
Expand Down
63 changes: 63 additions & 0 deletions TestFoundation/TestJSONEncoder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,68 @@ class TestJSONEncoder : XCTestCase {
test_codingOf(value: URL(string: "https://swift.org")!, toAndFrom: "\"https://swift.org\"")
}


// UInt and Int
func test_codingOfUIntMinMax() {

let encoder = JSONEncoder()

struct MyValue: Codable {
let intMin:Int = Int.min
let intMax:Int = Int.max
let uintMin:UInt = UInt.min
let uintMax:UInt = UInt.max
}

let myValue = MyValue()
let myDictI: [String:Any] = ["intMin": myValue.intMin, "intMax": myValue.intMax]
let myDictU: [String:Any] = ["uintMin": myValue.uintMin, "uintMax": myValue.uintMax]
let myDict1: [String:Any] = ["intMin": myValue.intMin]
let myDict2: [String:Any] = ["intMax": myValue.intMax]
let myDict3: [String:Any] = ["uintMin": myValue.uintMin]
let myDict4: [String:Any] = ["uintMax": myValue.uintMax]

func compareJSON(_ s1: String, _ s2: String) {
let ss1 = s1.trimmingCharacters(in: CharacterSet(charactersIn: "{}")).split(separator: Character(",")).sorted()
let ss2 = s2.trimmingCharacters(in: CharacterSet(charactersIn: "{}")).split(separator: Character(",")).sorted()
XCTAssertEqual(ss1, ss2)
}

do {
let result = try encoder.encode(myValue)
let r = String(data: result, encoding: .utf8) ?? "nil"
compareJSON(r, "{\"uintMin\":0,\"uintMax\":18446744073709551615,\"intMin\":-9223372036854775808,\"intMax\":9223372036854775807}")

let resultI = try JSONSerialization.data(withJSONObject: myDictI)
let rI = String(data: resultI, encoding: .utf8) ?? "nil"
compareJSON(rI, "{\"intMin\":-9223372036854775808,\"intMax\":9223372036854775807}")

let resultU = try JSONSerialization.data(withJSONObject: myDictU)
let rU = String(data: resultU, encoding: .utf8) ?? "nil"
compareJSON(rU, "{\"uintMax\":18446744073709551615,\"uintMin\":0}")

let result1 = try JSONSerialization.data(withJSONObject: myDict1)
let r1 = String(data: result1, encoding: .utf8) ?? "nil"
XCTAssertEqual(r1, "{\"intMin\":-9223372036854775808}")

let result2 = try JSONSerialization.data(withJSONObject: myDict2)
let r2 = String(data: result2, encoding: .utf8) ?? "nil"
XCTAssertEqual(r2, "{\"intMax\":9223372036854775807}")

let result3 = try JSONSerialization.data(withJSONObject: myDict3)
let r3 = String(data: result3, encoding: .utf8) ?? "nil"
XCTAssertEqual(r3, "{\"uintMin\":0}")

let result4 = try JSONSerialization.data(withJSONObject: myDict4)
let r4 = String(data: result4, encoding: .utf8) ?? "nil"
XCTAssertEqual(r4, "{\"uintMax\":18446744073709551615}")
} catch {
XCTFail(String(describing: error))
}
}



// MARK: - Helper Functions
private var _jsonEmptyDictionary: Data {
return "{}".data(using: .utf8)!
Expand Down Expand Up @@ -986,6 +1048,7 @@ extension TestJSONEncoder {
("test_codingOfUInt64", test_codingOfUInt64),
("test_codingOfInt", test_codingOfInt),
("test_codingOfUInt", test_codingOfUInt),
("test_codingOfUIntMinMax", test_codingOfUIntMinMax),
("test_codingOfFloat", test_codingOfFloat),
("test_codingOfDouble", test_codingOfDouble),
("test_codingOfString", test_codingOfString),
Expand Down
68 changes: 68 additions & 0 deletions TestFoundation/TestNSNumber.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class TestNSNumber : XCTestCase {
("test_description", test_description ),
("test_descriptionWithLocale", test_descriptionWithLocale ),
("test_objCType", test_objCType ),
("test_stringValue", test_stringValue),
]
}

Expand Down Expand Up @@ -1019,4 +1020,71 @@ class TestNSNumber : XCTestCase {
XCTAssertEqual("f" /* 0x66 */, objCType(NSNumber(value: Float.greatestFiniteMagnitude)))
XCTAssertEqual("d" /* 0x64 */, objCType(NSNumber(value: Double.greatestFiniteMagnitude)))
}

func test_stringValue() {

if UInt.max == UInt32.max {
XCTAssertEqual(NSNumber(value: UInt.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt.max).stringValue, "4294967295")
XCTAssertEqual(NSNumber(value: UInt.max - 1).stringValue, "4294967294")
} else if UInt.max == UInt64.max {
XCTAssertEqual(NSNumber(value: UInt.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt.max).stringValue, "18446744073709551615")
XCTAssertEqual(NSNumber(value: UInt.max - 1).stringValue, "18446744073709551614")
}

XCTAssertEqual(NSNumber(value: UInt8.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt8.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt8.max).stringValue, "255")
XCTAssertEqual(NSNumber(value: UInt8.max - 1).stringValue, "254")

XCTAssertEqual(NSNumber(value: UInt16.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt16.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt16.max).stringValue, "65535")
XCTAssertEqual(NSNumber(value: UInt16.max - 1).stringValue, "65534")

XCTAssertEqual(NSNumber(value: UInt32.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt32.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt32.max).stringValue, "4294967295")
XCTAssertEqual(NSNumber(value: UInt32.max - 1).stringValue, "4294967294")

XCTAssertEqual(NSNumber(value: UInt64.min).stringValue, "0")
XCTAssertEqual(NSNumber(value: UInt64.min + 1).stringValue, "1")
XCTAssertEqual(NSNumber(value: UInt64.max).stringValue, "18446744073709551615")
XCTAssertEqual(NSNumber(value: UInt64.max - 1).stringValue, "18446744073709551614")

if Int.max == Int32.max {
XCTAssertEqual(NSNumber(value: Int.min).stringValue, "-2147483648")
XCTAssertEqual(NSNumber(value: Int.min + 1).stringValue, "-2147483647")
XCTAssertEqual(NSNumber(value: Int.max).stringValue, "2147483647")
XCTAssertEqual(NSNumber(value: Int.max - 1).stringValue, "2147483646")
} else if Int.max == Int64.max {
XCTAssertEqual(NSNumber(value: Int.min).stringValue, "-9223372036854775808")
XCTAssertEqual(NSNumber(value: Int.min + 1).stringValue, "-9223372036854775807")
XCTAssertEqual(NSNumber(value: Int.max).stringValue, "9223372036854775807")
XCTAssertEqual(NSNumber(value: Int.max - 1).stringValue, "9223372036854775806")
}

XCTAssertEqual(NSNumber(value: Int8.min).stringValue, "-128")
XCTAssertEqual(NSNumber(value: Int8.min + 1).stringValue, "-127")
XCTAssertEqual(NSNumber(value: Int8.max).stringValue, "127")
XCTAssertEqual(NSNumber(value: Int8.max - 1).stringValue, "126")

XCTAssertEqual(NSNumber(value: Int16.min).stringValue, "-32768")
XCTAssertEqual(NSNumber(value: Int16.min + 1).stringValue, "-32767")
XCTAssertEqual(NSNumber(value: Int16.max).stringValue, "32767")
XCTAssertEqual(NSNumber(value: Int16.max - 1).stringValue, "32766")

XCTAssertEqual(NSNumber(value: Int32.min).stringValue, "-2147483648")
XCTAssertEqual(NSNumber(value: Int32.min + 1).stringValue, "-2147483647")
XCTAssertEqual(NSNumber(value: Int32.max).stringValue, "2147483647")
XCTAssertEqual(NSNumber(value: Int32.max - 1).stringValue, "2147483646")

XCTAssertEqual(NSNumber(value: Int64.min).stringValue, "-9223372036854775808")
XCTAssertEqual(NSNumber(value: Int64.min + 1).stringValue, "-9223372036854775807")
XCTAssertEqual(NSNumber(value: Int64.max).stringValue, "9223372036854775807")
XCTAssertEqual(NSNumber(value: Int64.max - 1).stringValue, "9223372036854775806")
}
}