Remove Logging (#3)

Author: leogdion

Package.resolved

@@ -41,18 +41,16 @@ let package = Package(
     .library(name: "SublimationBonjour", targets: ["SublimationBonjour"])
   ],
   dependencies: [
-    .package(url: "https://github.com/brightdigit/Sublimation", from: "2.0.0-alpha.5"),
-    .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0"),
-    .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0")
+    .package(url: "https://github.com/brightdigit/Sublimation.git", from: "2.0.1"),
+    .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0")
   ],
   targets: [
     .target(
       name: "SublimationBonjour",
       dependencies: [
         .product(name: "Sublimation", package: "Sublimation"),
         .product(name: "SublimationCore", package: "Sublimation"),
-        .product(name: "SwiftProtobuf", package: "swift-protobuf"),
-        .product(name: "Logging", package: "swift-log")
+        .product(name: "SwiftProtobuf", package: "swift-protobuf")
       ],
       swiftSettings: swiftSettings
     ),

Package.swift

@@ -29,8 +29,7 @@
 
 #if canImport(Network)
   public import Foundation
-
-  import Network
+  internal import Network
 
   #if canImport(os)
     public import os
@@ -46,9 +45,10 @@
   /// let hostURL = await depositor.first()
   /// ```
   public actor BonjourClient {
+
     private let browser: NWBrowser
     private let streams = StreamManager<UUID, URL>()
-    private let logger: Logger?
+    private let logger: LoggerType?
     private let defaultURLConfiguration: URLDefaultConfiguration
 
     /// AsyncStream of `URL` from the network.
@@ -76,7 +76,10 @@
     /// - Parameters:
     ///   - logger: Logger
     ///   - defaultURLConfiguration: default ``URL`` configuration for missing properties.
-    public init(logger: Logger? = nil, defaultURLConfiguration: URLDefaultConfiguration = .init()) {
+    public init(
+      logger: LoggerType? = nil,
+      defaultURLConfiguration: URLDefaultConfiguration = .init()
+    ) {
       assert(logger != nil)
       let descriptor: NWBrowser.Descriptor
       descriptor = .bonjourWithTXTRecord(type: "_sublimation._tcp", domain: nil)

Sources/SublimationBonjour/Client/BonjourClient.swift

@@ -0,0 +1,41 @@
+//
+//  LoggerType.swift
+//  SublimationBonjour
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the “Software”), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+#if canImport(os)
+  public import os
+#elseif canImport(Logging)
+  public import Logging
+#endif
+
+#if canImport(os) || canImport(Logging)
+  public typealias LoggerType = Logger
+#else
+  public typealias LoggerType = any NilLoggerType
+  public protocol NilLoggerType { func debug(_ message: String) }
+#endif

Sources/SublimationBonjour/Client/LoggerType.swift

@@ -29,12 +29,6 @@
 
 internal import Foundation
 
-#if canImport(os)
-  internal import os
-#elseif canImport(Logging)
-  internal import Logging
-#endif
-
 internal actor StreamManager<Key: Hashable & Sendable, Value: Sendable> {
   private var streamContinuations: [Key: AsyncStream<Value>.Continuation] = [:]
 
@@ -44,7 +38,7 @@ internal actor StreamManager<Key: Hashable & Sendable, Value: Sendable> {
 
   internal init(newID: @escaping @Sendable () -> Key) { self.newID = newID }
 
-  internal func yield(_ urls: [Value], logger: Logger?) {
+  internal func yield(_ urls: [Value], logger: LoggerType?) {
     if streamContinuations.isEmpty { logger?.debug("Missing Continuations.") }
     for streamContinuation in streamContinuations {
       for url in urls { streamContinuation.value.yield(url) }

Sources/SublimationBonjour/Client/StreamManager.swift

@@ -27,7 +27,7 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import Foundation
+internal import Foundation
 
 extension Dictionary where Key == String, Value == String {
   internal init(

Sources/SublimationBonjour/Extensions/Dictionary.swift

@@ -0,0 +1,46 @@
+//
+//  NWConnection.swift
+//  SublimationBonjour
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the “Software”), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+#if canImport(Network)
+  import Foundation
+  public import Network
+
+  extension NWConnection.State: @retroactive CustomDebugStringConvertible {
+    @_documentation(visibility: internal) public var debugDescription: String {
+      switch self { case .setup: return "setup" case .waiting(let error):
+        return "waiting: \(error.debugDescription)"
+        case .preparing: return "preparing"
+        case .ready: return "ready"
+        case .failed(let error): return "failed:  \(error.debugDescription)"
+        case .cancelled: return "cancelled"
+        @unknown default: return "unknown state"
+      }
+    }
+  }
+#endif

Sources/SublimationBonjour/Extensions/NWConnection.swift

@@ -27,7 +27,7 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import Foundation
+internal import Foundation
 
 extension String {
   internal func isLocalhost() -> Bool {

Sources/SublimationBonjour/Extensions/String.swift

@@ -27,7 +27,7 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import Foundation
+internal import Foundation
 
 extension URL {
   internal init?(scheme: String, host: String, port: Int) {

Sources/SublimationBonjour/Extensions/URL.swift

@@ -27,14 +27,13 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-#if canImport(Network)
+#if canImport(Network) && canImport(Logging)
 
   internal import Foundation
 
   public import Network
 
   public import SublimationCore
-
   public import Logging
 
   /// Sublimatory for using Bonjour auto-discovery.
@@ -165,26 +164,25 @@
       let txtRecord = NWTXTRecord(dictionary)
       assert(listener.service == nil)
       listener.service = .init(name: name, type: type, txtRecord: txtRecord)
-
+      let logger = self.logger
       listener.newConnectionHandler = { connection in
         connection.stateUpdateHandler = { state in
           switch state { case .waiting(let error):
 
-            self.logger.warning("Connection Waiting error: \(error)")
+            logger.debug("Connection Waiting error: \(error.localizedDescription)")
 
             case .ready:
-              self.logger.debug("Connection Ready")
-              self.logger.debug("Sending data \(data.count) bytes")
+              logger.debug("Connection Ready")
+              logger.debug("Sending data \(data.count) bytes")
               connection.send(
                 content: data,
                 completion: .contentProcessed { error in
-                  if let error { self.logger.warning("Connection Send error: \(error)") }
+                  if let error { self.logger.error("Connection Send error: \(error)") }
                   connection.cancel()
                 }
               )
-            case .failed(let error): self.logger.error("Connection Failure: \(error)")
-
-            default: self.logger.debug("Connection state updated: \(state)")
+            case .failed(let error): logger.debug("Connection Failure: \(error)")
+            default: logger.debug("Connection state updated: \(state.debugDescription)")
           }
         }
         connection.start(queue: connectionQueue)
@@ -202,7 +200,7 @@
               self.logger.error("Listener Failure: \(error)")
               continuation.resume(throwing: error)
             case .cancelled: continuation.resume()
-            default: self.logger.debug("Listener state updated: \(state)")
+            default: self.logger.debug("Listener state updated: \(state.debugDescription)")
           }
         }
       }