SWIFT-924 Implement methods on BSONValues to convert to Extended JSON (#31)

nspektor · web-flow · commit fe49ffc0dee5 · 2020-07-29T18:30:19.000-04:00
diff --git a/Sources/BSON/Array+BSONValue.swift b/Sources/BSON/Array+BSONValue.swift
@@ -26,6 +26,16 @@ extension Array: BSONValue where Element == BSON {
         }
     }
 
+    /// Converts this `BSONArray` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        .array(self.map { $0.toRelaxedExtendedJSON() })
+    }
+
+    /// Converts this `BSONArray` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        .array(self.map { $0.toCanonicalExtendedJSON() })
+    }
+
     internal static var bsonType: BSONType { .array }
 
     internal var bson: BSON { .array(self) }
diff --git a/Sources/BSON/BSON.swift b/Sources/BSON/BSON.swift
@@ -111,6 +111,16 @@ public enum BSON {
         self = doc.bson
     }
 
+    /// Converts this `BSON` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.bsonValue.toRelaxedExtendedJSON()
+    }
+
+    /// Converts this `BSON` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        self.bsonValue.toCanonicalExtendedJSON()
+    }
+
     /// Get the `BSONType` of this `BSON`.
     public var type: BSONType {
         self.bsonValue.bsonType
diff --git a/Sources/BSON/BSONBinary.swift b/Sources/BSON/BSONBinary.swift
@@ -198,6 +198,21 @@ extension BSONBinary: BSONValue {
         }
     }
 
+    /// Converts this `BSONBinary` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONBinary` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        [
+            "$binary": [
+                "base64": .string(Data(self.data.readableBytesView).base64EncodedString()),
+                "subType": .string(String(self.subtype.rawValue, radix: 16))
+            ]
+        ]
+    }
+
     internal static var bsonType: BSONType { .binary }
 
     internal var bson: BSON { .binary(self) }
diff --git a/Sources/BSON/BSONCode.swift b/Sources/BSON/BSONCode.swift
@@ -71,6 +71,16 @@ extension BSONCode: BSONValue {
         }
     }
 
+    /// Converts this `BSONCode` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONCode` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$code": .string(self.code)]
+    }
+
     internal static var bsonType: BSONType { .code }
 
     internal var bson: BSON { .code(self) }
@@ -128,6 +138,16 @@ extension BSONCodeWithScope: BSONValue {
         }
     }
 
+    /// Converts this `BSONCodeWithScope` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        ["$code": .string(self.code), "$scope": self.scope.toRelaxedExtendedJSON()]
+    }
+
+    /// Converts this `BSONCodeWithScope` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$code": .string(self.code), "$scope": self.scope.toCanonicalExtendedJSON()]
+    }
+
     internal static var bsonType: BSONType { .codeWithScope }
 
     internal var bson: BSON { .codeWithScope(self) }
diff --git a/Sources/BSON/BSONDBPointer.swift b/Sources/BSON/BSONDBPointer.swift
@@ -66,6 +66,21 @@ extension BSONDBPointer: BSONValue {
         self = BSONDBPointer(ref: refStr, id: oid)
     }
 
+    /// Converts this `BSONDBPointer` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONDBPointer` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        [
+            "$dbPointer": [
+                "$ref": .string(self.ref),
+                "$id": self.id.toCanonicalExtendedJSON()
+            ]
+        ]
+    }
+
     internal static var bsonType: BSONType { .dbPointer }
 
     internal var bson: BSON { .dbPointer(self) }
diff --git a/Sources/BSON/BSONDecimal128.swift b/Sources/BSON/BSONDecimal128.swift
@@ -509,6 +509,16 @@ extension BSONDecimal128: BSONValue {
         }
     }
 
+    /// Converts this `Decimal128` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `Decimal128` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$numberDecimal": .string(self.toString())]
+    }
+
     internal static var bsonType: BSONType { .decimal128 }
 
     internal var bson: BSON { .decimal128(self) }
diff --git a/Sources/BSON/BSONDocument.swift b/Sources/BSON/BSONDocument.swift
@@ -375,6 +375,24 @@ extension BSONDocument: BSONValue {
         self = BSONDocument(keyValuePairs: doc)
     }
 
+    /// Converts this `BSONDocument` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        var obj: [String: JSON] = [:]
+        for (key, value) in self {
+            obj[key] = value.toRelaxedExtendedJSON()
+        }
+        return .object(obj)
+    }
+
+    /// Converts this `BSONDocument` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        var obj: [String: JSON] = [:]
+        for (key, value) in self {
+            obj[key] = value.toCanonicalExtendedJSON()
+        }
+        return .object(obj)
+    }
+
     internal static var bsonType: BSONType { .document }
 
     internal var bson: BSON { .document(self) }
diff --git a/Sources/BSON/BSONEncoder.swift b/Sources/BSON/BSONEncoder.swift
@@ -770,6 +770,14 @@ private class MutableArray: BSONValue {
         fatalError("MutableArray: BSONValue.init(fromExtJSON) should be unused")
     }
 
+    internal func toRelaxedExtendedJSON() -> JSON {
+        fatalError("MutableArray: BSONValue.toRelaxedExtendedJSON() should be unused")
+    }
+
+    internal func toCanonicalExtendedJSON() -> JSON {
+        fatalError("MutableArray: BSONValue.toCanonicalExtendedJSON() should be unused")
+    }
+
     /// methods required by the BSONValue protocol that we don't actually need/use. MutableArray
     /// is just a BSONValue to simplify usage alongside true BSONValues within the encoder.
     static func read(from buffer: inout ByteBuffer) throws -> BSON {
@@ -858,6 +866,14 @@ private class MutableDictionary: BSONValue {
         fatalError("MutableDictionary: BSONValue.init(fromExtJSON) should be unused")
     }
 
+    internal func toRelaxedExtendedJSON() -> JSON {
+        fatalError("MutableDictionary: BSONValue.toRelaxedExtendedJSON() should be unused")
+    }
+
+    internal func toCanonicalExtendedJSON() -> JSON {
+        fatalError("MutableDictionary: BSONValue.toCanonicalExtendedJSON() should be unused")
+    }
+
     /// methods required by the BSONValue protocol that we don't actually need/use. MutableDictionary
     /// is just a BSONValue to simplify usage alongside true BSONValues within the encoder.
     static func read(from buffer: inout ByteBuffer) throws -> BSON {
diff --git a/Sources/BSON/BSONNulls.swift b/Sources/BSON/BSONNulls.swift
@@ -24,6 +24,16 @@ internal struct BSONNull: BSONValue, Equatable {
         }
     }
 
+    /// Converts this `BSONNull` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONNull` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        .null
+    }
+
     internal static var bsonType: BSONType { .null }
 
     internal var bson: BSON { .null }
@@ -70,6 +80,16 @@ internal struct BSONUndefined: BSONValue, Equatable {
         self = BSONUndefined()
     }
 
+    /// Converts this `BSONUndefined` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONUndefined` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$undefined": true]
+    }
+
     internal static var bsonType: BSONType { .undefined }
 
     internal var bson: BSON { .undefined }
@@ -116,6 +136,16 @@ internal struct BSONMinKey: BSONValue, Equatable {
         self = BSONMinKey()
     }
 
+    /// Converts this `BSONMinKey` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONMinKey` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$minKey": 1]
+    }
+
     internal static var bsonType: BSONType { .minKey }
 
     internal var bson: BSON { .minKey }
@@ -162,6 +192,16 @@ internal struct BSONMaxKey: BSONValue, Equatable {
         self = BSONMaxKey()
     }
 
+    /// Converts this `BSONMaxKey` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONMaxKey` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$maxKey": 1]
+    }
+
     internal static var bsonType: BSONType { .maxKey }
 
     internal var bson: BSON { .maxKey }
diff --git a/Sources/BSON/BSONObjectID.swift b/Sources/BSON/BSONObjectID.swift
@@ -61,7 +61,9 @@ public struct BSONObjectID: Equatable, Hashable, CustomStringConvertible {
         }
         self = BSONObjectID(data)
     }
+}
 
+extension BSONObjectID: BSONValue {
     /*
      * Initializes an `ObjectID` from ExtendedJSON.
      *
@@ -97,9 +99,17 @@ public struct BSONObjectID: Equatable, Hashable, CustomStringConvertible {
             )
         }
     }
-}
 
-extension BSONObjectID: BSONValue {
+    /// Converts this `BSONObjectID` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONObjectID` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$oid": .string(self.hex)]
+    }
+
     internal static var bsonType: BSONType { .objectID }
 
     internal var bson: BSON { .objectID(self) }
diff --git a/Sources/BSON/BSONRegularExpression.swift b/Sources/BSON/BSONRegularExpression.swift
@@ -97,6 +97,21 @@ extension BSONRegularExpression: BSONValue {
         self = BSONRegularExpression(pattern: patternStr, options: optionsStr)
     }
 
+    /// Converts this `BSONRegularExpression` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONRegularExpression` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        [
+            "$regularExpression": [
+                "pattern": .string(self.pattern),
+                "options": .string(self.options)
+            ]
+        ]
+    }
+
     internal static var bsonType: BSONType { .regex }
 
     internal var bson: BSON { .regex(self) }
diff --git a/Sources/BSON/BSONSymbol.swift b/Sources/BSON/BSONSymbol.swift
@@ -31,6 +31,16 @@ public struct BSONSymbol: BSONValue, CustomStringConvertible, Equatable, Hashabl
         self = BSONSymbol(str)
     }
 
+    /// Converts this `Symbol` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `Symbol` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$symbol": .string(self.stringValue)]
+    }
+
     internal static var bsonType: BSONType { .symbol }
 
     internal var bson: BSON { .symbol(self) }
diff --git a/Sources/BSON/BSONTimestamp.swift b/Sources/BSON/BSONTimestamp.swift
@@ -66,6 +66,21 @@ public struct BSONTimestamp: BSONValue, Equatable, Hashable {
         self = BSONTimestamp(timestamp: tInt, inc: iInt)
     }
 
+    /// Converts this `BSONTimestamp` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `BSONTimestamp` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        [
+            "$timestamp": [
+                "t": .number(Double(self.timestamp)),
+                "i": .number(Double(self.increment))
+            ]
+        ]
+    }
+
     internal static func read(from buffer: inout ByteBuffer) throws -> BSON {
         guard let increment = buffer.readInteger(endianness: .little, as: UInt32.self) else {
             throw BSONError.InternalError(message: "Cannot read increment from BSON timestamp")
diff --git a/Sources/BSON/BSONValue.swift b/Sources/BSON/BSONValue.swift
@@ -17,6 +17,12 @@ internal protocol BSONValue: Codable {
 
     /// Initializes a corresponding `BSONValue` from the provided extendedJSON.
     init?(fromExtJSON json: JSON, keyPath: [String]) throws
+
+    /// Converts this `BSONValue` to a corresponding `JSON` in relaxed extendedJSON format.
+    func toRelaxedExtendedJSON() -> JSON
+
+    /// Converts this `BSONValue` to a corresponding `JSON` in canonical extendedJSON format.
+    func toCanonicalExtendedJSON() -> JSON
 }
 
 /// Convenience extension to get static bsonType from an instance
diff --git a/Sources/BSON/Bool+BSONValue.swift b/Sources/BSON/Bool+BSONValue.swift
@@ -22,6 +22,16 @@ extension Bool: BSONValue {
         }
     }
 
+    /// Converts this `Bool` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        self.toCanonicalExtendedJSON()
+    }
+
+    /// Converts this `Bool` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        .bool(self)
+    }
+
     internal static var bsonType: BSONType { .bool }
 
     internal var bson: BSON { .bool(self) }
diff --git a/Sources/BSON/Date+BSONValue.swift b/Sources/BSON/Date+BSONValue.swift
@@ -46,6 +46,24 @@ extension Date: BSONValue {
         }
     }
 
+    /// Converts this `BSONDate` to a corresponding `JSON` in relaxed extendedJSON format.
+    internal func toRelaxedExtendedJSON() -> JSON {
+        // ExtendedJSON specifies 2 different ways to represent dates in
+        // relaxed extended json depending on if the date is between 1970 and 9999
+        // 1970 is 0 milliseconds since epoch, and 10,000 is 253,402,300,800,000.
+        if self.msSinceEpoch >= 0 && self.msSinceEpoch < 253_402_300_800_000 {
+            let date = ExtendedJSONDecoder.extJSONDateFormatter.string(from: self)
+            return ["$date": .string(date)]
+        } else {
+            return self.toCanonicalExtendedJSON()
+        }
+    }
+
+    /// Converts this `BSONDate` to a corresponding `JSON` in canonical extendedJSON format.
+    internal func toCanonicalExtendedJSON() -> JSON {
+        ["$date": self.msSinceEpoch.toCanonicalExtendedJSON()]
+    }
+
     internal static var bsonType: BSONType { .datetime }
 
     internal var bson: BSON { .datetime(self) }
diff --git a/Sources/BSON/Double+BSONValue.swift b/Sources/BSON/Double+BSONValue.swift
diff --git a/Sources/BSON/Integers+BSONValue.swift b/Sources/BSON/Integers+BSONValue.swift
diff --git a/Sources/BSON/String+BSONValue.swift b/Sources/BSON/String+BSONValue.swift
diff --git a/Tests/BSONTests/ExtendedJSONConversionTests.swift b/Tests/BSONTests/ExtendedJSONConversionTests.swift

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,9 @@ public struct BSONObjectID: Equatable, Hashable, CustomStringConvertible {`
`61`	`61`	`}`
`62`	`62`	`self = BSONObjectID(data)`
`63`	`63`	`}`
	`64`	`+}`
`64`	`65`
	`66`	`+extension BSONObjectID: BSONValue {`
`65`	`67`	`/*`
`66`	`68`	* Initializes an `ObjectID` from ExtendedJSON.
`67`	`69`	`*`
`@@ -97,9 +99,17 @@ public struct BSONObjectID: Equatable, Hashable, CustomStringConvertible {`
`97`	`99`	`)`
`98`	`100`	`}`
`99`	`101`	`}`
`100`		`-}`
`101`	`102`
`102`		`-extension BSONObjectID: BSONValue {`
	`103`	+ /// Converts this `BSONObjectID` to a corresponding `JSON` in relaxed extendedJSON format.
	`104`	`+ internal func toRelaxedExtendedJSON() -> JSON {`
	`105`	`+ self.toCanonicalExtendedJSON()`
	`106`	`+ }`
	`107`	`+`
	`108`	+ /// Converts this `BSONObjectID` to a corresponding `JSON` in canonical extendedJSON format.
	`109`	`+ internal func toCanonicalExtendedJSON() -> JSON {`
	`110`	`+ ["$oid": .string(self.hex)]`
	`111`	`+ }`
	`112`	`+`
`103`	`113`	`internal static var bsonType: BSONType { .objectID }`
`104`	`114`
`105`	`115`	`internal var bson: BSON { .objectID(self) }`