Merge pull request #3574 from element-hq/feature/bma/improveMediaModel

Clarify model for Event with attachment
element-hq · Oct 16, 2024 · 7ece687 · 7ece687
2 parents 95941fc + 6ea11fa
commit 7ece687
Show file tree

Hide file tree

Showing 58 changed files with 444 additions and 259 deletions.
diff --git a/...ssages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesFlowNode.kt b/...ssages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesFlowNode.kt
@@ -50,7 +50,6 @@ import io.element.android.features.poll.api.create.CreatePollMode
 import io.element.android.libraries.architecture.BackstackWithOverlayBox
 import io.element.android.libraries.architecture.BaseFlowNode
 import io.element.android.libraries.architecture.createNode
-import io.element.android.libraries.architecture.inputs
 import io.element.android.libraries.architecture.overlay.Overlay
 import io.element.android.libraries.architecture.overlay.operation.show
 import io.element.android.libraries.di.RoomScope
@@ -324,7 +323,8 @@ class MessagesFlowNode @AssistedInject constructor(
             is TimelineItemImageContent -> {
                 val navTarget = NavTarget.MediaViewer(
                     mediaInfo = MediaInfo(
-                        name = event.content.filename ?: event.content.body,
+                        filename = event.content.filename,
+                        caption = event.content.caption,
                         mimeType = event.content.mimeType,
                         formattedFileSize = event.content.formattedFileSize,
                         fileExtension = event.content.fileExtension
@@ -341,7 +341,8 @@ class MessagesFlowNode @AssistedInject constructor(
                 if (event.content.preferredMediaSource != null) {
                     val navTarget = NavTarget.MediaViewer(
                         mediaInfo = MediaInfo(
-                            name = event.content.body,
+                            filename = event.content.filename,
+                            caption = event.content.caption,
                             mimeType = event.content.mimeType,
                             formattedFileSize = event.content.formattedFileSize,
                             fileExtension = event.content.fileExtension
@@ -358,7 +359,8 @@ class MessagesFlowNode @AssistedInject constructor(
             is TimelineItemVideoContent -> {
                 val navTarget = NavTarget.MediaViewer(
                     mediaInfo = MediaInfo(
-                        name = event.content.filename ?: event.content.body,
+                        filename = event.content.filename,
+                        caption = event.content.caption,
                         mimeType = event.content.mimeType,
                         formattedFileSize = event.content.formattedFileSize,
                         fileExtension = event.content.fileExtension
@@ -372,7 +374,8 @@ class MessagesFlowNode @AssistedInject constructor(
             is TimelineItemFileContent -> {
                 val navTarget = NavTarget.MediaViewer(
                     mediaInfo = MediaInfo(
-                        name = event.content.body,
+                        filename = event.content.filename,
+                        caption = event.content.caption,
                         mimeType = event.content.mimeType,
                         formattedFileSize = event.content.formattedFileSize,
                         fileExtension = event.content.fileExtension
@@ -386,7 +389,8 @@ class MessagesFlowNode @AssistedInject constructor(
             is TimelineItemAudioContent -> {
                 val navTarget = NavTarget.MediaViewer(
                     mediaInfo = MediaInfo(
-                        name = event.content.body,
+                        filename = event.content.filename,
+                        caption = event.content.caption,
                         mimeType = event.content.mimeType,
                         formattedFileSize = event.content.formattedFileSize,
                         fileExtension = event.content.fileExtension

diff --git a/...pl/src/main/kotlin/io/element/android/features/messages/impl/actionlist/ActionListView.kt b/...pl/src/main/kotlin/io/element/android/features/messages/impl/actionlist/ActionListView.kt
@@ -269,19 +269,19 @@ private fun MessageSummary(event: TimelineItem.Event, modifier: Modifier = Modif
             content = { ContentForBody(stringResource(CommonStrings.common_shared_location)) }
         }
         is TimelineItemImageContent -> {
-            content = { ContentForBody(event.content.body) }
+            content = { ContentForBody(event.content.bestDescription) }
         }
         is TimelineItemStickerContent -> {
-            content = { ContentForBody(event.content.body) }
+            content = { ContentForBody(event.content.bestDescription) }
         }
         is TimelineItemVideoContent -> {
-            content = { ContentForBody(event.content.body) }
+            content = { ContentForBody(event.content.bestDescription) }
         }
         is TimelineItemFileContent -> {
-            content = { ContentForBody(event.content.body) }
+            content = { ContentForBody(event.content.bestDescription) }
         }
         is TimelineItemAudioContent -> {
-            content = { ContentForBody(event.content.body) }
+            content = { ContentForBody(event.content.bestDescription) }
         }
         is TimelineItemVoiceContent -> {
             content = { ContentForBody(textContent) }

diff --git a/...lin/io/element/android/features/messages/impl/timeline/components/TimelineItemEventRow.kt b/...lin/io/element/android/features/messages/impl/timeline/components/TimelineItemEventRow.kt
@@ -631,7 +631,7 @@ internal fun TimelineItemEventRowPreview() = ElementPreview {
             ATimelineItemEventRow(
                 event = aTimelineItemEvent(
                     isMine = isMine,
-                    content = aTimelineItemImageContent().copy(
+                    content = aTimelineItemImageContent(
                         aspectRatio = 2.5f
                     ),
                     groupPosition = TimelineItemGroupPosition.Last,

diff --git a/...id/features/messages/impl/timeline/components/TimelineItemEventRowForDirectRoomPreview.kt b/...id/features/messages/impl/timeline/components/TimelineItemEventRowForDirectRoomPreview.kt
@@ -38,7 +38,7 @@ internal fun TimelineItemEventRowForDirectRoomPreview() = ElementPreview {
             ATimelineItemEventRow(
                 event = aTimelineItemEvent(
                     isMine = it,
-                    content = aTimelineItemImageContent().copy(
+                    content = aTimelineItemImageContent(
                         aspectRatio = 5f
                     ),
                     groupPosition = TimelineItemGroupPosition.Last,

diff --git a/...t/android/features/messages/impl/timeline/components/TimelineItemEventRowShieldPreview.kt b/...t/android/features/messages/impl/timeline/components/TimelineItemEventRowShieldPreview.kt
@@ -45,7 +45,7 @@ internal fun TimelineItemEventRowShieldPreview() = ElementPreview {
         ATimelineItemEventRow(
             event = aTimelineItemEvent(
                 isMine = true,
-                content = aTimelineItemImageContent().copy(
+                content = aTimelineItemImageContent(
                     aspectRatio = 2.5f
                 ),
                 groupPosition = TimelineItemGroupPosition.Last,
@@ -54,7 +54,7 @@ internal fun TimelineItemEventRowShieldPreview() = ElementPreview {
         )
         ATimelineItemEventRow(
             event = aTimelineItemEvent(
-                content = aTimelineItemImageContent().copy(
+                content = aTimelineItemImageContent(
                     aspectRatio = 2.5f
                 ),
                 groupPosition = TimelineItemGroupPosition.Last,

diff --git a/...ndroid/features/messages/impl/timeline/components/TimelineItemEventRowWithReplyPreview.kt b/...ndroid/features/messages/impl/timeline/components/TimelineItemEventRowWithReplyPreview.kt
@@ -49,7 +49,7 @@ internal fun TimelineItemEventRowWithReplyContentToPreview(
                 event = aTimelineItemEvent(
                     isMine = it,
                     timelineItemReactions = aTimelineItemReactions(count = 0),
-                    content = aTimelineItemImageContent().copy(
+                    content = aTimelineItemImageContent(
                         aspectRatio = 2.5f
                     ),
                     inReplyTo = inReplyToDetails,

diff --git a/...element/android/features/messages/impl/timeline/components/event/TimelineItemAudioView.kt b/...element/android/features/messages/impl/timeline/components/event/TimelineItemAudioView.kt
@@ -63,7 +63,7 @@ fun TimelineItemAudioView(
         Spacer(Modifier.width(spacing))
         Column {
             Text(
-                text = content.body,
+                text = content.bestDescription,
                 color = ElementTheme.materialColors.primary,
                 maxLines = 2,
                 style = ElementTheme.typography.fontBodyLgRegular,

diff --git a/.../element/android/features/messages/impl/timeline/components/event/TimelineItemFileView.kt b/.../element/android/features/messages/impl/timeline/components/event/TimelineItemFileView.kt
@@ -64,7 +64,7 @@ fun TimelineItemFileView(
         Spacer(Modifier.width(spacing))
         Column {
             Text(
-                text = content.body,
+                text = content.bestDescription,
                 color = ElementTheme.materialColors.primary,
                 maxLines = 2,
                 style = ElementTheme.typography.fontBodyLgRegular,

diff --git a/...element/android/features/messages/impl/timeline/components/event/TimelineItemImageView.kt b/...element/android/features/messages/impl/timeline/components/event/TimelineItemImageView.kt
@@ -91,7 +91,7 @@ fun TimelineItemImageView(
                     model = MediaRequestData(
                         source = content.preferredMediaSource,
                         kind = MediaRequestData.Kind.File(
-                            body = content.filename ?: content.body,
+                            fileName = content.filename,
                             mimeType = content.mimeType,
                         ),
                     ),
@@ -108,7 +108,9 @@ fun TimelineItemImageView(
             val caption = if (LocalInspectionMode.current) {
                 SpannedString(content.caption)
             } else {
-                content.formatted?.body?.takeIf { content.formatted.format == MessageFormat.HTML } ?: SpannedString(content.caption)
+                content.formattedCaption?.body
+                    ?.takeIf { content.formattedCaption.format == MessageFormat.HTML }
+                    ?: SpannedString(content.caption)
             }
             CompositionLocalProvider(
                 LocalContentColor provides ElementTheme.colors.textPrimary,
@@ -158,9 +160,9 @@ internal fun TimelineImageWithCaptionRowPreview() = ElementPreview {
             ATimelineItemEventRow(
                 event = aTimelineItemEvent(
                     isMine = isMine,
-                    content = aTimelineItemImageContent().copy(
+                    content = aTimelineItemImageContent(
                         filename = "image.jpg",
-                        body = "A long caption that may wrap into several lines",
+                        caption = "A long caption that may wrap into several lines",
                         aspectRatio = 2.5f,
                     ),
                     groupPosition = TimelineItemGroupPosition.Last,
@@ -170,9 +172,9 @@ internal fun TimelineImageWithCaptionRowPreview() = ElementPreview {
         ATimelineItemEventRow(
             event = aTimelineItemEvent(
                 isMine = false,
-                content = aTimelineItemImageContent().copy(
+                content = aTimelineItemImageContent(
                     filename = "image.jpg",
-                    body = "Image with null aspectRatio",
+                    caption = "Image with null aspectRatio",
                     aspectRatio = null,
                 ),
                 groupPosition = TimelineItemGroupPosition.Last,

diff --git a/...ement/android/features/messages/impl/timeline/components/event/TimelineItemStickerView.kt b/...ement/android/features/messages/impl/timeline/components/event/TimelineItemStickerView.kt
@@ -43,7 +43,7 @@ fun TimelineItemStickerView(
     onShowClick: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
-    val description = content.body.takeIf { it.isNotEmpty() } ?: stringResource(CommonStrings.common_image)
+    val description = content.bestDescription.takeIf { it.isNotEmpty() } ?: stringResource(CommonStrings.common_image)
     Column(
         modifier = modifier.semantics { contentDescription = description },
     ) {
@@ -65,7 +65,7 @@ fun TimelineItemStickerView(
                     model = MediaRequestData(
                         source = content.preferredMediaSource,
                         kind = MediaRequestData.Kind.File(
-                            body = content.body,
+                            fileName = content.filename,
                             mimeType = content.mimeType,
                         ),
                     ),

diff --git a/...element/android/features/messages/impl/timeline/components/event/TimelineItemVideoView.kt b/...element/android/features/messages/impl/timeline/components/event/TimelineItemVideoView.kt
@@ -76,8 +76,8 @@ fun TimelineItemVideoView(
     ) {
         val containerModifier = if (content.showCaption) {
             Modifier
-                .padding(top = 6.dp)
-                .clip(RoundedCornerShape(6.dp))
+                    .padding(top = 6.dp)
+                    .clip(RoundedCornerShape(6.dp))
         } else {
             Modifier
         }
@@ -93,12 +93,12 @@ fun TimelineItemVideoView(
                 var isLoaded by remember { mutableStateOf(false) }
                 AsyncImage(
                     modifier = Modifier
-                        .fillMaxWidth()
-                        .then(if (isLoaded) Modifier.background(Color.White) else Modifier),
+                            .fillMaxWidth()
+                            .then(if (isLoaded) Modifier.background(Color.White) else Modifier),
                     model = MediaRequestData(
                         source = content.thumbnailSource,
                         kind = MediaRequestData.Kind.File(
-                            body = content.filename ?: content.body,
+                            fileName = content.filename,
                             mimeType = content.mimeType
                         )
                     ),
@@ -126,7 +126,9 @@ fun TimelineItemVideoView(
             val caption = if (LocalInspectionMode.current) {
                 SpannedString(content.caption)
             } else {
-                content.formatted?.body?.takeIf { content.formatted.format == MessageFormat.HTML } ?: SpannedString(content.caption)
+                content.formattedCaption?.body
+                    ?.takeIf { content.formattedCaption.format == MessageFormat.HTML }
+                    ?: SpannedString(content.caption)
             }
             CompositionLocalProvider(
                 LocalContentColor provides ElementTheme.colors.textPrimary,
@@ -178,7 +180,7 @@ internal fun TimelineVideoWithCaptionRowPreview() = ElementPreview {
                     isMine = isMine,
                     content = aTimelineItemVideoContent().copy(
                         filename = "video.mp4",
-                        body = "A long caption that may wrap into several lines",
+                        caption = "A long caption that may wrap into several lines",
                         aspectRatio = 2.5f,
                     ),
                     groupPosition = TimelineItemGroupPosition.Last,
@@ -190,7 +192,7 @@ internal fun TimelineVideoWithCaptionRowPreview() = ElementPreview {
                 isMine = false,
                 content = aTimelineItemVideoContent().copy(
                     filename = "video.mp4",
-                    body = "Video with null aspect ratio",
+                    caption = "Video with null aspect ratio",
                     aspectRatio = null,
                 ),
                 groupPosition = TimelineItemGroupPosition.Last,