mirror of
https://github.com/yattee/yattee.git
synced 2026-11-05 11:27:20 +00:00
Give remote playlist rows a name of their own
Playlist fetches threw away the only handle a row could be removed by: Invidious hands out an index/indexId pair per entry and both were dropped on conversion, so nothing downstream could say which row it meant. Both authenticated fetches now also return a snapshot — the playlist plus its addressable entries. Invidious entries carry the server's indexId and survive refetches; Piped has no such token, so its entries are addressed by position and are only valid inside the snapshot that minted them. The entry id carries the playlist id in both cases, so position 3 of one playlist can never be mistaken for position 3 of another. A row needs both an indexId and an index to be a target: rows missing either are still displayed but never appear in entries, so no removal can be aimed at a row the server refuses to name. Page-overlap dedupe stays keyed on index and never on videoId — the same video may sit in a playlist twice, and each copy is its own removable row.
This commit is contained in:
Arkadiusz Fal
470
YatteeTests/RemotePlaylistEntryTests.swift
Normal file
470
YatteeTests/RemotePlaylistEntryTests.swift
Normal file
@@ -0,0 +1,470 @@
|
||||
//
|
||||
// RemotePlaylistEntryTests.swift
|
||||
// YatteeTests
|
||||
//
|
||||
// A remote playlist row has to survive being named: the token that identifies
|
||||
// it must come back from parsing intact, and a row the server refuses to name
|
||||
// must never look addressable.
|
||||
//
|
||||
|
||||
import Testing
|
||||
import Foundation
|
||||
@testable import Yattee
|
||||
|
||||
// MARK: - Helpers
|
||||
|
||||
private let testBaseURL = URL(string: "https://invidious.example.com")!
|
||||
private let pipedBaseURL = URL(string: "https://piped.example.com")!
|
||||
|
||||
/// Builds one video object of an Invidious authenticated playlist page.
|
||||
private func invidiousVideoJSON(
|
||||
videoId: String,
|
||||
title: String,
|
||||
index: Int?,
|
||||
indexId: String?
|
||||
) -> String {
|
||||
var fields: [String] = [
|
||||
"\"type\": \"video\"",
|
||||
"\"videoId\": \"\(videoId)\"",
|
||||
"\"title\": \"\(title)\"",
|
||||
"\"author\": \"Test Channel\"",
|
||||
"\"authorId\": \"UCtest\"",
|
||||
"\"authorUrl\": \"/channel/UCtest\"",
|
||||
"\"lengthSeconds\": 120",
|
||||
"\"videoThumbnails\": []"
|
||||
]
|
||||
if let index {
|
||||
fields.append("\"index\": \(index)")
|
||||
}
|
||||
if let indexId {
|
||||
fields.append("\"indexId\": \"\(indexId)\"")
|
||||
}
|
||||
return "{\(fields.joined(separator: ", "))}"
|
||||
}
|
||||
|
||||
/// Builds one page of `/api/v1/auth/playlists/{id}`.
|
||||
private func invidiousPageJSON(
|
||||
playlistID: String = "IVPLtest",
|
||||
videoCount: Int,
|
||||
videos: [String]
|
||||
) -> Data {
|
||||
"""
|
||||
{
|
||||
"type": "invidiousPlaylist",
|
||||
"title": "Watch Later",
|
||||
"playlistId": "\(playlistID)",
|
||||
"author": "arek",
|
||||
"authorId": "UCowner",
|
||||
"description": "A private playlist",
|
||||
"videoCount": \(videoCount),
|
||||
"videos": [\(videos.joined(separator: ", "))]
|
||||
}
|
||||
""".data(using: .utf8)!
|
||||
}
|
||||
|
||||
/// Builds one video object of a Piped playlist response.
|
||||
private func pipedStreamJSON(videoId: String, title: String) -> String {
|
||||
"""
|
||||
{
|
||||
"url": "/watch?v=\(videoId)",
|
||||
"title": "\(title)",
|
||||
"uploaderName": "Test Channel",
|
||||
"uploaderUrl": "/channel/UCtest",
|
||||
"duration": 120,
|
||||
"thumbnail": "https://piped.example.com/thumb.jpg"
|
||||
}
|
||||
"""
|
||||
}
|
||||
|
||||
/// Builds the first page of `/playlists/{id}`.
|
||||
private func pipedFirstPageJSON(streams: [String], nextpage: String? = nil) -> Data {
|
||||
let nextpageValue = nextpage.map { "\"\($0)\"" } ?? "null"
|
||||
return """
|
||||
{
|
||||
"name": "My Piped Playlist",
|
||||
"description": "Playlist description",
|
||||
"uploader": "arek",
|
||||
"uploaderUrl": "/channel/UCowner",
|
||||
"videos": \(streams.count),
|
||||
"relatedStreams": [\(streams.joined(separator: ", "))],
|
||||
"nextpage": \(nextpageValue)
|
||||
}
|
||||
""".data(using: .utf8)!
|
||||
}
|
||||
|
||||
/// Builds a `/nextpage/playlists/{id}` page.
|
||||
private func pipedNextPageJSON(streams: [String], nextpage: String? = nil) -> Data {
|
||||
let nextpageValue = nextpage.map { "\"\($0)\"" } ?? "null"
|
||||
return """
|
||||
{
|
||||
"relatedStreams": [\(streams.joined(separator: ", "))],
|
||||
"nextpage": \(nextpageValue)
|
||||
}
|
||||
""".data(using: .utf8)!
|
||||
}
|
||||
|
||||
// MARK: - Invidious
|
||||
|
||||
@Suite("Invidious Remote Playlist Snapshot")
|
||||
struct InvidiousRemotePlaylistSnapshotTests {
|
||||
|
||||
@Test("Every indexed row keeps its indexId and its server position")
|
||||
func snapshotRetainsIndexTokens() throws {
|
||||
let page = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1"),
|
||||
invidiousVideoJSON(videoId: "ccc", title: "Third", index: 2, indexId: "TOKEN2")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.videos.count == 3)
|
||||
#expect(snapshot.entries.count == 3)
|
||||
#expect(snapshot.entries.map(\.position) == [0, 1, 2])
|
||||
#expect(snapshot.entries.map(\.video.id.videoID) == ["aaa", "bbb", "ccc"])
|
||||
#expect(snapshot.entries.map(\.id) == [
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN0"),
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN1"),
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN2")
|
||||
])
|
||||
}
|
||||
|
||||
@Test("The same video twice is two entries, not one")
|
||||
func duplicateVideoYieldsDistinctEntries() throws {
|
||||
let page = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "dup", title: "Duplicated", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "other", title: "Other", index: 1, indexId: "TOKEN1"),
|
||||
invidiousVideoJSON(videoId: "dup", title: "Duplicated", index: 2, indexId: "TOKEN2")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.videos.count == 3)
|
||||
#expect(snapshot.entries.count == 3)
|
||||
|
||||
let duplicates = snapshot.entries.filter { $0.video.id.videoID == "dup" }
|
||||
#expect(duplicates.count == 2)
|
||||
#expect(duplicates[0].id != duplicates[1].id)
|
||||
#expect(duplicates.map(\.position) == [0, 2])
|
||||
// Video hashes by id alone; the entry id is what keeps the two apart.
|
||||
#expect(duplicates[0].video == duplicates[1].video)
|
||||
#expect(Set(snapshot.entries).count == 3)
|
||||
}
|
||||
|
||||
@Test("A row without an indexId is displayed but never addressable")
|
||||
func rowWithoutIndexIDIsDisplayOnly() throws {
|
||||
let page = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "nameless", title: "Unnamed", index: 1, indexId: nil),
|
||||
invidiousVideoJSON(videoId: "ccc", title: "Third", index: 2, indexId: "TOKEN2")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.videos.map(\.id.videoID) == ["aaa", "nameless", "ccc"])
|
||||
#expect(snapshot.entries.map(\.video.id.videoID) == ["aaa", "ccc"])
|
||||
#expect(snapshot.entries.map(\.position) == [0, 2])
|
||||
}
|
||||
|
||||
@Test("A row without an index is display-only and sorts last")
|
||||
func rowWithoutIndexSortsLast() throws {
|
||||
let page = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "floating", title: "Unindexed", index: nil, indexId: "TOKENX"),
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.videos.map(\.id.videoID) == ["aaa", "bbb", "floating"])
|
||||
#expect(snapshot.entries.map(\.video.id.videoID) == ["aaa", "bbb"])
|
||||
}
|
||||
|
||||
@Test("Overlapping pages collapse by index, keeping the first copy")
|
||||
func overlappingPagesDedupeByIndex() throws {
|
||||
let firstPage = invidiousPageJSON(videoCount: 4, videos: [
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1"),
|
||||
invidiousVideoJSON(videoId: "ccc", title: "Third", index: 2, indexId: "TOKEN2")
|
||||
])
|
||||
let secondPage = invidiousPageJSON(videoCount: 4, videos: [
|
||||
invidiousVideoJSON(videoId: "ccc", title: "Third", index: 2, indexId: "TOKEN2"),
|
||||
invidiousVideoJSON(videoId: "ddd", title: "Fourth", index: 3, indexId: "TOKEN3")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [firstPage, secondPage],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.videos.map(\.id.videoID) == ["aaa", "bbb", "ccc", "ddd"])
|
||||
#expect(snapshot.entries.map(\.position) == [0, 1, 2, 3])
|
||||
#expect(snapshot.entries.map(\.id) == [
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN0"),
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN1"),
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN2"),
|
||||
.invidious(playlistID: "IVPLtest", indexID: "TOKEN3")
|
||||
])
|
||||
}
|
||||
|
||||
@Test("Dedupe never collapses a repeated video across pages")
|
||||
func dedupeKeepsRepeatedVideoAcrossPages() throws {
|
||||
let firstPage = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "dup", title: "Duplicated", index: 0, indexId: "TOKEN0"),
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1")
|
||||
])
|
||||
let secondPage = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1"),
|
||||
invidiousVideoJSON(videoId: "dup", title: "Duplicated", index: 2, indexId: "TOKEN2")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [firstPage, secondPage],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.count == 3)
|
||||
#expect(snapshot.entries.map(\.video.id.videoID) == ["dup", "bbb", "dup"])
|
||||
#expect(snapshot.entries.map(\.position) == [0, 1, 2])
|
||||
}
|
||||
|
||||
@Test("Out-of-order pages are sorted back into index order")
|
||||
func pagesArrivingOutOfOrderAreSorted() throws {
|
||||
let firstPage = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "ccc", title: "Third", index: 2, indexId: "TOKEN2"),
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0")
|
||||
])
|
||||
let secondPage = invidiousPageJSON(videoCount: 3, videos: [
|
||||
invidiousVideoJSON(videoId: "bbb", title: "Second", index: 1, indexId: "TOKEN1")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [firstPage, secondPage],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.map(\.position) == [0, 1, 2])
|
||||
#expect(snapshot.playlist.videos.map(\.id.videoID) == ["aaa", "bbb", "ccc"])
|
||||
}
|
||||
|
||||
@Test("Playlist metadata comes from the first page")
|
||||
func playlistMetadataSurvives() throws {
|
||||
let page = invidiousPageJSON(videoCount: 1, videos: [
|
||||
invidiousVideoJSON(videoId: "aaa", title: "First", index: 0, indexId: "TOKEN0")
|
||||
])
|
||||
|
||||
let snapshot = try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.playlist.title == "Watch Later")
|
||||
#expect(snapshot.playlist.description == "A private playlist")
|
||||
#expect(snapshot.playlist.videoCount == 1)
|
||||
#expect(snapshot.playlist.id.playlistID == "IVPLtest")
|
||||
}
|
||||
|
||||
@Test("An empty page set is a decoding failure, not an empty playlist")
|
||||
func emptyPageSetThrows() {
|
||||
#expect(throws: APIError.self) {
|
||||
try InvidiousAPI.authPlaylistSnapshot(
|
||||
fromPageJSON: [],
|
||||
playlistID: "IVPLtest",
|
||||
baseURL: testBaseURL
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Piped
|
||||
|
||||
@Suite("Piped Remote Playlist Snapshot")
|
||||
struct PipedRemotePlaylistSnapshotTests {
|
||||
|
||||
@Test("Positions run sequentially across every page in fetch order")
|
||||
func positionsAreSequentialAcrossPages() throws {
|
||||
let firstPage = pipedFirstPageJSON(streams: [
|
||||
pipedStreamJSON(videoId: "aaa", title: "First"),
|
||||
pipedStreamJSON(videoId: "bbb", title: "Second")
|
||||
], nextpage: "token")
|
||||
let secondPage = pipedNextPageJSON(streams: [
|
||||
pipedStreamJSON(videoId: "ccc", title: "Third"),
|
||||
pipedStreamJSON(videoId: "ddd", title: "Fourth")
|
||||
])
|
||||
|
||||
let snapshot = try PipedAPI.userPlaylistSnapshot(
|
||||
fromPageJSON: [firstPage, secondPage],
|
||||
playlistID: "playlist-uuid",
|
||||
instanceURL: pipedBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.count == 4)
|
||||
#expect(snapshot.entries.map(\.position) == [0, 1, 2, 3])
|
||||
#expect(snapshot.entries.map(\.video.id.videoID) == ["aaa", "bbb", "ccc", "ddd"])
|
||||
}
|
||||
|
||||
@Test("Entry ids embed the playlist ID")
|
||||
func entryIDsEmbedPlaylistID() throws {
|
||||
let page = pipedFirstPageJSON(streams: [
|
||||
pipedStreamJSON(videoId: "aaa", title: "First"),
|
||||
pipedStreamJSON(videoId: "bbb", title: "Second")
|
||||
])
|
||||
|
||||
let snapshot = try PipedAPI.userPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "playlist-uuid",
|
||||
instanceURL: pipedBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.map(\.id) == [
|
||||
.piped(playlistID: "playlist-uuid", position: 0),
|
||||
.piped(playlistID: "playlist-uuid", position: 1)
|
||||
])
|
||||
#expect(snapshot.playlist.id.playlistID == "playlist-uuid")
|
||||
}
|
||||
|
||||
@Test("Entry n is the same row as playlist.videos[n]")
|
||||
func entriesAlignWithDisplayedVideos() throws {
|
||||
let page = pipedFirstPageJSON(streams: [
|
||||
pipedStreamJSON(videoId: "aaa", title: "First"),
|
||||
pipedStreamJSON(videoId: "dup", title: "Duplicated"),
|
||||
pipedStreamJSON(videoId: "dup", title: "Duplicated")
|
||||
])
|
||||
|
||||
let snapshot = try PipedAPI.userPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "playlist-uuid",
|
||||
instanceURL: pipedBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.count == snapshot.playlist.videos.count)
|
||||
for entry in snapshot.entries {
|
||||
#expect(snapshot.playlist.videos[entry.position].id == entry.video.id)
|
||||
}
|
||||
// Two rows of the same video stay two distinct entries.
|
||||
#expect(Set(snapshot.entries).count == 3)
|
||||
}
|
||||
|
||||
@Test("A playlist with no streams yields no entries")
|
||||
func emptyPlaylistYieldsNoEntries() throws {
|
||||
let page = pipedFirstPageJSON(streams: [])
|
||||
|
||||
let snapshot = try PipedAPI.userPlaylistSnapshot(
|
||||
fromPageJSON: [page],
|
||||
playlistID: "playlist-uuid",
|
||||
instanceURL: pipedBaseURL
|
||||
)
|
||||
|
||||
#expect(snapshot.entries.isEmpty)
|
||||
#expect(snapshot.playlist.videos.isEmpty)
|
||||
#expect(snapshot.playlist.title == "My Piped Playlist")
|
||||
}
|
||||
|
||||
@Test("An empty page set is a decoding failure")
|
||||
func emptyPageSetThrows() {
|
||||
#expect(throws: APIError.self) {
|
||||
try PipedAPI.userPlaylistSnapshot(
|
||||
fromPageJSON: [],
|
||||
playlistID: "playlist-uuid",
|
||||
instanceURL: pipedBaseURL
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Entry identity
|
||||
|
||||
@Suite("Remote Playlist Entry ID")
|
||||
struct RemotePlaylistEntryIDTests {
|
||||
|
||||
@Test("The same position in two playlists is two different entries")
|
||||
func positionsDoNotCollideAcrossPlaylists() {
|
||||
let left = RemotePlaylistEntryID.piped(playlistID: "one", position: 3)
|
||||
let right = RemotePlaylistEntryID.piped(playlistID: "two", position: 3)
|
||||
|
||||
#expect(left != right)
|
||||
#expect(Set([left, right]).count == 2)
|
||||
}
|
||||
|
||||
@Test("The same indexId in two playlists is two different entries")
|
||||
func indexIDsDoNotCollideAcrossPlaylists() {
|
||||
let left = RemotePlaylistEntryID.invidious(playlistID: "one", indexID: "TOKEN")
|
||||
let right = RemotePlaylistEntryID.invidious(playlistID: "two", indexID: "TOKEN")
|
||||
|
||||
#expect(left != right)
|
||||
#expect(Set([left, right]).count == 2)
|
||||
}
|
||||
|
||||
@Test("Identical cases are equal and hash together")
|
||||
func identicalCasesMatch() {
|
||||
let invidious = RemotePlaylistEntryID.invidious(playlistID: "one", indexID: "TOKEN")
|
||||
let piped = RemotePlaylistEntryID.piped(playlistID: "one", position: 3)
|
||||
|
||||
#expect(invidious == .invidious(playlistID: "one", indexID: "TOKEN"))
|
||||
#expect(piped == .piped(playlistID: "one", position: 3))
|
||||
#expect(Set([invidious, .invidious(playlistID: "one", indexID: "TOKEN")]).count == 1)
|
||||
#expect(Set([piped, .piped(playlistID: "one", position: 3)]).count == 1)
|
||||
}
|
||||
|
||||
@Test("An Invidious id is never equal to a Piped id")
|
||||
func backendsNeverCollide() {
|
||||
let invidious = RemotePlaylistEntryID.invidious(playlistID: "one", indexID: "3")
|
||||
let piped = RemotePlaylistEntryID.piped(playlistID: "one", position: 3)
|
||||
|
||||
#expect(invidious != piped)
|
||||
#expect(Set([invidious, piped]).count == 2)
|
||||
}
|
||||
|
||||
@Test("Entries differing only by identity stay distinct")
|
||||
func entriesWithSameVideoStayDistinct() {
|
||||
let video = Video(
|
||||
id: .global("aaa"),
|
||||
title: "Same video",
|
||||
description: nil,
|
||||
author: Author(id: "UCtest", name: "Test Channel"),
|
||||
duration: 120,
|
||||
publishedAt: nil,
|
||||
publishedText: nil,
|
||||
viewCount: nil,
|
||||
likeCount: nil,
|
||||
thumbnails: [],
|
||||
isLive: false,
|
||||
isUpcoming: false,
|
||||
scheduledStartTime: nil
|
||||
)
|
||||
|
||||
let first = RemotePlaylistEntry(
|
||||
id: .invidious(playlistID: "one", indexID: "TOKEN0"),
|
||||
video: video,
|
||||
position: 0
|
||||
)
|
||||
let second = RemotePlaylistEntry(
|
||||
id: .invidious(playlistID: "one", indexID: "TOKEN2"),
|
||||
video: video,
|
||||
position: 2
|
||||
)
|
||||
|
||||
#expect(first != second)
|
||||
#expect(Set([first, second]).count == 2)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user