SwiftLint

.github/workflows/ci.yaml

@@ -176,7 +176,12 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Install SwiftLint
+        run: brew install swiftlint
+      - name: SwiftLint
+        run: swiftlint lint --strict --reporter github-actions-logging
       - name: SwiftFormat Lint
+        if: always()
         run: swiftformat --lint . --reporter github-actions-log
         # Comes pre-installed on macOS runners
   build-docs:

.swiftlint.yml

@@ -0,0 +1,17 @@
+excluded:
+  - Sources/LiveKit/Protos
+
+disabled_rules:
+  - todo
+  - nesting
+  - identifier_name
+  - multiple_closures_with_trailing_closure
+  # SwiftFormat conflicts
+  - trailing_comma
+  - line_length
+  - opening_brace
+
+type_name:
+  excluded:
+    - ID
+    - OS

Sources/LiveKit/Audio/AudioDeviceModuleDelegateAdapter.swift

@@ -70,12 +70,14 @@ class AudioDeviceModuleDelegateAdapter: NSObject, LKRTCAudioDeviceModuleDelegate
         return entryPoint?.engineWillRelease(engine) ?? 0
     }
 
+    // swiftlint:disable:next function_parameter_count
     func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureInputFromSource src: AVAudioNode?, toDestination dst: AVAudioNode, format: AVAudioFormat, context: [AnyHashable: Any]) -> Int {
         guard let audioManager else { return 0 }
         let entryPoint = audioManager.buildEngineObserverChain()
         return entryPoint?.engineWillConnectInput(engine, src: src, dst: dst, format: format, context: context) ?? 0
     }
 
+    // swiftlint:disable:next function_parameter_count
     func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureOutputFromSource src: AVAudioNode, toDestination dst: AVAudioNode?, format: AVAudioFormat, context: [AnyHashable: Any]) -> Int {
         guard let audioManager else { return 0 }
         let entryPoint = audioManager.buildEngineObserverChain()

Sources/LiveKit/Audio/Manager/AudioManager.swift

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// swiftlint:disable file_length
+
 import Accelerate
 import AVFoundation
 import Combine

Sources/LiveKit/Broadcast/IPC/IPCChannel.swift

@@ -114,7 +114,7 @@ final class IPCChannel: Sendable {
             guard let rawMessage = try await upstream.next() else {
                 return nil
             }
-            let (data, context, isComplete) = rawMessage
+            let (data, context, isComplete) = (rawMessage.data, rawMessage.context, rawMessage.isComplete)
             guard let data, isComplete else { return nil }
 
             guard let payloadSize = context?.ipcMessagePayloadSize,
@@ -223,7 +223,11 @@ private extension NWConnection {
         AsyncMessageSequence(connection: self)
     }
 
-    typealias IncomingMessage = (Data?, NWConnection.ContentContext?, Bool)
+    struct IncomingMessage {
+        let data: Data?
+        let context: NWConnection.ContentContext?
+        let isComplete: Bool
+    }
 
     struct AsyncMessageSequence: AsyncSequence, AsyncIteratorProtocol {
         let connection: NWConnection
@@ -243,7 +247,7 @@ private extension NWConnection {
         try await withCheckedThrowingContinuation { [weak self] continuation in
             self?.receiveMessage { data, context, isComplete, error in
                 guard let error else {
-                    continuation.resume(returning: (data, context, isComplete))
+                    continuation.resume(returning: IncomingMessage(data: data, context: context, isComplete: isComplete))
                     return
                 }
                 continuation.resume(throwing: error)

Sources/LiveKit/Broadcast/IPC/IPCProtocol.swift

@@ -47,7 +47,7 @@ final class IPCProtocol: NWProtocolFramerImplementation, Loggable {
 
     func handleInput(framer: NWProtocolFramer.Instance) -> Int {
         while true {
-            var tempHeader: Header? = nil
+            var tempHeader: Header?
             let parsed = framer.parseInput(
                 minimumIncompleteLength: Header.encodedSize,
                 maximumLength: Header.encodedSize

Sources/LiveKit/Core/DataChannelPair.swift

@@ -14,18 +14,21 @@
  * limitations under the License.
  */
 
+// swiftlint:disable file_length
+
 import DequeModule
 import Foundation
 
 internal import LiveKitWebRTC
 
 // MARK: - Internal delegate
 
-protocol DataChannelDelegate: Sendable {
+protocol DataChannelDelegate: AnyObject, Sendable {
     func dataChannel(_ dataChannelPair: DataChannelPair, didReceiveDataPacket dataPacket: Livekit_DataPacket)
     func dataChannel(_ dataChannelPair: DataChannelPair, didFailToDecryptDataPacket dataPacket: Livekit_DataPacket, error: LiveKitError)
 }
 
+// swiftlint:disable:next type_body_length
 class DataChannelPair: NSObject, @unchecked Sendable, Loggable {
     // MARK: - Public
 
@@ -133,6 +136,7 @@ class DataChannelPair: NSObject, @unchecked Sendable, Loggable {
 
     // MARK: - Event handling
 
+    // swiftlint:disable:next cyclomatic_complexity
     private func handleEvents(
         events: AsyncStream<ChannelEvent>
     ) async {
@@ -476,7 +480,7 @@ private extension DataChannelPair.ChannelKind {
 
 private extension LKRTCDataChannel {
     var kind: DataChannelPair.ChannelKind {
-        guard label == LKRTCDataChannel.labels.lossy else {
+        guard label == LKRTCDataChannel.Labels.lossy else {
             return .reliable
         }
         return .lossy

Sources/LiveKit/Core/Room+DataStream.swift

@@ -69,8 +69,7 @@ public extension Room {
         onError: (@Sendable (Error) -> Void)?
     ) {
         Task {
-            do { try await registerByteStreamHandler(for: topic, onNewStream: onNewStream) }
-            catch { onError?(error) }
+            do { try await registerByteStreamHandler(for: topic, onNewStream: onNewStream) } catch { onError?(error) }
         }
     }
 
@@ -82,8 +81,7 @@ public extension Room {
         onError: (@Sendable (Error) -> Void)?
     ) {
         Task {
-            do { try await registerTextStreamHandler(for: topic, onNewStream: onNewStream) }
-            catch { onError?(error) }
+            do { try await registerTextStreamHandler(for: topic, onNewStream: onNewStream) } catch { onError?(error) }
         }
     }
 }

Sources/LiveKit/Core/Room+Engine.swift

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// swiftlint:disable file_length
+
 import Foundation
 
 #if canImport(Network)
@@ -113,6 +115,7 @@ extension Room {
 // MARK: - Internal
 
 extension Room {
+    // swiftlint:disable:next function_body_length
     func configureTransports(connectResponse: SignalClient.ConnectResponse) async throws {
         func makeConfiguration() -> LKRTCConfiguration {
             let connectOptions = _state.connectOptions
@@ -169,10 +172,10 @@ extension Room {
 
             // data over pub channel for backwards compatibility
 
-            let reliableDataChannel = await publisher.dataChannel(for: LKRTCDataChannel.labels.reliable,
+            let reliableDataChannel = await publisher.dataChannel(for: LKRTCDataChannel.Labels.reliable,
                                                                   configuration: RTC.createDataChannelConfiguration())
 
-            let lossyDataChannel = await publisher.dataChannel(for: LKRTCDataChannel.labels.lossy,
+            let lossyDataChannel = await publisher.dataChannel(for: LKRTCDataChannel.Labels.lossy,
                                                                configuration: RTC.createDataChannelConfiguration(ordered: false, maxRetransmits: 0))
 
             publisherDataChannel.set(reliable: reliableDataChannel)
@@ -268,6 +271,7 @@ extension Room {
         log("\(_state.connectStopwatch)")
     }
 
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     func startReconnect(reason: StartReconnectReason, nextReconnectMode: ReconnectMode? = nil) async throws {
         log("[Connect] Starting, reason: \(reason)")
 

Sources/LiveKit/Core/Room+EngineDelegate.swift

@@ -19,6 +19,7 @@ import Foundation
 internal import LiveKitWebRTC
 
 extension Room {
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     func engine(_: Room, didMutateState state: Room.State, oldState: Room.State) {
         if state.connectionState != oldState.connectionState {
             // connectionState did update

Sources/LiveKit/Core/Room+TransportDelegate.swift

@@ -108,8 +108,8 @@ extension Room: TransportDelegate {
 
         if _state.isSubscriberPrimary, transport.target == .subscriber {
             switch dataChannel.label {
-            case LKRTCDataChannel.labels.reliable: subscriberDataChannel.set(reliable: dataChannel)
-            case LKRTCDataChannel.labels.lossy: subscriberDataChannel.set(lossy: dataChannel)
+            case LKRTCDataChannel.Labels.reliable: subscriberDataChannel.set(reliable: dataChannel)
+            case LKRTCDataChannel.Labels.lossy: subscriberDataChannel.set(lossy: dataChannel)
             default: log("Unknown data channel label \(dataChannel.label)", .warning)
             }
         }

Sources/LiveKit/Core/Room.swift

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// swiftlint:disable file_length
+
 import Combine
 import Foundation
 
@@ -22,6 +24,7 @@ import Network
 #endif
 
 @objc
+// swiftlint:disable:next type_body_length
 public class Room: NSObject, @unchecked Sendable, ObservableObject, Loggable {
     // MARK: - MulticastDelegate
 
@@ -213,6 +216,7 @@ public class Room: NSObject, @unchecked Sendable, ObservableObject, Loggable {
     }
 
     @objc
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     public init(delegate: RoomDelegate? = nil,
                 connectOptions: ConnectOptions? = nil,
                 roomOptions: RoomOptions? = nil)
@@ -312,6 +316,7 @@ public class Room: NSObject, @unchecked Sendable, ObservableObject, Loggable {
     }
 
     @objc
+    // swiftlint:disable:next function_body_length
     public func connect(url: String,
                         token: String,
                         connectOptions: ConnectOptions? = nil,

Sources/LiveKit/Core/SignalClient.swift

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// swiftlint:disable file_length
+
 import Foundation
 
 internal import LiveKitWebRTC
@@ -107,6 +109,7 @@ actor SignalClient: Loggable {
     }
 
     @discardableResult
+    // swiftlint:disable:next function_body_length
     func connect(_ url: URL,
                  _ token: String,
                  connectOptions: ConnectOptions? = nil,
@@ -269,6 +272,7 @@ private extension SignalClient {
         }
     }
 
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     func _process(signalResponse: Livekit_SignalResponse) async {
         guard connectionState != .disconnected else {
             log("connectionState is .disconnected", .error)

Sources/LiveKit/DataStream/Outgoing/ByteStreamWriter.swift

@@ -79,17 +79,15 @@ public extension ByteStreamWriter {
     @available(*, unavailable, message: "Use async write(_:) method instead.")
     func write(_ data: Data, completion: @Sendable @escaping (Error?) -> Void) {
         Task {
-            do { try await write(data) }
-            catch { completion(error) }
+            do { try await write(data) } catch { completion(error) }
         }
     }
 
     @objc
     @available(*, unavailable, message: "Use async close(reason:) method instead.")
     func close(reason: String?, completion: @Sendable @escaping (Error?) -> Void) {
         Task {
-            do { try await close(reason: reason) }
-            catch { completion(error) }
+            do { try await close(reason: reason) } catch { completion(error) }
         }
     }
 }

Sources/LiveKit/DataStream/Outgoing/TextStreamWriter.swift

@@ -64,17 +64,15 @@ public extension TextStreamWriter {
     @available(*, unavailable, message: "Use async write(_:) method instead.")
     func write(_ text: String, onCompletion: @Sendable @escaping (Error?) -> Void) {
         Task {
-            do { try await write(text) }
-            catch { onCompletion(error) }
+            do { try await write(text) } catch { onCompletion(error) }
         }
     }
 
     @objc
     @available(*, unavailable, message: "Use async close(reason:) method instead.")
     func close(reason: String?, onCompletion: @Sendable @escaping (Error?) -> Void) {
         Task {
-            do { try await close(reason: reason) }
-            catch { onCompletion(error) }
+            do { try await close(reason: reason) } catch { onCompletion(error) }
         }
     }
 }

Sources/LiveKit/Extensions/LKRTCRtpSender.swift

@@ -28,7 +28,7 @@ extension LKRTCRtpSender: Loggable {
 
         // For SVC mode...
         if let firstEncoding = encodings.first,
-           let _ = ScalabilityMode.fromString(firstEncoding.scalabilityMode)
+           ScalabilityMode.fromString(firstEncoding.scalabilityMode) != nil
         {
             let _enabled = qualities.highest != .off
             if firstEncoding.isActive != _enabled {

Sources/LiveKit/Extensions/PixelBuffer.swift

@@ -60,6 +60,7 @@ public extension CVPixelBuffer {
 }
 
 public extension CMSampleBuffer {
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     static func from(_ pixelBuffer: CVPixelBuffer) -> CMSampleBuffer? {
         var sampleBuffer: CMSampleBuffer?
 
@@ -179,6 +180,7 @@ public extension Data {
 
 extension OSType {
     // Get string representation of CVPixelFormatType
+    // swiftlint:disable:next function_body_length
     func toString() -> String {
         let types = [
             kCVPixelFormatType_TwoComponent8: "kCVPixelFormatType_TwoComponent8",

Sources/LiveKit/Extensions/RTCDataChannel+Util.swift

@@ -19,7 +19,7 @@ import Foundation
 internal import LiveKitWebRTC
 
 extension LKRTCDataChannel {
-    enum labels {
+    enum Labels {
         static let reliable = "_reliable"
         static let lossy = "_lossy"
     }

Sources/LiveKit/Extensions/RTCI420Buffer.swift

@@ -19,6 +19,7 @@ import Foundation
 internal import LiveKitWebRTC
 
 extension LKRTCI420Buffer {
+    // swiftlint:disable:next function_body_length
     func toPixelBuffer() -> CVPixelBuffer? {
         // default options
         let options = [

Sources/LiveKit/LiveKit+DeviceHelpers.swift

@@ -44,7 +44,11 @@ public extension LiveKitSDK {
     /// Blocking version of ensureDeviceAccess that uses DispatchGroup to wait for permissions.
     static func ensureDeviceAccessSync(for types: Set<AVMediaType>) -> Bool {
         let group = DispatchGroup()
-        var result = true
+        #if swift(>=6.0)
+        nonisolated(unsafe) var result = false
+        #else
+        var result = false
+        #endif
 
         for type in types {
             if ![.video, .audio].contains(type) {