Logger: Pick up subsystem from #fileid instead of stacktrace hacking

Author: nevyn

Sources/AlloPlace/PlaceServerApp.swift

@@ -4,7 +4,7 @@ import allonet2
 import alloheadless
 import Logging
 
-private var logger = Logger(label: "place.app")
+private var logger = Logger(labelSuffix: "place.app")
 
 @main @MainActor
 struct PlaceServerApp: AsyncParsableCommand

Sources/AlloReality/SpatialAudioAttenuationSystem.swift

@@ -6,7 +6,7 @@ import Logging
 // TODO: Better solution: Instead of setting audioListener, we should do the vision pro hack on macos as well!! That way, the spatial field uses real world coordinates without any kind of scaling or custom listener position or anything — it’s just a real spatial audio field with correct distances. We might need this attenuation system to do "audio hidden by wall" etc though...
 public struct SpatialAudioAttenuationSystem: RealityKit.System
 {
-    let logger: Logger! = Logger(label: "spatialaudioattenuationsystem")
+    let logger: Logger! = Logger(labelSuffix: "spatialaudioattenuationsystem")
 
     public init(scene: Scene) {}
 

Sources/AlloReality/SpatialAudioPlayer.swift

@@ -25,7 +25,7 @@ public class SpatialAudioPlayer
     fileprivate var state: [MediaStreamId: SpatialAudioPlaybackState] = [:]
     var streamCancellables: Set<AnyCancellable> = []
     var listenerCancellables: Set<AnyCancellable> = []
-    var logger: Logger! = Logger(label: "spatialaudioplayer")
+    var logger: Logger! = Logger(labelSuffix: "spatialaudioplayer")
 
     /// Construct a SpatialAudioPlayer which uses `mapper` to create audio related components and `client` to react to network events. Note: announce must have completed and avatar exist before instantiating this class.
     public init(mapper: RealityViewMapper, client: AlloUserClient, content: RealityViewContentProtocol, addon: ListenerAddon? = nil)
@@ -34,7 +34,7 @@ public class SpatialAudioPlayer
         self.client = client
         self.content = content
         self.addon = addon
-        self.logger = Logger(label: "spatialaudioplayer", metadataProvider: Logger.MetadataProvider { [weak self] in
+        self.logger = Logger(labelSuffix: "spatialaudioplayer", metadataProvider: Logger.MetadataProvider { [weak self] in
             guard let self, let cid = self.client.cid else { return [:] }
             return ["clientId": .stringConvertible(cid)]
         })

Sources/alloclient/UIWebRTCTransport.swift

@@ -30,7 +30,7 @@ class UIWebRTCTransport: NSObject, Transport, LKRTCPeerConnectionDelegate, LKRTC
     private let offerAnswerConstraints = LKRTCMediaConstraints(mandatoryConstraints: [:], optionalConstraints: [:])
 
     private let audioSessionActive = false
-    private var logger = Logger(label: "transport.webrtc")
+    private var logger = Logger(labelSuffix: "transport.webrtc")
 
     public required init(
         with connectionOptions: TransportConnectionOptions,
@@ -214,7 +214,7 @@ class UIWebRTCTransport: NSObject, Transport, LKRTCPeerConnectionDelegate, LKRTC
             // Warning: LKRTCCallbackLoggers are installed globally. If two WebRTC sessions are running in the same process, both will get both's log messages.
             wlogger = LKRTCCallbackLogger()
             wlogger!.severity = .warning
-            var innerLogger = Logger(label: "transport.webrtc.wrapped")
+            var innerLogger = Logger(labelSuffix: "transport.webrtc.wrapped")
             wlogger!.start(messageAndSeverityHandler: { [weak self] (message, severity) in
                 guard let self = self else {
                     innerLogger.warning("WebRTC log AFTER deallocation: \(message)")
@@ -677,7 +677,7 @@ extension SignallingIceCandidate
 /// LKRTCAudioDeviceModule delegate whose only purpose is to stop playout/playback of every incoming audio track. This is because we want allonet to only deliver PCM packets up to the app layer to be played back spatially, and not have GoogleWebRTC play it back in stereo. I couldn't find any API to change this behavior without overriding this delegate.
 class PlaybackDisablingAudioDeviceModuleDelegate: NSObject, LKRTCAudioDeviceModuleDelegate
 {
-    var logger = Logger(label: "transport.webrtc.adc")
+    var logger = Logger(labelSuffix: "transport.webrtc.adc")
 
     func audioDeviceModule(_ audioDeviceModule: LKRTCAudioDeviceModule, didReceiveSpeechActivityEvent speechActivityEvent: LKRTCSpeechActivityEvent)
     {

Sources/alloheadless/HeadlessWebRTCTransport.swift

@@ -25,14 +25,14 @@ public class HeadlessWebRTCTransport: Transport
             }
         }
     }
-    var logger = Logger(label: "transport.headless")
+    var logger = Logger(labelSuffix: "transport.headless")
 
     private var peer: AlloWebRTCPeer
     private var channels: [String: AlloWebRTCPeer.DataChannel] = [:] // track which channels are created
     private var connectionStatus: ConnectionStatus
     private var cancellables = Set<AnyCancellable>()
 
-    private static var datachannelLogger = Logger(label: "transport.headless.libdatachannel")
+    private static var datachannelLogger = Logger(labelSuffix: "transport.headless.libdatachannel")
     private static var initialized: Bool = false
     private static func initialize()
     {
@@ -231,7 +231,7 @@ public class HeadlessWebRTCTransport: Transport
 
     public static func forward(mediaStream: MediaStream, from sender: any Transport, to receiver: any Transport) throws -> MediaStreamForwarder
     {
-        var logger = Logger(label: "transport.libdatachannel").forClient(receiver.clientId!)
+        var logger = Logger(labelSuffix: "transport.libdatachannel").forClient(receiver.clientId!)
         logger.info("Forwarding media stream \(mediaStream.mediaId) from \(sender.clientId) to \(receiver.clientId)")
         let track = mediaStream as! AlloWebRTCPeer.Track
         let receiverHeadless = (receiver as! HeadlessWebRTCTransport)

Sources/allonet2/AlloClient.swift

@@ -73,7 +73,7 @@ open class AlloClient : AlloSessionDelegate, ObservableObject, Identifiable, Ent
         return lhs.url == rhs.url && lhs.identity == rhs.identity
     }
 
-    public var logger = Logger(label: "client")
+    public var logger = Logger(labelSuffix: "client")
 
     // MARK: - Connection state related
 

Sources/allonet2/AlloSession.swift

@@ -34,7 +34,7 @@ public protocol AlloSessionDelegate: AnyObject
 public class AlloSession : NSObject, TransportDelegate
 {
     public weak var delegate: AlloSessionDelegate?
-    nonisolated(unsafe) private var logger = Logger(label: "session")
+    nonisolated(unsafe) private var logger = Logger(labelSuffix: "session")
 
     internal let transport: Transport
 
@@ -79,7 +79,7 @@ public class AlloSession : NSObject, TransportDelegate
         self.side = side
         self.transport = transport
         super.init()
-        self.logger = Logger(label: "session", metadataProvider: Logger.MetadataProvider {
+        self.logger = Logger(labelSuffix: "session", metadataProvider: Logger.MetadataProvider {
             guard let cid = self.clientId else { return [:] }
             return ["clientId": .stringConvertible(cid)]
         })

Sources/allonet2/Logging/LoggingUtil.swift

@@ -23,3 +23,18 @@ extension Logger
         return interactionLogger
     }
 }
+
+extension Logger
+{
+    public init(labelSuffix: String, fileId: String = #fileID)
+    {
+        let module = fileId.split(separator: "/").first!
+        self.init(label: "\(module):\(labelSuffix)")
+    }
+    
+    public init(labelSuffix: String, fileId: String = #fileID, metadataProvider: MetadataProvider)
+    {
+        let module = fileId.split(separator: "/").first!
+        self.init(label: "\(module):\(labelSuffix)", metadataProvider: metadataProvider)
+    }
+}

Sources/allonet2/PlaceServer/ConnectedClient.swift

@@ -24,6 +24,6 @@ internal class ConnectedClient
     {
         self.session = session
         self.status = status
-        self.logger = Logger(label: "place.server").forClient(self.cid)
+        self.logger = Logger(labelSuffix: "place.server").forClient(self.cid)
     }
 }

Sources/allonet2/PlaceServer/PlaceServer.swift

@@ -21,7 +21,7 @@ public class PlaceServer : AlloSessionDelegate
     let options: TransportConnectionOptions
     let alloAppAuthToken: String
 
-    var logger = Logger(label: "place.server")
+    var logger = Logger(labelSuffix: "place.server")
 
     var sfu: PlaceServerSFU!
     var web: PlaceServerHTTP!
@@ -142,7 +142,7 @@ public class PlaceServer : AlloSessionDelegate
     {
         let cid = sess.clientId!
         guard let client = self.clients[cid] else { return }
-        let logger = client.remoteLoggers[m.label, setDefault: Logger(label: "remote:\(m.label)")]
+        let logger = client.remoteLoggers[m.label, setDefault: Logger(labelSuffix: "remote:\(m.label)")]
         var metadata = m.metadata ?? [:]
         metadata["loggedFromClientId"] = .string(cid.uuidString)
         logger.log(