Merge branch 'main' into MF-781/update-pre-commit-hook-and-update-set…

…up-script

Package.resolved

@@ -45,15 +45,6 @@
         "version" : "1.6.1"
       }
     },
-    {
-      "identity" : "swiftlintplugin",
-      "kind" : "remoteSourceControl",
-      "location" : "https://github.com/lukepistrol/SwiftLintPlugin",
-      "state" : {
-        "revision" : "5a65f4074975f811da666dfe31a19850950b1ea4",
-        "version" : "0.56.2"
-      }
-    },
     {
       "identity" : "swxmlhash",
       "kind" : "remoteSourceControl",

Package.swift

@@ -44,16 +44,12 @@ let package = Package(
 		.package(url: "https://github.com/drmohundro/SWXMLHash.git", from: "7.0.2"),
 		.package(url: "https://github.com/kishikawakatsumi/KeychainAccess.git", from: "4.2.2"),
 		.package(url: "https://github.com/MobileNativeFoundation/Kronos.git", exact: "4.2.2"),
-		.package(url: "https://github.com/lukepistrol/SwiftLintPlugin", from: "0.54.0"),
 		.package(url: "https://github.com/apple/swift-log.git", from: "1.6.1"),
 		.package(url: "https://github.com/Flight-School/AnyCodable", from: "0.6.0"),
 	] + (shouldIncludeDocCPlugin ? [.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")] : []),
 	targets: [
 		.target(
-			name: "Template",
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
-			]
+			name: "Template"
 		),
 		.testTarget(
 			name: "TemplateTests",
@@ -67,19 +63,13 @@ let package = Package(
 				.AnyCodable,
 				.auth,
 				.common,
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 		.target(
 			name: "Common",
 			dependencies: [
 				.Logging,
 				.AnyCodable,
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 		.testTarget(
@@ -95,9 +85,6 @@ let package = Package(
 				.GRDB,
 				.SWXMLHash,
 				.auth,
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 		.testTarget(
@@ -114,9 +101,6 @@ let package = Package(
 				.common,
 				.KeychainAccess,
 				.Logging,
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 		.testTarget(
@@ -136,9 +120,6 @@ let package = Package(
 			],
 			resources: [
 				.process("README.md"),
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 		.testTarget(
@@ -150,9 +131,6 @@ let package = Package(
 			],
 			resources: [
 				.process("Resources"),
-			],
-			plugins: [
-				.plugin(name: "SwiftLint", package: "SwiftLintPlugin"),
 			]
 		),
 	]

Sources/Auth/Login/LoginRepository.swift

@@ -11,7 +11,7 @@ final class LoginRepository {
 	private let tokensStore: TokensStore
 	private let exponentialBackoffPolicy: RetryPolicy
 	private let logger: TidalLogger?
-	
+
 	private var codeVerifier: String?
 
 	init(
@@ -74,7 +74,7 @@ final class LoginRepository {
 			case let .success(successData):
 				try saveTokens(response: successData)
 			case let .failure(error):
-				self.logger?.log(loggable: AuthLoggable.finalizeLoginNetworkError(error: error))
+				logger?.log(loggable: AuthLoggable.finalizeLoginNetworkError(error: error))
 			}
 
 			return response
@@ -113,9 +113,9 @@ final class LoginRepository {
 			deviceLoginPollHelper.prepareForPoll(interval: response.interval, maxDuration: response.expiresIn)
 			return response
 		}
-		
+
 		if case let .failure(error) = result {
-			self.logger?.log(loggable: AuthLoggable.initializeDeviceLoginNetworkError(error: error))
+			logger?.log(loggable: AuthLoggable.initializeDeviceLoginNetworkError(error: error))
 		}
 
 		return result
@@ -133,8 +133,9 @@ final class LoginRepository {
 		case let .success(successData):
 			try saveTokens(response: successData)
 		case let .failure(error):
-			let loggable = error.subStatus?.description.isSubStatus(status: .expiredAccessToken) == true ? AuthLoggable.finalizeDevicePollingLimitReached : AuthLoggable.finalizeDeviceLoginNetworkError(error: error)
-			self.logger?.log(loggable: loggable)
+			let loggable = error.subStatus?.description.isSubStatus(status: .expiredAccessToken) == true ? AuthLoggable
+				.finalizeDevicePollingLimitReached : AuthLoggable.finalizeDeviceLoginNetworkError(error: error)
+			logger?.log(loggable: loggable)
 		}
 
 		return response

Sources/Auth/Model/AuthLoggable.swift

@@ -63,25 +63,25 @@ extension AuthLoggable {
 
 		switch self {
 		case let .initializeDeviceLoginNetworkError(error),
-			let .finalizeLoginNetworkError(error),
-			let .finalizeDeviceLoginNetworkError(error),
-			let .getCredentialsUpgradeTokenNetworkError(error),
-			let .loadTokensFromStoreError(error):
+		     let .finalizeLoginNetworkError(error),
+		     let .finalizeDeviceLoginNetworkError(error),
+		     let .getCredentialsUpgradeTokenNetworkError(error),
+		     let .loadTokensFromStoreError(error):
 			metadata[Logger.Metadata.errorKey] = .string(.init(describing: error))
 		case let .getCredentialsRefreshTokenNetworkError(error, previousSubstatus),
-			let .getCredentialsRefreshTokenWithClientCredentialsNetworkError(error, previousSubstatus):
+		     let .getCredentialsRefreshTokenWithClientCredentialsNetworkError(error, previousSubstatus):
 			metadata[Logger.Metadata.errorKey] = .string(.init(describing: error))
 			metadata[Self.metadataPreviousSubstatusKey] = "\(previousSubstatus ?? "nil")"
 		case let .authLogout(reason, error, previousSubstatus):
 			metadata[Logger.Metadata.reasonKey] = "\(reason)"
-			if let error = error {
+			if let error {
 				metadata[Logger.Metadata.errorKey] = .string(.init(describing: error))
 			}
 			metadata[Self.metadataPreviousSubstatusKey] = "\(previousSubstatus ?? "nil")"
 		default:
 			break
 		}
-		
+
 		metadata[Logger.Metadata.codeKey] = .string(eventCode)
 
 		return metadata
@@ -95,11 +95,11 @@ extension AuthLoggable {
 			.error
 		}
 	}
-	
+
 	var source: String? {
 		"Auth"
 	}
-	
+
 	private var eventCode: String {
 		let intCode = switch self {
 		case .initializeDeviceLoginNetworkError:
@@ -129,7 +129,7 @@ extension AuthLoggable {
 		case .loadTokensFromStoreError:
 			13
 		}
-		
+
 		return intCode.description
 	}
 }

Sources/Auth/TidalAuth.swift

@@ -15,18 +15,20 @@ public class TidalAuth: Auth & CredentialsProvider {
 	) {
 		self.config = config
 
-		let tokensStore = DefaultTokensStore(credentialsKey: config.credentialsKey, credentialsAccessGroup: config.credentialsAccessGroup)
+		let tokensStore = DefaultTokensStore(
+			credentialsKey: config.credentialsKey,
+			credentialsAccessGroup: config.credentialsAccessGroup
+		)
 
-		let authLogger: TidalLogger?
-		if config.enableLogging {
-			authLogger = TidalLogger(label: "Auth", level: .trace)
+		let authLogger: TidalLogger? = if config.enableLogging {
+			TidalLogger(label: "Auth", level: .trace)
 		} else {
-			authLogger = nil
+			nil
 		}
 		loginRepository = provideLoginRepository(config, tokensStore: tokensStore, logger: authLogger)
 		tokenRepository = provideTokenRepository(config, tokensStore: tokensStore, logger: authLogger)
 	}
-	
+
 	private func provideLoginRepository(_ config: AuthConfig, tokensStore: TokensStore, logger: TidalLogger?) -> LoginRepository {
 		LoginRepository(
 			authConfig: config,
@@ -48,7 +50,7 @@ public class TidalAuth: Auth & CredentialsProvider {
 			tokensStore: tokensStore,
 			tokenService: DefaultTokenService(authBaseUrl: config.tidalAuthServiceBaseUri),
 			defaultBackoffPolicy: DefaultRetryPolicy(),
-			upgradeBackoffPolicy: DefaultRetryPolicy(), 
+			upgradeBackoffPolicy: DefaultRetryPolicy(),
 			logger: logger
 		)
 	}

Sources/Auth/TokenRepository.swift

@@ -89,7 +89,7 @@ struct TokenRepository {
 			) }
 		} else if let clientSecret = authConfig.clientSecret {
 			// if nothing is stored, we will try and refresh using a client secret
-			self.logger?.log(loggable: AuthLoggable.getCredentialsRefreshTokenIsNotAvailable)
+			logger?.log(loggable: AuthLoggable.getCredentialsRefreshTokenIsNotAvailable)
 
 			refreshCredentialsBlock = { await getClientAccessToken(clientSecret: clientSecret) }
 			networkErrorLoggableBlock = { AuthLoggable.getCredentialsRefreshTokenWithClientCredentialsNetworkError(
@@ -110,20 +110,23 @@ struct TokenRepository {
 			switch (authResult, networkErrorLoggableBlock) {
 			case let (.failure(error), _) where shouldLogoutWithLowerLevelTokenAfterUpdate(error: error):
 				if let loggable = logoutAfterErrorLoggableBlock?(error) {
-					self.logger?.log(loggable: loggable)
+					logger?.log(loggable: loggable)
 				}
 				return .success(.init(authConfig: authConfig))
 
 			case let (.failure(error), .some(networkErrorLoggableBlock)):
-				self.logger?.log(loggable: networkErrorLoggableBlock(error))
+				logger?.log(loggable: networkErrorLoggableBlock(error))
 
 			default: break
 			}
 
 			return authResult
 		}
 
-		self.logger?.log(loggable: AuthLoggable.authLogout(reason: "No refresh token or client secret available", previousSubstatus: apiErrorSubStatus))
+		logger?.log(loggable: AuthLoggable.authLogout(
+			reason: "No refresh token or client secret available",
+			previousSubstatus: apiErrorSubStatus
+		))
 		return logout()
 	}
 
@@ -162,10 +165,10 @@ struct TokenRepository {
 		switch result {
 		case let .success(tokens):
 			if tokens.credentials.token == nil {
-				self.logger?.log(loggable: AuthLoggable.getCredentialsUpgradeTokenNoTokenInResponse)
+				logger?.log(loggable: AuthLoggable.getCredentialsUpgradeTokenNoTokenInResponse)
 			}
 		case let .failure(error):
-			self.logger?.log(loggable: AuthLoggable.getCredentialsUpgradeTokenNetworkError(error: error))
+			logger?.log(loggable: AuthLoggable.getCredentialsUpgradeTokenNetworkError(error: error))
 		}
 
 		return result

Sources/Common/Logger/LoggerMetadata+Extension.swift

@@ -5,7 +5,7 @@ public extension Logger.Metadata {
 	init(stringDict: [String: String]) {
 		self = stringDict.mapValues { .string($0) }
 	}
-	
+
 	// Common keys that can be used in metadata for the sake of consistency
 	static let errorKey = "error"
 	static let codeKey = "code"

Sources/Common/Logger/TidalLoggable.swift

@@ -4,13 +4,14 @@ import Logging
 public protocol TidalLoggable {
 	/// Message you want to log
 	var loggingMessage: Logger.Message { get }
-	
+
 	/// Additional information attached to a log message
 	var loggingMetadata: Logger.Metadata { get }
-	
+
 	/// Level of a log message
 	var logLevel: Logger.Level { get }
-
-	/// The origin of a log message. If you don't provide it, it will be set automatically to the name of a calling module, which might not be intended
+
+	/// The origin of a log message. If you don't provide it, it will be set automatically to the name of a calling module, which
+	/// might not be intended
 	var source: String? { get }
 }

Sources/Common/Logger/TidalLogger.swift

@@ -1,24 +1,34 @@
 import Logging
 
+// MARK: - TidalLogger
+
 /// Struct abstraction for a logger offering a convenient API for logging.
 public struct TidalLogger {
 	private var logger: Logger
 
 	public init(label: String, level: Logger.Level = .trace) {
-		self.logger = Logger(label: label)
-		self.logger.logLevel = level
+		logger = Logger(label: label)
+		logger.logLevel = level
 	}
 }
 
 private extension TidalLogger {
-	func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata? = nil, source: String? = nil, file: String, function: String, line: UInt) {
-		self.logger.log(level: level, message, metadata: metadata, source: source, file: file, function: function, line: line)
+	func log(
+		level: Logger.Level,
+		message: Logger.Message,
+		metadata: Logger.Metadata? = nil,
+		source: String? = nil,
+		file: String,
+		function: String,
+		line: UInt
+	) {
+		logger.log(level: level, message, metadata: metadata, source: source, file: file, function: function, line: line)
 	}
 }
 
 public extension TidalLogger {
 	func log(loggable: TidalLoggable, file: String = #fileID, function: String = #function, line: UInt = #line) {
-		self.log(
+		log(
 			level: loggable.logLevel,
 			message: loggable.loggingMessage,
 			metadata: loggable.loggingMetadata,
@@ -28,11 +38,12 @@ public extension TidalLogger {
 			line: line
 		)
 	}
-	
+
 	/// Logs a string message
 	/// - Parameters:
 	///   - message: Message you want to log
-	///   - source: The origin of a log message. If you don't provide it, it will be set automatically to the name of a calling module, which might not be intended
+	///   - source: The origin of a log message. If you don't provide it, it will be set automatically to the name of a calling
+	/// module, which might not be intended
 	///   - level: Level of a log message
 	///   - metadata: Additional information attached to a log message
 	///   - file: The file this log message originates from (there's usually no need to pass it explicitly as it
@@ -52,8 +63,8 @@ public extension TidalLogger {
 	) {
 		let level = level ?? logger.logLevel
 		let loggerMessage = Logger.Message(stringLiteral: message)
-	
-		self.log(
+
+		log(
 			level: level,
 			message: loggerMessage,
 			metadata: metadata,

Sources/EventProducer/TidalEventSender.swift

@@ -118,8 +118,9 @@ public final class TidalEventSender: EventSender {
 		)
 		endOutage(eventName: event.name)
 	}
-
-	/// Used to explicitly send all events directly from the scheduler. Usage would depend on the client (ex. when app moves to the background)
+
+	/// Used to explicitly send all events directly from the scheduler. Usage would depend on the client (ex. when app moves to the
+	/// background)
 	public func sendAllEvents() async throws {
 		let headerHelper = HeaderHelper(credentialsProvider: config?.credentialsProvider)
 		do {

Sources/Player/Common/Data/AudioCodec.swift

@@ -91,7 +91,7 @@ public enum AudioCodec: Equatable, Codable {
 			}
 			switch mode {
 			// We can't know the exact codec, but the client does not need it.
-			case AudioMode.DOLBY_ATMOS, AudioMode.SONY_360RA: 
+			case AudioMode.DOLBY_ATMOS, AudioMode.SONY_360RA:
 				PlayerWorld.logger?.log(loggable: PlayerLoggable.audioCodecInitWithLowQualityAndUnsupportedMode(mode: mode.rawValue))
 				return nil
 			case AudioMode.STEREO: self = .HE_AAC_V1