import { Md5 } from "ts-md5/dist/md5"; import { v4 as uuid } from "uuid"; import { isDodgyImage, Navidrome, t } from "../src/navidrome"; import encryption from "../src/encryption"; import axios from "axios"; jest.mock("axios"); import randomString from "../src/random_string"; import { Album, Artist, AuthSuccess, Images, albumToAlbumSummary, range, asArtistAlbumPairs, Track, AlbumSummary, artistToArtistSummary, NO_IMAGES, } from "../src/music_service"; import { anAlbum, anArtist, aTrack } from "./builders"; jest.mock("../src/random_string"); describe("t", () => { it("should be an md5 of the password and the salt", () => { const p = "password123"; const s = "saltydog"; expect(t(p, s)).toEqual(Md5.hashStr(`${p}${s}`)); }); }); describe("isDodgyImage", () => { describe("when ends with 2a96cbd8b46e442fc41c2b86b821562f.png", () => { it("is dodgy", () => { expect( isDodgyImage("http://something/2a96cbd8b46e442fc41c2b86b821562f.png") ).toEqual(true); }); }); describe("when does not end with 2a96cbd8b46e442fc41c2b86b821562f.png", () => { it("is dodgy", () => { expect(isDodgyImage("http://something/somethingelse.png")).toEqual(false); expect( isDodgyImage( "http://something/2a96cbd8b46e442fc41c2b86b821562f.png?withsomequerystring=true" ) ).toEqual(false); }); }); }); const ok = (data: string) => ({ status: 200, data, }); const artistInfoXml = ( images: Images ) => ` ${images.small || ""} ${images.medium || ""} ${images.large || ""} `; const albumXml = ( artist: Artist, album: AlbumSummary, tracks: Track[] = [] ) => `${tracks.map((track) => songXml(track))}`; const songXml = (track: Track) => ``; const albumListXml = ( albums: [Artist, Album][] ) => ` ${albums.map(([artist, album]) => albumXml(artist, album) )} `; const artistXml = ( artist: Artist ) => ` ${artist.albums.map((album) => albumXml(artist, album))} `; const genresXml = ( genres: string[] ) => ` ${genres.map( (it) => `${it}` )} `; const getAlbumXml = ( artist: Artist, album: Album, tracks: Track[] ) => ` ${albumXml( artist, album, tracks )} `; const getSongXml = ( track: Track ) => ` ${songXml( track )} `; const PING_OK = ``; describe("Navidrome", () => { const url = "http://127.0.0.22:4567"; const username = "user1"; const password = "pass1"; const salt = "saltysalty"; const navidrome = new Navidrome(url, encryption("secret")); const mockedRandomString = (randomString as unknown) as jest.Mock; const mockGET = jest.fn(); beforeEach(() => { jest.clearAllMocks(); axios.get = mockGET; mockedRandomString.mockReturnValue(salt); }); const authParams = { u: username, t: t(password, salt), s: salt, v: "1.16.1", c: "bonob", }; const headers = { "User-Agent": "bonob", }; describe("generateToken", () => { describe("when the credentials are valid", () => { it("should be able to generate a token and then login using it", async () => { (axios.get as jest.Mock).mockResolvedValue(ok(PING_OK)); const token = (await navidrome.generateToken({ username, password, })) as AuthSuccess; expect(token.authToken).toBeDefined(); expect(token.nickname).toEqual(username); expect(token.userId).toEqual(username); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/ping.view`, { params: authParams, headers, }); }); }); describe("when the credentials are not valid", () => { it("should be able to generate a token and then login using it", async () => { (axios.get as jest.Mock).mockResolvedValue({ status: 200, data: ` `, }); const token = await navidrome.generateToken({ username, password }); expect(token).toEqual({ message: "Wrong username or password" }); }); }); }); describe("getting genres", () => { const genres = ["HipHop", "Rap", "TripHop", "Pop", "Rock"]; beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(genresXml(genres)))); }); it("should return them alphabetically sorted", async () => { const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.genres()); expect(result).toEqual(genres.sort()); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getGenres`, { params: { ...authParams, }, headers, }); }); }); describe("getting an artist", () => { const album1: Album = anAlbum(); const album2: Album = anAlbum(); const artist: Artist = anArtist({ albums: [album1, album2], }); beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(artistXml(artist)))) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist.image))) ); }); describe("when the artist exists", () => { it("should return it", async () => { const result: Artist = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.artist(artist.id)); expect(result).toEqual({ id: artist.id, name: artist.name, image: artist.image, albums: artist.albums, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtist`, { params: { id: artist.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist.id, ...authParams, }, headers, }); }); }); }); describe("getting artists", () => { describe("when there are no results", () => { beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve( ok(` `) ) ); }); it("should return empty", async () => { const artists = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.artists({ _index: 0, _count: 100 })); expect(artists).toEqual({ results: [], total: 0, }); }); }); describe("when there are artists", () => { const artist1 = anArtist(); const artist2 = anArtist(); const artist3 = anArtist(); const artist4 = anArtist(); const getArtistsXml = ` `; describe("when no paging is in effect", () => { beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(getArtistsXml))) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist1.image))) ) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist2.image))) ) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist3.image))) ) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist4.image))) ); }); it("should return all the artists", async () => { const artists = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.artists({ _index: 0, _count: 100 })); const expectedResults = [artist1, artist2, artist3, artist4].map( (it) => ({ id: it.id, name: it.name, image: it.image, }) ); expect(artists).toEqual({ results: expectedResults, total: 4, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtists`, { params: authParams, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist1.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist2.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist3.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist4.id, ...authParams, }, headers, }); }); }); describe("when paging specified", () => { beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(getArtistsXml))) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist2.image))) ) .mockImplementationOnce(() => Promise.resolve(ok(artistInfoXml(artist3.image))) ); }); it("should return only the correct page of artists", async () => { const artists = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.artists({ _index: 1, _count: 2 })); const expectedResults = [artist2, artist3].map((it) => ({ id: it.id, name: it.name, image: it.image, })); expect(artists).toEqual({ results: expectedResults, total: 4 }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtists`, { params: authParams, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist2.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, { params: { id: artist3.id, ...authParams, }, headers, }); }); }); }); }); describe("getting albums", () => { describe("filtering", () => { const album1 = anAlbum({ genre: "Pop" }); const album2 = anAlbum({ genre: "Rock" }); const album3 = anAlbum({ genre: "Pop" }); const artist = anArtist({ albums: [album1, album2, album3] }); describe("by genre", () => { beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve( ok( albumListXml([ [artist, album1], [artist, album3], ]) ) ) ); }); it("should pass the filter to navidrome", async () => { const q = { _index: 0, _count: 500, genre: "Pop" }; const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.albums(q)); expect(result).toEqual({ results: [album1, album3].map(albumToAlbumSummary), total: 2, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbumList`, { params: { type: "byGenre", genre: "Pop", size: 500, offset: 0, ...authParams, }, headers, }); }); }); }); describe("when there are less than 500 albums", () => { const artist1 = anArtist({ name: "abba", albums: [anAlbum(), anAlbum(), anAlbum()], }); const artist2 = anArtist({ name: "babba", albums: [anAlbum(), anAlbum(), anAlbum()], }); const artists = [artist1, artist2]; const albums = artists.flatMap((artist) => artist.albums); beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(albumListXml(asArtistAlbumPairs(artists)))) ); }); describe("querying for all of them", () => { it("should return all of them with corrent paging information", async () => { const paging = { _index: 0, _count: 500 }; const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.albums(paging)); expect(result).toEqual({ results: albums, total: 6, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbumList`, { params: { type: "alphabeticalByArtist", size: 500, offset: 0, ...authParams, }, headers, }); }); }); describe("querying for a page of them", () => { it("should return the page with the corrent paging information", async () => { const paging = { _index: 2, _count: 2 }; const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.albums(paging)); expect(result).toEqual({ results: [albums[2], albums[3]], total: 6, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbumList`, { params: { type: "alphabeticalByArtist", size: 500, offset: 0, ...authParams, }, headers, }); }); }); }); describe("when there are more than 500 albums", () => { const first500Albums = range(500).map((i) => anAlbum({ name: `album ${i}` }) ); const artist = anArtist({ name: "> 500 albums", albums: [...first500Albums, anAlbum(), anAlbum(), anAlbum()], }); beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve( ok( albumListXml( first500Albums.map( (album) => [artist, album] as [Artist, Album] ) ) ) ) ); }); describe("querying for all of them", () => { it("will return only the first 500 with the correct paging information", async () => { const paging = { _index: 0, _count: 1000 }; const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.albums(paging)); expect(result).toEqual({ results: first500Albums.map(albumToAlbumSummary), total: 500, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbumList`, { params: { type: "alphabeticalByArtist", size: 500, offset: 0, ...authParams, }, headers, }); }); }); }); }); describe("getting an album", () => { describe("when it exists", () => { const album = anAlbum(); const artist = anArtist({ albums: [album] }); const tracks = [ aTrack({ artist, album }), aTrack({ artist, album }), aTrack({ artist, album }), aTrack({ artist, album }), ]; beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(getAlbumXml(artist, album, tracks))) ); }); it("should return the album", async () => { const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.album(album.id)); expect(result).toEqual(album); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbum`, { params: { id: album.id, ...authParams, }, headers, }); }); }); }); describe("getting tracks", () => { describe("for an album", () => { describe("when it exists", () => { const album = anAlbum({ id: "album1", name: "Burnin" }); const albumSummary = albumToAlbumSummary(album); const artist = anArtist({ id: "artist1", name: "Bob Marley", albums: [album], }); const artistSummary = { ...artistToArtistSummary(artist), image: NO_IMAGES, }; const tracks = [ aTrack({ artist: artistSummary, album: albumSummary }), aTrack({ artist: artistSummary, album: albumSummary }), aTrack({ artist: artistSummary, album: albumSummary }), aTrack({ artist: artistSummary, album: albumSummary }), ]; beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(getAlbumXml(artist, album, tracks))) ); }); it("should return the album", async () => { const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.tracks(album.id)); expect(result).toEqual(tracks); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbum`, { params: { id: album.id, ...authParams, }, headers, }); }); }); }); describe("a single track", () => { const album = anAlbum({ id: "album1", name: "Burnin" }); const albumSummary = albumToAlbumSummary(album); const artist = anArtist({ id: "artist1", name: "Bob Marley", albums: [album], }); const artistSummary = { ...artistToArtistSummary(artist), image: NO_IMAGES, }; const track = aTrack({ artist: artistSummary, album: albumSummary }); beforeEach(() => { mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(ok(getSongXml(track)))) .mockImplementationOnce(() => Promise.resolve(ok(getAlbumXml(artist, album, []))) ); }); it("should return the track", async () => { const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.track(track.id)); expect(result).toEqual(track); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getSong`, { params: { id: track.id, ...authParams, }, headers, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getAlbum`, { params: { id: album.id, ...authParams, }, headers, }); }); }); }); describe("streaming a track", () => { const trackId = uuid(); describe("when navidrome doesnt return a content-range, accept-ranges or content-length", () => { it("should return undefined values", async () => { const streamResponse = { status: 200, headers: { "content-type": "audio/mpeg", }, data: Buffer.from("the track", "ascii"), }; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.stream({ trackId, range: undefined })); expect(result.headers).toEqual({ "content-type": "audio/mpeg", "content-length": undefined, "content-range": undefined, "accept-ranges": undefined, }); }); }); describe("when navidrome returns a undefined for content-range, accept-ranges or content-length", () => { it("should return undefined values", async () => { const streamResponse = { status: 200, headers: { "content-type": "audio/mpeg", "content-length": undefined, "content-range": undefined, "accept-ranges": undefined, }, data: Buffer.from("the track", "ascii"), }; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.stream({ trackId, range: undefined })); expect(result.headers).toEqual({ "content-type": "audio/mpeg", "content-length": undefined, "content-range": undefined, "accept-ranges": undefined, }); }); }); describe("with no range specified", () => { describe("navidrome returns a 200", () => { it("should return the content", async () => { const streamResponse = { status: 200, headers: { "content-type": "audio/mpeg", "content-length": "1667", "content-range": "-200", "accept-ranges": "bytes", "some-other-header": "some-value", }, data: Buffer.from("the track", "ascii"), }; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.stream({ trackId, range: undefined })); expect(result.headers).toEqual({ "content-type": "audio/mpeg", "content-length": "1667", "content-range": "-200", "accept-ranges": "bytes", }); expect(result.data.toString()).toEqual("the track"); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/stream`, { params: { id: trackId, ...authParams, }, headers: { "User-Agent": "bonob", }, responseType: "arraybuffer", }); }); }); describe("navidrome returns something other than a 200", () => { it("should return the content", async () => { const trackId = "track123"; const streamResponse = { status: 400, }; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const musicLibrary = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)); return expect( musicLibrary.stream({ trackId, range: undefined }) ).rejects.toEqual(`Navidrome failed with a 400`); }); }); }); describe("with range specified", () => { it("should send the range to navidrome", async () => { const range = "1000-2000"; const streamResponse = { status: 200, headers: { "content-type": "audio/flac", "content-length": "66", "content-range": "100-200", "accept-ranges": "none", "some-other-header": "some-value", }, data: Buffer.from("the track", "ascii"), }; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.stream({ trackId, range })); expect(result.headers).toEqual({ "content-type": "audio/flac", "content-length": "66", "content-range": "100-200", "accept-ranges": "none", }); expect(result.data.toString()).toEqual("the track"); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/stream`, { params: { id: trackId, ...authParams, }, headers: { "User-Agent": "bonob", Range: range, }, responseType: "arraybuffer", }); }); }); }); describe("fetching cover art", () => { describe("fetching album art", () => { describe("when no size is specified", () => { it("should fetch the image", async () => { const streamResponse = { status: 200, headers: { "content-type": "image/jpeg", }, data: Buffer.from("the image", "ascii"), }; const coverArtId = "someCoverArt"; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.coverArt(coverArtId)); expect(result).toEqual({ contentType: streamResponse.headers["content-type"], data: streamResponse.data, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getCoverArt`, { params: { id: coverArtId, ...authParams, }, headers, responseType: "arraybuffer", }); }); }); describe("when size is specified", () => { it("should fetch the image", async () => { const streamResponse = { status: 200, headers: { "content-type": "image/jpeg", }, data: Buffer.from("the image", "ascii"), }; const coverArtId = "someCoverArt"; const size = 1879; mockGET .mockImplementationOnce(() => Promise.resolve(ok(PING_OK))) .mockImplementationOnce(() => Promise.resolve(streamResponse)); const result = await navidrome .generateToken({ username, password }) .then((it) => it as AuthSuccess) .then((it) => navidrome.login(it.authToken)) .then((it) => it.coverArt(coverArtId, size)); expect(result).toEqual({ contentType: streamResponse.headers["content-type"], data: streamResponse.data, }); expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getCoverArt`, { params: { id: coverArtId, size, ...authParams, }, headers, responseType: "arraybuffer", }); }); }); }); }); });