chore: update comments

MailCore/API/MailApiFetcher/MailApiFetcher.swift

@@ -26,14 +26,15 @@ import Sentry
 import UIKit
 
 // TODO: move to Core and share with kDrive
-struct UserAgentBuilder {
-    func modelIdentifier() -> String {
+/// Something to construct a standard Infomaniak User-Agent
+public struct UserAgentBuilder {
+    func modelIdentifier() -> String? {
         if let simulatorModelIdentifier = ProcessInfo()
             .environment["SIMULATOR_MODEL_IDENTIFIER"] { return simulatorModelIdentifier }
         var sysinfo = utsname()
         uname(&sysinfo) // ignore return value
         return String(bytes: Data(bytes: &sysinfo.machine,
-                                  count: Int(_SYS_NAMELEN)), encoding: .ascii)!
+                                  count: Int(_SYS_NAMELEN)), encoding: .ascii)?
             .trimmingCharacters(in: .controlCharacters)
     }
 
@@ -44,28 +45,30 @@ struct UserAgentBuilder {
         return String(cString: archRaw)
     }
 
-    var userAgent: String {
+    /// The standard infomaniak app user agent
+    public var userAgent: String {
         let release = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String ?? "x.x.x"
         let build = Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") as? String ?? "x"
 
         let executableName = Bundle.main.bundleIdentifier ?? "com.infomaniak.x"
         let appVersion = "\(release)-\(build)"
-        let hardwareDevice = modelIdentifier()
+        let hardwareDevice = modelIdentifier() ?? "unknownModel"
 
-        let processInfo = ProcessInfo.processInfo
+        let operatingSystemVersion = ProcessInfo.processInfo.operatingSystemVersion
         let OSNameAndVersion =
-            "\(UIDevice.current.systemName) \(processInfo.operatingSystemVersion.majorVersion).\(processInfo.operatingSystemVersion.minorVersion).\(processInfo.operatingSystemVersion.patchVersion)"
+            "\(UIDevice.current.systemName) \(operatingSystemVersion.majorVersion).\(operatingSystemVersion.minorVersion).\(operatingSystemVersion.patchVersion)"
 
         let cpuArchitecture = microarchitecture() ?? "unknownArch"
 
         /// Something like:
-        /// `com.infomaniak.mail/1.0.5-1 (iPhone15,2; iOS16.4.0)`
-        /// `com.infomaniak.mail.ShareExtension/1.0.5-1 (iPhone15,2; iOS16.4.0)`
+        /// `com.infomaniak.mail/1.0.5-1 (iPhone15,2; iOS16.4.0; arm64e)`
+        /// `com.infomaniak.mail.ShareExtension/1.0.5-1 (iPhone15,2; iOS16.4.0; arm64e)`
         let userAgent = "\(executableName)/\(appVersion) (\(hardwareDevice); \(OSNameAndVersion); \(cpuArchitecture))"
         return userAgent
     }
 }
 
+/// Something to set the user agent for AF requests
 public class UserAgentAdapter: RequestAdapter {
     public static let userAgentKey = "User-Agent"