Add proxy config, cleanup enums (#137)

kylebrowning · web-flow · commit e0198e02fb4a · 2022-06-14T09:19:16.000-07:00
* Add proxy config, cleanup enums

* remove lazy var jsonEncoder()
diff --git a/Sources/APNSwift/APNSClient.swift b/Sources/APNSwift/APNSClient.swift
@@ -17,8 +17,11 @@ import Foundation
 import Logging
 import NIOCore
 import NIOFoundationCompat
+import NIOSSL
 
 public final class APNSClient {
+    internal static let loggingDisabled = Logger(
+        label: "APNS-do-not-log", factory: { _ in SwiftLogNoOpLogHandler() })
 
     private let configuration: APNSConfiguration
     private let bearerTokenFactory: APNSBearerTokenFactory
@@ -27,10 +30,6 @@ public final class APNSClient {
     internal let jsonEncoder = JSONEncoder()
     internal let jsonDecoder = JSONDecoder()
 
-    private var logger: Logger? {
-        configuration.logger
-    }
-
     /// APNSClient manages the connection and sending of push notifications to Apple's servers
     ///
     /// - Parameter configuration: `APNSConfiguration` contains various values the client will need.
@@ -42,9 +41,18 @@ public final class APNSClient {
             authenticationConfig: configuration.authenticationConfig,
             logger: configuration.logger
         )
+
+        let httpClientConfiguration = HTTPClient.Configuration(
+            proxy: configuration.proxy?.base
+        )
+
         self.httpClient = HTTPClient(
-            eventLoopGroupProvider: configuration.eventLoopGroupProvider.httpClientValue
+            eventLoopGroupProvider: configuration.eventLoopGroupProvider.httpClientValue,
+            configuration: httpClientConfiguration,
+            backgroundActivityLogger: configuration.logger ?? APNSClient.loggingDisabled
         )
+
+        jsonEncoder.outputFormatting = .withoutEscapingSlashes
     }
 
     /// Shuts down the connections
@@ -74,10 +82,12 @@ public final class APNSClient {
         priority: Int?,
         collapseIdentifier: String?,
         topic: String?,
-        apnsID: UUID?
+        apnsID: UUID?,
+        logger: Logger? = nil
     ) async throws {
-
         let topic = topic ?? configuration.topic
+        let logger = logger ?? configuration.logger
+
         let urlBase: String =
             environment?.url.absoluteString ?? configuration.environment.url.absoluteString
 
@@ -87,7 +97,7 @@ public final class APNSClient {
         request.headers.add(name: "user-agent", value: "APNS/swift-nio")
         request.headers.add(name: "content-length", value: "\(payload.readableBytes)")
         request.headers.add(name: "apns-topic", value: topic)
-        request.headers.add(name: "apns-push-type", value: pushType.rawValue)
+        request.headers.add(name: "apns-push-type", value: pushType.base.rawValue)
         request.headers.add(name: "host", value: urlBase)
 
         if let priority = priority {
@@ -118,7 +128,9 @@ public final class APNSClient {
             request,
             timeout: configuration.timeout ?? .seconds(30)
         )
+
         logger?.debug("APNS request - finished - \(response.status)")
+
         if response.status != .ok {
             let body = try await response.body.collect(upTo: 1024 * 1024)
 
@@ -130,13 +142,28 @@ public final class APNSClient {
 }
 
 extension APNSClient {
-    public enum PushType: String {
-        case alert
-        case background
-        case mdm
-        case voip
-        case fileprovider
-        case complication
+    public struct PushType: Hashable, Sendable {
+        internal enum Base: String {
+            case alert
+            case background
+            case mdm
+            case voip
+            case fileprovider
+            case complication
+        }
+
+        internal var base: Base
+
+        init(_ base: Base) {
+            self.base = base
+        }
+
+        public static let alert = PushType(.alert)
+        public static let background = PushType(.background)
+        public static let mdm = PushType(.mdm)
+        public static let voip = PushType(.voip)
+        public static let fileprovider = PushType(.fileprovider)
+        public static let complication = PushType(.complication)
     }
 }
 
@@ -172,7 +199,8 @@ extension APNSClient {
         priority: Int? = nil,
         collapseIdentifier: String? = nil,
         topic: String? = nil,
-        apnsID: UUID? = nil
+        apnsID: UUID? = nil,
+        logger: Logger? = nil
     ) async throws {
         try await self.send(
             APNSPayload(alert: alert),
@@ -184,7 +212,8 @@ extension APNSClient {
             priority: priority,
             collapseIdentifier: collapseIdentifier,
             topic: topic,
-            apnsID: apnsID
+            apnsID: apnsID,
+            logger: logger
         )
     }
 
@@ -218,7 +247,8 @@ extension APNSClient {
         priority: Int? = nil,
         collapseIdentifier: String? = nil,
         topic: String? = nil,
-        apnsID: UUID? = nil
+        apnsID: UUID? = nil,
+        logger: Logger? = nil
     ) async throws {
         struct BasicNotification: APNSNotification {
             let aps: APNSPayload
@@ -233,7 +263,8 @@ extension APNSClient {
             priority: priority,
             collapseIdentifier: collapseIdentifier,
             topic: topic,
-            apnsID: apnsID
+            apnsID: apnsID,
+            logger: logger
         )
     }
 
@@ -267,14 +298,22 @@ extension APNSClient {
         priority: Int? = nil,
         collapseIdentifier: String? = nil,
         topic: String? = nil,
-        apnsID: UUID? = nil
+        apnsID: UUID? = nil,
+        logger: Logger? = nil
     ) async throws where Notification: APNSNotification {
         let data: Data
         if let encoder = encoder {
             data = try encoder.encode(notification)
         } else {
             data = try jsonEncoder.encode(notification)
         }
+
+        let loggerToUse = logger ?? configuration.logger
+        if let loggerLevel = loggerToUse?.logLevel, loggerLevel >= .debug {
+            let payloadString = String(data: data, encoding: .utf8) ?? ""
+            loggerToUse?.debug("APNS Payload: \(payloadString)")
+        }
+
         try await self.send(
             raw: data,
             pushType: pushType,
@@ -284,7 +323,8 @@ extension APNSClient {
             priority: priority,
             collapseIdentifier: collapseIdentifier,
             topic: topic,
-            apnsID: apnsID
+            apnsID: apnsID,
+            logger: loggerToUse
         )
     }
 
@@ -299,7 +339,8 @@ extension APNSClient {
         priority: Int?,
         collapseIdentifier: String?,
         topic: String?,
-        apnsID: UUID? = nil
+        apnsID: UUID? = nil,
+        logger: Logger? = nil
     ) async throws
     where Bytes: Collection, Bytes.Element == UInt8 {
         var buffer = ByteBufferAllocator().buffer(capacity: payload.count)
@@ -313,7 +354,8 @@ extension APNSClient {
             priority: priority,
             collapseIdentifier: collapseIdentifier,
             topic: topic,
-            apnsID: apnsID
+            apnsID: apnsID,
+            logger: logger
         )
     }
 }
diff --git a/Sources/APNSwift/APNSConfiguration.swift b/Sources/APNSwift/APNSConfiguration.swift
@@ -51,6 +51,7 @@ public struct APNSConfiguration {
     /// Optional timeout time if the connection does not receive a response.
     internal let timeout: TimeAmount?
     internal let eventLoopGroupProvider: EventLoopGroupProvider
+    internal let proxy: Proxy?
 
     /// `APNSConfiguration` provides the values for APNSClient to use when sending pushes
     /// - Parameters:
@@ -66,14 +67,16 @@ public struct APNSConfiguration {
         environment: APNSConfiguration.Environment,
         eventLoopGroupProvider: EventLoopGroupProvider,
         logger: Logger? = nil,
-        timeout: TimeAmount? = nil
+        timeout: TimeAmount? = nil,
+        proxy: Proxy? = nil
     ) {
         self.topic = topic
         self.authenticationConfig = authenticationConfig
         self.environment = environment
         self.eventLoopGroupProvider = eventLoopGroupProvider
         self.timeout = timeout
         self.logger = logger
+        self.proxy = proxy
     }
 }
 
@@ -94,19 +97,58 @@ extension APNSConfiguration {
     }
 
     /// Specifies how `EventLoopGroup` will be created and establishes lifecycle ownership.
-    public enum EventLoopGroupProvider {
-        /// `EventLoopGroup` will be provided by the user. Owner of this group is responsible for its lifecycle.
-        case shared(EventLoopGroup)
+    public struct EventLoopGroupProvider {
+        var httpClientValue: HTTPClient.EventLoopGroupProvider
+
+        init(_ httpClientValue: HTTPClient.EventLoopGroupProvider) {
+            self.httpClientValue = httpClientValue
+        }
+
         /// `EventLoopGroup` will be created by the client. When `syncShutdown` is called, created `EventLoopGroup` will be shut down as well.
-        case createNew
+        public static let createNew = EventLoopGroupProvider(.createNew)
 
-        internal var httpClientValue: HTTPClient.EventLoopGroupProvider {
-            switch self {
-            case .createNew:
-                return .createNew
-            case .shared(let group):
-                return .shared(group)
+        /// `EventLoopGroup` will be provided by the user. Owner of this group is responsible for its lifecycle.
+        public static func shared(_ eventLoopGroup: EventLoopGroup) -> EventLoopGroupProvider {
+            .init(.shared(eventLoopGroup))
+        }
+    }
+}
+
+extension APNSConfiguration {
+    public struct Proxy {
+        public struct HTTPAuthorization {
+            var base: HTTPClient.Authorization
+
+            init(_ base: HTTPClient.Authorization) {
+                self.base = base
             }
+
+            public static func basic(username: String, password: String) -> HTTPClient.Authorization
+            {
+                .basic(username: username, password: password)
+            }
+            public static func basic(credentials: String) -> HTTPClient.Authorization {
+                .basic(credentials: credentials)
+            }
+            public static func bearer(tokens: String) -> HTTPClient.Authorization {
+                .bearer(tokens: tokens)
+            }
+        }
+
+        var base: HTTPClient.Configuration.Proxy
+
+        public static func server(host: String, port: Int) -> Proxy {
+            return .server(host: host, port: port)
+        }
+
+        public static func http(host: String, port: Int, authorization: HTTPAuthorization? = nil)
+            -> Proxy
+        {
+            return .http(host: host, port: port, authorization: authorization)
+        }
+
+        public static func socks(host: String, port: Int = 1080) -> Proxy {
+            return .socks(host: host, port: port)
         }
     }
 }
diff --git a/Sources/APNSwift/APNSPayload.swift b/Sources/APNSwift/APNSPayload.swift
@@ -57,6 +57,7 @@ public struct APNSPayload: Codable {
         self.alert = alert
         self.badge = badge
         self.sound = sound
+
         if let hasContentAvailable = hasContentAvailable {
             self.contentAvailable = hasContentAvailable ? 1 : 0
         } else {
diff --git a/Sources/APNSwift/APNSSound.swift b/Sources/APNSwift/APNSSound.swift
@@ -37,18 +37,33 @@ public struct APNSSoundDictionary: Codable, Equatable {
         self.volume = volume
     }
 }
-/// An enum to define how to use sound.
-/// - Parameter string: use this for a normal alert sound
-/// - Parameter critical: use for a critical alert type
-public enum APNSSoundType: Codable, Equatable {
-    case normal(String)
-    case critical(APNSSoundDictionary)
+
+public struct APNSSoundType: Codable, Equatable {
+    internal enum Base: Codable, Equatable {
+        case normal(String)
+        case critical(APNSSoundDictionary)
+    }
+    internal var base: Base
+
+    public static let none: APNSSoundType? = nil
+
+    init(_ base: Base) {
+        self.base = base
+    }
+
+    public static func makeNormalSound(soundFileName: String) -> APNSSoundType {
+        return APNSSoundType(.normal(soundFileName))
+    }
+
+    public static func makeDictionarySound(soundDictionary: APNSSoundDictionary) -> APNSSoundType {
+        return APNSSoundType(.critical(soundDictionary))
+    }
 }
 
 extension APNSSoundType {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.singleValueContainer()
-        switch self {
+        switch self.base {
         case .normal(let string):
             try container.encode(string)
         case .critical(let dict):
@@ -59,9 +74,9 @@ extension APNSSoundType {
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         if let critical = try? container.decode(APNSSoundDictionary.self) {
-            self = .critical(critical)
+            self = .init(.critical(critical))
         } else {
-            self = .normal(try container.decode(String.self))
+            self = .init(.normal(try container.decode(String.self)))
         }
     }
 }
diff --git a/Sources/APNSwiftExample/main.swift b/Sources/APNSwiftExample/main.swift
diff --git a/Tests/APNSwiftTests/APNSwiftRequestTests.swift b/Tests/APNSwiftTests/APNSwiftRequestTests.swift
