edits after first review on Github

changelog.d/7762.feature

@@ -1 +1 @@
-Added lab feature to pin/unpin messages
+Added lab feature to pin/unpin messages

gradle.properties

@@ -8,7 +8,7 @@
 # The setting is particularly useful for tweaking memory settings.
 
 # Build Time Optimizations
-org.gradle.jvmargs=-Xmx4g -Xms512M -XX:MaxPermSize=2048m -XX:MaxMetaspaceSize=1g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:+UseParallelGC
+org.gradle.jvmargs=-Xmx4g -Xms512M -XX:MaxMetaspaceSize=1g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:+UseParallelGC
 org.gradle.configureondemand=true
 org.gradle.parallel=true
 org.gradle.vfs.watch=true

library/ui-strings/src/main/res/values/strings.xml

@@ -77,6 +77,10 @@
     <string name="notice_room_server_acl_set_allowed">• Servers matching %s are allowed.</string>
     <string name="notice_room_server_acl_set_ip_literals_allowed">• Servers matching IP literals are allowed.</string>
     <string name="notice_room_server_acl_set_ip_literals_not_allowed">• Servers matching IP literals are banned.</string>
+    <string name="notice_user_pinned_event">%1$s pinned a message.</string>
+    <string name="notice_user_unpinned_event">%1$s unpinned a message.</string>
+    <string name="notice_user_pinned_event_by_you">You pinned a message.</string>
+    <string name="notice_user_unpinned_event_by_you">You unpinned a message.</string>
 
     <string name="notice_room_server_acl_updated_title">%s changed the server ACLs for this room.</string>
     <string name="notice_room_server_acl_updated_title_by_you">You changed the server ACLs for this room.</string>
@@ -373,7 +377,7 @@
     <string name="action_sign_out_confirmation_simple">Are you sure you want to sign out?</string>
     <string name="action_voice_call">Voice Call</string>
     <string name="action_video_call">Video Call</string>
-    <string name="action_open_pinned_messages">Open Pinned Messages</string>
+    <string name="action_open_pinned_events">Open Pinned Messages</string>
     <string name="action_view_threads">View Threads</string>
     <string name="action_mark_all_as_read">Mark all as read</string>
     <string name="action_quick_reply">Quick reply</string>
@@ -803,11 +807,9 @@
     <string name="threads_labs_enable_notice_message">Your homeserver does not currently support threads, so this feature may be unreliable. Some threaded messages may not be reliably available. %sDo you want to enable threads anyway?</string>
 
     <!-- Pinning -->
-    <string name="pinning_message">Pin</string>
-    <string name="unpinning_message">Unpin</string>
-    <string name="pinned_messages_timeline_title">Pinned Messages</string>
-    <string name="user_pinned_message">%1$s pinned a message.</string>
-    <string name="user_unpinned_message">%1$s unpinned a message.</string>
+    <string name="pinning_event">Pin</string>
+    <string name="unpinning_event">Unpin</string>
+    <string name="pinned_events_timeline_title">Pinned Messages</string>
 
     <!-- Search -->
     <string name="search_hint">Search</string>
@@ -3039,7 +3041,7 @@
 
     <string name="labs_auto_report_uisi">Auto Report Decryption Errors.</string>
     <string name="labs_auto_report_uisi_desc">Your system will automatically send logs when an unable to decrypt error occurs</string>
-    <string name="labs_enable_pinned_messages">Enable Pinned Messages</string>
+    <string name="labs_enable_pinned_events">Enable Pinned Messages</string>
     <string name="labs_enable_thread_messages">Enable Thread Messages</string>
     <string name="labs_enable_thread_messages_desc">Note: app will be restarted</string>
     <string name="settings_show_latest_profile">Show latest user info</string>

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/Event.kt

@@ -449,10 +449,10 @@ fun Event.supportsNotification() =
 fun Event.isContentReportable() =
         this.getClearType() in EventType.MESSAGE + EventType.STATE_ROOM_BEACON_INFO.values
 
-fun Event.getIdsOfPinnedEvents(): MutableList<String>? {
+fun Event.getIdsOfPinnedEvents(): List<String>? {
     return getClearContent()?.toModel<PinnedEventsStateContent>()?.eventIds
 }
 
-fun Event.getPreviousIdsOfPinnedEvents(): MutableList<String>? {
+fun Event.getPreviousIdsOfPinnedEvents(): List<String>? {
     return resolvedPrevContent()?.toModel<PinnedEventsStateContent>()?.eventIds
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/pinnedmessages/PinnedEventsStateContent.kt

@@ -24,5 +24,5 @@ import com.squareup.moshi.JsonClass
  */
 @JsonClass(generateAdapter = true)
 data class PinnedEventsStateContent(
-        @Json(name = "pinned") val eventIds: MutableList<String>
+        @Json(name = "pinned") val eventIds: List<String>
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/state/StateService.kt

@@ -67,9 +67,14 @@ interface StateService {
     suspend fun deleteAvatar()
 
     /**
-     * Pin a message of the room.
+     * Pin an event of the room.
      */
-    suspend fun pinMessage(eventIds: MutableList<String>)
+    suspend fun pinEvent(eventId: String)
+
+    /**
+     * Unpin an event of the room.
+     */
+    suspend fun unpinEvent(eventId: String)
 
     /**
      * Send a state event to the room.
@@ -108,16 +113,6 @@ interface StateService {
      */
     fun getStateEventsLive(eventTypes: Set<String>, stateKey: QueryStateEventValue): LiveData<List<Event>>
 
-    /**
-     * Get state event containing the IDs of pinned events of the room
-     */
-    fun getPinnedEventsState(): Event?
-
-    /**
-     * Tells if an event is a pinned message
-     */
-    fun isPinned(eventId: String): Boolean?
-
     suspend fun setJoinRulePublic()
     suspend fun setJoinRuleInviteOnly()
     suspend fun setJoinRuleRestricted(allowList: List<String>)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt

@@ -43,7 +43,7 @@ interface Timeline {
     /**
      * This must be called before any other method after creating the timeline. It ensures the underlying database is open
      */
-    fun start(rootThreadEventId: String? = null, rootPinnedMessageEventId: String? = null)
+    fun start(rootThreadEventId: String? = null, isFromPinnedEventsTimeline: Boolean = false)
 
     /**
      * This must be called when you don't need the timeline. It ensures the underlying database get closed.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/TimelineSettings.kt

@@ -33,9 +33,9 @@ data class TimelineSettings(
          */
         val rootThreadEventId: String? = null,
         /**
-         * The root pinned message eventId if this is a pinned messages timeline, or null if this is NOT a pinned messages timeline.
+         * True if the timeline is a pinned messages timeline.
          */
-        val rootPinnedMessageEventId: String? = null,
+        val isFromPinnedEventsTimeline: Boolean = false,
         /**
          * If true Sender Info shown in room will get the latest data information (avatar + displayName).
          */
@@ -50,5 +50,5 @@ data class TimelineSettings(
     /**
      * Returns true if this is a pinned messages timeline or false otherwise.
      */
-    fun isPinnedMessagesTimeline() = rootPinnedMessageEventId != null
+    fun isPinnedEventsTimeline() = isFromPinnedEventsTimeline
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAPI.kt

@@ -33,7 +33,6 @@ import org.matrix.android.sdk.internal.session.room.membership.RoomMembersRespon
 import org.matrix.android.sdk.internal.session.room.membership.admin.UserIdAndReason
 import org.matrix.android.sdk.internal.session.room.membership.joining.InviteBody
 import org.matrix.android.sdk.internal.session.room.membership.threepid.ThreePidInviteBody
-import org.matrix.android.sdk.internal.session.room.pinnedmessages.PinnedEventsStateResponse
 import org.matrix.android.sdk.internal.session.room.read.ReadBody
 import org.matrix.android.sdk.internal.session.room.relation.RelationsResponse
 import org.matrix.android.sdk.internal.session.room.reporting.ReportContentBody
@@ -249,7 +248,7 @@ internal interface RoomAPI {
                 @Path("roomId") roomId: String,
                 @Path("eventType") eventType: String,
                 @Path("state_key") stateKey: String
-    ): PinnedEventsStateResponse
+    ): Content
 
     /**
      * Paginate relations for event based in normal topological order.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/state/DefaultStateService.kt

@@ -173,23 +173,32 @@ internal class DefaultStateService @AssistedInject constructor(
         )
     }
 
-    override suspend fun pinMessage(eventIds: MutableList<String>) {
+    override suspend fun pinEvent(eventId: String) {
+        val pinnedEvents = getStateEvent(EventType.STATE_ROOM_PINNED_EVENT, QueryStringValue.Equals(""))
+                ?.getIdsOfPinnedEvents()
+                ?.toMutableList()
+        pinnedEvents?.add(eventId)
+        val newListOfPinnedEvents = pinnedEvents?.toList() ?: return
+        setPinnedEvents(newListOfPinnedEvents)
+    }
+
+    override suspend fun unpinEvent(eventId: String) {
+        val pinnedEvents = getStateEvent(EventType.STATE_ROOM_PINNED_EVENT, QueryStringValue.Equals(""))
+                ?.getIdsOfPinnedEvents()
+                ?.toMutableList()
+        pinnedEvents?.remove(eventId)
+        val newListOfPinnedEvents = pinnedEvents?.toList() ?: return
+        setPinnedEvents(newListOfPinnedEvents)
+    }
+
+    private suspend fun setPinnedEvents(eventIds: List<String>) {
         sendStateEvent(
                 eventType = EventType.STATE_ROOM_PINNED_EVENT,
                 body = PinnedEventsStateContent(eventIds).toContent(),
                 stateKey = ""
         )
     }
 
-    override fun getPinnedEventsState(): Event? {
-        return getStateEvent(EventType.STATE_ROOM_PINNED_EVENT, QueryStringValue.Equals(""))
-    }
-
-    override fun isPinned(eventId: String): Boolean? {
-        val idsOfPinnedEvents: MutableList<String> = getPinnedEventsState()?.getIdsOfPinnedEvents() ?: return null
-        return idsOfPinnedEvents.contains(eventId)
-    }
-
     override suspend fun setJoinRulePublic() {
         updateJoinRule(RoomJoinRules.PUBLIC, null)
     }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/timeline/DefaultTimeline.kt

@@ -99,8 +99,7 @@ internal class DefaultTimeline(
     private var isFromThreadTimeline = false
     private var rootThreadEventId: String? = null
 
-    private var isFromPinnedMessagesTimeline = false
-    private var rootPinnedMessageEventId: String? = null
+    private var isFromPinnedEventsTimeline = false
 
     private val strategyDependencies = LoadTimelineStrategy.Dependencies(
             timelineSettings = settings,
@@ -132,7 +131,7 @@ internal class DefaultTimeline(
     override fun addListener(listener: Timeline.Listener): Boolean {
         listeners.add(listener)
         timelineScope.launch {
-            val snapshot = if (isFromPinnedMessagesTimeline) {
+            val snapshot = if (isFromPinnedEventsTimeline) {
                 getPinnedEvents()
             } else {
                 strategy.buildSnapshot()
@@ -152,7 +151,7 @@ internal class DefaultTimeline(
         listeners.clear()
     }
 
-    override fun start(rootThreadEventId: String?, rootPinnedMessageEventId: String?) {
+    override fun start(rootThreadEventId: String?, isFromPinnedEventsTimeline: Boolean) {
         timelineScope.launch {
             loadRoomMembersIfNeeded()
         }
@@ -161,8 +160,7 @@ internal class DefaultTimeline(
                 if (isStarted.compareAndSet(false, true)) {
                     isFromThreadTimeline = rootThreadEventId != null
                     this@DefaultTimeline.rootThreadEventId = rootThreadEventId
-                    isFromPinnedMessagesTimeline = rootPinnedMessageEventId != null
-                    this@DefaultTimeline.rootPinnedMessageEventId = rootPinnedMessageEventId
+                    this@DefaultTimeline.isFromPinnedEventsTimeline = isFromPinnedEventsTimeline
                     // /
                     val realm = Realm.getInstance(realmConfiguration)
                     ensureReadReceiptAreLoaded(realm)
@@ -267,8 +265,8 @@ internal class DefaultTimeline(
             }
         }
         Timber.v("$baseLogMessage: result $loadMoreResult")
-        val hasMoreToLoad = if (isFromPinnedMessagesTimeline) {
-            !areAllPinnedMessagesLoaded()
+        val hasMoreToLoad = if (isFromPinnedEventsTimeline) {
+            !areAllPinnedEventsLoaded()
         } else {
             loadMoreResult != LoadMoreResult.REACHED_END
         }
@@ -352,7 +350,7 @@ internal class DefaultTimeline(
     }
 
     private suspend fun postSnapshot() {
-        val snapshot = if (isFromPinnedMessagesTimeline) {
+        val snapshot = if (isFromPinnedEventsTimeline) {
             getPinnedEvents()
         } else {
             strategy.buildSnapshot()
@@ -371,25 +369,22 @@ internal class DefaultTimeline(
         }
     }
 
-    private fun getIdsOfPinnedEvents(): MutableList<String> {
+    private fun getIdsOfPinnedEvents(): List<String> {
         return stateEventDataSource
                 .getStateEvent(roomId, EventType.STATE_ROOM_PINNED_EVENT, QueryStringValue.Equals(""))
-                ?.getIdsOfPinnedEvents() ?: mutableListOf("")
+                ?.getIdsOfPinnedEvents()
+                .orEmpty()
     }
 
     private fun getPinnedEvents(): List<TimelineEvent> {
-        val idsOfPinnedEvents = getIdsOfPinnedEvents()
-        val pinnedEvents = ArrayList<TimelineEvent>()
-        for (id in idsOfPinnedEvents) {
-            val timelineEvent = timelineEventDataSource.getTimelineEvent(roomId, id)
-            if (timelineEvent != null) {
-                pinnedEvents.add(timelineEvent)
-            }
-        }
-        return pinnedEvents.reversed()
+        return getIdsOfPinnedEvents()
+                .mapNotNull { id ->
+                    timelineEventDataSource.getTimelineEvent(roomId, id)
+                }
+                .reversed()
     }
 
-    private fun areAllPinnedMessagesLoaded(): Boolean {
+    private fun areAllPinnedEventsLoaded(): Boolean {
         return getIdsOfPinnedEvents().size == getPinnedEvents().size
     }
 

vector-config/src/main/res/values/config-settings.xml

@@ -39,7 +39,7 @@
     <!-- Level 1: Labs -->
     <bool name="settings_labs_deferred_dm_visible">true</bool>
     <bool name="settings_labs_deferred_dm_default">true</bool>
-    <bool name="settings_labs_pinned_messages_default">false</bool>
+    <bool name="settings_labs_pinned_events_default">false</bool>
     <bool name="settings_labs_thread_messages_default">false</bool>
     <bool name="settings_labs_new_app_layout_default">true</bool>
     <bool name="settings_labs_new_session_manager_default">false</bool>

vector/src/main/AndroidManifest.xml

@@ -149,7 +149,7 @@
         <activity android:name=".features.roomdirectory.roompreview.RoomPreviewActivity" />
         <activity android:name=".features.home.room.filtered.FilteredRoomsActivity" />
         <activity android:name=".features.home.room.threads.ThreadsActivity" />
-        <activity android:name=".features.home.room.pinnedmessages.PinnedMessagesActivity" />
+        <activity android:name=".features.home.room.pinnedmessages.PinnedEventsActivity" />
 
         <activity
             android:name=".features.home.room.detail.RoomDetailActivity"

vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailAction.kt

@@ -30,8 +30,8 @@ import org.matrix.android.sdk.api.session.widgets.model.Widget
 import org.matrix.android.sdk.api.util.MatrixItem
 
 sealed class RoomDetailAction : VectorViewModelAction {
-    data class PinMessage(val eventId: String) : RoomDetailAction()
-    data class UnpinMessage(val eventId: String) : RoomDetailAction()
+    data class PinEvent(val eventId: String) : RoomDetailAction()
+    data class UnpinEvent(val eventId: String) : RoomDetailAction()
     data class SendSticker(val stickerContent: MessageStickerContent) : RoomDetailAction()
     data class SendMedia(val attachments: List<ContentAttachmentData>, val compressBeforeSending: Boolean) : RoomDetailAction()
     data class TimelineEventTurnsVisible(val event: TimelineEvent) : RoomDetailAction()

vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailViewState.kt

@@ -71,7 +71,6 @@ data class RoomDetailViewState(
         val isAllowedToManageWidgets: Boolean = false,
         val isAllowedToStartWebRTCCall: Boolean = true,
         val isAllowedToSetupEncryption: Boolean = true,
-        val rootPinnedMessageEventId: String?,
         val hasFailedSending: Boolean = false,
         val jitsiState: JitsiState = JitsiState(),
         val switchToParentSpace: Boolean = false,
@@ -81,6 +80,7 @@ data class RoomDetailViewState(
         val isSharingLiveLocation: Boolean = false,
         val showKeyboardWhenPresented: Boolean = false,
         val sharedData: SharedData? = null,
+        val isFromPinnedEventsTimeline: Boolean = false,
 ) : MavericksState {
 
     constructor(args: TimelineArgs) : this(
@@ -93,7 +93,7 @@ data class RoomDetailViewState(
             rootThreadEventId = args.threadTimelineArgs?.rootThreadEventId,
             showKeyboardWhenPresented = args.threadTimelineArgs?.showKeyboard.orFalse(),
             sharedData = args.sharedData,
-            rootPinnedMessageEventId = args.pinnedMessagesTimelineArgs?.rootPinnedMessageEventId,
+            isFromPinnedEventsTimeline = args.pinnedEventsTimelineArgs != null,
     )
 
     fun isCallOptionAvailable(): Boolean {
@@ -115,7 +115,7 @@ data class RoomDetailViewState(
 
     fun isThreadTimeline() = rootThreadEventId != null
 
-    fun isPinnedMessagesTimeline() = rootPinnedMessageEventId != null
+    fun isPinnedEventsTimeline() = isFromPinnedEventsTimeline
 
     fun isLocalRoom() = RoomLocalEcho.isLocalEchoId(roomId)
 }