Loading artist images from navidrome

tests/navidrome.test.ts

@@ -1,6 +1,6 @@
 import { Md5 } from "ts-md5/dist/md5";
 
-import { Navidrome, t } from "../src/navidrome";
+import { Navidrome, t, artistInfo } from "../src/navidrome";
 import encryption from "../src/encryption";
 
 import axios from "axios";
@@ -18,6 +18,28 @@ describe("t", () => {
   });
 });
 
+const ok = (data: string) => ({
+  status: 200,
+  data,
+});
+
+const artistInfoXml = (
+  artistInfo: Partial<artistInfo>
+) => `<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="0.40.0 (8799358a)">
+          <artistInfo>
+              <biography></biography>
+              <musicBrainzId></musicBrainzId>
+              <lastFmUrl></lastFmUrl>
+              <smallImageUrl>${artistInfo.smallImageUrl || ""}</smallImageUrl>
+              <mediumImageUrl>${
+                artistInfo.mediumImageUrl || ""
+              }</mediumImageUrl>
+              <largeImageUrl>${artistInfo.largeImageUrl || ""}</largeImageUrl>
+          </artistInfo>
+        </subsonic-response>`;
+
+const PING_OK = `<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="0.40.0 (8799358a)"></subsonic-response>`;
+
 describe("navidrome", () => {
   const url = "http://127.0.0.22:4567";
   const username = "user1";
@@ -27,11 +49,12 @@ describe("navidrome", () => {
   const navidrome = new Navidrome(url, encryption("secret"));
 
   const mockedRandomString = (randomString as unknown) as jest.Mock;
+  const mockGET = jest.fn()
 
   beforeEach(() => {
     jest.clearAllMocks();
 
-    axios.get = jest.fn();
+    axios.get = mockGET;
 
     mockedRandomString.mockReturnValue(salt);
   });
@@ -47,13 +70,12 @@ describe("navidrome", () => {
   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({
-          status: 200,
-          data: `<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="0.40.0 (8799358a)">
-                 </subsonic-response>`,
-        });
+        (axios.get as jest.Mock).mockResolvedValue(ok(PING_OK));
 
-        const token = await navidrome.generateToken({ username, password }) as AuthSuccess;
+        const token = (await navidrome.generateToken({
+          username,
+          password,
+        })) as AuthSuccess;
 
         expect(token.authToken).toBeDefined();
         expect(token.nickname).toEqual(username);
@@ -75,51 +97,117 @@ describe("navidrome", () => {
         });
 
         const token = await navidrome.generateToken({ username, password });
-        expect(token).toEqual({ message: "Wrong username or password" })
+        expect(token).toEqual({ message: "Wrong username or password" });
       });
     });
   });
 
   describe("getArtists", () => {
+    const getArtistsXml = `<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="0.40.0 (8799358a)">
+                              <artists lastModified="1614586749000" ignoredArticles="The El La Los Las Le Les Os As O A">
+                                <index name="#">
+                                  <artist id="2911b2d67a6b11eb804dd360a6225680" name="artist1" albumCount="22"></artist>
+                                  <artist id="3c0b9d7a7a6b11eb9773f398e6236ad6" name="artist2" albumCount="9"></artist>
+                                </index>
+                                <index name="A">
+                                  <artist id="3c5113007a6b11eb87173bfb9b07f9b1" name="artist3" albumCount="2"></artist>
+                                </index>
+                                <index name="B">
+                                  <artist id="3ca781c27a6b11eb897ebbb5773603ad" name="artist4" albumCount="2"></artist>
+                                </index>
+                              </artists>
+                            </subsonic-response>`;
+
+    const artist1_getArtistInfoXml = artistInfoXml({
+      smallImageUrl: "sml1",
+      mediumImageUrl: "med1",
+      largeImageUrl: "lge1",
+    });
+    const artist2_getArtistInfoXml = artistInfoXml({
+      smallImageUrl: "sml2",
+      mediumImageUrl: undefined,
+      largeImageUrl: "lge2",
+    });
+    const artist3_getArtistInfoXml = artistInfoXml({
+      smallImageUrl: undefined,
+      mediumImageUrl: "med3",
+      largeImageUrl: undefined,
+    });
+    const artist4_getArtistInfoXml = artistInfoXml({
+      smallImageUrl: "sml4",
+      mediumImageUrl: "med4",
+      largeImageUrl: "lge4",
+    });
+
     beforeEach(() => {
-      (axios.get as jest.Mock).mockResolvedValue({
-        status: 200,
-        data: `<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="0.40.0 (8799358a)">
-                <artists lastModified="1614586749000" ignoredArticles="The El La Los Las Le Les Os As O A">
-                  <index name="#">
-                    <artist id="2911b2d67a6b11eb804dd360a6225680" name="10 Planets" albumCount="22"></artist>
-                    <artist id="3c0b9d7a7a6b11eb9773f398e6236ad6" name="1200 Ounces" albumCount="9"></artist>
-                  </index>
-                  <index name="A">
-                    <artist id="3c5113007a6b11eb87173bfb9b07f9b1" name="AAAB" albumCount="2"></artist>
-                  </index>
-                  <index name="B">
-                    <artist id="3ca781c27a6b11eb897ebbb5773603ad" name="BAAB" albumCount="2"></artist>
-                  </index>
-                </artists>
-              </subsonic-response>`,
-      });
+      mockGET
+      .mockImplementationOnce(() => Promise.resolve(ok(PING_OK)))
+      .mockImplementationOnce(() => Promise.resolve(ok(getArtistsXml)))
+      .mockImplementationOnce(() => Promise.resolve(ok(artist1_getArtistInfoXml)))
+      .mockImplementationOnce(() => Promise.resolve(ok(artist2_getArtistInfoXml)))
+      .mockImplementationOnce(() => Promise.resolve(ok(artist3_getArtistInfoXml)))
+      .mockImplementationOnce(() => Promise.resolve(ok(artist4_getArtistInfoXml)));
     });
 
     describe("when no paging is in effect", () => {
       it("should return all the artists", async () => {
         const artists = await navidrome
           .generateToken({ username, password })
-          .then(it => it as AuthSuccess)
+          .then((it) => it as AuthSuccess)
           .then((it) => navidrome.login(it.authToken))
           .then((it) => it.artists({ _index: 0, _count: 100 }));
 
         const expectedArtists = [
-          { id: "2911b2d67a6b11eb804dd360a6225680", name: "10 Planets" },
-          { id: "3c0b9d7a7a6b11eb9773f398e6236ad6", name: "1200 Ounces" },
-          { id: "3c5113007a6b11eb87173bfb9b07f9b1", name: "AAAB" },
-          { id: "3ca781c27a6b11eb897ebbb5773603ad", name: "BAAB" },
+          {
+            id: "2911b2d67a6b11eb804dd360a6225680",
+            name: "artist1",
+            image: { small: "sml1", medium: "med1", large: "lge1" },
+          },
+          {
+            id: "3c0b9d7a7a6b11eb9773f398e6236ad6",
+            name: "artist2",
+            image: { small: "sml2", medium: "", large: "lge2" },
+          },
+          {
+            id: "3c5113007a6b11eb87173bfb9b07f9b1",
+            name: "artist3",
+            image: { small: "", medium: "med3", large: "" },
+          },
+          {
+            id: "3ca781c27a6b11eb897ebbb5773603ad",
+            name: "artist4",
+            image: { small: "sml4", medium: "med4", large: "lge4" },
+          },
         ];
         expect(artists).toEqual({ results: expectedArtists, total: 4 });
 
         expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtists`, {
           params: authParams,
         });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "2911b2d67a6b11eb804dd360a6225680",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3c0b9d7a7a6b11eb9773f398e6236ad6",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3c5113007a6b11eb87173bfb9b07f9b1",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3ca781c27a6b11eb897ebbb5773603ad",
+            ...authParams,
+          },
+        });
       });
     });
 
@@ -127,19 +215,51 @@ describe("navidrome", () => {
       it("should return only the correct page of artists", async () => {
         const artists = await navidrome
           .generateToken({ username, password })
-          .then(it => it as AuthSuccess)
+          .then((it) => it as AuthSuccess)
           .then((it) => navidrome.login(it.authToken))
           .then((it) => it.artists({ _index: 1, _count: 2 }));
 
-        const expectedArtists = [
-          { id: "3c0b9d7a7a6b11eb9773f398e6236ad6", name: "1200 Ounces" },
-          { id: "3c5113007a6b11eb87173bfb9b07f9b1", name: "AAAB" },
-        ];
-        expect(artists).toEqual({ results: expectedArtists, total: 4 });
+          const expectedArtists = [
+            {
+              id: "3c0b9d7a7a6b11eb9773f398e6236ad6",
+              name: "artist2",
+              image: { small: "sml2", medium: "", large: "lge2" },
+            },
+            {
+              id: "3c5113007a6b11eb87173bfb9b07f9b1",
+              name: "artist3",
+              image: { small: "", medium: "med3", large: "" },
+            },
+          ];
+          expect(artists).toEqual({ results: expectedArtists, total: 4 });
 
         expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtists`, {
           params: authParams,
         });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "2911b2d67a6b11eb804dd360a6225680",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3c0b9d7a7a6b11eb9773f398e6236ad6",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3c5113007a6b11eb87173bfb9b07f9b1",
+            ...authParams,
+          },
+        });
+        expect(axios.get).toHaveBeenCalledWith(`${url}/rest/getArtistInfo`, {
+          params: {
+            id: "3ca781c27a6b11eb897ebbb5773603ad",
+            ...authParams,
+          },
+        });
       });
     });
   });