e918dc66ae
* Disable image and document picker integration tests as they randomly fail to load and are flakey. * Delete any pre-existing log files * Various tracing tweaks and fixes: - delete the custom tracing log levels as we can't control their ouput - implement comparable on them - change default levels only if the new chosen level increases their verbosity * Make logging targets mandatory and fix their logging levels * Switch back to using the `run_tests` reset simulator flag as `fastlane snapshot reset_simulators` was too generic and slow * Switch all integration test taps to `tapCenter` (nee forceTap) after noticing missed taps on CI. * Make the logging file prefix explicit, let the main app not use one. * Rename tracing configuration `target` to `currentTarget`
82 lines
3.3 KiB
Swift
82 lines
3.3 KiB
Swift
//
|
|
// Copyright 2022-2024 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
// Please see LICENSE in the repository root for full details.
|
|
//
|
|
|
|
import Foundation
|
|
import MatrixRustSDK
|
|
|
|
enum RustTracing {
|
|
/// The base filename used for log files. This may be suffixed by the target
|
|
/// name and other log management metadata during rotation.
|
|
static let filePrefix = "console"
|
|
/// The directory that stores all of the log files.
|
|
static var logsDirectory: URL {
|
|
if ProcessInfo.isRunningIntegrationTests {
|
|
"/Users/Shared"
|
|
} else {
|
|
.appGroupContainerDirectory
|
|
}
|
|
}
|
|
|
|
private(set) static var currentTracingConfiguration: TracingConfiguration?
|
|
static func setup(configuration: TracingConfiguration) {
|
|
currentTracingConfiguration = configuration
|
|
|
|
// Keep a minimum of 1 week of log files. In reality it will be longer
|
|
// as the app is unlikely to be running continuously.
|
|
let maxFiles: UInt64 = 24 * 7
|
|
|
|
// Log everything on integration tests to check whether
|
|
// the logs contain any sensitive data. See `UserFlowTests.swift`
|
|
let filter = if ProcessInfo.isRunningIntegrationTests {
|
|
TracingConfiguration(logLevel: .trace, currentTarget: "integrationtests", filePrefix: nil).filter
|
|
} else {
|
|
configuration.filter
|
|
}
|
|
|
|
setupTracing(config: .init(filter: filter,
|
|
writeToStdoutOrSystem: true,
|
|
writeToFiles: .init(path: logsDirectory.path(percentEncoded: false),
|
|
filePrefix: configuration.fileName,
|
|
fileSuffix: configuration.fileExtension,
|
|
maxFiles: maxFiles)))
|
|
}
|
|
|
|
/// 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] {
|
|
var logFiles = [(url: URL, modificationDate: Date)]()
|
|
|
|
let fileManager = FileManager.default
|
|
let enumerator = fileManager.enumerator(at: logsDirectory, includingPropertiesForKeys: [.contentModificationDateKey])
|
|
|
|
// Find all *.log files and their modification dates.
|
|
while let logURL = enumerator?.nextObject() as? URL {
|
|
guard let resourceValues = try? logURL.resourceValues(forKeys: [.contentModificationDateKey]),
|
|
let modificationDate = resourceValues.contentModificationDate
|
|
else { continue }
|
|
|
|
if logURL.lastPathComponent.hasPrefix(filePrefix) {
|
|
logFiles.append((logURL, modificationDate))
|
|
}
|
|
}
|
|
|
|
let sortedFiles = logFiles.sorted { $0.modificationDate > $1.modificationDate }.map(\.url)
|
|
|
|
MXLog.info("logFiles: \(sortedFiles.map(\.lastPathComponent))")
|
|
|
|
return sortedFiles
|
|
}
|
|
|
|
/// Delete all log files.
|
|
static func deleteLogFiles() {
|
|
let fileManager = FileManager.default
|
|
for logFileURL in logFiles {
|
|
try? fileManager.removeItem(at: logFileURL)
|
|
}
|
|
}
|
|
}
|