feat: add RSS video thumbnails

Author: Priveetee

openapi/paths/rss.yaml

@@ -108,7 +108,7 @@ RssFeedDocument:
       - { name: token, in: query, required: true, schema: { type: string } }
     responses:
       '200':
-        description: RSS document
+        description: RSS 2.0 document. Video items include a media:thumbnail element when a HTTP(S) thumbnail URL is available.
         headers:
           ETag: { schema: { type: string } }
           Last-Modified: { schema: { type: string } }

src/main/kotlin/dev/typetype/server/services/RssDocumentRenderer.kt

@@ -3,6 +3,7 @@ package dev.typetype.server.services
 import dev.typetype.server.models.RssFeedItem
 import dev.typetype.server.models.VideoItem
 import java.io.ByteArrayOutputStream
+import java.net.URI
 import java.net.URLEncoder
 import java.nio.charset.StandardCharsets
 import java.time.Instant
@@ -23,6 +24,7 @@ internal object RssDocumentRenderer {
         writer.writeStartDocument(StandardCharsets.UTF_8.name(), "1.0")
         writer.writeStartElement("rss")
         writer.writeAttribute("version", "2.0")
+        writer.writeNamespace("media", MEDIA_NAMESPACE)
         writer.writeStartElement("channel")
         writer.element("title", feed.name)
         writer.element("link", publicBaseUrl)
@@ -52,6 +54,11 @@ internal object RssDocumentRenderer {
         writeEndElement()
         element("author", video.uploaderName)
         video.shortDescription?.takeIf(String::isNotBlank)?.let { element("description", it) }
+        video.thumbnailUrl.httpUrlOrNull()?.let { thumbnailUrl ->
+            writeStartElement("media", "thumbnail", MEDIA_NAMESPACE)
+            writeAttribute("url", thumbnailUrl)
+            writeEndElement()
+        }
         RssVideoMetadata.publishedAtMillis(video).takeIf { it > 0 }
             ?.let { element("pubDate", RFC_1123.format(Instant.ofEpochMilli(it))) }
         writeEndElement()
@@ -63,5 +70,14 @@ internal object RssDocumentRenderer {
         writeEndElement()
     }
 
+    private fun String.httpUrlOrNull(): String? = runCatching {
+        URI(this).takeIf { uri ->
+            uri.isAbsolute && uri.host != null &&
+                (uri.scheme.equals("http", ignoreCase = true) ||
+                uri.scheme.equals("https", ignoreCase = true))
+        }?.toString()
+    }.getOrNull()
+
+    private const val MEDIA_NAMESPACE = "http://search.yahoo.com/mrss/"
     private val RFC_1123 = DateTimeFormatter.RFC_1123_DATE_TIME.withZone(ZoneOffset.UTC)
 }

src/test/kotlin/dev/typetype/server/RssDocumentRendererTest.kt

@@ -0,0 +1,60 @@
+package dev.typetype.server
+
+import dev.typetype.server.models.RssFeedItem
+import dev.typetype.server.services.RssDocumentRenderer
+import org.junit.jupiter.api.Assertions.assertFalse
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Test
+
+class RssDocumentRendererTest {
+    @Test
+    fun `renders a media thumbnail for HTTP(S) video thumbnails`() {
+        val video = testVideoItem().copy(thumbnailUrl = "https://img.example/thumb.jpg")
+
+        val xml = RssDocumentRenderer.render(feed(), listOf(video), "https://video.example", 1_000L)
+            .toString(Charsets.UTF_8)
+
+        assertTrue(xml.contains("xmlns:media=\"http://search.yahoo.com/mrss/\""))
+        assertTrue(xml.contains("<media:thumbnail url=\"https://img.example/thumb.jpg\""))
+    }
+
+    @Test
+    fun `omits a media thumbnail when the video has no HTTP(S) thumbnail`() {
+        val xml = RssDocumentRenderer.render(feed(), listOf(testVideoItem()), "https://video.example", 1_000L)
+            .toString(Charsets.UTF_8)
+
+        assertFalse(xml.contains("media:thumbnail"))
+    }
+
+    @Test
+    fun `omits a media thumbnail for unsupported or relative URLs`() {
+        val video = testVideoItem().copy(thumbnailUrl = "ftp://img.example/thumb.jpg")
+
+        val xml = RssDocumentRenderer.render(feed(), listOf(video), "https://video.example", 1_000L)
+            .toString(Charsets.UTF_8)
+
+        assertFalse(xml.contains("media:thumbnail"))
+
+        val relativeScheme = testVideoItem().copy(thumbnailUrl = "https:/img.example/thumb.jpg")
+        val relativeXml = RssDocumentRenderer.render(feed(), listOf(relativeScheme), "https://video.example", 1_000L)
+            .toString(Charsets.UTF_8)
+
+        assertFalse(relativeXml.contains("media:thumbnail"))
+    }
+
+    private fun feed() = RssFeedItem(
+        id = "feed-id",
+        name = "Feed",
+        scope = "all",
+        channelUrls = emptyList(),
+        serviceIds = listOf(0, 5, 6),
+        includeVideos = true,
+        includeShorts = true,
+        includeLive = true,
+        includeUpcoming = true,
+        enabled = true,
+        createdAt = 1L,
+        updatedAt = 1L,
+        lastUsedAt = null,
+    )
+}

src/test/kotlin/dev/typetype/server/RssFeedReaderRoutesTest.kt

@@ -70,7 +70,7 @@ class RssFeedReaderRoutesTest {
         assertEquals(HttpStatusCode.OK, first.status)
         assertEquals("application/rss+xml; charset=utf-8", first.headers[HttpHeaders.ContentType])
         assertEquals("private, max-age=300, must-revalidate", first.headers[HttpHeaders.CacheControl])
-        assertTrue(first.bodyAsText().contains("<rss version=\"2.0\">"))
+        assertTrue(first.bodyAsText().contains("<rss version=\"2.0\""))
         assertTrue(first.bodyAsText().contains("https://video.example/watch?v="))
         val etag = first.headers[HttpHeaders.ETag]!!
         val lastModified = first.headers[HttpHeaders.LastModified]!!