@ -55,6 +55,28 @@ class SessionUtilSpec: QuickSpec {
)
}
)
@ TestState ( singleton : . jobRunner , in : dependencies ) var mockJobRunner : MockJobRunner ! = MockJobRunner (
initialSetup : { jobRunner in
jobRunner
. when { $0 . add ( any ( ) , job : any ( ) , dependantJob : any ( ) , canStartJob : any ( ) , using : any ( ) ) }
. thenReturn ( nil )
}
)
@ TestState var createGroupOutput : SessionUtil . CreatedGroupInfo ! = {
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
db ,
name : " TestGroup " ,
description : nil ,
displayPictureUrl : nil ,
displayPictureFilename : nil ,
displayPictureEncryptionKey : nil ,
members : [ ] ,
using : dependencies
)
}
} ( )
@ TestState ( cache : . sessionUtil , in : dependencies ) var mockSessionUtilCache : MockSessionUtilCache ! = MockSessionUtilCache (
initialSetup : { cache in
var conf : UnsafeMutablePointer < config_object > !
@ -64,9 +86,14 @@ class SessionUtilSpec: QuickSpec {
cache . when { $0 . setConfig ( for : any ( ) , sessionId : any ( ) , to : any ( ) ) } . thenReturn ( ( ) )
cache . when { $0 . config ( for : . userGroups , sessionId : any ( ) ) }
. thenReturn ( Atomic ( . object ( conf ) ) )
cache . when { $0 . config ( for : . groupInfo , sessionId : any ( ) ) }
. thenReturn ( Atomic ( createGroupOutput . groupState [ . groupInfo ] ) )
cache . when { $0 . config ( for : . groupMembers , sessionId : any ( ) ) }
. thenReturn ( Atomic ( createGroupOutput . groupState [ . groupMembers ] ) )
cache . when { $0 . config ( for : . groupKeys , sessionId : any ( ) ) }
. thenReturn ( Atomic ( createGroupOutput . groupState [ . groupKeys ] ) )
}
)
@ TestState var createGroupOutput : SessionUtil . CreatedGroupInfo !
@ TestState var userGroupsConfig : SessionUtil . Config !
// MARK: - S e s s i o n U t i l
@ -272,7 +299,7 @@ class SessionUtilSpec: QuickSpec {
}
}
// MARK: - w h e n c r e a t i n g a g r o u p
// MARK: - - w h e n c r e a t i n g a g r o u p
context ( " when creating a group " ) {
beforeEach {
var userGroupsConf : UnsafeMutablePointer < config_object > !
@ -285,7 +312,7 @@ class SessionUtilSpec: QuickSpec {
. thenReturn ( Atomic ( userGroupsConfig ) )
}
// MARK: - - t h r o w s w h e n t h e r e i s n o u s e r e d 2 5 5 1 9 k e y P a i r
// MARK: - - -- t h r o w s w h e n t h e r e i s n o u s e r e d 2 5 5 1 9 k e y P a i r
it ( " throws when there is no user ed25519 keyPair " ) {
var resultError : Error ? = nil
@ -311,7 +338,7 @@ class SessionUtilSpec: QuickSpec {
expect ( resultError ) . to ( matchError ( MessageSenderError . noKeyPair ) )
}
// MARK: - - t h r o w s w h e n i t f a i l s t o g e n e r a t e a n e w i d e n t i t y e d 2 5 5 1 9 k e y P a i r
// MARK: - - -- t h r o w s w h e n i t f a i l s t o g e n e r a t e a n e w i d e n t i t y e d 2 5 5 1 9 k e y P a i r
it ( " throws when it fails to generate a new identity ed25519 keyPair " ) {
var resultError : Error ? = nil
@ -338,7 +365,7 @@ class SessionUtilSpec: QuickSpec {
expect ( resultError ) . to ( matchError ( MessageSenderError . noKeyPair ) )
}
// MARK: - - t h r o w s w h e n g i v e n a n i n v a l i d m e m b e r i d
// MARK: - - -- t h r o w s w h e n g i v e n a n i n v a l i d m e m b e r i d
it ( " throws when given an invalid member id " ) {
var resultError : Error ? = nil
@ -375,7 +402,7 @@ class SessionUtilSpec: QuickSpec {
) )
}
// MARK: - - r e t u r n s t h e c o r r e c t i d e n t i t y k e y P a i r
// MARK: - - -- r e t u r n s t h e c o r r e c t i d e n t i t y k e y P a i r
it ( " returns the correct identity keyPair " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -399,7 +426,7 @@ class SessionUtilSpec: QuickSpec {
) )
}
// MARK: - - r e t u r n s a c l o s e d g r o u p w i t h t h e c o r r e c t d a t a s e t
// MARK: - - -- r e t u r n s a c l o s e d g r o u p w i t h t h e c o r r e c t d a t a s e t
it ( " returns a closed group with the correct data set " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -429,7 +456,7 @@ class SessionUtilSpec: QuickSpec {
expect ( createGroupOutput . group . invited ) . to ( beFalse ( ) )
}
// MARK: - - r e t u r n s t h e m e m b e r s s e t u p c o r r e c t l y
// MARK: - - -- r e t u r n s t h e m e m b e r s s e t u p c o r r e c t l y
it ( " returns the members setup correctly " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -475,7 +502,7 @@ class SessionUtilSpec: QuickSpec {
] ) )
}
// MARK: - - a d d s t h e c u r r e n t u s e r a s a n a d m i n w h e n n o t p r o v i d e d
// MARK: - - -- a d d s t h e c u r r e n t u s e r a s a n a d m i n w h e n n o t p r o v i d e d
it ( " adds the current user as an admin when not provided " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -503,7 +530,7 @@ class SessionUtilSpec: QuickSpec {
expect ( createGroupOutput . members . map { $0 . role } ) . to ( contain ( . admin ) )
}
// MARK: - - h a n d l e s m e m b e r s w i t h o u t p r o f i l e d a t a c o r r e c t l y
// MARK: - - -- h a n d l e s m e m b e r s w i t h o u t p r o f i l e d a t a c o r r e c t l y
it ( " handles members without profile data correctly " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -529,7 +556,7 @@ class SessionUtilSpec: QuickSpec {
expect ( createGroupOutput . members . map { $0 . role } ) . to ( contain ( . standard ) )
}
// MARK: - - s t o r e s t h e c o n f i g s t a t e s i n t h e c a c h e c o r r e c t l y
// MARK: - - -- s t o r e s t h e c o n f i g s t a t e s i n t h e c a c h e c o r r e c t l y
it ( " stores the config states in the cache correctly " ) {
createGroupOutput = mockStorage . write ( using : dependencies ) { db in
try SessionUtil . createGroup (
@ -586,9 +613,9 @@ class SessionUtilSpec: QuickSpec {
}
}
// MARK: - w h e n s a v i n g a c r e a t e d a g r o u p
// MARK: - - w h e n s a v i n g a c r e a t e d a g r o u p
context ( " when saving a created a group " ) {
// MARK: - - s a v e s c o n f i g d u m p s f o r t h e s t o r e d c o n f i g s
// MARK: - - -- s a v e s c o n f i g d u m p s f o r t h e s t o r e d c o n f i g s
it ( " saves config dumps for the stored configs " ) {
mockStorage . write ( using : dependencies ) { db in
createGroupOutput = try SessionUtil . createGroup (
@ -630,7 +657,7 @@ class SessionUtilSpec: QuickSpec {
. to ( contain ( [ 1234567890000 ] ) )
}
// MARK: - - a d d s t h e g r o u p t o t h e u s e r g r o u p s c o n f i g
// MARK: - - -- a d d s t h e g r o u p t o t h e u s e r g r o u p s c o n f i g
it ( " adds the group to the user groups config " ) {
mockStorage . write ( using : dependencies ) { db in
createGroupOutput = try SessionUtil . createGroup (
@ -663,6 +690,287 @@ class SessionUtilSpec: QuickSpec {
expect ( result ? . map { $0 . timestampMs } . asSet ( ) ) . to ( contain ( [ 1234567890000 ] ) )
}
}
// MARK: - - w h e n r e c e i v i n g a G R O U P _ I N F O u p d a t e
context ( " when receiving a GROUP_INFO update " ) {
@ TestState var latestGroup : ClosedGroup ?
@ TestState var initialDisappearingConfig : DisappearingMessagesConfiguration ?
@ TestState var latestDisappearingConfig : DisappearingMessagesConfiguration ?
beforeEach {
mockStorage . write ( using : dependencies ) { db in
try SessionThread . fetchOrCreate (
db ,
id : createGroupOutput . group . threadId ,
variant : . group ,
shouldBeVisible : true ,
calledFromConfigHandling : false ,
using : dependencies
)
try createGroupOutput . group . insert ( db )
try createGroupOutput . members . forEach { try $0 . insert ( db ) }
initialDisappearingConfig = try DisappearingMessagesConfiguration
. fetchOne ( db , id : createGroupOutput . group . threadId )
. defaulting (
to : DisappearingMessagesConfiguration . defaultWith ( createGroupOutput . group . threadId )
)
}
}
// MARK: - - - - d o e s n o t h i n g i f t h e r e a r e n o c h a n g e s
it ( " does nothing if there are no changes " ) {
dependencies . setMockableValue ( key : " needsDump " , false )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( createGroupOutput . groupState [ . groupInfo ] ) . toNot ( beNil ( ) )
expect ( createGroupOutput . group ) . to ( equal ( latestGroup ) )
}
// MARK: - - - - t h r o w s i f t h e c o n f i g i s i n v a l i d
it ( " throws if the config is invalid " ) {
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
expect {
try SessionUtil . handleGroupInfoUpdate (
db ,
in : . invalid ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
. to ( throwError ( ) )
}
}
// MARK: - - - - r e m o v e s g r o u p d a t a i f t h e g r o u p i s d e s t r o y e d
it ( " removes group data if the group is destroyed " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map { groups_info_destroy_group ( $0 ) }
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( latestGroup ? . authData ) . to ( beNil ( ) )
expect ( latestGroup ? . groupIdentityPrivateKey ) . to ( beNil ( ) )
}
// MARK: - - - - u p d a t e s t h e n a m e i f i t c h a n g e d
it ( " updates the name if it changed " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map {
var updatedName : [ CChar ] = " UpdatedName " . cArray . nullTerminated ( )
groups_info_set_name ( $0 , & updatedName )
}
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( createGroupOutput . group . name ) . to ( equal ( " TestGroup " ) )
expect ( latestGroup ? . name ) . to ( equal ( " UpdatedName " ) )
}
// MARK: - - - - u p d a t e s t h e d e s c r i p t i o n i f i t c h a n g e d
it ( " updates the description if it changed " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map {
var updatedDesc : [ CChar ] = " UpdatedDesc " . cArray . nullTerminated ( )
groups_info_set_description ( $0 , & updatedDesc )
}
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( createGroupOutput . group . groupDescription ) . to ( beNil ( ) )
expect ( latestGroup ? . groupDescription ) . to ( equal ( " UpdatedDesc " ) )
}
// MARK: - - - - u p d a t e s t h e f o r m a t i o n t i m e s t a m p i f i t c h a n g e d
it ( " updates the formation timestamp if it changed " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map { groups_info_set_created ( $0 , 54321 ) }
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( createGroupOutput . group . formationTimestamp ) . to ( equal ( 1234567890 ) )
expect ( latestGroup ? . formationTimestamp ) . to ( equal ( 54321 ) )
}
// MARK: - - - - a n d t h e d i s p l a y p i c t u r e w a s c h a n g e d
context ( " and the display picture was changed " ) {
// MARK: - - - - - - r e m o v e s t h e d i s p l a y p i c t u r e
it ( " removes the display picture " ) {
mockStorage . write ( using : dependencies ) { db in
try ClosedGroup
. updateAll (
db ,
ClosedGroup . Columns . displayPictureUrl . set ( to : " TestUrl " ) ,
ClosedGroup . Columns . displayPictureEncryptionKey . set ( to : Data ( [ 1 , 2 , 3 ] ) ) ,
ClosedGroup . Columns . displayPictureFilename . set ( to : " TestFilename " )
)
}
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestGroup = mockStorage . read ( using : dependencies ) { db in
try ClosedGroup . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( latestGroup ? . displayPictureUrl ) . to ( beNil ( ) )
expect ( latestGroup ? . displayPictureEncryptionKey ) . to ( beNil ( ) )
expect ( latestGroup ? . displayPictureFilename ) . to ( beNil ( ) )
expect ( latestGroup ? . lastDisplayPictureUpdate ) . to ( equal ( 1234567891 ) )
}
// MARK: - - - - - - s c h e d u l e s a d i s p l a y p i c t u r e d o w n l o a d j o b i f t h e r e i s a n e w o n e
it ( " schedules a display picture download job if there is a new one " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map {
var displayPic : user_profile_pic = user_profile_pic ( )
displayPic . url = " https://www.oxen.io/file/1234 " . toLibSession ( )
displayPic . key = Data (
repeating : 1 ,
count : DisplayPictureManager . aes256KeyByteLength
) . toLibSession ( )
groups_info_set_pic ( $0 , displayPic )
}
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
expect ( mockJobRunner )
. to ( call ( . exactly ( times : 1 ) , matchingParameters : . all ) { jobRunner in
jobRunner . add (
any ( ) ,
job : Job (
variant : . displayPictureDownload ,
behaviour : . runOnce ,
shouldBlock : false ,
shouldBeUnique : true ,
shouldSkipLaunchBecomeActive : false ,
details : DisplayPictureDownloadJob . Details (
target : . group (
id : createGroupOutput . group . threadId ,
url : " https://www.oxen.io/file/1234 " ,
encryptionKey : Data (
repeating : 1 ,
count : DisplayPictureManager . aes256KeyByteLength
)
) ,
timestamp : 1234567891
)
) ,
canStartJob : true ,
using : any ( )
)
} )
}
}
// MARK: - - - - u p d a t e s t h e d i s a p p e a r i n g m e s s a g e s c o n f i g
it ( " updates the disappearing messages config " ) {
createGroupOutput . groupState [ . groupInfo ] ? . conf . map { groups_info_set_expiry_timer ( $0 , 10 ) }
dependencies . setMockableValue ( key : " needsDump " , true )
mockStorage . write ( using : dependencies ) { db in
try SessionUtil . handleGroupInfoUpdate (
db ,
in : createGroupOutput . groupState [ . groupInfo ] ,
groupSessionId : SessionId ( . group , hex : createGroupOutput . group . threadId ) ,
serverTimestampMs : 1234567891000 ,
using : dependencies
)
}
latestDisappearingConfig = mockStorage . read ( using : dependencies ) { db in
try DisappearingMessagesConfiguration . fetchOne ( db , id : createGroupOutput . group . threadId )
}
expect ( initialDisappearingConfig ? . isEnabled ) . to ( beFalse ( ) )
expect ( initialDisappearingConfig ? . durationSeconds ) . to ( equal ( 0 ) )
expect ( latestDisappearingConfig ? . isEnabled ) . to ( beTrue ( ) )
expect ( latestDisappearingConfig ? . durationSeconds ) . to ( equal ( 10 ) )
}
}
}
}
}
// MARK: - C o n v e n i e n c e
private extension SessionUtil . Config {
var conf : UnsafeMutablePointer < config_object > ? {
switch self {
case . object ( let conf ) : return conf
default : return nil
}
}
}
Morgan Pretty
1 year ago