-
Notifications
You must be signed in to change notification settings - Fork 315
Expand file tree
/
Copy pathChatClient.kt
More file actions
5333 lines (5001 loc) · 205 KB
/
ChatClient.kt
File metadata and controls
5333 lines (5001 loc) · 205 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2014-2026 Stream.io Inc. All rights reserved.
*
* Licensed under the Stream License;
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.getstream.chat.android.client
import android.content.Context
import android.util.Log
import androidx.annotation.CheckResult
import androidx.lifecycle.DefaultLifecycleObserver
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.ProcessLifecycleOwner
import androidx.media3.common.AudioAttributes
import androidx.media3.common.C.AUDIO_CONTENT_TYPE_MUSIC
import androidx.media3.exoplayer.ExoPlayer
import io.getstream.chat.android.client.ChatClient.Companion.MAX_COOLDOWN_TIME_SECONDS
import io.getstream.chat.android.client.api.ChatApi
import io.getstream.chat.android.client.api.ChatClientConfig
import io.getstream.chat.android.client.api.ErrorCall
import io.getstream.chat.android.client.api.models.GetThreadOptions
import io.getstream.chat.android.client.api.models.PinnedMessagesPagination
import io.getstream.chat.android.client.api.models.QueryChannelRequest
import io.getstream.chat.android.client.api.models.QueryChannelsRequest
import io.getstream.chat.android.client.api.models.QueryThreadsRequest
import io.getstream.chat.android.client.api.models.QueryUsersRequest
import io.getstream.chat.android.client.api.models.SendActionRequest
import io.getstream.chat.android.client.api.models.UpdatePollRequest
import io.getstream.chat.android.client.api.models.identifier.AddDeviceIdentifier
import io.getstream.chat.android.client.api.models.identifier.ConnectUserIdentifier
import io.getstream.chat.android.client.api.models.identifier.DeleteDeviceIdentifier
import io.getstream.chat.android.client.api.models.identifier.DeleteMessageForMeIdentifier
import io.getstream.chat.android.client.api.models.identifier.DeleteMessageIdentifier
import io.getstream.chat.android.client.api.models.identifier.DeleteReactionIdentifier
import io.getstream.chat.android.client.api.models.identifier.GetDevicesIdentifier
import io.getstream.chat.android.client.api.models.identifier.GetMessageIdentifier
import io.getstream.chat.android.client.api.models.identifier.GetRepliesIdentifier
import io.getstream.chat.android.client.api.models.identifier.GetRepliesMoreIdentifier
import io.getstream.chat.android.client.api.models.identifier.HideChannelIdentifier
import io.getstream.chat.android.client.api.models.identifier.MarkAllReadIdentifier
import io.getstream.chat.android.client.api.models.identifier.MarkReadIdentifier
import io.getstream.chat.android.client.api.models.identifier.QueryChannelIdentifier
import io.getstream.chat.android.client.api.models.identifier.QueryChannelsIdentifier
import io.getstream.chat.android.client.api.models.identifier.QueryMembersIdentifier
import io.getstream.chat.android.client.api.models.identifier.SendEventIdentifier
import io.getstream.chat.android.client.api.models.identifier.SendGiphyIdentifier
import io.getstream.chat.android.client.api.models.identifier.SendMessageIdentifier
import io.getstream.chat.android.client.api.models.identifier.SendReactionIdentifier
import io.getstream.chat.android.client.api.models.identifier.ShuffleGiphyIdentifier
import io.getstream.chat.android.client.api.models.identifier.UpdateMessageIdentifier
import io.getstream.chat.android.client.api.models.identifier.getNewerRepliesIdentifier
import io.getstream.chat.android.client.api2.mapping.DtoMapping
import io.getstream.chat.android.client.api2.model.dto.AttachmentDto
import io.getstream.chat.android.client.api2.model.dto.DownstreamChannelDto
import io.getstream.chat.android.client.api2.model.dto.DownstreamMessageDto
import io.getstream.chat.android.client.api2.model.dto.DownstreamReactionDto
import io.getstream.chat.android.client.api2.model.dto.DownstreamUserDto
import io.getstream.chat.android.client.attachment.AttachmentsSender
import io.getstream.chat.android.client.audio.AudioPlayer
import io.getstream.chat.android.client.audio.NativeMediaPlayerImpl
import io.getstream.chat.android.client.audio.StreamAudioPlayer
import io.getstream.chat.android.client.cdn.CDN
import io.getstream.chat.android.client.cdn.internal.StreamMediaDataSource
import io.getstream.chat.android.client.channel.ChannelClient
import io.getstream.chat.android.client.channel.state.ChannelStateLogicProvider
import io.getstream.chat.android.client.clientstate.DisconnectCause
import io.getstream.chat.android.client.clientstate.UserState
import io.getstream.chat.android.client.clientstate.UserStateService
import io.getstream.chat.android.client.debugger.ChatClientDebugger
import io.getstream.chat.android.client.debugger.SendMessageDebugger
import io.getstream.chat.android.client.debugger.StubChatClientDebugger
import io.getstream.chat.android.client.di.ChatModule
import io.getstream.chat.android.client.errorhandler.ErrorHandler
import io.getstream.chat.android.client.errorhandler.onCreateChannelError
import io.getstream.chat.android.client.errorhandler.onMessageError
import io.getstream.chat.android.client.errorhandler.onQueryMembersError
import io.getstream.chat.android.client.errorhandler.onReactionError
import io.getstream.chat.android.client.errors.cause.StreamChannelNotFoundException
import io.getstream.chat.android.client.events.ChatEvent
import io.getstream.chat.android.client.events.ConnectedEvent
import io.getstream.chat.android.client.events.ConnectingEvent
import io.getstream.chat.android.client.events.DisconnectedEvent
import io.getstream.chat.android.client.events.HasOwnUser
import io.getstream.chat.android.client.events.NewMessageEvent
import io.getstream.chat.android.client.events.NotificationChannelMutesUpdatedEvent
import io.getstream.chat.android.client.events.NotificationMutesUpdatedEvent
import io.getstream.chat.android.client.events.NotificationReminderDueEvent
import io.getstream.chat.android.client.events.UserEvent
import io.getstream.chat.android.client.events.UserUpdatedEvent
import io.getstream.chat.android.client.extensions.ATTACHMENT_TYPE_FILE
import io.getstream.chat.android.client.extensions.ATTACHMENT_TYPE_IMAGE
import io.getstream.chat.android.client.extensions.cidToTypeAndId
import io.getstream.chat.android.client.extensions.extractBaseUrl
import io.getstream.chat.android.client.extensions.getCreatedAtOrNull
import io.getstream.chat.android.client.extensions.internal.isLaterThanDays
import io.getstream.chat.android.client.header.VersionPrefixHeader
import io.getstream.chat.android.client.helpers.AppSettingManager
import io.getstream.chat.android.client.helpers.CallPostponeHelper
import io.getstream.chat.android.client.interceptor.SendMessageInterceptor
import io.getstream.chat.android.client.interceptor.message.internal.PrepareMessageLogicImpl
import io.getstream.chat.android.client.internal.file.StreamFileManager
import io.getstream.chat.android.client.logger.ChatLogLevel
import io.getstream.chat.android.client.logger.ChatLoggerConfigImpl
import io.getstream.chat.android.client.logger.ChatLoggerHandler
import io.getstream.chat.android.client.logger.StreamLogLevelValidator
import io.getstream.chat.android.client.logger.StreamLoggerHandler
import io.getstream.chat.android.client.notifications.ChatNotifications
import io.getstream.chat.android.client.notifications.PushNotificationReceivedListener
import io.getstream.chat.android.client.notifications.handler.ChatNotification
import io.getstream.chat.android.client.notifications.handler.NotificationConfig
import io.getstream.chat.android.client.notifications.handler.NotificationHandler
import io.getstream.chat.android.client.notifications.handler.NotificationHandlerFactory
import io.getstream.chat.android.client.parser2.adapters.CustomObjectDtoAdapter
import io.getstream.chat.android.client.parser2.adapters.internal.StreamDateFormatter
import io.getstream.chat.android.client.persistance.repository.RepositoryFacade
import io.getstream.chat.android.client.persistance.repository.factory.RepositoryFactory
import io.getstream.chat.android.client.persistance.repository.noop.NoOpRepositoryFactory
import io.getstream.chat.android.client.persistence.db.ChatClientDatabase
import io.getstream.chat.android.client.persistence.repository.ChatClientRepository
import io.getstream.chat.android.client.plugin.DependencyResolver
import io.getstream.chat.android.client.plugin.MessageDeliveredPluginFactory
import io.getstream.chat.android.client.plugin.Plugin
import io.getstream.chat.android.client.plugin.factory.PluginFactory
import io.getstream.chat.android.client.plugin.factory.ThrottlingPluginFactory
import io.getstream.chat.android.client.query.AddMembersParams
import io.getstream.chat.android.client.query.CreateChannelParams
import io.getstream.chat.android.client.receipts.MessageReceiptManager
import io.getstream.chat.android.client.receipts.MessageReceiptReporter
import io.getstream.chat.android.client.scope.ClientScope
import io.getstream.chat.android.client.scope.UserScope
import io.getstream.chat.android.client.setup.state.ClientState
import io.getstream.chat.android.client.setup.state.internal.MutableClientState
import io.getstream.chat.android.client.socket.ChatSocket
import io.getstream.chat.android.client.socket.SocketListener
import io.getstream.chat.android.client.token.CacheableTokenProvider
import io.getstream.chat.android.client.token.ConstantTokenProvider
import io.getstream.chat.android.client.token.TokenManager
import io.getstream.chat.android.client.token.TokenManagerImpl
import io.getstream.chat.android.client.token.TokenProvider
import io.getstream.chat.android.client.transformer.ApiModelTransformers
import io.getstream.chat.android.client.uploader.FileTransformer
import io.getstream.chat.android.client.uploader.FileUploader
import io.getstream.chat.android.client.uploader.NoOpFileTransformer
import io.getstream.chat.android.client.uploader.StreamCdnImageMimeTypes
import io.getstream.chat.android.client.user.CredentialConfig
import io.getstream.chat.android.client.user.CurrentUserFetcher
import io.getstream.chat.android.client.user.storage.SharedPreferencesCredentialStorage
import io.getstream.chat.android.client.user.storage.UserCredentialStorage
import io.getstream.chat.android.client.utils.ProgressCallback
import io.getstream.chat.android.client.utils.TokenUtils
import io.getstream.chat.android.client.utils.internal.ServerClockOffset
import io.getstream.chat.android.client.utils.mergePartially
import io.getstream.chat.android.client.utils.message.ensureId
import io.getstream.chat.android.client.utils.observable.ChatEventsObservable
import io.getstream.chat.android.client.utils.observable.Disposable
import io.getstream.chat.android.client.utils.retry.NoRetryPolicy
import io.getstream.chat.android.client.utils.stringify
import io.getstream.chat.android.core.internal.InternalStreamChatApi
import io.getstream.chat.android.core.internal.StreamHandsOff
import io.getstream.chat.android.core.utils.date.max
import io.getstream.chat.android.models.AppSettings
import io.getstream.chat.android.models.Attachment
import io.getstream.chat.android.models.BannedUser
import io.getstream.chat.android.models.BannedUsersSort
import io.getstream.chat.android.models.Channel
import io.getstream.chat.android.models.ConnectionData
import io.getstream.chat.android.models.ConnectionState
import io.getstream.chat.android.models.Device
import io.getstream.chat.android.models.DraftMessage
import io.getstream.chat.android.models.DraftsSort
import io.getstream.chat.android.models.EventType
import io.getstream.chat.android.models.FilterObject
import io.getstream.chat.android.models.Filters
import io.getstream.chat.android.models.Flag
import io.getstream.chat.android.models.GuestUser
import io.getstream.chat.android.models.InitializationState
import io.getstream.chat.android.models.Location
import io.getstream.chat.android.models.Member
import io.getstream.chat.android.models.MemberData
import io.getstream.chat.android.models.Message
import io.getstream.chat.android.models.MessageReminder
import io.getstream.chat.android.models.Mute
import io.getstream.chat.android.models.Option
import io.getstream.chat.android.models.PendingMessage
import io.getstream.chat.android.models.Poll
import io.getstream.chat.android.models.PollConfig
import io.getstream.chat.android.models.PollOption
import io.getstream.chat.android.models.PushMessage
import io.getstream.chat.android.models.PushPreference
import io.getstream.chat.android.models.PushPreferenceLevel
import io.getstream.chat.android.models.QueryDraftsResult
import io.getstream.chat.android.models.QueryPollVotesResult
import io.getstream.chat.android.models.QueryPollsResult
import io.getstream.chat.android.models.QueryReactionsResult
import io.getstream.chat.android.models.QueryRemindersResult
import io.getstream.chat.android.models.QueryThreadsResult
import io.getstream.chat.android.models.Reaction
import io.getstream.chat.android.models.SearchMessagesResult
import io.getstream.chat.android.models.Thread
import io.getstream.chat.android.models.UnreadCounts
import io.getstream.chat.android.models.UploadAttachmentsNetworkType
import io.getstream.chat.android.models.UploadedFile
import io.getstream.chat.android.models.User
import io.getstream.chat.android.models.UserBlock
import io.getstream.chat.android.models.VideoCallInfo
import io.getstream.chat.android.models.VideoCallToken
import io.getstream.chat.android.models.Vote
import io.getstream.chat.android.models.querysort.QuerySortByField
import io.getstream.chat.android.models.querysort.QuerySorter
import io.getstream.log.AndroidStreamLogger
import io.getstream.log.CompositeStreamLogger
import io.getstream.log.StreamLog
import io.getstream.log.taggedLogger
import io.getstream.result.Error
import io.getstream.result.Result
import io.getstream.result.call.Call
import io.getstream.result.call.CoroutineCall
import io.getstream.result.call.doOnResult
import io.getstream.result.call.doOnStart
import io.getstream.result.call.flatMap
import io.getstream.result.call.map
import io.getstream.result.call.retry
import io.getstream.result.call.retry.RetryPolicy
import io.getstream.result.call.share
import io.getstream.result.call.toUnitCall
import io.getstream.result.call.withPrecondition
import io.getstream.result.flatMapSuspend
import io.getstream.result.onErrorSuspend
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Job
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.job
import kotlinx.coroutines.launch
import kotlinx.coroutines.plus
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import kotlinx.coroutines.withTimeout
import kotlinx.coroutines.withTimeoutOrNull
import okhttp3.Interceptor
import okhttp3.OkHttpClient
import okhttp3.ResponseBody
import java.io.File
import java.util.Calendar
import java.util.Date
import java.util.concurrent.atomic.AtomicReference
import kotlin.coroutines.CoroutineContext
import kotlin.reflect.full.isSubclassOf
import kotlin.time.Duration.Companion.days
/**
* The ChatClient is the main entry point for all low-level operations on chat
*/
@Suppress("NEWER_VERSION_IN_SINCE_KOTLIN", "TooManyFunctions", "LargeClass")
public class ChatClient
@Suppress("LongParameterList")
internal constructor(
public val config: ChatClientConfig,
private val api: ChatApi,
private val dtoMapping: DtoMapping,
private val notifications: ChatNotifications,
private val tokenManager: TokenManager = TokenManagerImpl(),
private val userCredentialStorage: UserCredentialStorage,
private val userStateService: UserStateService = UserStateService(),
private val clientDebugger: ChatClientDebugger = StubChatClientDebugger,
private val tokenUtils: TokenUtils = TokenUtils,
private val clientScope: ClientScope,
private val userScope: UserScope,
internal val retryPolicy: RetryPolicy,
private val appSettingsManager: AppSettingManager,
private val chatSocket: ChatSocket,
@InternalStreamChatApi
public val pluginFactories: List<PluginFactory>,
private val mutableClientState: MutableClientState,
private val currentUserFetcher: CurrentUserFetcher,
private val repositoryFactoryProvider: RepositoryFactory.Provider,
@InternalStreamChatApi
public val audioPlayer: AudioPlayer,
private val now: () -> Date = ::Date,
@InternalStreamChatApi
public val serverClockOffset: ServerClockOffset,
private val repository: ChatClientRepository,
private val messageReceiptReporter: MessageReceiptReporter,
internal val messageReceiptManager: MessageReceiptManager,
@InternalStreamChatApi
public val cdn: CDN? = null,
) {
private val logger by taggedLogger(TAG)
private val fileManager = StreamFileManager()
private val waitConnection = MutableSharedFlow<Result<ConnectionData>>()
public val clientState: ClientState = mutableClientState
private val streamDateFormatter: StreamDateFormatter = StreamDateFormatter()
private val eventsObservable = ChatEventsObservable(waitConnection, userScope, chatSocket)
private val eventMutex = Mutex()
/**
* The user's id for which the client is initialized.
* Used in [initializeClientWithUser] to prevent recreating objects like repository, plugins, etc.
*/
private val initializedUserId = AtomicReference<String?>(null)
/**
* Launches a new coroutine in the [UserScope] without blocking the current thread
* and returns a reference to the coroutine as a [Job].
*/
internal fun launch(
block: suspend CoroutineScope.() -> Unit,
) = userScope.launch(block = block)
/**
* Inherits the [UserScope] and provides its [Job] as an anchor for children.
*/
@InternalStreamChatApi
public fun inheritScope(block: (Job) -> CoroutineContext): CoroutineScope {
if (userScope.userId.value == null) {
logger.e { "[inheritScope] userId is null" }
clientDebugger.onNonFatalErrorOccurred(
tag = TAG,
src = "inheritScope",
desc = "ChatClient::connectUser() must be called before inheriting scope",
error = Error.GenericError("userScope.userId.value is null"),
)
}
return userScope + block(userScope.coroutineContext.job)
}
@InternalStreamChatApi
public val repositoryFacade: RepositoryFacade
get() = _repositoryFacade
?: (getCurrentUser() ?: getStoredUser())
?.let { user ->
createRepositoryFacade(userScope, createRepositoryFactory(user))
.also { _repositoryFacade = it }
}
?: createRepositoryFacade(userScope)
private var _repositoryFacade: RepositoryFacade? = null
private var pushNotificationReceivedListener: PushNotificationReceivedListener =
PushNotificationReceivedListener { _, _ -> }
/**
* The list of plugins added once user is connected.
*
* @see [Plugin]
*/
@Volatile
@InternalStreamChatApi
public var plugins: List<Plugin> = emptyList()
/**
* Resolves dependency [T] within the provided plugin [DR].
* This method can't be called before user is connected because plugins are added only after user
* connection is completed.
*
* @see [Plugin]
* @throws IllegalStateException if plugin was not added or dependency is not found.
*/
@InternalStreamChatApi
@Throws(IllegalStateException::class)
@Suppress("ThrowsCount")
public inline fun <reified DR : DependencyResolver, reified T : Any> resolveDependency(): T {
StreamLog.d(TAG) { "[resolveDependency] DR: ${DR::class.simpleName}, T: ${T::class.simpleName}" }
return when {
DR::class.isSubclassOf(PluginFactory::class) -> resolveFactoryDependency<DR, T>()
DR::class.isSubclassOf(Plugin::class) -> resolvePluginDependency<DR, T>()
else -> error("Unsupported dependency resolver: ${DR::class}")
}
}
@PublishedApi
@InternalStreamChatApi
@Throws(IllegalStateException::class)
@Suppress("ThrowsCount")
internal inline fun <reified F : DependencyResolver, reified T : Any> resolveFactoryDependency(): T {
StreamLog.v(TAG) { "[resolveFactoryDependency] F: ${F::class.simpleName}, T: ${T::class.simpleName}" }
val resolver = pluginFactories.find { plugin ->
plugin is F
} ?: throw IllegalStateException(
"Factory '${F::class.qualifiedName}' was not found. Did you init it within ChatClient?",
)
return resolver.resolveDependency(T::class)
?: throw IllegalStateException(
"Dependency '${T::class.qualifiedName}' was not resolved by factory '${F::class.qualifiedName}'",
)
}
@PublishedApi
@InternalStreamChatApi
@Throws(IllegalStateException::class)
@Suppress("ThrowsCount")
internal inline fun <reified P : DependencyResolver, reified T : Any> resolvePluginDependency(): T {
StreamLog.v(TAG) { "[resolvePluginDependency] P: ${P::class.simpleName}, T: ${T::class.simpleName}" }
// Snapshot plugins BEFORE checking initializationState to avoid a race with disconnect().
// disconnect() sets initializationState to NOT_INITIALIZED before clearing plugins,
// so if we snapshot plugins first and then see COMPLETE, the snapshot is guaranteed valid.
val currentPlugins = plugins
val initState = awaitInitializationState(RESOLVE_DEPENDENCY_TIMEOUT)
if (initState != InitializationState.COMPLETE) {
StreamLog.e(TAG) { "[resolvePluginDependency] failed (initializationState is not COMPLETE): $initState " }
throw IllegalStateException("ChatClient::connectUser() must be called before resolving any dependency")
}
val resolver = currentPlugins.find { plugin ->
plugin is P
} ?: throw IllegalStateException(
"Plugin '${P::class.qualifiedName}' was not found. Did you init it within ChatClient?",
)
return resolver.resolveDependency(T::class)
?: throw IllegalStateException(
"Dependency '${T::class.qualifiedName}' was not resolved by plugin '${P::class.qualifiedName}'",
)
}
@InternalStreamChatApi
@StreamHandsOff(
"This method is used to avoid race-condition between plugin initialization and dependency resolution.",
)
public fun awaitInitializationState(timeoutMilliseconds: Long): InitializationState? {
var initState: InitializationState? = clientState.initializationState.value
var spendTime = 0L
inheritScope { Job(it) }.launch {
initState = withTimeoutOrNull(timeoutMilliseconds) {
clientState.initializationState.first { it == InitializationState.COMPLETE }
}
}
while (initState == InitializationState.INITIALIZING && spendTime < timeoutMilliseconds) {
java.lang.Thread.sleep(INITIALIZATION_DELAY)
spendTime += INITIALIZATION_DELAY
}
return initState
}
/**
* Error handlers for API calls.
*/
private val errorHandlers: List<ErrorHandler>
get() = plugins.mapNotNull { it.getErrorHandler() }.sorted()
public var logicRegistry: ChannelStateLogicProvider? = null
internal lateinit var attachmentsSender: AttachmentsSender
init {
eventsObservable.subscribeSuspend { event ->
eventMutex.withLock {
handleEvent(event)
}
}
}
private suspend fun handleEvent(event: ChatEvent) {
when (event) {
is ConnectedEvent -> {
logger.i { "[handleEvent] event: ConnectedEvent(userId='${event.me.id}')" }
val user = event.me
val connectionId = event.connectionId
api.setConnection(user.id, connectionId)
notifications.onSetUser(user)
mutableClientState.setConnectionState(ConnectionState.Connected)
mutableClientState.setUser(user)
}
is NewMessageEvent -> {
notifications.onChatEvent(event)
messageReceiptManager.markMessageAsDelivered(event.message)
}
is NotificationReminderDueEvent -> notifications.onChatEvent(event)
is ConnectingEvent -> {
logger.i { "[handleEvent] event: ConnectingEvent" }
mutableClientState.setConnectionState(ConnectionState.Connecting)
}
is UserUpdatedEvent -> {
val eventUser = event.user
val currentUser = clientState.user.value
if (currentUser?.id == eventUser.id) {
val mergedUser = currentUser.mergePartially(eventUser)
mutableClientState.setUser(mergedUser)
}
}
is NotificationMutesUpdatedEvent -> {
mutableClientState.setUser(event.me)
}
is NotificationChannelMutesUpdatedEvent -> {
mutableClientState.setUser(event.me)
}
is DisconnectedEvent -> {
logger.i { "[handleEvent] event: DisconnectedEvent(disconnectCause=${event.disconnectCause})" }
api.releaseConnection()
mutableClientState.setConnectionState(ConnectionState.Offline)
when (event.disconnectCause) {
is DisconnectCause.ConnectionReleased,
is DisconnectCause.NetworkNotAvailable,
is DisconnectCause.WebSocketNotAvailable,
is DisconnectCause.Error,
-> {
}
is DisconnectCause.UnrecoverableError -> {
disconnectSuspend(true)
}
}
}
else -> Unit // Ignore other events
}
event.extractCurrentUser()?.let { currentUser ->
userStateService.onUserUpdated(currentUser)
mutableClientState.setUser(currentUser)
storePushNotificationsConfig(
currentUser.id,
currentUser.name,
userStateService.state !is UserState.UserSet,
)
}
}
/**
* Either entirely extracts current user from the event
* or merges the one from the event into the existing current user.
*/
private fun ChatEvent.extractCurrentUser(): User? {
return when (this) {
is HasOwnUser -> me
is UserEvent -> getCurrentUser()
?.takeIf { it.id == user.id }
?.mergePartially(user)
else -> null
}
}
//region Set user
/**
* Initializes [ChatClient] for a specific user. The [tokenProvider] implementation is used
* for the initial token, and it's also invoked whenever the user's token has expired, to
* fetch a new token.
*
* @param user The user to set.
* @param tokenProvider A [TokenProvider] implementation.
* @param timeoutMilliseconds A timeout in milliseconds when the process will be aborted.
*
* @return [Result] of [ConnectionData] with the info of the established connection or a detailed error.
*/
@Suppress("LongMethod")
private suspend fun setUser(
user: User,
tokenProvider: TokenProvider,
timeoutMilliseconds: Long?,
): Result<ConnectionData> {
val isAnonymous = user == anonUser
val cacheableTokenProvider = CacheableTokenProvider(tokenProvider)
val userState = userStateService.state
return when {
tokenUtils.getUserId(cacheableTokenProvider.loadToken()) != user.id -> {
logger.e {
"The user_id provided on the JWT token doesn't match with the current user you try to connect"
}
Result.Failure(
Error.GenericError(
"The user_id provided on the JWT token doesn't match with the current user you try to connect",
),
)
}
userState is UserState.NotSet -> {
logger.v { "[setUser] user is NotSet" }
mutableClientState.setUser(user)
initializeClientWithUser(user, cacheableTokenProvider, isAnonymous)
userStateService.onSetUser(user, isAnonymous)
chatSocket.connectUser(user, isAnonymous)
mutableClientState.setInitializationState(InitializationState.COMPLETE)
waitFirstConnection(timeoutMilliseconds)
}
userState is UserState.UserSet -> {
logger.w {
"[setUser] Trying to set user without disconnecting the previous one - " +
"make sure that previously set user is disconnected."
}
when {
userState.user.id != user.id -> {
logger.e { "[setUser] Trying to set different user without disconnect previous one." }
Result.Failure(
Error.GenericError(
"User cannot be set until the previous one is disconnected.",
),
)
}
else -> {
getConnectionId()?.let {
mutableClientState.setInitializationState(InitializationState.COMPLETE)
Result.Success(ConnectionData(userState.user, it))
}
?: run {
logger.e {
"[setUser] Trying to connect the same user twice without a previously completed " +
"connection."
}
Result.Failure(
Error.GenericError(
"Failed to connect user. Please check you haven't connected a user already.",
),
)
}
}
}
}
else -> {
logger.e { "[setUser] Failed to connect user. Please check you don't have connected user already." }
Result.Failure(
Error.GenericError(
"Failed to connect user. Please check you don't have connected user already.",
),
)
}
}.onErrorSuspend {
disconnectSuspend(flushPersistence = true)
}
}
@Synchronized
private fun initializeClientWithUser(
user: User,
tokenProvider: CacheableTokenProvider,
isAnonymous: Boolean,
) {
logger.i { "[initializeClientWithUser] user.id: '${user.id}'" }
val clientJobCount = clientScope.coroutineContext[Job]?.children?.count() ?: -1
val userJobCount = userScope.coroutineContext[Job]?.children?.count() ?: -1
logger.v { "[initializeClientWithUser] clientJobCount: $clientJobCount, userJobCount: $userJobCount" }
if (initializedUserId.get() != user.id) {
_repositoryFacade = createRepositoryFacade(userScope, createRepositoryFactory(user))
plugins = pluginFactories.map { it.get(user) }
initializedUserId.set(user.id)
} else {
logger.i {
"[initializeClientWithUser] initializing client with the same user id." +
" Skipping repository and plugins recreation"
}
}
plugins.forEach { it.onUserSet(user) }
// fire a handler here that the chatDomain and chatUI can use
config.isAnonymous = isAnonymous
tokenManager.setTokenProvider(tokenProvider)
appSettingsManager.loadAppSettings()
warmUp()
messageReceiptReporter.start()
logger.i { "[initializeClientWithUser] user.id: '${user.id}'completed" }
}
private fun createRepositoryFactory(user: User): RepositoryFactory =
repositoryFactoryProvider.createRepositoryFactory(user)
private fun createRepositoryFacade(
scope: CoroutineScope,
repositoryFactory: RepositoryFactory = NoOpRepositoryFactory,
): RepositoryFacade =
RepositoryFacade.create(repositoryFactory, scope)
/**
* Get the current settings of the app. Check [AppSettings].
*
* @return [AppSettings] the settings of the app.
*/
@CheckResult
public fun appSettings(): Call<AppSettings> = api.appSettings()
/**
* Initializes [ChatClient] for a specific user.
* The [tokenProvider] implementation is used for the initial token,
* and it's also invoked whenever the user's token has expired, to fetch a new token.
*
* This method performs required operations before connecting with the Stream API.
* Moreover, it warms up the connection, sets up notifications, and connects to the socket.
*
* Check out [docs](https://getstream.io/chat/docs/android/init_and_users/) for more info about tokens.
* Also visit [this site](https://jwt.io) to find more about Json Web Token standard.
* You can generate the JWT token on using one of the available libraries or use our manual
* [tool](https://getstream.io/chat/docs/react/token_generator/) for token generation.
*
* @see TokenProvider
*
* @param user The user to set.
* @param tokenProvider A [TokenProvider] implementation.
* @param timeoutMilliseconds The timeout in milliseconds to be waiting until the connection is established.
*
* @return Executable [Call] responsible for connecting the user.
*/
@CheckResult
@JvmOverloads
public fun connectUser(
user: User,
tokenProvider: TokenProvider,
timeoutMilliseconds: Long? = null,
): Call<ConnectionData> {
return CoroutineCall(clientScope) {
userScope.userId.value = user.id
connectUserSuspend(user, tokenProvider, timeoutMilliseconds)
}
.share(clientScope) { ConnectUserIdentifier(user) }
}
private suspend fun connectUserSuspend(
user: User,
tokenProvider: TokenProvider,
timeoutMilliseconds: Long?,
): Result<ConnectionData> {
mutableClientState.setInitializationState(InitializationState.INITIALIZING)
logger.d { "[connectUserSuspend] userId: '${user.id}', username: '${user.name}'" }
return setUser(user, tokenProvider, timeoutMilliseconds).also { result ->
logger.v {
"[connectUserSuspend] " +
"completed: ${result.stringify { "ConnectionData(connectionId=${it.connectionId})" }}"
}
}
}
/**
* Changes the user. Disconnects the current user and connects to a new one.
* The [tokenProvider] implementation is used for the initial token,
* and it's also invoked whenever the user's token has expired, to fetch a new token.
*
* This method disconnects from the SDK and right after connects to it with the new User.
*
* @see TokenProvider
*
* @param user The user to set.
* @param tokenProvider A [TokenProvider] implementation.
* @param timeoutMilliseconds The timeout in milliseconds to be waiting until the connection is established.
*
* @return Executable [Call] responsible for connecting the user.
*/
@CheckResult
@JvmOverloads
public fun switchUser(
user: User,
tokenProvider: TokenProvider,
timeoutMilliseconds: Long? = null,
onDisconnectionComplete: () -> Unit = {},
): Call<ConnectionData> {
return CoroutineCall(clientScope) {
logger.d { "[switchUser] user.id: '${user.id}'" }
notifications.deleteDevice(getCurrentUser()) // always delete device if switching users
disconnectUserSuspend(flushPersistence = true)
// change userId only after disconnect,
// otherwise the userScope won't cancel coroutines related to the previous user.
userScope.userId.value = user.id
onDisconnectionComplete()
connectUserSuspend(user, tokenProvider, timeoutMilliseconds).also {
logger.v { "[switchUser] completed('${user.id}')" }
}
}
}
/**
* Changes the user. Disconnects the current user and connects to a new one.
* The [tokenProvider] implementation is used for the initial token,
* and it's also invoked whenever the user's token has expired, to fetch a new token.
*
* This method disconnects from the SDK and right after connects to it with the new User.
*
* @see TokenProvider
*
* @param user The user to set.
* @param token Instance of JWT token.
* @param timeoutMilliseconds The timeout in milliseconds to be waiting until the connection is established.
*
* @return Executable [Call] responsible for connecting the user.
*/
@CheckResult
@JvmOverloads
public fun switchUser(
user: User,
token: String,
timeoutMilliseconds: Long? = null,
onDisconnectionComplete: () -> Unit = {},
): Call<ConnectionData> {
return switchUser(user, ConstantTokenProvider(token), timeoutMilliseconds, onDisconnectionComplete)
}
/**
* Initializes [ChatClient] for a specific user using the given user [token].
* Check [ChatClient.connectUser] with [TokenProvider] parameter for advanced use cases.
*
* @param user Instance of [User] type.
* @param token Instance of JWT token.
*
* @return Executable [Call] responsible for connecting the user.
*/
@CheckResult
@JvmOverloads
public fun connectUser(
user: User,
token: String,
timeoutMilliseconds: Long? = null,
): Call<ConnectionData> {
return connectUser(user, ConstantTokenProvider(token), timeoutMilliseconds)
}
/**
* Initializes [ChatClient] with stored user data.
* Caution: This method doesn't establish connection to the web socket, you should use [connectUser] instead.
*
* This method initializes [ChatClient] to allow the use of Stream REST API client.
* Moreover, it warms up the connection, and sets up notifications.
*/
internal suspend fun setUserWithoutConnectingIfNeeded() {
if (clientState.initializationState.value == InitializationState.INITIALIZING) {
delay(INITIALIZATION_DELAY)
return setUserWithoutConnectingIfNeeded()
} else if (isUserSet() || clientState.initializationState.value == InitializationState.COMPLETE) {
logger.d {
"[setUserWithoutConnectingIfNeeded] User is already set: ${isUserSet()}" +
" Initialization state: ${clientState.initializationState.value}"
}
return
}
userCredentialStorage.get()?.let { credentialConfig ->
val tokenProvider = config.notificationConfig.tokenProvider
initializeClientWithUser(
User(
id = credentialConfig.userId,
name = credentialConfig.userName,
),
tokenProvider = CacheableTokenProvider(
tokenProvider = tokenProvider ?: ConstantTokenProvider(credentialConfig.userToken),
),
isAnonymous = credentialConfig.isAnonymous,
)
}
}
/**
* Checks if there are currently stored user credentials in the local storage.
*/
@InternalStreamChatApi
public fun containsStoredCredentials(): Boolean {
return userCredentialStorage.get() != null
}
private fun storePushNotificationsConfig(userId: String, userName: String, isAnonymous: Boolean) {
userCredentialStorage.put(
CredentialConfig(
userToken = getCurrentToken() ?: "",
userId = userId,
userName = userName,
isAnonymous = isAnonymous,
),
)
}
@CheckResult
@JvmOverloads
public fun connectAnonymousUser(timeoutMilliseconds: Long? = null): Call<ConnectionData> {
return CoroutineCall(clientScope) {
logger.d { "[connectAnonymousUser] no args" }
userScope.userId.value = ANONYMOUS_USER_ID
setUser(
anonUser,
ConstantTokenProvider(devToken(ANONYMOUS_USER_ID)),
timeoutMilliseconds,
).also { result ->
logger.v {
"[connectAnonymousUser] " +
"completed: ${result.stringify { "ConnectionData(connectionId=${it.connectionId})" }}"
}
}
}
}
private suspend fun waitFirstConnection(timeoutMilliseconds: Long?): Result<ConnectionData> =
timeoutMilliseconds?.let {
withTimeoutOrNull(timeoutMilliseconds) { waitConnection.first() }
?: Result.Failure(
Error.GenericError("Connection wasn't established in ${timeoutMilliseconds}ms"),
)
} ?: waitConnection.first()
@CheckResult
@JvmOverloads
public fun connectGuestUser(
userId: String,
username: String,
timeoutMilliseconds: Long? = null,
): Call<ConnectionData> {
return CoroutineCall(clientScope) {
logger.d { "[connectGuestUser] userId: '$userId', username: '$username'" }
userScope.userId.value = userId
getGuestToken(userId, username).await()
.flatMapSuspend { setUser(it.user, ConstantTokenProvider(it.token), timeoutMilliseconds) }
.onSuccess { connectionData ->
logger.v {
"[connectGuestUser] completed: ConnectionData(connectionId=${connectionData.connectionId})"
}
}
}
}
@CheckResult
public fun getGuestToken(userId: String, userName: String): Call<GuestUser> {
return api.getGuestUser(userId, userName)
}
/**
* Query members and apply side effects if there are any.
*
* @param channelType The type of channel.
* @param channelId The id of the channel.
* @param offset Offset limit.
* @param limit Number of members to fetch.
* @param filter [FilterObject] to filter members of certain type.
* @param sort Sort the list of members.
* @param members List of members to search in distinct channels.
*
* @return [Call] with a list of members or an error.
*/
@Suppress("LongParameterList")
@CheckResult
public fun queryMembers(
channelType: String,
channelId: String,
offset: Int,
limit: Int,
filter: FilterObject,
sort: QuerySorter<Member>,
members: List<Member> = emptyList(),
): Call<List<Member>> {
logger.d { "[queryMembers] cid: $channelType:$channelId, offset: $offset, limit: $limit" }
return api.queryMembers(channelType, channelId, offset, limit, filter, sort, members)
.doOnResult(userScope) { result ->
plugins.forEach { plugin ->
logger.v { "[queryMembers] #doOnResult; plugin: ${plugin::class.qualifiedName}" }
plugin.onQueryMembersResult(
result,
channelType,
channelId,
offset,
limit,
filter,
sort,
members,
)
logger.v { "[queryMembers] result: ${result.stringify { "Members(count=${it.size})" }}" }
}
}
.onQueryMembersError(errorHandlers, channelType, channelId, offset, limit, filter, sort, members)
.share(userScope) { QueryMembersIdentifier(channelType, channelId, offset, limit, filter, sort, members) }
}
/**
* Uploads a file for the given channel. Progress can be accessed via [callback].
*
* The Stream CDN imposes the following restrictions on file uploads:
* - The maximum file size is 100 MB
*
* @param channelType The channel type. ie messaging.
* @param channelId The channel id. ie 123.
* @param file The file that needs to be uploaded.
* @param callback The callback to track progress.
*
* @return Executable async [Call] which completes with [Result] containing an instance of [UploadedFile]
* if the file was successfully uploaded.
*
* @see FileUploader
* @see <a href="https://getstream.io/chat/docs/android/file_uploads/?language=kotlin">File Uploads</a>
*/
@CheckResult
@JvmOverloads
public fun sendFile(
channelType: String,
channelId: String,
file: File,