Merge pull request #24 from sendbird/release/3.12.1

3.12.1

Author: sendbird-sdk-deployment

CHANGELOG.md

@@ -1,4 +1,6 @@
 # Changelog
+### v3.12.1 (Jan 18, 2024) with Chat SDK `v4.14.1`
+* Fix memory leaks in UIKit.
 ### v3.12.0 (Jan, 2024) with Chat SDK `v4.13.0`
 * Added `sendLogImpression(List<BaseMessage>)` in `FeedNotificationChannelViewModel`.
 * Improved performance of scrolling in Message List.

gradle.properties

@@ -16,5 +16,5 @@ org.gradle.jvmargs=-Xmx1536m
 # https://developer.android.com/topic/libraries/support-library/androidx-rn
 android.useAndroidX=true
 
-UIKIT_VERSION = 3.12.0
+UIKIT_VERSION = 3.12.1
 UIKIT_VERSION_CODE = 1

uikit-samples/src/main/java/com/sendbird/uikit/samples/basic/GroupChannelMainActivity.kt

@@ -91,6 +91,11 @@ class GroupChannelMainActivity : AppCompatActivity() {
         })
     }
 
+    override fun onPause() {
+        super.onPause()
+        SendbirdChat.removeUserEventHandler(USER_EVENT_HANDLER_KEY)
+    }
+
     private fun redirectChannelIfNeeded(intent: Intent?) {
         if (intent == null) return
         if (intent.flags and Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY == Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY) {

uikit-samples/src/main/java/com/sendbird/uikit/samples/common/LoginActivity.kt

@@ -82,7 +82,6 @@ open class LoginActivity : AppCompatActivity() {
                 Logger.e(e)
                 ContextUtils.toastError(this@LoginActivity, "${e.message}")
                 WaitingDialog.dismiss()
-                PreferenceUtils.clearAll()
                 return@authenticate
             }
             WaitingDialog.dismiss()

uikit-samples/src/main/java/com/sendbird/uikit/samples/notification/NotificationLoginActivity.kt

@@ -32,7 +32,6 @@ class NotificationLoginActivity : LoginActivity() {
             if (e != null) {
                 Logger.e(e)
                 ContextUtils.toastError(this@NotificationLoginActivity, "${e.message}")
-                PreferenceUtils.clearAll()
                 return@authenticate
             }
             PreferenceUtils.userId = userId

uikit-samples/src/main/res/values-ko/strings.xml

@@ -172,7 +172,7 @@
     <string name="text_confirm">확인</string>
     <string name="text_select_count">%d명 선택</string>
 
-    <string name="app_name">SendbirdUIKitCustomSample</string>
+    <string name="app_name">UIKitSamples</string>
     <string name="text_title_login_activity">Sendbird UIKit Sample</string>
 
     <string name="text_version_info">UI Kit v%1$s &#160;&#160;&#160;&#160; SDK v%2$s</string>

uikit/build.gradle

@@ -64,7 +64,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
 
     // Sendbird
-    api 'com.sendbird.sdk:sendbird-chat:4.13.0'
+    api 'com.sendbird.sdk:sendbird-chat:4.14.1'
 
     implementation 'com.github.bumptech.glide:glide:4.13.0'
     annotationProcessor 'com.github.bumptech.glide:compiler:4.13.0'

uikit/src/main/java/com/sendbird/uikit/activities/adapter/FormFieldAdapter.kt

@@ -3,22 +3,23 @@ package com.sendbird.uikit.activities.adapter
 import android.view.LayoutInflater
 import android.view.ViewGroup
 import androidx.recyclerview.widget.DiffUtil
+import com.sendbird.android.message.Form
+import com.sendbird.android.message.FormField
 import com.sendbird.uikit.activities.viewholder.BaseViewHolder
 import com.sendbird.uikit.databinding.SbViewFormFieldBinding
-import com.sendbird.uikit.internal.model.Form
-import com.sendbird.uikit.internal.model.FormField
+import com.sendbird.uikit.internal.extensions.lastValidation
 
 internal class FormFieldAdapter : BaseAdapter<FormField, BaseViewHolder<FormField>>() {
     private val formFields: MutableList<FormField> = mutableListOf()
 
-    fun isReadyToSubmit(): Boolean {
-        return formFields.all { it.isReadyToSubmit() }
+    fun isSubmittable(): Boolean {
+        return formFields.all { it.isSubmittable }
     }
 
     fun updateValidation() {
         formFields.forEachIndexed { index, formField ->
             val lastValidation = formField.lastValidation
-            val validation = formField.isReadyToSubmit()
+            val validation = formField.isSubmittable
             formField.lastValidation = validation
             if (lastValidation != validation) {
                 notifyItemChanged(index)
@@ -27,7 +28,7 @@ internal class FormFieldAdapter : BaseAdapter<FormField, BaseViewHolder<FormFiel
     }
 
     fun setFormFields(form: Form) {
-        val newFormFields = if (form.isAnswered) {
+        val newFormFields = if (form.isSubmitted) {
             form.formFields.filter { it.answer != null }
         } else {
             form.formFields
@@ -83,7 +84,7 @@ internal class FormFieldAdapter : BaseAdapter<FormField, BaseViewHolder<FormFiel
         override fun areItemsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean {
             val oldItem = oldList[oldItemPosition]
             val newItem = newList[newItemPosition]
-            return oldItem.formFieldKey == newItem.formFieldKey &&
+            return oldItem.key == newItem.key &&
                 oldItem.messageId == newItem.messageId
         }
 

uikit/src/main/java/com/sendbird/uikit/activities/adapter/MessageListAdapter.java

@@ -10,8 +10,7 @@
 import com.sendbird.android.message.BaseMessage;
 import com.sendbird.uikit.activities.viewholder.MessageViewHolder;
 import com.sendbird.uikit.interfaces.OnItemClickListener;
-import com.sendbird.uikit.internal.extensions.MessageListAdapterExtensionsKt;
-import com.sendbird.uikit.internal.interfaces.OnSubmitButtonClickListener;
+import com.sendbird.uikit.interfaces.FormSubmitButtonClickListener;
 import com.sendbird.uikit.internal.ui.viewholders.FormMessageViewHolder;
 import com.sendbird.uikit.internal.ui.viewholders.SuggestedRepliesViewHolder;
 import com.sendbird.uikit.internal.wrappers.SendbirdUIKitImpl;
@@ -25,6 +24,9 @@ public class MessageListAdapter extends BaseMessageListAdapter {
     @Nullable
     protected OnItemClickListener<String> suggestedRepliesClickListener;
 
+    @Nullable
+    protected FormSubmitButtonClickListener formSubmitButtonClickListener;
+
     public MessageListAdapter(boolean useMessageGroupUI) {
         this(null, useMessageGroupUI);
     }
@@ -68,7 +70,7 @@ public void onBindViewHolder(@NonNull MessageViewHolder holder, int position) {
         if (holder instanceof FormMessageViewHolder) {
             FormMessageViewHolder formMessageViewHolder = (FormMessageViewHolder) holder;
             formMessageViewHolder.setOnSubmitClickListener((message, form) -> {
-                final OnSubmitButtonClickListener finalListener = MessageListAdapterExtensionsKt.getSubmitButtonClickListener(this);
+                final FormSubmitButtonClickListener finalListener = this.formSubmitButtonClickListener;
                 if (finalListener != null) {
                     finalListener.onClicked(message, form);
                 }
@@ -96,4 +98,25 @@ public OnItemClickListener<String> getSuggestedRepliesClickListener() {
     public void setSuggestedRepliesClickListener(@Nullable OnItemClickListener<String> suggestedRepliesClickListener) {
         this.suggestedRepliesClickListener = suggestedRepliesClickListener;
     }
+
+    /**
+     * Returns a callback to be invoked when the Form submit button is clicked.
+     *
+     * @return {@link FormSubmitButtonClickListener} to be invoked when the Form submit button is clicked.
+     * since 3.12.1
+     */
+    @Nullable
+    public FormSubmitButtonClickListener getFormSubmitButtonClickListener() {
+        return formSubmitButtonClickListener;
+    }
+
+    /**
+     * Register a callback to be invoked when the Form submit button is clicked.
+     *
+     * @param formSubmitButtonClickListener The callback that will run when the Form submit button is clicked.
+     * since 3.12.1
+     */
+    public void setFormSubmitButtonClickListener(@Nullable FormSubmitButtonClickListener formSubmitButtonClickListener) {
+        this.formSubmitButtonClickListener = formSubmitButtonClickListener;
+    }
 }

uikit/src/main/java/com/sendbird/uikit/activities/viewholder/MessageViewHolderFactory.java

@@ -265,13 +265,8 @@ public static int getViewType(@NonNull BaseMessage message) {
     public static MessageType getMessageType(@NonNull BaseMessage message) {
         MessageType type;
 
-        Map<String, String> extendedMessagePayload = message.getExtendedMessagePayload();
-        if (!extendedMessagePayload.isEmpty()) {
-            if (message.getChannelType() == ChannelType.GROUP
-                && !MessageExtensionsKt.getForms(message).isEmpty()
-            ) {
-                return MessageType.VIEW_TYPE_FORM_TYPE_MESSAGE;
-            }
+        if (message.getChannelType() == ChannelType.GROUP && !message.getForms().isEmpty()) {
+            return MessageType.VIEW_TYPE_FORM_TYPE_MESSAGE;
         }
 
         if (message instanceof UserMessage) {

uikit/src/main/java/com/sendbird/uikit/consts/StringSet.kt

@@ -148,22 +148,4 @@ object StringSet {
     const val quote_reply = "quote_reply"
     const val thread = "thread"
     const val parent = "parent"
-
-    // AI ChatBot
-    const val sub_type = "sub_type"
-    const val sub_data = "sub_data"
-    const val suggested_replies = "suggested_replies"
-    const val forms = "forms"
-    const val key = "key"
-    const val fields = "fields"
-    const val data = "data"
-    const val title = "title"
-    const val input_type = "input_type"
-    const val regex = "regex"
-    const val placeholder = "placeholder"
-    const val required = "required"
-    const val text = "text"
-    const val phone = "phone"
-    const val email = "email"
-    const val password = "password"
 }

uikit/src/main/java/com/sendbird/uikit/fragments/ChannelFragment.java

@@ -22,6 +22,7 @@
 import com.sendbird.android.channel.Role;
 import com.sendbird.android.message.BaseMessage;
 import com.sendbird.android.message.FileMessage;
+import com.sendbird.android.message.Form;
 import com.sendbird.android.message.SendingStatus;
 import com.sendbird.android.params.MessageListParams;
 import com.sendbird.android.params.UserMessageCreateParams;
@@ -51,7 +52,6 @@
 import com.sendbird.uikit.interfaces.OnItemClickListener;
 import com.sendbird.uikit.interfaces.OnItemLongClickListener;
 import com.sendbird.uikit.internal.extensions.MessageExtensionsKt;
-import com.sendbird.uikit.internal.extensions.MessageListComponentExtensionsKt;
 import com.sendbird.uikit.internal.model.VoicePlayerManager;
 import com.sendbird.uikit.log.Logger;
 import com.sendbird.uikit.model.DialogListItem;
@@ -203,7 +203,11 @@ public void onDestroy() {
         if (!isInitCallFinished.get()) {
             shouldDismissLoadingDialog();
         }
-        MessageExtensionsKt.clearTemporaryAnswers(getChannelUrl());
+
+        ChannelViewModel.ChannelMessageData channelMessageData = getViewModel().getMessageList().getValue();
+        if (channelMessageData != null) {
+            MessageExtensionsKt.clearLastValidations(channelMessageData.getMessages());
+        }
     }
 
     /**
@@ -260,6 +264,7 @@ protected void onBindMessageListComponent(@NonNull MessageListComponent messageL
         messageListComponent.setOnEmojiReactionLongClickListener(emojiReactionLongClickListener != null ? emojiReactionLongClickListener : (view, position, message, reactionKey) -> showEmojiReactionDialog(message, position));
         messageListComponent.setOnEmojiReactionMoreButtonClickListener(emojiReactionMoreButtonClickListener != null ? emojiReactionMoreButtonClickListener : (view, position, message) -> showEmojiListDialog(message));
         messageListComponent.setSuggestedRepliesClickListener((view, position, data) -> onSuggestedRepliesClicked(data));
+        messageListComponent.setFormSubmitButtonClickListener(this::onFormSubmitButtonClicked);
         messageListComponent.setOnTooltipClickListener(tooltipClickListener != null ? tooltipClickListener : this::onMessageTooltipClicked);
 
         messageListComponent.setOnQuoteReplyMessageLongClickListener(this::onQuoteReplyMessageLongClicked);
@@ -274,14 +279,6 @@ protected void onBindMessageListComponent(@NonNull MessageListComponent messageL
             return false;
         });
 
-        MessageListComponentExtensionsKt.setSubmitButtonClickListener(messageListComponent, (message, form) -> {
-            MessageExtensionsKt.submitForm(message, form, (e) -> {
-                if (e != null) {
-                    showConfirmDialog(getString(R.string.sb_forms_submit_failed));
-                }
-            });
-        });
-
         final ChannelModule module = getModule();
         viewModel.getMessageList().observeAlways(getViewLifecycleOwner(), receivedMessageData -> {
             boolean isInitialCallFinished = isInitCallFinished.getAndSet(true);
@@ -528,6 +525,20 @@ protected void onSuggestedRepliesClicked(@NonNull String suggestedReply) {
         sendUserMessage(params);
     }
 
+    /**
+     * Called when the Form submit button is clicked.
+     *
+     * @param message The message that contains the form
+     * @param form The form to be submitted
+     * since 3.12.1
+     */
+    protected void onFormSubmitButtonClicked(@NonNull BaseMessage message, @NonNull Form form) {
+        message.submitForm(form, (e) -> {
+            if (e != null) {
+                showConfirmDialog(getString(R.string.sb_forms_submit_failed));
+            }
+        });
+    }
 
     /**
      * Find the same message as the message ID and move it to the matching message.

uikit/src/main/java/com/sendbird/uikit/interfaces/FormSubmitButtonClickListener.kt

@@ -0,0 +1,20 @@
+package com.sendbird.uikit.interfaces
+
+import com.sendbird.android.message.BaseMessage
+import com.sendbird.android.message.Form
+
+/**
+ * Interface definition for a callback to be invoked when the submit button of the form is clicked.
+ *
+ * @since 3.12.1
+ */
+fun interface FormSubmitButtonClickListener {
+    /**
+     * Called when the submit button of the form is clicked.
+     *
+     * @param message the message that contains the form
+     * @param form the form to be submitted
+     * @since 3.12.1
+     */
+    fun onClicked(message: BaseMessage, form: Form)
+}

uikit/src/main/java/com/sendbird/uikit/internal/extensions/MessageExtensions.kt

@@ -1,20 +1,16 @@
 package com.sendbird.uikit.internal.extensions
 
 import android.content.Context
-import com.sendbird.android.annotation.AIChatBotExperimental
-import com.sendbird.android.handler.CompletionHandler
 import com.sendbird.android.message.BaseFileMessage
 import com.sendbird.android.message.BaseMessage
 import com.sendbird.android.message.FileMessage
+import com.sendbird.android.message.FormField
 import com.sendbird.android.message.MultipleFilesMessage
 import com.sendbird.uikit.R
 import com.sendbird.uikit.consts.StringSet
-import com.sendbird.uikit.internal.model.Form
-import com.sendbird.uikit.internal.singleton.JsonParser
 import com.sendbird.uikit.internal.singleton.MessageDisplayDataManager
 import com.sendbird.uikit.model.UserMessageDisplayData
 import com.sendbird.uikit.utils.MessageUtils
-import java.util.concurrent.ConcurrentHashMap
 
 internal fun BaseMessage.hasParentMessage() = parentMessageId != 0L
 
@@ -81,59 +77,22 @@ internal fun BaseFileMessage.getName(context: Context): String {
     }
 }
 
-@OptIn(AIChatBotExperimental::class)
-internal fun BaseMessage.submitForm(form: Form, handler: CompletionHandler? = null) {
-    val answers = form.formFields.fold(mutableMapOf<String, String>()) { acc, formField ->
-        val answer = formField.temporaryAnswer ?: return@fold acc
-        acc.apply { put(answer.formFieldKey, answer.answer) }
-    }
-
-    this.submitForm(form.formKey, answers) { e ->
-        handler?.onResult(e)
-    }
+internal fun List<BaseMessage>.clearLastValidations() {
+    this.flatMap { message -> message.forms }
+        .flatMap { form -> form.formFields }
+        .forEach { formField -> formField.lastValidation = null }
 }
 
-internal val BaseMessage.suggestedReplies: List<String>
-    get() {
-        val suggestedReplies = extendedMessagePayload[StringSet.suggested_replies] ?: return emptyList()
-        return try {
-            JsonParser.fromJson(suggestedReplies)
-        } catch (e: Exception) {
-            emptyList()
-        }
-    }
-
-internal val formMap: MutableMap<Long, Pair<String, List<Form>>> = ConcurrentHashMap()
-
-internal val BaseMessage.forms: List<Form>
-    get() {
-        formMap[this.messageId]?.let { return it.second }
-        val forms = extendedMessagePayload[StringSet.forms] ?: return emptyList()
-        return try {
-            JsonParser.fromJson<List<Form>>(forms).onEach { form ->
-                // setting answer to formField manually.
-                val answeredList = form.answeredList
-                form.formFields.forEach { formField ->
-                    formField.messageId = this.messageId
-                    formField.answer = answeredList?.find { it.formFieldKey == formField.formFieldKey }
-                }
-            }.also {
-                formMap[messageId] = this.channelUrl to it
-            }
-        } catch (e: Exception) {
-            emptyList()
+internal val lastValidations: MutableMap<String, Boolean?> = mutableMapOf()
+internal var FormField.lastValidation: Boolean?
+    get() = lastValidations[this.identifier]
+    set(value) {
+        if (value == null) {
+            lastValidations.remove(this.identifier)
+        } else {
+            lastValidations[this.identifier] = value
         }
     }
 
-internal fun clearTemporaryAnswers(channelUrl: String) {
-    formMap.forEach {
-        if (it.value.first == channelUrl) {
-            it.value.second.forEach { form ->
-                form.formFields.forEach { formField ->
-                    formField.temporaryAnswer = null
-                    formField.lastValidation = null
-                }
-            }
-        }
-    }
-}
+private val FormField.identifier: String
+    get() = "${this.messageId}_${this.key}"