[Hygiene]Additional logging

Author: ipavlidakis

Sources/StreamVideo/CallSettings/MicrophoneManager.swift

@@ -12,35 +12,72 @@ public final class MicrophoneManager: ObservableObject, CallSettingsManager, @un
     /// The status of the microphone.
     @Published public internal(set) var status: CallSettingsStatus
     let state = CallSettingsState()
-
+    
     init(callController: CallController, initialStatus: CallSettingsStatus) {
         self.callController = callController
         status = initialStatus
     }
-
+    
     /// Toggles the microphone state.
-    public func toggle() async throws {
-        try await updateAudioStatus(status.next)
+    public func toggle(
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async throws {
+        try await updateAudioStatus(
+            status.next,
+            file: file,
+            function: function,
+            line: line
+        )
     }
-
+    
     /// Enables the microphone.
-    public func enable() async throws {
-        try await updateAudioStatus(.enabled)
+    public func enable(
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async throws {
+        try await updateAudioStatus(
+            .enabled,
+            file: file,
+            function: function,
+            line: line
+        )
     }
-
+    
     /// Disables the microphone.
-    public func disable() async throws {
-        try await updateAudioStatus(.disabled)
+    public func disable(
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async throws {
+        try await updateAudioStatus(
+            .disabled,
+            file: file,
+            function: function,
+            line: line
+        )
     }
 
     // MARK: - private
 
-    private func updateAudioStatus(_ status: CallSettingsStatus) async throws {
+    private func updateAudioStatus(
+        _ status: CallSettingsStatus,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async throws {
         try await updateState(
             newState: status.boolValue,
             current: self.status.boolValue,
             action: { [unowned self] state in
-                try await callController.changeAudioState(isEnabled: state)
+                try await callController.changeAudioState(
+                    isEnabled: state,
+                    file: file,
+                    function: function,
+                    line: line
+                )
             },
             onUpdate: { _ in
                 self.status = status

Sources/StreamVideo/Controllers/CallController.swift

@@ -152,8 +152,18 @@ class CallController: @unchecked Sendable {
 
     /// Changes the audio state for the current user.
     /// - Parameter isEnabled: whether audio should be enabled.
-    func changeAudioState(isEnabled: Bool) async throws {
-        await webRTCCoordinator.changeAudioState(isEnabled: isEnabled)
+    func changeAudioState(
+        isEnabled: Bool,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async throws {
+        await webRTCCoordinator.changeAudioState(
+            isEnabled: isEnabled,
+            file: file,
+            function: function,
+            line: line
+        )
     }
 
     /// Changes the video state for the current user.

Sources/StreamVideo/Utils/AudioSession/RTCAudioStore/Effects/RTCAudioStore+RouteChangeEffect.swift

@@ -92,7 +92,10 @@ extension RTCAudioStore {
                         subsystems: .audioSession
                     )
                     delegate?.audioSessionAdapterDidUpdateSpeakerOn(
-                        session.currentRoute.isSpeaker
+                        session.currentRoute.isSpeaker,
+                        file: #file,
+                        function: #function,
+                        line: #line
                     )
                 }
                 return
@@ -101,12 +104,18 @@ extension RTCAudioStore {
             switch (activeCallSettings.speakerOn, session.currentRoute.isSpeaker) {
             case (true, false):
                 delegate?.audioSessionAdapterDidUpdateSpeakerOn(
-                    false
+                    false,
+                    file: #file,
+                    function: #function,
+                    line: #line
                 )
 
             case (false, true) where session.category == AVAudioSession.Category.playAndRecord.rawValue:
                 delegate?.audioSessionAdapterDidUpdateSpeakerOn(
-                    true
+                    true,
+                    file: #file,
+                    function: #function,
+                    line: #line
                 )
 
             default:

Sources/StreamVideo/Utils/AudioSession/StreamAudioSessionAdapterDelegate.swift

@@ -12,6 +12,9 @@ protocol StreamAudioSessionAdapterDelegate: AnyObject {
     ///   - audioSession: The `AudioSession` instance that made the update.
     ///   - callSettings: The updated `CallSettings`.
     func audioSessionAdapterDidUpdateSpeakerOn(
-        _ speakerOn: Bool
+        _ speakerOn: Bool,
+        file: StaticString,
+        function: StaticString,
+        line: UInt
     )
 }

Sources/StreamVideo/Utils/CustomStringInterpolation/String.StringInterpolation+Nil.swift

@@ -8,4 +8,12 @@ extension String.StringInterpolation {
     mutating func appendInterpolation<T: CustomStringConvertible>(_ value: T?) {
         appendInterpolation(value ?? "nil" as CustomStringConvertible)
     }
+
+    mutating func appendInterpolation<T: AnyObject>(_ value: T) {
+        if let convertible = value as? CustomStringConvertible {
+            appendInterpolation(convertible)
+        } else {
+            appendInterpolation("\(Unmanaged.passUnretained(value).toOpaque())")
+        }
+    }
 }

Sources/StreamVideo/WebRTC/v2/WebRTCCoordinator.swift

@@ -135,9 +135,25 @@ final class WebRTCCoordinator: @unchecked Sendable {
     /// Changes the audio state (enabled/disabled) for the call.
     ///
     /// - Parameter isEnabled: Whether the audio should be enabled.
-    func changeAudioState(isEnabled: Bool) async {
+    func changeAudioState(
+        isEnabled: Bool,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: UInt = #line
+    ) async {
         await stateAdapter
-            .enqueueCallSettings { $0.withUpdatedAudioState(isEnabled) }
+            .enqueueCallSettings(
+                functionName: function,
+                fileName: file,
+                lineNumber: line
+            ) {
+                $0.withUpdatedAudioState(
+                    isEnabled,
+                    file: file,
+                    function: function,
+                    line: line
+                )
+            }
     }
 
     /// Changes the video state (enabled/disabled) for the call.

Sources/StreamVideo/WebRTC/v2/WebRTCStateAdapter.swift

@@ -508,6 +508,13 @@ actor WebRTCStateAdapter: ObservableObject, StreamAudioSessionAdapterDelegate, W
             }
 
             await set(callSettings: updatedCallSettings)
+            log.debug(
+                "CallSettings updated \(currentCallSettings) -> \(updatedCallSettings)",
+                subsystems: .webRTC,
+                functionName: functionName,
+                fileName: fileName,
+                lineNumber: lineNumber
+            )
 
             guard
                 let publisher = await self.publisher
@@ -684,19 +691,32 @@ actor WebRTCStateAdapter: ObservableObject, StreamAudioSessionAdapterDelegate, W
 
     // MARK: - AudioSessionDelegate
 
-    nonisolated func audioSessionAdapterDidUpdateSpeakerOn(_ speakerOn: Bool) {
+    nonisolated func audioSessionAdapterDidUpdateSpeakerOn(
+        _ speakerOn: Bool,
+        file: StaticString,
+        function: StaticString,
+        line: UInt
+
+    ) {
         Task(disposableBag: disposableBag) { [weak self] in
             guard let self else {
                 return
             }
-            await self.enqueueCallSettings {
+            await self.enqueueCallSettings(
+                functionName: function,
+                fileName: file,
+                lineNumber: line
+            ) {
                 $0.withUpdatedSpeakerState(speakerOn)
             }
-            log.debug(
-                "AudioSession delegated updated speakerOn:\(speakerOn).",
-                subsystems: .audioSession
-            )
         }
+        log.debug(
+            "AudioSession delegated updated speakerOn:\(speakerOn).",
+            subsystems: .audioSession,
+            functionName: function,
+            fileName: file,
+            lineNumber: line
+        )
     }
 
     // MARK: - WebRTCPermissionsAdapterDelegate

StreamVideoTests/Mock/CallController_Mock.swift

@@ -24,7 +24,8 @@ class CallController_Mock: CallController, @unchecked Sendable {
         mockResponseBuilder.makeJoinCallResponse(cid: super.call?.cId ?? "default:\(String.unique)")
     }
 
-    override func changeAudioState(isEnabled: Bool) async throws { /* no op */ }
+    override func changeAudioState(isEnabled: Bool, file: StaticString, function: StaticString, line: UInt) async throws {
+    /* no op */ }
 
     override func changeVideoState(isEnabled: Bool) async throws { /* no op */ }
 

StreamVideoTests/Utils/AudioSession/RTCAudioStore/Effects/RouteChangeEffect_Tests.swift

@@ -14,7 +14,12 @@ final class RouteChangeEffect_Tests: XCTestCase, @unchecked Sendable {
     final class MockDelegate: StreamAudioSessionAdapterDelegate {
         private(set) var updatedSpeakerOn: Bool?
 
-        func audioSessionAdapterDidUpdateSpeakerOn(_ speakerOn: Bool) {
+        func audioSessionAdapterDidUpdateSpeakerOn(
+            _ speakerOn: Bool,
+            file: StaticString,
+            function: StaticString,
+            line: UInt
+        ) {
             updatedSpeakerOn = speakerOn
         }
     }

StreamVideoTests/WebRTC/v2/WebRTCStateAdapter_Tests.swift

@@ -831,7 +831,10 @@ final class WebRTCStateAdapter_Tests: XCTestCase, @unchecked Sendable {
         }
 
         subject.audioSessionAdapterDidUpdateSpeakerOn(
-            true
+            true,
+            file: #file,
+            function: #function,
+            line: #line
         )
 
         await fulfillment { await self.subject.callSettings.speakerOn }