Merge pull request #388 from mattpolzin/disable-vendor-extensions-via-userInfo

Disable vendor extensions via user info

Author: mattpolzin

README.md

@@ -293,6 +293,16 @@ Many OpenAPIKit types support [Specification Extensions](https://spec.openapis.o
 
 You can get or set specification extensions via the `vendorExtensions` property on any object that supports this feature. The keys are `Strings` beginning with the aforementioned "x-" prefix and the values are `AnyCodable`. If you set an extension without using the "x-" prefix, the prefix will be added upon encoding.
 
+If you wish to disable decoding/encoding of vendor extensions for performance reasons, you can configure the Encoder and Decoder using their `userInfo`:
+```swift
+let userInfo = [VendorExtensionsConfiguration.enabledKey: false]
+let encoder = JSONEncoder()
+encoder.userInfo = userInfo
+
+let decoder = JSONDecoder()
+decoder.userInfo = userInfo
+```
+
 #### AnyCodable
 OpenAPIKit uses the `AnyCodable` type for vendor extensions and constructing examples for JSON Schemas. OpenAPIKit's `AnyCodable` type is an adaptation of the Flight School library that can be found [here](https://github.com/Flight-School/AnyCodable).
 

Sources/OpenAPIKit/CodableVendorExtendable.swift

@@ -21,8 +21,21 @@ public protocol VendorExtendable {
     var vendorExtensions: VendorExtensions { get set }
 }
 
+/// OpenAPIKit supports some additional Encoder/Decoder configuration above and beyond
+/// what the Encoder or Decoder support out of box.
+///
+/// To _disable_ encoding or decoding of Vendor Extensions (by default these are _enabled),
+/// set `userInfo[VendorExtensionsConfiguration.enabledKey] = false` for your encoder or decoder.
 public enum VendorExtensionsConfiguration {
-    public static var isEnabled = true
+    public static let enabledKey: CodingUserInfoKey = .init(rawValue: "vendor-extensions-enabled")!
+
+    static func isEnabled(for decoder: Decoder) -> Bool {
+        decoder.userInfo[enabledKey] as? Bool ?? true
+    }
+
+    static func isEnabled(for encoder: Encoder) -> Bool {
+        encoder.userInfo[enabledKey] as? Bool ?? true
+    }
 }
 
 internal protocol ExtendableCodingKey: CodingKey, Equatable {
@@ -75,7 +88,7 @@ internal enum VendorExtensionDecodingError: Swift.Error, CustomStringConvertible
 extension CodableVendorExtendable {
 
     internal static func extensions(from decoder: Decoder) throws -> VendorExtensions {
-        guard VendorExtensionsConfiguration.isEnabled else {
+        guard VendorExtensionsConfiguration.isEnabled(for: decoder) else {
             return [:]
         }
 
@@ -109,9 +122,6 @@ extension CodableVendorExtendable {
     }
 
     internal func encodeExtensions<T: KeyedEncodingContainerProtocol>(to container: inout T) throws where T.Key == Self.CodingKeys {
-        guard VendorExtensionsConfiguration.isEnabled else {
-            return
-        }
         for (key, value) in vendorExtensions {
             let xKey = key.starts(with: "x-") ? key : "x-\(key)"
             try container.encode(value, forKey: .extendedKey(for: xKey))

Sources/OpenAPIKit/Components Object/Components.swift

@@ -180,7 +180,9 @@ extension OpenAPI.Components: Encodable {
             try container.encode(pathItems, forKey: .pathItems)
         }
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/Content/Content.swift

@@ -161,7 +161,9 @@ extension OpenAPI.Content: Encodable {
 
         try container.encodeIfPresent(encoding, forKey: .encoding)
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/Document/Document.swift

@@ -456,7 +456,9 @@ extension OpenAPI.Document: Encodable {
             try container.encode(paths, forKey: .paths)
         }
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
 
         if !components.isEmpty {
             try container.encode(components, forKey: .components)

Sources/OpenAPIKit/Document/DocumentInfo.swift

@@ -191,7 +191,9 @@ extension OpenAPI.Document.Info.License: Encodable {
             }
         }
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 
@@ -269,7 +271,9 @@ extension OpenAPI.Document.Info.Contact: Encodable {
         try container.encodeIfPresent(url?.absoluteString, forKey: .url)
         try container.encodeIfPresent(email, forKey: .email)
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 
@@ -345,7 +349,9 @@ extension OpenAPI.Document.Info: Encodable {
         try container.encodeIfPresent(license, forKey: .license)
         try container.encode(version, forKey: .version)
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/Example.swift

@@ -106,7 +106,9 @@ extension OpenAPI.Example: Encodable {
             break
         }
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/ExternalDocumentation.swift

@@ -57,7 +57,9 @@ extension OpenAPI.ExternalDocumentation: Encodable {
         try container.encodeIfPresent(description, forKey: .description)
         try container.encode(url.absoluteString, forKey: .url)
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/Header/Header.swift

@@ -289,7 +289,9 @@ extension OpenAPI.Header: Encodable {
             try container.encode(deprecated, forKey: .deprecated)
         }
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }
 

Sources/OpenAPIKit/Link.swift

@@ -174,7 +174,9 @@ extension OpenAPI.Link: Encodable {
         try container.encodeIfPresent(description, forKey: .description)
         try container.encodeIfPresent(server, forKey: .server)
 
-        try encodeExtensions(to: &container)
+        if VendorExtensionsConfiguration.isEnabled(for: encoder) {
+            try encodeExtensions(to: &container)
+        }
     }
 }