Meshtastic-Apple/Meshtastic/Accessory/Accessory Manager/AccessoryManager+Connect.swift

//
//  AccessoryManager+Connect.swift
//  Meshtastic
//
//  Created by Jake Bordens on 7/24/25.
//

import Foundation
import OSLog
import MeshtasticProtobufs
import CoreBluetooth

private let maxRetries = 1
private let retryDelay: Duration = .seconds(2)

extension AccessoryManager {
	func connect(to device: Device, withConnection: Connection? = nil, wantConfig: Bool = true, wantDatabase: Bool = true, versionCheck: Bool = true) async throws {
		Logger.transport.info("AccessoryManager.connect(to: \(device.name, privacy: .public), withConnection: \(withConnection != nil), wantConfig: \(wantConfig), wantDatabase: \(wantDatabase), versionCheck: \(versionCheck))")
		// Prevent new connection if one is active
		if activeConnection != nil {
			throw AccessoryError.connectionFailed("Already connected to a device")
		}
		
		guard let transport = transportForType(device.transportType) else {
			throw AccessoryError.connectionFailed("No transport for type")
		}
		
		// Clear any errors from last time
		lastConnectionError = nil
		packetsSent = 0
		packetsReceived = 0
		expectedNodeDBSize = nil
		
		// Prepare to connect
		self.connectionStepper = SequentialSteps(maxRetries: maxRetries, retryDelay: retryDelay) {
			
			// Step 0
			Step { @MainActor retryAttempt in
				Logger.transport.info("🔗👟 [Connect] Starting connection to \(device.id, privacy: .public)")
				if retryAttempt > 0 {
					try await self.closeConnection() // clean-up before retries.
					self.updateState(.retrying(attempt: retryAttempt + 1))
					self.allowDisconnect = true
				} else {
					self.updateState(.connecting)
				}
				self.updateDevice(deviceId: device.id, key: \.connectionState, value: .connecting)
			}
			
			// Step 1: Setup the connection
			Step(timeout: .seconds(5)) { @MainActor _ in
				Logger.transport.info("🔗👟[Connect] Step 1: connection to \(device.id, privacy: .public)")
				do {
					let connection: Connection
					if let providedConnection = withConnection {
						connection = providedConnection
					} else {
						connection = try await transport.connect(to: device)
					}
					let eventStream = try await connection.connect()
					self.updateState(.communicating)
					self.connectionEventTask = Task {
						for await event in eventStream {
							self.didReceive(event)
						}
						Logger.transport.info("[Accessory] Event stream closed")
					}
					self.activeConnection = (device: device, connection: connection)
				} catch let error as CBError where error.code == .peerRemovedPairingInformation {
					await self.connectionStepper?.cancelCurrentlyExecutingStep(withError: AccessoryError.coreBluetoothError(error), cancelFullProcess: true)
				}
			}
			
			// Step 2: Send Heartbeat before wantConfig (config)
			Step { @MainActor _ in
				guard wantConfig else {
					Logger.transport.info("👟 [Connect] Step 2: wantConfig = false, skipping heartbeat")
					return
				}
				Logger.transport.info("💓👟 [Connect] Step 2: Send heartbeat")
				try await self.sendHeartbeat()
			}
			
			// Step 3: Send WantConfig (config)
			Step(timeout: .seconds(30)) { @MainActor _ in
				guard wantConfig else {
					Logger.transport.info("👟 [Connect] Step 4: wantConfig = false, skipping wantConfig")
					return
				}
				Logger.transport.info("🔗👟 [Connect] Step 3: Send wantConfig (config)")
				try await self.sendWantConfig()
			}
			
			// Step 4: Send Heartbeat before wantConfig (database)
			Step { @MainActor _ in
				guard wantDatabase else {
					Logger.transport.info("👟 [Connect] Step 4: wantDatabase = false, skipping heartbeat")
					return
				}
				Logger.transport.info("💓 [Connect] Step 4: Send heartbeat")
				try await self.sendHeartbeat()
			}
			
			// Step 5: Send WantConfig (database)
			Step(timeout: .seconds(3.0), onFailure: .retryStep(attempts: 3)) { @MainActor _ in
				guard wantDatabase else {
					Logger.transport.info("👟 [Connect] Step 5: wantDatabase = false, skipping wantDatabase")
					return
				}
				Logger.transport.info("🔗👟 [Connect] Step 5: Send wantConfig (database)")
				self.updateState(.retrievingDatabase(nodeCount: 0))
				self.allowDisconnect = true
				
				Logger.transport.info("🔗 Saving preferredPeripheralId: \(device.id.uuidString)")
				UserDefaults.preferredPeripheralId = device.id.uuidString
				
				try await self.sendWantDatabase()
			}
			
			// Step 5a: Wait for end of WantConfig (database)
			Step { @MainActor _ in
				guard wantDatabase else {
					Logger.transport.info("👟 [Connect] Step 4: wantDatabase = false, skipping waitForWantDatabase")
					return
				}
				Logger.transport.info("🔗👟 [Connect] Step 5a: Wait for the final database")
				try await self.waitForWantDatabaseResponse()
			}
			
			// Step 6: Version check
			Step { @MainActor _ in
				guard versionCheck else {
					Logger.transport.info("👟 [Connect] Step 6: versionCheck = false, skipping version check")
					return
				}
				Logger.transport.info("🔗👟 [Connect] Step 6: Version check")

				guard let firmwareVersion = self.activeConnection?.device.firmwareVersion else {
					Logger.transport.error("🔗 [Connect] Firmware version not available for device \(device.name, privacy: .public)")
					throw AccessoryError.connectionFailed("Firmware version not available")
				}
				
				let lastDotIndex = firmwareVersion.lastIndex(of: ".")
				if lastDotIndex == nil {
					throw AccessoryError.versionMismatch("🚨" + "Update Your Firmware".localized)
				}
				
				let version = firmwareVersion[...(lastDotIndex ?? String.Index(utf16Offset: 6, in: firmwareVersion))].dropLast()
				
				// TODO: do we really need to store the firmware version in the UserDefaults?
				UserDefaults.firmwareVersion = String(version)
				
				let supportedVersion = self.checkIsVersionSupported(forVersion: self.minimumVersion)
				if !supportedVersion {
					throw AccessoryError.connectionFailed("🚨" + "Update Your Firmware".localized)
				}
			}
			
			// Step 7: Update UI and status to connected
			Step { @MainActor _ in
				Logger.transport.info("🔗👟 [Connect] Step 7: Update Time, UI and status")
				// Send time to device
				try? await self.sendTime()
				
				// Allow disconnect here too
				self.allowDisconnect = true

				// We have an active connection
				self.updateDevice(deviceId: device.id, key: \.connectionState, value: .connected)
				self.updateState(.subscribed)
				
				// If we successfully connected to a manual connection, then save it to the list
				// Remember, Device is a value type (struct) so don't use use `device` here, thats
				// The value at the instantiation of the connect process.  We want the currently
				// updated device object in `activeConnection` with its additonal metadata from
				// NodeInfo packets.
				if let activeDevice = self.activeConnection?.device, activeDevice.isManualConnection {
					ManualConnectionList.shared.insert(device: activeDevice)
				}
			}
			
			// Step 8: Update UI and status to connected
			Step { @MainActor _ in
				Logger.transport.debug("🔗👟 [Connect] Step 8: Initialize MQTT and Location Provider")
				self.stopDiscovery()
				await self.initializeMqtt()
				self.initializeLocationProvider()
				if transport.requiresPeriodicHeartbeat {
					await self.setupPeriodicHeartbeat()
				}
				
				if let device = self.activeConnection?.device {
					var version: String?
					if let firmwareVersion = device.firmwareVersion {
						if let lastDotIndex = firmwareVersion.lastIndex(of: ".") {
							version = String(firmwareVersion[...(lastDotIndex)].dropLast())
						} else {
							version = firmwareVersion
						}
					}
				
					let connectionWasRestored = (withConnection != nil)
					Logger.datadog.action(.connect(firmwareVersion: version,
													transportType: device.transportType.rawValue,
												   hardwareModel: device.hardwareModel,
												   nodes: self.expectedNodeDBSize,
												  connectionRestored: connectionWasRestored))
				}
			}
		}
		
		// Run the connection process
		do {
			try await connectionStepper?.run()
			Logger.transport.debug("🔗 [Connect] ConnectionStepper completed.")
		} catch {
			Logger.transport.error("🔗 [Connect] Error returned by connectionStepper: \(error)")
			try await self.closeConnection()
			updateState(.discovering)
			self.lastConnectionError = error
		}
		
		// All done, one way or another, clean up
		self.connectionStepper = nil
	}
}

// Sequentially stepped tasks
typealias Step = SequentialSteps.Step
actor SequentialSteps {
	
	typealias StepClosure = @Sendable (_ retryAttempt: Int) async throws -> Void
	
	enum FailureBehavior {
		case fail
		case retryStep(attempts: Int)
		case retryAll
	}
	
	struct Step {
		let timeout: Duration?
		let failureBehavior: FailureBehavior
		let operation: StepClosure
		
		init(timeout: Duration? = nil, onFailure: FailureBehavior = .retryAll, operation: @escaping StepClosure) {
			self.timeout = timeout
			self.failureBehavior = onFailure
			self.operation = operation
		}
	}
	
	private enum SequentialStepError: Error, LocalizedError {
		case timeout(stepNumber: Int, afterWaiting: Duration)
		
		var errorDescription: String? {
			switch self {
			case .timeout(let stepNumber, let afterWaiting):
				return "Timeout after \(afterWaiting) waiting for step \(stepNumber)."
			}
		}
	}
	let steps: [Step]
	var currentlyExecutingStep: Task<Void, any Error>?
	var cancelled = false
	var maxRetries: Int
	var retryDelay: Duration
	var isRunning: Bool = false
	var externalError: Error?
	
	init(maxRetries: Int = 3, retryDelay: Duration = .seconds(3), @StepsBuilder _ builder: () -> [Step]) {
		self.maxRetries	= maxRetries
		self.retryDelay = retryDelay
		self.steps = builder()
	}
	
	func run() async throws {
		self.isRunning = true
		retryLoop: for attempt in 0..<maxRetries {
			for stepNumber in 0..<steps.count {
				if cancelled {
					throw externalError ?? CancellationError()
				}
				let currentStep = steps[stepNumber]
				let isRetry = (attempt > 0)
				if isRetry {
					try await Task.sleep(for: retryDelay)
				}
				do {
					let stepRetries = if case let .retryStep(attempts) = currentStep.failureBehavior, attempts > 0 { attempts } else { 1 }
					stepRetryLoop: for stepRetryAttempt in 0..<stepRetries {
						if stepRetryAttempt > 0 {
							Logger.transport.info("[Retry Step Loop] Retrying step \(stepNumber + 1) for the \(stepRetryAttempt + 1) time.")
							try await Task.sleep(for: retryDelay)
						}
						do {
							// Starting a new attempt for this step.
							if let duration = currentStep.timeout {
								// Execute this task with a timeout
								self.currentlyExecutingStep = executeWithTimeout(stepNumber: stepNumber, timeout: duration) {
									try await currentStep.operation(attempt)
								}
								try await self.currentlyExecutingStep!.value
							} else {
								// Execute this task without a timeout
								self.currentlyExecutingStep = Task {
									try await currentStep.operation(attempt)
								}
								try await self.currentlyExecutingStep!.value
							}
							break stepRetryLoop // Exit retry loop if successful
						} catch {
							if stepRetryAttempt == stepRetries - 1 {
								// If this is the last retry attempt, we throw the error to the outer loop
								throw error
							} else {
								switch error {
								case let SequentialStepError.timeout(stepNumber, afterWaiting):
									Logger.transport.info("[Inner Retry Step Loop] Sequential process timed out on step \(stepNumber) of \(stepRetries) after waiting \(afterWaiting)")
								case is CancellationError:
									if let externalError {
										// Something from the outside had an error which caused the cancellation of this step
										let errorToThrow = externalError
										self.externalError = nil
										throw errorToThrow
									}
									break stepRetryLoop
								default:
									Logger.transport.error("[Inner Retry Step Loop] Sequential process failed on step \(stepNumber) with error: \(error.localizedDescription, privacy: .public)")
								}
							}
						}
					}
				} catch {
					switch error {
					case let SequentialStepError.timeout(stepNumber, afterWaiting):
						Logger.transport.info("[Outer Step Retry Loop] Sequential process timed out on step \(stepNumber) after waiting \(afterWaiting)")
					default:
						Logger.transport.error("[Outer Step Retry Loop] Sequential process failed on step \(stepNumber) with error: \(error.localizedDescription, privacy: .public)")
					}
					switch currentStep.failureBehavior {
					case .retryAll, .retryStep:
						// TODO: we could have a .retryStepAndFail and a .retryStepAndContinue instead of just .retryStep to clarify the behavior here
						continue retryLoop
					case .fail:
						isRunning = false
						throw error
					}
				}
			}
			// We have finished all steps
			isRunning = false
			return
		}
		isRunning = false
		throw AccessoryError.tooManyRetries
	}
	
	func cancel() {
		cancelled = true
		self.currentlyExecutingStep?.cancel()
	}
	
	func cancelCurrentlyExecutingStep(withError: Error?, cancelFullProcess: Bool = false) {
		self.externalError = withError
		if cancelFullProcess {
			cancel()
		} else {
			self.currentlyExecutingStep?.cancel()
		}
	}
	
	func executeWithTimeout<ReturnType>(stepNumber: Int, timeout: Duration, operation: @escaping @Sendable () async throws -> ReturnType) -> Task<ReturnType, Error> {
		return Task {
			try await withThrowingTaskGroup(of: ReturnType.self) { group -> ReturnType in
				group.addTask(operation: operation)
				group.addTask {
					try await _Concurrency.Task.sleep(for: timeout)
					throw SequentialStepError.timeout(stepNumber: stepNumber, afterWaiting: timeout)
				}
				guard let success = try await group.next() else {
					throw SequentialStepError.timeout(stepNumber: stepNumber, afterWaiting: timeout)
				}
				group.cancelAll()
				return success
			}
		}
	}
	
	@resultBuilder
	struct StepsBuilder {
		static func buildBlock(_ components: Step...) -> [Step] {
			return components
		}
	}
}