Remove internal log utility that used os_log in a not-recommended way (#1172)

* Remove internal log utility that uses `os_log` in a not-recommended way

* Avoid wrapping logging calls in helper functions

Author: d-ronnqvist

Sources/SwiftDocC/DocumentationService/ExternalReferenceResolverServiceClient.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -11,6 +11,13 @@
 import Foundation
 import SymbolKit
 
+#if canImport(os)
+    import os
+    private let logger = Logger(subsystem: "org.swift.docc", category: "ExternalReferenceResolverServiceClient")
+#else
+    private let logger = NoOpLoggerShim()
+#endif
+
 /// A client for performing link resolution requests to a documentation server.
 class ExternalReferenceResolverServiceClient {
     /// The maximum amount of time, in seconds, to await a response from the external reference resolver.
@@ -73,21 +80,36 @@ class ExternalReferenceResolverServiceClient {
         }
 
         guard resultGroup.wait(timeout: .now() + .seconds(Self.responseTimeout)) == .success else {
-            logError(.timeout)
+            logger.log("Timed out when resolving request.")
             throw Error.timeout
         }
 
         switch result {
         case .success(let data?)?:
             return data
         case .success?:
-            logError(.missingPayload)
+            logger.log("Received nil payload when resolving request.")
             throw Error.missingPayload
         case .failure(let error):
-            logError(error)
+            switch error {
+            case .failedToEncodeRequest(let underlyingError):
+                logger.log("Unable to encode request for request: \(underlyingError.localizedDescription)")
+            case .invalidResponse(let underlyingError):
+                logger.log("Received invalid response when resolving request: \(underlyingError.localizedDescription)")
+            case .invalidResponseType(let receivedType):
+                logger.log("Received unknown response type when resolving request: '\(receivedType)'")
+            case .missingPayload:
+                logger.log("Received nil payload when resolving request.")
+            case .timeout:
+                logger.log("Timed out when resolving request.")
+            case .receivedErrorFromServer(let message):
+                logger.log("Received error from server when resolving request: \(message)")
+            case .unknownError:
+                logger.log("Unknown error when resolving request.")
+            }
             throw error
         case nil:
-            logError(.unknownError)
+            logger.log("Unknown error when resolving request.")
             throw Error.unknownError
         }
     }
@@ -103,25 +125,6 @@ class ExternalReferenceResolverServiceClient {
                 .failure(.invalidResponseType(receivedType: message.type.rawValue))
         }
     }
-    
-    private func logError(_ error: Error) {
-        switch error {
-        case .failedToEncodeRequest(let underlyingError):
-            xlog("Unable to encode request for request: \(underlyingError.localizedDescription)")
-        case .invalidResponse(let underlyingError):
-            xlog("Received invalid response when resolving request: \(underlyingError.localizedDescription)")
-        case .invalidResponseType(let receivedType):
-            xlog("Received unknown response type when resolving request: '\(receivedType)'")
-        case .missingPayload:
-            xlog("Received nil payload when resolving request.")
-        case .timeout:
-            xlog("Timed out when resolving request.")
-        case .receivedErrorFromServer(let message):
-            xlog("Received error from server when resolving request: \(message)")
-        case .unknownError:
-            xlog("Unknown error when resolving request.")
-        }
-    }
 
     enum Error: Swift.Error {
         case failedToEncodeRequest(underlyingError: Swift.Error)

Sources/SwiftDocC/Servers/FileServer.swift

@@ -20,6 +20,13 @@ import UniformTypeIdentifiers
 import WinSDK
 #endif
 
+#if canImport(os)
+    import os
+    private let logger = Logger(subsystem: "org.swift.docc", category: "FileServer")
+#else
+    private let logger = NoOpLoggerShim()
+#endif
+
 fileprivate let slashCharSet = CharacterSet(charactersIn: "/")
 
 /**
@@ -95,7 +102,7 @@ public class FileServer {
             mimeType = FileServer.mimeType(for: url.pathExtension)
         } else { // request is for a path, we need to fake a redirect here
             if url.pathComponents.isEmpty {
-                xlog("Tried to load an invalid URL: \(url.absoluteString).\nFalling back to serve index.html.")
+                logger.log("Tried to load an invalid URL: \(url.absoluteString).\nFalling back to serve index.html.")
             }
             mimeType = "text/html"
             data = self.data(for: baseURL.appendingPathComponent("/index.html"))