Live tracking for memory leaks

DemoApp/Sources/Components/MemoryLeaksViewer/MemoryLeaksViewer.swift

@@ -0,0 +1,63 @@
+//
+// Copyright © 2023 Stream.io Inc. All rights reserved.
+//
+
+import Foundation
+import SwiftUI
+import StreamVideo
+
+struct MemoryLeaksViewer: View {
+
+    @Injected(\.appearance) var appearance
+
+    @StateObject private var snapshot = MemorySnapshot(
+        includeDeallocatedObjects: false,
+        includeNotLeaked: false
+    )
+    @State private var entries: [MemorySnapshot.Entry] = []
+
+    var body: some View {
+        List {
+            ForEach(entries, id: \.typeName) { entry in
+                makeEntryView(for: entry)
+            }
+        }
+        .onReceive(snapshot.$items) { entries = $0 }
+        .navigationTitle("MemoryLeaks Viewer")
+        .modifier(
+            SearchableModifier { query in
+                if query.isEmpty {
+                    entries = snapshot.items
+                } else {
+                    entries = snapshot
+                        .items
+                        .filter { $0.typeName.contains(query) }
+                }
+            })
+    }
+
+    @ViewBuilder
+    func makeEntryView(for entry: MemorySnapshot.Entry) -> some View {
+        Label {
+            HStack {
+                Text(entry.typeName)
+                    .font(appearance.fonts.body)
+                    .foregroundColor(appearance.colors.text)
+                    .lineLimit(1)
+                    .frame(maxWidth: .infinity, alignment: .leading)
+
+                Text("\(entry.refCount)/\(entry.maxCount)")
+                    .font(appearance.fonts.caption1)
+                    .foregroundColor(appearance.colors.text)
+                    .lineLimit(1)
+            }
+        } icon: {
+            if entry.refCount > entry.maxCount {
+                Image(systemName: "exclamationmark.triangle")
+                    .foregroundColor(appearance.colors.accentRed)
+            } else {
+                EmptyView()
+            }
+        }
+    }
+}

DemoApp/Sources/Views/CallTopView/DemoCallTopView.swift

@@ -18,6 +18,9 @@ struct DemoCallTopView: View {
     @ObservedObject var appState = AppState.shared
     @State var sharingPopupDismissed = false
 
+    @State private var isLogsViewerVisible: Bool = false
+    @State private var isMemoryLeaksViewerVisible: Bool = false
+
     init(viewModel: CallViewModel) {
         self.viewModel = viewModel
     }
@@ -53,6 +56,13 @@ struct DemoCallTopView: View {
 
 
                 reactionsList()
+
+                if AppEnvironment.configuration == .debug {
+                    RealtimeDebugMenu(
+                        isLogsViewerVisible: $isLogsViewerVisible,
+                        isMemoryLeaksViewerVisible: $isMemoryLeaksViewerVisible
+                    )
+                }
             } label: {
                 Image(systemName: "ellipsis")
                     .foregroundColor(.white)
@@ -94,6 +104,8 @@ struct DemoCallTopView: View {
             .opacity(sharingPopupDismissed ? 0 : 1)
             : nil
         )
+        .sheet(isPresented: $isLogsViewerVisible) { NavigationView { MemoryLogViewer() } }
+        .sheet(isPresented: $isMemoryLeaksViewerVisible) { NavigationView { MemoryLeaksViewer() } }
     }
 
     private var hideLayoutMenu: Bool {

DemoApp/Sources/Views/Login/DebugMenu.swift

@@ -57,6 +57,7 @@ struct DebugMenu: View {
     }
 
     @State private var isLogsViewerVisible: Bool = false
+    @State private var isMemoryLeaksViewerVisible: Bool = false
 
     var body: some View {
         Menu {
@@ -96,24 +97,16 @@ struct DebugMenu: View {
                 label: "Performance Tracker"
             ) { self.performanceTrackerVisibility = $0 }
 
-            Button {
-                isLogsViewerVisible = true
-            } label: {
-                Label {
-                    Text("Show logs")
-                } icon: {
-                    Image(systemName: "text.insert")
-                }
-            }
-
+            RealtimeDebugMenu(
+                isLogsViewerVisible: $isLogsViewerVisible,
+                isMemoryLeaksViewerVisible: $isMemoryLeaksViewerVisible
+            )
         } label: {
             Image(systemName: "gearshape.fill")
                 .foregroundColor(colors.text)
-        }.sheet(isPresented: $isLogsViewerVisible) {
-            NavigationView {
-                MemoryLogViewer()
-            }
         }
+        .sheet(isPresented: $isLogsViewerVisible) { NavigationView { MemoryLogViewer() } }
+        .sheet(isPresented: $isMemoryLeaksViewerVisible) { NavigationView { MemoryLeaksViewer() } }
     }
 
     @ViewBuilder
@@ -168,3 +161,42 @@ struct DebugMenu: View {
         }
     }
 }
+
+struct RealtimeDebugMenu: View {
+
+    @Injected(\.colors) var colors
+
+    @Binding var isLogsViewerVisible: Bool
+    @Binding var isMemoryLeaksViewerVisible: Bool
+
+    var body: some View {
+        Menu {
+            Button {
+                isLogsViewerVisible = true
+            } label: {
+                Label {
+                    Text("Show logs")
+                } icon: {
+                    Image(systemName: "text.insert")
+                }
+            }
+
+            Button {
+                isMemoryLeaksViewerVisible = true
+            } label: {
+                Label {
+                    Text("Show MemoryLeaks")
+                } icon: {
+                    Image(systemName: "memorychip")
+                }
+            }
+        } label: {
+            Label {
+                Text("Realtime")
+            } icon: {
+                Image(systemName: "flowchart")
+            }
+            .foregroundColor(colors.text)
+        }
+    }
+}

Sources/StreamVideo/Call.swift

@@ -60,6 +60,8 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
         )
         self.callController.call = self
         self.subscribeToLocalCallSettingsChanges()
+
+        MemoryLeakDetector.track(self)
     }
 
     convenience internal init(

Sources/StreamVideo/CallSettings/CameraManager.swift

@@ -20,6 +20,8 @@ public final class CameraManager: ObservableObject, CallSettingsManager, @unchec
         self.callController = callController
         self.status = initialStatus
         self.direction = initialDirection
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Toggles the camera state.

Sources/StreamVideo/CallSettings/MicrophoneManager.swift

@@ -15,6 +15,8 @@ public final class MicrophoneManager: ObservableObject, CallSettingsManager, @un
     init(callController: CallController, initialStatus: CallSettingsStatus) {
         self.callController = callController
         self.status = initialStatus
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Toggles the microphone state.

Sources/StreamVideo/CallSettings/SpeakerManager.swift

@@ -20,6 +20,8 @@ public final class SpeakerManager: ObservableObject, CallSettingsManager, @unche
         self.callController = callController
         self.status = initialSpeakerStatus
         self.audioOutputStatus = initialAudioOutputStatus
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Toggles the speaker during a call.

Sources/StreamVideo/CallState.swift

@@ -82,7 +82,11 @@ public class CallState: ObservableObject {
 
     private var localCallSettingsUpdate = false
     private var durationTimer: Foundation.Timer?
-
+
+    public init() {
+        MemoryLeakDetector.track(self)
+    }
+
     internal func updateState(from event: VideoEvent) {
         switch event {
         case .typeBlockedUserEvent(let event):

Sources/StreamVideo/Controllers/CallController.swift

@@ -49,6 +49,8 @@ class CallController {
         self.environment = environment
         self.defaultAPI = defaultAPI
         self.cachedLocation = cachedLocation
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Joins a call with the provided information.

Sources/StreamVideo/Controllers/CallsController.swift

@@ -41,6 +41,8 @@ public class CallsController: ObservableObject {
         self.streamVideo = streamVideo
         self.subscribeToWatchEvents()
         self.subscribeToConnectionUpdates()
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Loads the next page of calls.

Sources/StreamVideo/HTTPClient/HTTPClient.swift

@@ -31,6 +31,8 @@ final class URLSessionClient: HTTPClient, @unchecked Sendable {
     ) {
         self.urlSession = urlSession
         self.tokenProvider = tokenProvider
+
+        MemoryLeakDetector.track(self)
     }
 
     func execute(request: URLRequest) async throws -> Data {

Sources/StreamVideo/HTTPClient/InternetConnection.swift

@@ -59,6 +59,8 @@ class InternetConnection {
         status = monitor.status
         monitor.delegate = self
         monitor.start()
+
+        MemoryLeakDetector.track(self)
     }
 
     deinit {
@@ -202,7 +204,11 @@ extension InternetConnection {
 
             return .available(quality)
         }
-
+
+        init() {
+            MemoryLeakDetector.track(self)
+        }
+
         deinit {
             stop()
         }

Sources/StreamVideo/Models/CallSettings.swift

@@ -33,6 +33,8 @@ public final class CallSettings: ObservableObject, Sendable {
         #else
         self.videoOn = videoOn
         #endif
+
+        MemoryLeakDetector.track(self)
     }
 
     public var shouldPublish: Bool {

Sources/StreamVideo/OpenApi/URLSessionTransport.swift

@@ -19,6 +19,8 @@ final class URLSessionTransport: DefaultAPITransport, @unchecked Sendable {
     ) {
         self.urlSession = urlSession
         self.tokenProvider = tokenProvider
+
+        MemoryLeakDetector.track(self)
     }
 
     func setTokenUpdater(_ tokenUpdater: @escaping UserTokenUpdater) {

Sources/StreamVideo/OpenApi/generated/APIs/DefaultAPI.swift

@@ -72,6 +72,8 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
         self.transport = transport
         self.middlewares = middlewares
         self.jsonDecoder = jsonDecoder
+
+        MemoryLeakDetector.track(self)
     }
 
     func send<Response: Codable>(

Sources/StreamVideo/StreamVideo.swift

@@ -162,6 +162,8 @@ public class StreamVideo: ObservableObject {
                 try await self.connectUser(isInitial: true)
             }
         }
+
+        MemoryLeakDetector.track(self)
     }
 
     /// Connects the current user.
@@ -242,7 +244,7 @@ public class StreamVideo: ObservableObject {
     public func disconnect() async {
         eventHandlers.removeAll()
 
-        await withCheckedContinuation { [webSocketClient] continuation in
+        await withCheckedContinuation { [weak webSocketClient] continuation in
             if let webSocketClient = webSocketClient {
                 webSocketClient.disconnect {
                     continuation.resume()
@@ -563,7 +565,7 @@ extension StreamVideo: ConnectionStateDelegate {
         case let .disconnected(source):
             if let serverError = source.serverError, serverError.isInvalidTokenError
                 || (source.serverError as? APIError)?.isTokenExpiredError == true {
-                Task {
+                Task { [weak webSocketClient] in
                     do {
                         guard let apiTransport = apiTransport as? URLSessionTransport else { return }
                         self.token = try await apiTransport.refreshToken()

Sources/StreamVideo/Utils/LocationFetcher.swift

@@ -4,7 +4,7 @@
 
 import Foundation
 
-class LocationFetcher {
+enum LocationFetcher {
 
     static func getLocation() async throws -> String {
         guard let url = URL(string: "https://hint.stream-io-video.com/") else {

Sources/StreamVideo/Utils/Logger/Logger.swift

@@ -17,7 +17,16 @@ public struct LogSubsystem: OptionSet {
     }
 
     /// All subsystems within the SDK.
-    public static let all: LogSubsystem = [.database, .httpRequests, .webSocket, .webRTC, .other, .offlineSupport]
+    public static let all: LogSubsystem = [
+        .database,
+        .httpRequests,
+        .webSocket,
+        .webRTC,
+        .other,
+        .offlineSupport,
+        .thermalState,
+        .memoryLeaks
+    ]
 
     /// The subsystem responsible for any other part of the SDK.
     /// This is the default subsystem value for logging, to be used when `subsystem` is not specified.
@@ -31,8 +40,12 @@ public struct LogSubsystem: OptionSet {
     public static let webSocket = Self(rawValue: 1 << 3)
     /// The subsystem responsible for offline support.
     public static let offlineSupport = Self(rawValue: 1 << 4)
-    // The subsustem responsible for web rtc.
+    /// The subsystem responsible for WebRTC.
     public static let webRTC = Self(rawValue: 1 << 5)
+    /// The subsystem responsible for ThermalState observation.
+    public static let thermalState = Self(rawValue: 1 << 6)
+    /// The subsystem responsible for memory leaks observation.
+    public static let memoryLeaks = Self(rawValue: 1 << 7)
 }
 
 public enum LogConfig {