@ -12,11 +12,18 @@ import SessionSnodeKit
import SignalUtilitiesKit
import SessionUtilitiesKit
// MARK: - L o g . C a t e g o r y
private extension Log . Category {
static let cat : Log . Category = . create ( " NotificationServiceExtension " , defaultLevel : . info )
}
// MARK: - N o t i f i c a t i o n S e r v i c e E x t e n s i o n
public final class NotificationServiceExtension : UNNotificationServiceExtension {
// C a l l e d v i a t h e O S s o c r e a t e a d e f a u l t ' D e p e n d e n c i e s ' i n s t a n c e
private var dependencies : Dependencies = Dependencies . createEmpty ( )
private var startTime : CFTimeInterval = 0
private var fallbackRunId : String = " N/A " // s t r i n g l i n t : i g n o r e
private var contentHandler : ( ( UNNotificationContent ) -> Void ) ?
private var request : UNNotificationRequest ?
@ ThreadSafe private var hasCompleted : Bool = false
@ -32,9 +39,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// MARK: D i d r e c e i v e a r e m o t e p u s h n o t i f i c a t i o n r e q u e s t
override public func didReceive ( _ request : UNNotificationRequest , withContentHandler contentHandler : @ escaping ( UNNotificationContent ) -> Void ) {
let runId : String = UUID ( ) . uuidString
self . startTime = CACurrentMediaTime ( )
self . fallbackRunId = runId
self . contentHandler = contentHandler
self . request = request
@ -47,14 +52,14 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// A b o r t i f t h e m a i n a p p i s r u n n i n g
guard ! dependencies [ defaults : . appGroup , key : . isMainAppActive ] else {
return self . completeSilenty ( . ignoreDueToMainAppRunning , r unId: runId )
return self . completeSilenty ( . ignoreDueToMainAppRunning , r equestId: request . identifier )
}
guard let notificationContent = request . content . mutableCopy ( ) as ? UNMutableNotificationContent else {
return self . completeSilenty ( . ignoreDueToNoContentFromApple , r unId: runId )
return self . completeSilenty ( . ignoreDueToNoContentFromApple , r equestId: request . identifier )
}
Log . info ( " didReceive called with runId: \( runId ) . " )
Log . info ( . cat , " didReceive called with requestId: \( request . identifier ) . " )
// / C r e a t e t h e c o n t e x t i f w e d o n ' t h a v e i t ( n e e d e d b e f o r e _ a n y _ i n t e r a c t i o n w i t h t h e d a t a b a s e )
if ! dependencies [ singleton : . appContext ] . isValid {
@ -65,14 +70,12 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
// / A c t u a l l y p e r f o r m t h e s e t u p
DispatchQueue . main . sync {
self . performSetup ( runId : runId ) { [ weak self ] in
self ? . handleNotification ( notificationContent , runId : runId )
}
self . performSetup ( requestId : request . identifier ) { [ weak self ] in
self ? . handleNotification ( notificationContent , requestId : request . identifier )
}
}
private func handleNotification ( _ notificationContent : UNMutableNotificationContent , r un Id: String ) {
private func handleNotification ( _ notificationContent : UNMutableNotificationContent , r equest Id: String ) {
let ( maybeData , metadata , result ) = PushNotificationAPI . processNotification (
notificationContent : notificationContent ,
using : dependencies
@ -92,21 +95,21 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant : nil ,
threadDisplayName : nil ,
resolution : . errorProcessing ( result ) ,
r unId: run Id
r equestId: request Id
)
case ( . success , _ ) , ( . legacySuccess , _ ) , ( . failure , _ ) :
return self . completeSilenty ( . errorProcessing ( result ) , r unId: run Id)
return self . completeSilenty ( . errorProcessing ( result ) , r equestId: request Id)
// J u s t l o g i f t h e n o t i f i c a t i o n w a s t o o l o n g ( a ~ 2 k m e s s a g e s h o u l d b e a b l e t o f i t s o
// t h e s e w i l l m o s t c o m m o n l y b e c a l l o r c o n f i g m e s s a g e s )
case ( . successTooLong , _ ) :
return self . completeSilenty ( . ignoreDueToContentSize ( metadata ) , r unId: run Id)
return self . completeSilenty ( . ignoreDueToContentSize ( metadata ) , r equestId: request Id)
case ( . failureNoContent , _ ) : return self . completeSilenty ( . errorNoContent ( metadata ) , r unId: run Id)
case ( . legacyFailure , _ ) : return self . completeSilenty ( . errorNoContentLegacy , r unId: run Id)
case ( . failureNoContent , _ ) : return self . completeSilenty ( . errorNoContent ( metadata ) , r equestId: request Id)
case ( . legacyFailure , _ ) : return self . completeSilenty ( . errorNoContentLegacy , r equestId: request Id)
case ( . legacyForceSilent , _ ) :
return self . completeSilenty ( . ignoreDueToNonLegacyGroupLegacyNotification , r unId: run Id)
return self . completeSilenty ( . ignoreDueToNonLegacyGroupLegacyNotification , r equestId: request Id)
}
}
@ -242,7 +245,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
using : dependencies
)
return self ? . handleSuccessForIncomingCall ( db , for : callMessage , r unId: run Id)
return self ? . handleSuccessForIncomingCall ( db , for : callMessage , r equestId: request Id)
}
// P e r f o r m a n y r e q u i r e d p o s t - h a n d l i n g l o g i c
@ -294,8 +297,8 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
db . afterNextTransaction (
onCommit : { _ in self ? . completeSilenty ( . success ( metadata ) , r unId: run Id) } ,
onRollback : { _ in self ? . completeSilenty ( . errorTransactionFailure , r unId: run Id) }
onCommit : { _ in self ? . completeSilenty ( . success ( metadata ) , r equestId: request Id) } ,
onRollback : { _ in self ? . completeSilenty ( . errorTransactionFailure , r equestId: request Id) }
)
}
catch {
@ -307,23 +310,23 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
DispatchQueue . main . async {
switch ( error , processedThreadVariant , metadata . namespace . isConfigNamespace ) {
case ( MessageReceiverError . noGroupKeyPair , _ , _ ) :
self ? . completeSilenty ( . errorLegacyGroupKeysMissing , r unId: run Id)
self ? . completeSilenty ( . errorLegacyGroupKeysMissing , r equestId: request Id)
case ( MessageReceiverError . outdatedMessage , _ , _ ) :
self ? . completeSilenty ( . ignoreDueToOutdatedMessage , r unId: run Id)
self ? . completeSilenty ( . ignoreDueToOutdatedMessage , r equestId: request Id)
case ( MessageReceiverError . ignorableMessage , _ , _ ) :
self ? . completeSilenty ( . ignoreDueToRequiresNoNotification , r unId: run Id)
self ? . completeSilenty ( . ignoreDueToRequiresNoNotification , r equestId: request Id)
case ( MessageReceiverError . duplicateMessage , _ , _ ) ,
( MessageReceiverError . duplicateControlMessage , _ , _ ) ,
( MessageReceiverError . duplicateMessageNewSnode , _ , _ ) :
self ? . completeSilenty ( . ignoreDueToDuplicateMessage , r unId: run Id)
self ? . completeSilenty ( . ignoreDueToDuplicateMessage , r equestId: request Id)
// / I f i t w a s a ` d e c r y p t i o n F a i l e d ` e r r o r , b u t i t w a s f o r a c o n f i g n a m e s p a c e t h e n j u s t f a i l s i l e n t l y ( d o n ' t
// / w a n t t o s h o w t h e f a l l b a c k n o t i f i c a t i o n i n t h i s c a s e )
case ( MessageReceiverError . decryptionFailed , _ , true ) :
self ? . completeSilenty ( . errorMessageHandling ( . decryptionFailed ) , r unId: run Id)
self ? . completeSilenty ( . errorMessageHandling ( . decryptionFailed ) , r equestId: request Id)
// / I f i t w a s a ` d e c r y p t i o n F a i l e d ` e r r o r f o r a g r o u p c o n v e r s a t i o n a n d t h e g r o u p d o e s n ' t e x i s t o r
// / d o e s n ' t h a v e a u t h i n f o ( i e . g r o u p d e s t r o y e d o r m e m b e r k i c k e d ) , t h e n j u s t f a i l s i l e n t l y ( d o n ' t w a n t
@ -336,7 +339,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
group . authData != nil
)
else {
self ? . completeSilenty ( . errorMessageHandling ( . decryptionFailed ) , r unId: run Id)
self ? . completeSilenty ( . errorMessageHandling ( . decryptionFailed ) , r equestId: request Id)
return
}
@ -347,7 +350,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant : processedThreadVariant ,
threadDisplayName : threadDisplayName ,
resolution : . errorMessageHandling ( . decryptionFailed ) ,
r unId: run Id
r equestId: request Id
)
case ( let msgError as MessageReceiverError , _ , _ ) :
@ -357,7 +360,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant : processedThreadVariant ,
threadDisplayName : threadDisplayName ,
resolution : . errorMessageHandling ( msgError ) ,
r unId: run Id
r equestId: request Id
)
default :
@ -367,7 +370,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant : processedThreadVariant ,
threadDisplayName : threadDisplayName ,
resolution : . errorOther ( error ) ,
r unId: run Id
r equestId: request Id
)
}
}
@ -384,12 +387,13 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// MARK: S e t u p
private func performSetup ( r un Id: String , completion : @ escaping ( ) -> Void ) {
Log . info ( " Performing setup for runId: \( run ) . " )
private func performSetup ( r equest Id: String , completion : @ escaping ( ) -> Void ) {
Log . info ( . cat , " Performing setup for requestId: \( request ) . " )
dependencies . warmCache ( cache : . appVersion )
AppSetup . setupEnvironment (
requestId : requestId ,
appSpecificBlock : { [ dependencies ] in
// s t r i n g l i n t : i g n o r e _ s t a r t
Log . setup ( with : Logger (
@ -416,12 +420,12 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
} ,
migrationsCompletion : { [ weak self , dependencies ] result in
switch result {
case . failure ( let error ) : self ? . completeSilenty ( . errorDatabaseMigrations ( error ) , r unId: run Id)
case . failure ( let error ) : self ? . completeSilenty ( . errorDatabaseMigrations ( error ) , r equestId: request Id)
case . success :
DispatchQueue . main . async {
// E n s u r e s t o r a g e i s a c t u a l l y v a l i d
guard dependencies [ singleton : . storage ] . isValid else {
self ? . completeSilenty ( . errorDatabaseInvalid , r unId: run Id)
self ? . completeSilenty ( . errorDatabaseInvalid , r equestId: request Id)
return
}
@ -431,7 +435,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// s o i t i s p o s s i b l e t h a t c o u l d c h a n g e i n t h e f u t u r e . I f i t d o e s , d o n o t h i n g
// a n d d o n ' t d i s t u r b t h e u s e r . M e s s a g e s w i l l b e p r o c e s s e d w h e n t h e y o p e n t h e a p p .
guard dependencies [ singleton : . storage , key : . isReadyForAppExtensions ] else {
self ? . completeSilenty ( . errorNotReadyForExtensions , r unId: run Id)
self ? . completeSilenty ( . errorNotReadyForExtensions , r equestId: request Id)
return
}
@ -454,10 +458,18 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
override public func serviceExtensionTimeWillExpire ( ) {
// C a l l e d j u s t b e f o r e t h e e x t e n s i o n w i l l b e t e r m i n a t e d b y t h e s y s t e m .
// U s e t h i s a s a n o p p o r t u n i t y t o d e l i v e r y o u r " b e s t a t t e m p t " a t m o d i f i e d c o n t e n t , o t h e r w i s e t h e o r i g i n a l p u s h p a y l o a d w i l l b e u s e d .
completeSilenty ( . errorTimeout , r unId: fallbackRunId )
completeSilenty ( . errorTimeout , r equestId: ( request ? . identifier ? ? " N/A " ) ) // s t r i n g l i n t : i g n o r e
}
private func completeSilenty ( _ resolution : NotificationResolution , runId : String ) {
private func completeSilenty ( _ resolution : NotificationResolution , requestId : String ) {
// T h i s c a n b e c a l l e d f r o m w i t h i n d a t a b a s e t h r e a d s s o t o p r e v e n t b l o c k i n g a n d w e i r d
// b e h a v i o u r s m a k e s u r e t o s e n d i t t o t h e m a i n t h r e a d i n s t e a d
guard Thread . isMainThread else {
return DispatchQueue . main . async { [ weak self ] in
self ? . completeSilenty ( resolution , requestId : requestId )
}
}
// E n s u r e w e o n l y r u n t h i s o n c e
guard _hasCompleted . performUpdateAndMap ( { ( true , $0 ) } ) = = false else { return }
@ -474,8 +486,9 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
let duration : CFTimeInterval = ( CACurrentMediaTime ( ) - startTime )
Log . custom ( resolution . logLevel , [ , " \( resolution ) after \( . seconds ( duration ) , unit : . ms ) , r unId: \( run Id) . " )
Log . custom ( resolution . logLevel , [ .cat ], " \( resolution ) after \( . seconds ( duration ) , unit : . ms ) , r equestId: \( request Id) . " )
Log . flush ( )
Log . reset ( )
self . contentHandler ! ( silentContent )
}
@ -483,7 +496,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
private func handleSuccessForIncomingCall (
_ db : Database ,
for callMessage : CallMessage ,
r un Id: String
r equest Id: String
) {
if #available ( iOSApplicationExtension 14.5 , * ) , Preferences . isCallKitSupported {
guard let caller : String = callMessage . sender , let timestamp = callMessage . sentTimestampMs else { return }
@ -499,14 +512,14 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
CXProvider . reportNewIncomingVoIPPushPayload ( payload ) { error in
if let error = error {
Log . error ( " Failed to notify main app of call message: \( error ) . " )
Log . error ( . cat , " Failed to notify main app of call message: \( error ) . " )
dependencies [ singleton : . storage ] . read { db in
self ? . handleFailureForVoIP ( db , for : callMessage , r unId: run Id)
self ? . handleFailureForVoIP ( db , for : callMessage , r equestId: request Id)
}
}
else {
dependencies [ defaults : . appGroup , key : . lastCallPreOffer ] = Date ( )
self ? . completeSilenty ( . successCall , r unId: run Id)
self ? . completeSilenty ( . successCall , r equestId: request Id)
}
}
}
@ -517,11 +530,11 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
)
}
else {
self . handleFailureForVoIP ( db , for : callMessage , r unId: run Id)
self . handleFailureForVoIP ( db , for : callMessage , r equestId: request Id)
}
}
private func handleFailureForVoIP ( _ db : Database , for callMessage : CallMessage , r un Id: String ) {
private func handleFailureForVoIP ( _ db : Database , for callMessage : CallMessage , r equest Id: String ) {
let notificationContent = UNMutableNotificationContent ( )
notificationContent . userInfo = [ NotificationServiceExtension . isFromRemoteKey : true ]
notificationContent . title = Constants . app_name
@ -545,16 +558,16 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
UNUserNotificationCenter . current ( ) . add ( request ) { error in
if let error = error {
Log . error ( " Failed to add notification request due to error: \( error ) . " )
Log . error ( . cat , " Failed to add notification request for requestId: \( requestId ) due to error: \( error ) . " )
}
semaphore . signal ( )
}
semaphore . wait ( )
Log . info ( " Add remote notification request ." )
Log . info ( . cat , " Add remote notification request for requestId: \( requestId ) ." )
db . afterNextTransaction (
onCommit : { [ weak self ] _ in self ? . completeSilenty ( . errorCallFailure , r unId: run Id) } ,
onRollback : { [ weak self ] _ in self ? . completeSilenty ( . errorTransactionFailure , r unId: run Id) }
onCommit : { [ weak self ] _ in self ? . completeSilenty ( . errorCallFailure , r equestId: request Id) } ,
onRollback : { [ weak self ] _ in self ? . completeSilenty ( . errorTransactionFailure , r equestId: request Id) }
)
}
@ -564,24 +577,42 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant : SessionThread . Variant ? ,
threadDisplayName : String ? ,
resolution : NotificationResolution ,
r un Id: String
r equest Id: String
) {
// T h i s c a n b e c a l l e d f r o m w i t h i n d a t a b a s e t h r e a d s s o t o p r e v e n t b l o c k i n g a n d w e i r d
// b e h a v i o u r s m a k e s u r e t o s e n d i t t o t h e m a i n t h r e a d i n s t e a d
guard Thread . isMainThread else {
return DispatchQueue . main . async { [ weak self ] in
self ? . handleFailure (
for : content ,
metadata : metadata ,
threadVariant : threadVariant ,
threadDisplayName : threadDisplayName ,
resolution : resolution ,
requestId : requestId
)
}
}
let duration : CFTimeInterval = ( CACurrentMediaTime ( ) - startTime )
Log . error ( " \( resolution ) after \( . seconds ( duration ) , unit : . ms ) , showing generic failure message for message from namespace: \( metadata . namespace ) , runId: \( runId ) . " )
Log . flush ( )
let previewType : Preferences . NotificationPreviewType = dependencies [ singleton : . storage , key : . preferencesNotificationPreviewType ]
. defaulting ( to : . nameAndPreview )
Log . error ( . cat , " \( resolution ) after \( . seconds ( duration ) , unit : . ms ) , showing generic failure message for message from namespace: \( metadata . namespace ) , requestId: \( requestId ) . " )
// / N o w w e a r e d o n e w i t h t h e d a t a b a s e , w e s h o u l d s u s p e n d i t
if ! dependencies [ defaults : . appGroup , key : . isMainAppActive ] {
dependencies [ singleton : . storage ] . suspendDatabaseAccess ( )
}
// / C l e a r t h e l o g g e r
Log . flush ( )
Log . reset ( )
content . title = Constants . app_name
content . userInfo = [ NotificationServiceExtension . isFromRemoteKey : true ]
// / I f i t ' s a n o t i f i c a t i o n f o r a g r o u p c o n v e r s a t i o n , t h e n o t i f i c a t i o n p r e f e r e n c e s a r e r i g h t a n d w e h a v e a n a m e f o r t h e g r o u p
// / t h e n w e s h o u l d i n c l u d e i t i n t h e n o t i f i c a t i o n c o n t e n t
let previewType : Preferences . NotificationPreviewType = dependencies [ singleton : . storage , key : . preferencesNotificationPreviewType ]
. defaulting ( to : . nameAndPreview )
switch ( threadVariant , previewType , threadDisplayName ) {
case ( . group , . nameAndPreview , . some ( let name ) ) , ( . group , . nameNoPreview , . some ( let name ) ) ,
( . legacyGroup , . nameAndPreview , . some ( let name ) ) , ( . legacyGroup , . nameNoPreview , . some ( let name ) ) :
Morgan Pretty
1 month ago