Update the default logs directory and allow collection from elsewhere. (#4352)

* Replace deprecated URL methods. * Start putting log files in Library/Logs (moving existing files with a migration.) * Make Tracing.deleteLogFiles aware of the legacy logs location. * Allow the logs to be collected from a different directory.
2026-11-03 06:55:59 +00:00 · 2025-07-24 09:49:29 +01:00
parent 76e83462a8
commit d6f7607538
7 changed files with 73 additions and 23 deletions
@@ -401,9 +401,14 @@ class AppCoordinator: AppCoordinatorProtocol, AuthenticationFlowCoordinatorDeleg
        }
        
        if oldVersion < Version(1, 6, 7) {
-            Tracing.deleteLogFiles()
+            Tracing.deleteLogFiles(in: Tracing.legacyLogsDirectory)
            MXLog.info("Migrating to v1.6.7, log files have been wiped")
        }
+        
+        if oldVersion < Version(25, 7, 4) {
+            Tracing.migrateLogFiles()
+            MXLog.info("Migrating to version 25.07.4, log files have been moved.")
+        }
    }
    
    // This could be removed once the adoption of 25.06.x is widespread.
@@ -23,10 +23,17 @@ extension URL {
        
        return url
    }
+    
+    static var appGroupLogsDirectory: URL {
+        appGroupContainerDirectory
+            .appending(component: "Library", directoryHint: .isDirectory)
+            .appending(component: "Logs", directoryHint: .isDirectory)
+            .appending(component: InfoPlistReader.main.baseBundleIdentifier, directoryHint: .isDirectory)
+    }

    /// The base directory where all session data is stored.
    static var sessionsBaseDirectory: URL {
-        let applicationSupportSessionsURL = applicationSupportBaseDirectory.appendingPathComponent("Sessions", isDirectory: true)
+        let applicationSupportSessionsURL = applicationSupportBaseDirectory.appending(component: "Sessions", directoryHint: .isDirectory)
        
        try? FileManager.default.createDirectoryIfNeeded(at: applicationSupportSessionsURL)

@@ -36,9 +43,9 @@ extension URL {
    /// The base directory where all application support data is stored.
    static var applicationSupportBaseDirectory: URL {
        var url = appGroupContainerDirectory
-            .appendingPathComponent("Library", isDirectory: true)
-            .appendingPathComponent("Application Support", isDirectory: true)
-            .appendingPathComponent(InfoPlistReader.main.baseBundleIdentifier, isDirectory: true)
+            .appending(component: "Library", directoryHint: .isDirectory)
+            .appending(component: "Application Support", directoryHint: .isDirectory)
+            .appending(component: InfoPlistReader.main.baseBundleIdentifier, directoryHint: .isDirectory)

        try? FileManager.default.createDirectoryIfNeeded(at: url)
        
@@ -56,10 +63,10 @@ extension URL {
    /// The base directory where all application support data is stored.
    static var sessionCachesBaseDirectory: URL {
        let url = appGroupContainerDirectory
-            .appendingPathComponent("Library", isDirectory: true)
-            .appendingPathComponent("Caches", isDirectory: true)
-            .appendingPathComponent(InfoPlistReader.main.baseBundleIdentifier, isDirectory: true)
-            .appendingPathComponent("Sessions", isDirectory: true)
+            .appending(component: "Library", directoryHint: .isDirectory)
+            .appending(component: "Caches", directoryHint: .isDirectory)
+            .appending(component: InfoPlistReader.main.baseBundleIdentifier, directoryHint: .isDirectory)
+            .appending(component: "Sessions", directoryHint: .isDirectory)

        try? FileManager.default.createDirectoryIfNeeded(at: url)
        
@@ -75,7 +82,7 @@ extension URL {
    /// Make sure to manually tidy up any files you place in here once you've transferred them from one bundle to another.
    static var appGroupTemporaryDirectory: URL {
        let url = appGroupContainerDirectory
-            .appendingPathComponent("tmp", isDirectory: true)
+            .appending(component: "tmp", directoryHint: .isDirectory)

        try? FileManager.default.createDirectoryIfNeeded(at: url)
        
@@ -17,10 +17,16 @@ enum Tracing {
        if ProcessInfo.isRunningIntegrationTests {
            "/Users/Shared"
        } else {
-            .appGroupContainerDirectory
+            logsDirectoryOverride ?? .appGroupLogsDirectory
        }
    }
    
+    /// Set this to temporarily override the directory from which logs will be collected.
+    /// This basically only affects ``logFiles``, and doesn't inform the SDK to write
+    /// the logs to a different directory, which should be done before setting this.
+    static var logsDirectoryOverride: URL?
+    static var legacyLogsDirectory: URL { .appGroupContainerDirectory }
+    
    static let fileExtension = "log"
    
    static func buildConfiguration(logLevel: LogLevel, traceLogPacks: Set<TraceLogPack>,
@@ -52,13 +58,17 @@ enum Tracing {
                     sentryDsn: sentryURL?.absoluteString)
    }
    
-    /// A list of all log file URLs, sorted chronologically. This is only public for testing purposes, within
-    /// the app please use ``copyLogs(to:)`` so that the files are name appropriates for QuickLook.
-    static var logFiles: [URL] {
+    /// A list of all log file URLs, sorted chronologically.
+    static var logFiles: [URL] { logFiles(in: logsDirectory) }
+    
+    /// Collect all of the logs in the given directory, sorting them chronologically.
+    private static func logFiles(in directory: URL) -> [URL] {
        var logFiles = [(url: URL, modificationDate: Date)]()
        
        let fileManager = FileManager.default
-        let enumerator = fileManager.enumerator(at: logsDirectory, includingPropertiesForKeys: [.contentModificationDateKey])
+        let enumerator = fileManager.enumerator(at: directory,
+                                                includingPropertiesForKeys: [.contentModificationDateKey],
+                                                options: .skipsSubdirectoryDescendants)
        
        // Find all *.log files and their modification dates.
        while let logURL = enumerator?.nextObject() as? URL {
@@ -78,10 +88,38 @@ enum Tracing {
        return sortedFiles
    }
    
-    /// Delete all log files.
-    static func deleteLogFiles() {
+    static func migrateLogFiles() {
+        MXLog.info("Moving log files to \(logsDirectory)")
        let fileManager = FileManager.default
-        for logFileURL in logFiles {
+        let oldLogFiles = logFiles(in: legacyLogsDirectory)
+        
+        for oldFileURL in oldLogFiles {
+            do {
+                let newFileURL = logsDirectory.appending(component: oldFileURL.lastPathComponent)
+                try fileManager.moveItem(at: oldFileURL, to: newFileURL)
+                MXLog.info("Moved \(newFileURL.lastPathComponent)")
+            } catch {
+                MXLog.error("Failed to move \(oldFileURL.lastPathComponent): \(error.localizedDescription)")
+                
+                let nsError = error as NSError
+                if nsError.domain == NSCocoaErrorDomain, nsError.code == NSFileWriteFileExistsError {
+                    // By now there will already be some logs in the new directory, so there is likely to be
+                    // one log file that cannot be removed. As this is a one-off operation lets just delete it.
+                    MXLog.error("Attempting to delete log file \(oldFileURL.lastPathComponent)")
+                    try? fileManager.removeItem(at: oldFileURL)
+                }
+            }
+        }
+    }
+    
+    /// Delete all log files.
+    static func deleteLogFiles(in directory: URL) {
+        let fileManager = FileManager.default
+        
+        // We don't simply delete logsDirectory as once upon a time the logs
+        // we written to the very top-level of the app group container and
+        // there's a migration in place for old users of the app.
+        for logFileURL in logFiles(in: directory) {
            try? fileManager.removeItem(at: logFileURL)
        }
    }