Building a production-ready Chat SDK with Jetpack Compose (Mobius 2021)

In this session, we talk about how we built the world's first Jetpack Compose Chat SDK, what challenges we met along the way, and why put so much trust into a technology that only recently became stable.

We also talk about the API design and what decisions we've made to allow for both quick-to-integrate default behavior and UI, as well as a rich set of customization options to make the SDK fit your needs.

More details: https://zsmb.co/appearances/mobius-2021/

Transcript

1. Building a production-ready Chat SDK with Jetpack Compose Filip Babić Jetpack Compose Lead @filbabic Márton Braun Android Dev Advocate @zsmb13 1
2. About Filip Lead Android Developer for Jetpack Compose at Stream GDE @ Kotlin & Android. Published author and conference speaker. Links: - @filbabic on Twitter - /in/filbabic/ on LinkedIn 2
3. About Márton Android Developer Advocate at Stream GDE @ Kotlin & Android. Published author and conference speaker. Find me: - @zsmb13 on Twitter - on zsmb.co - /in/zsmb13 on LinkedIn 3
4. Contents • Why Jetpack Compose? • Compose in production? • Our component design system • Common pitfalls & concerns • Component readability • Customization 4
5. Why Jetpack Compose? 5
6. Why Jetpack Compose? It’ll change Android development forever • Faster and more efficient development • Intuitive API design after the initial learning curve • Declarative + components as functions = deep customization • Language consistency (all Kotlin!) 6
7. Why Jetpack Compose for Stream? Meet users where they are • Provide easy-to-use, “idiomatic” APIs • Great match for our SDK’s customization needs ◦ Theming ◦ Slot APIs 7
8. Compose in production? 8
9. Compose in production? It’s been pretty stable for many months now - since the first betas. The core API is stable and secure, but there are some parts of the API that need more work. For the most part, you can avoid these experimental APIs in your day-to-day. 9
10. API to watch out for • Accompanist libraries • Some lazy APIs • Sticky headers, Grids • Some modifiers • Some Material Components (e.g. clickable Card and Surface) 10
11. Using experimental APIs 11 zsmb.co/opt-in-annotations/
12. With all that, we can say that Compose is prod-ready and here to stay! :] 12
13. Component design system 13
14. Component design system We provide three component types • Screen components: Out-of-the-box solutions with limited customization. • Bound components: OoB solutions for a portion of the screen. More customizable. • Stateless components: State-driven components offering full customization. 14
15. override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContent { ChatTheme { MessagesScreen( channelId = channelId, messageLimit = 30, onBackPressed = { finish() }, onHeaderActionClick = {} ) } } } Screen components 15
16. @Composable public fun MessagesScreen( channelId: String, messageLimit: Int = 30, showHeader: Boolean = true, onBackPressed: () -> Unit = {}, onHeaderActionClick: () -> Unit = {}, ) Screen components 16
17. @Composable public fun MessagesScreen( channelId: String, messageLimit: Int = 30, showHeader: Boolean = true, onBackPressed: () -> Unit = {}, onHeaderActionClick: () -> Unit = {}, ) Screen components 17
18. // Rest of your UI / setContent MessageList( modifier = Modifier .background(ChatTheme.colors.appBackground) .fillMaxSize(), viewModel = listViewModel, onThreadClick = { message -> // Handle clicks } ) Bound components 18
19. @Composable public fun MessageList( viewModel: MessageListViewModel, modifier: Modifier = Modifier, onThreadClick: (Message) -> Unit = { viewModel.openMessageThread(it) }, onLongItemClick: (Message) -> Unit = { viewModel.selectMessage(it) }, onMessagesStartReached: () -> Unit = { viewModel.loadMore() }, onScrollToBottom: () -> Unit = { viewModel.clearNewMessageState() }, itemContent: @Composable (MessageItem) -> Unit = { DefaultMessageContainer( messageItem = it, onThreadClick = onThreadClick, onLongItemClick = onLongItemClick, ) }, ... ) Bound components 19
20. @Composable public fun MessageList( viewModel: MessageListViewModel, modifier: Modifier = Modifier, onThreadClick: (Message) -> Unit = { viewModel.openMessageThread(it) }, onLongItemClick: (Message) -> Unit = { viewModel.selectMessage(it) }, onMessagesStartReached: () -> Unit = { viewModel.loadMore() }, onScrollToBottom: () -> Unit = { viewModel.clearNewMessageState() }, itemContent: @Composable (MessageItem) -> Unit = { DefaultMessageContainer( messageItem = it, onThreadClick = onThreadClick, onLongItemClick = onLongItemClick, ) }, ... ) Bound components 20
21. @Composable public fun MessageList( viewModel: MessageListViewModel, modifier: Modifier = Modifier, onThreadClick: (Message) -> Unit = { viewModel.openMessageThread(it) }, onLongItemClick: (Message) -> Unit = { viewModel.selectMessage(it) }, onMessagesStartReached: () -> Unit = { viewModel.loadMore() }, onScrollToBottom: () -> Unit = { viewModel.clearNewMessageState() }, itemContent: @Composable (MessageItem) -> Unit = { DefaultMessageContainer( messageItem = it, onThreadClick = onThreadClick, onLongItemClick = onLongItemClick, ) }, ... ) Bound components 21
23. @Composable public fun Messages( messagesState: MessagesState, onMessagesStartReached: () -> Unit, onLastVisibleMessageChanged: (MessageItem) -> Unit, onScrollToBottom: () -> Unit, modifier: Modifier = Modifier, itemContent: @Composable (MessageItem) -> Unit, ) Stateless components 23
24. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components Loading & Pagination state 24
25. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components 25
26. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components Empty and Loaded states 26
27. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components 27
28. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components Overlay (selected message) Thread mode Unread message indicator 28
29. public data class MessagesState( val isLoading: Boolean = true, val isLoadingMore: Boolean = false, val endOfMessages: Boolean = false, val messageItems: List<MessageItem> = emptyList(), val selectedMessage: Message? = null, val currentUser: User? = null, val newMessageState: NewMessageState? = null, val parentMessageId: String? = null, val unreadCount: Int = 0, ) Stateless components 29
30. Common Pitfalls 30
31. • Thinking imperatively - you can’t “update” the UI or set listeners. • Hardcoding customization - using modifiers too much in internal code. • Migrating everything - just like with Kotlin, you should migrate slowly. • Lack of examples - there aren’t too many examples out there to guide you. Common pitfalls/issues in Compose Things you’ll probably run into 31
32. Common Concerns 32
33. • Dynamic sized components (Avatar) • Message List optimizations (Optimistic updates) • Deep customization (e.g. attachments, colors, typography…) Common Concerns Things we were worried about 33
34. Component Readability 34
35. Component Readability Avoid falling into the trap of component hell Most declarative UI frameworks suffer from the issue of deep component nesting. For readability, we suggest moving to a “flat structure” if possible for your high-level components, as well as logically decoupling components. 35
36. @Composable public fun MessagesScreen(...) { Box(modifier = Modifier.fillMaxSize()) { Scaffold( modifier = Modifier.fillMaxSize(), topBar = { if (showHeader) MessageListHeader(...) }, bottomBar = { MessageComposer() } ) { MessageList() } } } 36
37. @Composable public fun MessagesScreen(...) { Box(modifier = Modifier.fillMaxSize()) { Scaffold(...) { MessageList() } if (selectedMessage != null) SelectedMessageOverlay() if (isShowingAttachments) AttachmentsPicker() val deleteAction = messageActions.firstOrNull { it is Delete } if (deleteAction != null) SimpleDialog() } } 37
39. Box(modifier = Modifier.fillMaxSize()) { BottomDrawer(drawerContent = { AnimatedVisibility(visible = isShowingAttachments) { AttachmentsPicker(...) } }) { Scaffold(topBar = { ... }, bottomBar = { ... }) { MessageList(itemContent = { }) } } if (messageActions.any { it is Delete }){ } } 39
40. Customization mindset 40
41. Customization Mindset Give out-of-the-box solutions, allow customization • Provide a modifier in components people will use - Jetpack Compose API Guidelines. • Think about exposing content parameters where appropriate - Slot APIs. • Think about theming and building a design system. • Provide customization for state and action handlers. 41
42. State Action handlers UI & Slot APIs Component parameters @Composable public fun MessageComposer( viewModel: MessageComposerViewModel, onSendMessage: (Message) -> Unit = { viewModel.sendMessage(it) }, onAttachmentsClick: () -> Unit = {}, onValueChange: (String) -> Unit = { viewModel.setMessageInput(it) }, onAttachmentRemoved: (Attachment) -> Unit = { viewModel.removeSelectedAttachment(it) }, onCancelAction: () -> Unit = { viewModel.dismissMessageActions() }, modifier: Modifier = Modifier, integrations: @Composable RowScope.() -> Unit = { DefaultComposerIntegrations(onAttachmentsClick) }, label: @Composable () -> Unit = { DefaultComposerLabel() }, input: @Composable RowScope.() -> Unit = { MessageInput( modifier = Modifier .fillMaxWidth() .weight(1f), label = label, value = viewModel.input, attachments = viewModel.selectedAttachments, activeAction = viewModel.activeAction, onValueChange = onValueChange, onAttachmentRemoved = onAttachmentRemoved ) }, ) 42
43. State @Composable public fun MessageComposer( viewModel: MessageComposerViewModel, ) 43
44. @Composable public fun MessageComposer( value: String, attachments: List<Attachment>, activeAction: MessageAction?, ) State @Composable public fun MessageComposer( viewModel: MessageComposerViewModel, ) 44
45. Action handlers @Composable public fun MessageComposer( onSendMessage: (Message) -> Unit = { viewModel.sendMessage(it) }, onAttachmentsClick: () -> Unit = {}, onValueChange: (String) -> Unit = { viewModel.setMessageInput(it) }, onAttachmentRemoved: (Attachment) -> Unit = { viewModel.removeSelectedAttachment(it) }, onCancelAction: () -> Unit = { viewModel.dismissMessageActions() }, ) 45
46. Action handlers @Composable public fun MessageComposer( onSendMessage: (Message) -> Unit = { viewModel.sendMessage(it) }, onAttachmentsClick: () -> Unit = {}, onValueChange: (String) -> Unit = { viewModel.setMessageInput(it) }, onAttachmentRemoved: (Attachment) -> Unit = { viewModel.removeSelectedAttachment(it) }, onCancelAction: () -> Unit = { viewModel.dismissMessageActions() }, ) MessageComposer( viewModel = composerViewModel, onSendMessage = { message -> message.text = message.text.replace("XML", "Jetpack Compose") composerViewModel.sendMessage(message) } ) 46
47. Action handlers @Composable public fun MessageComposer( onSendMessage: (Message) -> Unit = { viewModel.sendMessage(it) }, onAttachmentsClick: () -> Unit = {}, onValueChange: (String) -> Unit = { viewModel.setMessageInput(it) }, onAttachmentRemoved: (Attachment) -> Unit = { viewModel.removeSelectedAttachment(it) }, onCancelAction: () -> Unit = { viewModel.dismissMessageActions() }, ) MessageComposer( viewModel = composerViewModel, onSendMessage = { message -> message.text = message.text.replace("XML", "Jetpack Compose") composerViewModel.sendMessage(message) } ) 47
48. @Composable public fun MessageComposer( integrations: @Composable RowScope.() -> Unit = { DefaultComposerIntegrations(onAttachmentsClick) }, label: @Composable () -> Unit = { DefaultComposerLabel() }, input: @Composable RowScope.() -> Unit = { MessageInput( modifier = Modifier.fillMaxWidth().weight(1f), label = label, value = viewModel.input, attachments = viewModel.selectedAttachments, activeAction = viewModel.activeAction, onValueChange = onValueChange, onAttachmentRemoved = onAttachmentRemoved ) }, ) Slot APIs 48
49. @Composable public fun MessageComposer( integrations: @Composable RowScope.() -> Unit = { DefaultComposerIntegrations(onAttachmentsClick) }, label: @Composable () -> Unit = { DefaultComposerLabel() }, input: @Composable RowScope.() -> Unit = { MessageInput( modifier = Modifier.fillMaxWidth().weight(1f), label = label, value = viewModel.input, attachments = viewModel.selectedAttachments, activeAction = viewModel.activeAction, onValueChange = onValueChange, onAttachmentRemoved = onAttachmentRemoved ) }, ) Slot APIs 49
50. @Composable public fun MessageComposer( integrations: @Composable RowScope.() -> Unit = { DefaultComposerIntegrations(onAttachmentsClick) }, label: @Composable () -> Unit = { DefaultComposerLabel() }, input: @Composable RowScope.() -> Unit = { MessageInput( modifier = Modifier.fillMaxWidth().weight(1f), label = label, value = viewModel.input, attachments = viewModel.selectedAttachments, activeAction = viewModel.activeAction, onValueChange = onValueChange, onAttachmentRemoved = onAttachmentRemoved ) }, ) Slot APIs 50
51. @Composable public fun MessageComposer( integrations: @Composable RowScope.() -> Unit = { DefaultComposerIntegrations(onAttachmentsClick) }, label: @Composable () -> Unit = { DefaultComposerLabel() }, input: @Composable RowScope.() -> Unit = { MessageInput( modifier = Modifier.fillMaxWidth().weight(1f), label = label, value = viewModel.input, attachments = viewModel.selectedAttachments, activeAction = viewModel.activeAction, onValueChange = onValueChange, onAttachmentRemoved = onAttachmentRemoved ) }, ) Slot APIs 51
52. @Composable public fun ChatTheme( isInDarkMode: Boolean = isSystemInDarkTheme(), colors: StreamColors = if (isInDarkMode) StreamColors.defaultDarkColors() else StreamColors.defaultColors(), typography: StreamTypography = StreamTypography.default, shapes: StreamShapes = StreamShapes.default, attachmentFactories: List<AttachmentFactory> = StreamAttachmentFactories.defaultFactories, reactionTypes: Map<String, Int> = defaultReactionTypes, content: @Composable () -> Unit, ) { CompositionLocalProvider( LocalColors provides colors, LocalTypography provides typography, LocalShapes provides shapes, LocalAttachmentFactories provides attachmentFactories, LocalReactionTypes provides reactionTypes, ) { content() } } 52
53. @Composable public fun ChatTheme( isInDarkMode: Boolean = isSystemInDarkTheme(), colors: StreamColors = if (isInDarkMode) StreamColors.defaultDarkColors() else StreamColors.defaultColors(), typography: StreamTypography = StreamTypography.default, shapes: StreamShapes = StreamShapes.default, attachmentFactories: List<AttachmentFactory> = StreamAttachmentFactories.defaultFactories, reactionTypes: Map<String, Int> = defaultReactionTypes, content: @Composable () -> Unit, ) { CompositionLocalProvider( LocalColors provides colors, LocalTypography provides typography, LocalShapes provides shapes, LocalAttachmentFactories provides attachmentFactories, LocalReactionTypes provides reactionTypes, ) { content() } } 53
54. @Composable public fun ChatTheme( isInDarkMode: Boolean = isSystemInDarkTheme(), colors: StreamColors = if (isInDarkMode) StreamColors.defaultDarkColors() else StreamColors.defaultColors(), typography: StreamTypography = StreamTypography.default, shapes: StreamShapes = StreamShapes.default, attachmentFactories: List<AttachmentFactory> = StreamAttachmentFactories.defaultFactories, reactionTypes: Map<String, Int> = defaultReactionTypes, content: @Composable () -> Unit, ) { CompositionLocalProvider( LocalColors provides colors, LocalTypography provides typography, LocalShapes provides shapes, LocalAttachmentFactories provides attachmentFactories, LocalReactionTypes provides reactionTypes, ) { content() } } 54
55. public data class StreamColors( public val textHighEmphasis: Color, public val textLowEmphasis: Color, public val disabled: Color, public val borders: Color, public val inputBackground: Color, public val appBackground: Color, public val barsBackground: Color, public val linkBackground: Color, public val primaryAccent: Color, public val errorAccent: Color, public val infoAccent: Color, public val highlight: Color, ) 55
56. Chat SDK Resources • Compose Chat SDK on GitHub 🌟 • https://github.com/GetStream/stream-chat-android/ • Compose Tutorial • https://getstream.io/chat/compose/tutorial/ • Compose SDK docs • https://getstream.io/chat/docs/sdk/android/compose/overview/ • Twitter • @getstream_io 56
57. Jetpack Compose Resources • Official Jetpack Compose API Guidelines • https://github.com/androidx/androidx/blob/androidx-main/compose/doc s/compose-api-guidelines.md • Google Compose pathway • https://developer.android.com/courses/pathways/compose • GDG Osijek YT • www.youtube.com/channel/UCAXQuBMZ5B7f4thG5gO_3Rw 57
58. Questions? Filip Babić Jetpack Compose Lead @filbabic Márton Braun Android Dev Advocate @zsmb13 58