@ -5,6 +5,319 @@
import Foundation
import SignalCoreKit
// MARK: - L o g
public enum Log {
fileprivate typealias LogInfo = ( level : Log . Level , message : String , withPrefixes : Bool , silenceForTests : Bool )
public enum Level {
case trace
case debug
case info
case warn
case error
case critical
case off
}
private static var logger : Atomic < Logger ? > = Atomic ( nil )
private static var pendingStartupLogs : Atomic < [ LogInfo ] > = Atomic ( [ ] )
public static func setup ( with logger : Logger ) {
logger . retrievePendingStartupLogs = {
pendingStartupLogs . mutate { pendingStartupLogs in
let logs : [ LogInfo ] = pendingStartupLogs
pendingStartupLogs = [ ]
return logs
}
}
Log . logger . mutate { $0 = logger }
}
public static func enterForeground ( ) {
guard logger . wrappedValue != nil else { return }
OWSLogger . info ( " " )
OWSLogger . info ( " " )
}
public static func logFilePath ( ) -> String ? {
guard
let logger : Logger = logger . wrappedValue
else { return nil }
return logger . fileLogger . logFileManager . sortedLogFilePaths . first
}
public static func flush ( ) {
DDLog . flushLog ( )
}
// MARK: - L o g F u n c t i o n s
public static func trace (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . trace , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func debug (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . debug , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func info (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . info , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func warn (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . warn , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func error (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . error , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func critical (
_ message : String ,
withPrefixes : Bool = true ,
silenceForTests : Bool = false
) {
custom ( . critical , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
public static func custom (
_ level : Log . Level ,
_ message : String ,
withPrefixes : Bool ,
silenceForTests : Bool
) {
guard
let logger : Logger = logger . wrappedValue ,
logger . startupCompleted . wrappedValue
else { return pendingStartupLogs . mutate { $0 . append ( ( level , message , withPrefixes , silenceForTests ) ) } }
logger . log ( level , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
}
// MARK: - L o g g e r
public class Logger {
private let isRunningTests : Bool = ( ProcessInfo . processInfo . environment [ " XCTestConfigurationFilePath " ] = = nil )
private let primaryPrefix : String
private let forceNSLog : Bool
fileprivate let fileLogger : DDFileLogger
fileprivate let startupCompleted : Atomic < Bool > = Atomic ( false )
fileprivate var retrievePendingStartupLogs : ( ( ) -> [ Log . LogInfo ] ) ?
public init (
primaryPrefix : String ,
customDirectory : String ? = nil ,
forceNSLog : Bool = false
) {
self . primaryPrefix = primaryPrefix
self . forceNSLog = forceNSLog
switch customDirectory {
case . none : self . fileLogger = DDFileLogger ( )
case . some ( let customDirectory ) :
let logFileManager : DDLogFileManagerDefault = DDLogFileManagerDefault ( logsDirectory : customDirectory )
self . fileLogger = DDFileLogger ( logFileManager : logFileManager )
}
self . fileLogger . rollingFrequency = kDayInterval // R e f r e s h e v e r y d a y
self . fileLogger . logFileManager . maximumNumberOfLogFiles = 3 // S a v e 3 d a y s ' l o g f i l e s
DDLog . add ( self . fileLogger )
// N o w t h a t w e a r e s e t u p w e s h o u l d l o a d t h e e x t e n s i o n l o g s w h i c h w i l l t h e n
// c o m p l e t e t h e s t a r t u p p r o c e s s w h e n c o m p l e t e d
self . loadExtensionLogs ( )
}
// MARK: - F u n c t i o n s
private func loadExtensionLogs ( ) {
// T h e e x t e n s i o n s w r i t e t h e i r l o g s t o t h e a p p s h a r e d d i r e c t o r y b u t t h e m a i n a p p w r i t e s
// t o a l o c a l d i r e c t o r y ( s o t h e y c a n b e e x p o r t e d v i a X C o d e ) - t h e b e l o w c o d e r e a d s a n y
// l o g s f r o m t h e s h a r e d d i r e c t l y a n d a t t e m p t s t o a d d t h e m t o t h e m a i n a p p l o g s t o m a k e
// d e b u g g i n g u s e r i s s u e s i n e x t e n s i o n s e a s i e r
DispatchQueue . global ( qos : . utility ) . async { [ weak self ] in
guard let currentLogFileInfo : DDLogFileInfo = self ? . fileLogger . currentLogFileInfo else {
self ? . completeStartup ( error : " Unable to retrieve current log file. " )
return
}
DDLog . loggingQueue . async {
let extensionInfo : [ ( dir : String , type : ExtensionType ) ] = [
( " \( OWSFileSystem . appSharedDataDirectoryPath ( ) ) /Logs/NotificationExtension " , . notification ) ,
( " \( OWSFileSystem . appSharedDataDirectoryPath ( ) ) /Logs/ShareExtension " , . share )
]
let extensionLogs : [ ( path : String , type : ExtensionType ) ] = extensionInfo . flatMap { dir , type -> [ ( path : String , type : ExtensionType ) ] in
guard let files : [ String ] = try ? FileManager . default . contentsOfDirectory ( atPath : dir ) else { return [ ] }
return files . map { ( " \( dir ) / \( $0 ) " , type ) }
}
do {
guard let fileHandle : FileHandle = FileHandle ( forWritingAtPath : currentLogFileInfo . filePath ) else {
throw StorageError . objectNotFound
}
// E n s u r e w e c l o s e t h e f i l e h a n d l e
defer { fileHandle . closeFile ( ) }
// M o v e t o t h e e n d o f t h e f i l e t o i n s e r t t h e l o g s
if #available ( iOS 13.4 , * ) { try fileHandle . seekToEnd ( ) }
else { fileHandle . seekToEndOfFile ( ) }
try extensionLogs
. grouped ( by : \ . type )
. forEach { type , value in
guard ! value . isEmpty else { return } // I g n o r e i f t h e r e a r e n o l o g s
guard
let typeNameStartData : Data = " 🧩 \( type . name ) -- Start \n " . data ( using : . utf8 ) ,
let typeNameEndData : Data = " 🧩 \( type . name ) -- End \n " . data ( using : . utf8 )
else { throw StorageError . invalidData }
var hasWrittenStartLog : Bool = false
// W r i t e t h e l o g s
try value . forEach { path , _ in
let logData : Data = try Data ( contentsOf : URL ( fileURLWithPath : path ) )
guard ! logData . isEmpty else { return } // I g n o r e e m p t y f i l e s
// W r i t e t h e t y p e s t a r t s e p a r a t o r i f n e e d e d
if ! hasWrittenStartLog {
if #available ( iOS 13.4 , * ) { try fileHandle . write ( contentsOf : typeNameStartData ) }
else { fileHandle . write ( typeNameStartData ) }
hasWrittenStartLog = true
}
// W r i t e t h e l o g d a t a t o t h e l o g f i l e
if #available ( iOS 13.4 , * ) { try fileHandle . write ( contentsOf : logData ) }
else { fileHandle . write ( logData ) }
// E x t e n s i o n l o g s h a v e b e e n w r i t e n t o t h e a p p l o g s , r e m o v e t h e m n o w
try ? FileManager . default . removeItem ( atPath : path )
}
// W r i t e t h e t y p e e n d s e p a r a t o r i f n e e d e d
if hasWrittenStartLog {
if #available ( iOS 13.4 , * ) { try fileHandle . write ( contentsOf : typeNameEndData ) }
else { fileHandle . write ( typeNameEndData ) }
}
}
}
catch {
self ? . completeStartup ( error : " Unable to write extension logs to current log file " )
return
}
self ? . completeStartup ( )
}
}
}
private func completeStartup ( error : String ? = nil ) {
let pendingLogs : [ Log . LogInfo ] = startupCompleted . mutate { startupCompleted in
startupCompleted = true
return ( retrievePendingStartupLogs ? ( ) ? ? [ ] )
}
// A f t e r c r e a t i n g a n e w l o g g e r w e w a n t t o l o g t w o e m p t y l i n e s t o m a k e i t e a s i e r t o r e a d
OWSLogger . info ( " " )
OWSLogger . info ( " " )
// A d d a n y l o g s t h a t w e r e p e n d i n g d u r i n g t h e s t a r t u p p r o c e s s
pendingLogs . forEach { level , message , withPrefixes , silenceForTests in
log ( level , message , withPrefixes : withPrefixes , silenceForTests : silenceForTests )
}
}
fileprivate func log (
_ level : Log . Level ,
_ message : String ,
withPrefixes : Bool ,
silenceForTests : Bool
) {
guard ! silenceForTests || ! isRunningTests else { return }
// S o r t o u t t h e p r e f i x e s
let logPrefix : String = {
guard withPrefixes else { return " " }
let prefixes : String = [
primaryPrefix ,
( Thread . isMainThread ? " Main " : nil ) ,
( DispatchQueue . isDBWriteQueue ? " DBWrite " : nil )
]
. compactMap { $0 }
. joined ( separator : " , " )
return " [ \( prefixes ) ] "
} ( )
// C l e a n u p t h e m e s s a g e i f n e e d e d ( r e p l a c e d o u b l e p e r i o d s w i t h s i n g l e , t r i m w h i t e s p a c e )
let logMessage : String = logPrefix
. appending ( message )
. replacingOccurrences ( of : " ... " , with : " ||| " )
. replacingOccurrences ( of : " .. " , with : " . " )
. replacingOccurrences ( of : " ||| " , with : " ... " )
. trimmingCharacters ( in : . whitespacesAndNewlines )
switch level {
case . off : return
case . trace : OWSLogger . verbose ( logMessage )
case . debug : OWSLogger . debug ( logMessage )
case . info : OWSLogger . info ( logMessage )
case . warn : OWSLogger . warn ( logMessage )
case . error , . critical : OWSLogger . error ( logMessage )
}
#if DEBUG
print ( logMessage )
#endif
if forceNSLog {
NSLog ( message )
}
}
}
// MARK: - C o n v e n i e n c e
private enum ExtensionType {
case share
case notification
var name : String {
switch self {
case . share : return " ShareExtension "
case . notification : return " NotificationExtension "
}
}
}
private extension DispatchQueue {
static var isDBWriteQueue : Bool {
// / T h e ` d i s p a t c h _ q u e u e _ g e t _ l a b e l ` f u n c t i o n i s u s e d t o g e t t h e l a b e l f o r a g i v e n D i s p a t c h Q u e u e , i n S w i f t t h i s
@ -22,27 +335,7 @@ private extension DispatchQueue {
}
}
// FIXME: R e m o v e t h i s o n c e e v e r y t h i n g h a s b e e n u p d a t e d t o u s e t h e n e w ` L o g . x ( ) ` m e t h o d s
public func SNLog ( _ message : String , forceNSLog : Bool = false ) {
let logPrefixes : String = [
" Session " ,
( Thread . isMainThread ? " Main " : nil ) ,
( DispatchQueue . isDBWriteQueue ? " DBWrite " : nil )
]
. compactMap { $0 }
. joined ( separator : " , " )
#if DEBUG
print ( " [ \( logPrefixes ) ] \( message ) " )
#endif
OWSLogger . info ( " [ \( logPrefixes ) ] \( message ) " )
if forceNSLog {
NSLog ( message )
}
}
public func SNLogNotTests ( _ message : String ) {
guard ProcessInfo . processInfo . environment [ " XCTestConfigurationFilePath " ] = = nil else { return }
SNLog ( message )
Log . info ( message )
}
Morgan Pretty
11 months ago