bonob/tests/server.test.ts

import { v4 as uuid } from "uuid";
import dayjs from "dayjs";
import request from "supertest";
import Image from "image-js";

import { MusicService } from "../src/music_service";
import makeServer, {
  BONOB_ACCESS_TOKEN_HEADER,
  ICONS,
  RangeBytesFromFilter,
  rangeFilterFor,
} from "../src/server";

import { SONOS_DISABLED, Sonos, Device } from "../src/sonos";

import { aDevice, aService } from "./builders";
import { InMemoryMusicService } from "./in_memory_music_service";
import { AccessTokens, ExpiringAccessTokens } from "../src/access_tokens";
import { InMemoryLinkCodes, LinkCodes } from "../src/link_codes";
import { Response } from "express";
import { Transform } from "stream";
import url from "../src/url_builder";
import i8n, { randomLang } from "../src/i8n";
import {
  SONOS_RECOMMENDED_IMAGE_SIZES,
} from "../src/smapi";

describe("rangeFilterFor", () => {
  describe("invalid range header string", () => {
    it("should fail", () => {
      const cases = [
        "bytes",
        "bytes=0",
        "bytes=-",
        "bytes=100-200,300-400",
        "bytes=100-200, 300-400",
        "seconds",
        "seconds=0",
        "seconds=-",
      ];

      for (let range in cases) {
        expect(() => rangeFilterFor(range)).toThrowError(
          `Unsupported range: ${range}`
        );
      }
    });
  });

  describe("bytes", () => {
    describe("0-", () => {
      it("should return a RangeBytesFromFilter", () => {
        const filter = rangeFilterFor("bytes=0-");

        expect(filter instanceof RangeBytesFromFilter).toEqual(true);
        expect((filter as RangeBytesFromFilter).from).toEqual(0);
        expect(filter.range(100)).toEqual("0-99/100");
      });
    });

    describe("64-", () => {
      it("should return a RangeBytesFromFilter", () => {
        const filter = rangeFilterFor("bytes=64-");

        expect(filter instanceof RangeBytesFromFilter).toEqual(true);
        expect((filter as RangeBytesFromFilter).from).toEqual(64);
        expect(filter.range(8877)).toEqual("64-8876/8877");
      });
    });

    describe("-900", () => {
      it("should fail", () => {
        expect(() => rangeFilterFor("bytes=-900")).toThrowError(
          "Unsupported range: bytes=-900"
        );
      });
    });

    describe("100-200", () => {
      it("should fail", () => {
        expect(() => rangeFilterFor("bytes=100-200")).toThrowError(
          "Unsupported range: bytes=100-200"
        );
      });
    });

    describe("100-200, 400-500", () => {
      it("should fail", () => {
        expect(() => rangeFilterFor("bytes=100-200, 400-500")).toThrowError(
          "Unsupported range: bytes=100-200, 400-500"
        );
      });
    });
  });

  describe("not bytes", () => {
    it("should fail", () => {
      const cases = [
        "seconds=0-",
        "seconds=100-200",
        "chickens=100-200, 400-500",
      ];

      for (let range in cases) {
        expect(() => rangeFilterFor(range)).toThrowError(
          `Unsupported range: ${range}`
        );
      }
    });
  });
});

describe("RangeBytesFromFilter", () => {
  describe("range from", () => {
    describe("0-", () => {
      it("should not filter at all", () => {
        const filter = new RangeBytesFromFilter(0);
        const result: any[] = [];

        const callback = (_?: Error | null, data?: any) => {
          if (data) result.push(...data!);
        };

        filter._transform(["a", "b", "c"], "ascii", callback);
        filter._transform(["d", "e", "f"], "ascii", callback);

        expect(result).toEqual(["a", "b", "c", "d", "e", "f"]);
      });
    });

    describe("1-", () => {
      it("should filter the first byte", () => {
        const filter = new RangeBytesFromFilter(1);
        const result: any[] = [];

        const callback = (_?: Error | null, data?: any) => {
          if (data) result.push(...data!);
        };

        filter._transform(["a", "b", "c"], "ascii", callback);
        filter._transform(["d", "e", "f"], "ascii", callback);

        expect(result).toEqual(["b", "c", "d", "e", "f"]);
      });
    });

    describe("5-", () => {
      it("should filter the first byte", () => {
        const filter = new RangeBytesFromFilter(5);
        const result: any[] = [];

        const callback = (_?: Error | null, data?: any) => {
          if (data) result.push(...data!);
        };

        filter._transform(["a", "b", "c"], "ascii", callback);
        filter._transform(["d", "e", "f"], "ascii", callback);

        expect(result).toEqual(["f"]);
      });
    });
  });
});

describe("server", () => {
  beforeEach(() => {
    jest.clearAllMocks();
    jest.resetAllMocks();
  });

  const bonobUrlWithNoContextPath = url("http://bonob.localhost:1234");
  const bonobUrlWithContextPath = url("http://bonob.localhost:1234/aContext");

  const langName = randomLang();
  const acceptLanguage = `le-ET,${langName};q=0.9,en;q=0.8`;
  const serviceNameForLang = "Foo Service";
  const lang = i8n(serviceNameForLang)(langName);

  [bonobUrlWithNoContextPath, bonobUrlWithContextPath].forEach((bonobUrl) => {
    describe(`a bonobUrl of ${bonobUrl}`, () => {
      describe("/", () => {
        describe("when sonos integration is disabled", () => {
          const server = makeServer(
            SONOS_DISABLED,
            aService(),
            bonobUrl,
            new InMemoryMusicService()
          );

          describe("devices list", () => {
            it("should be empty", async () => {
              const res = await request(server)
                .get(bonobUrl.append({ pathname: "/" }).pathname())
                .send();

              expect(res.status).toEqual(200);
              expect(res.text).not.toMatch(/class=device/);
            });
          });
        });

        describe("when there are 2 devices and bonob is not registered", () => {
          const service1 = aService({
            name: "s1",
            sid: 1,
          });
          const service2 = aService({
            name: "s2",
            sid: 2,
          });
          const service3 = aService({
            name: "s3",
            sid: 3,
          });
          const service4 = aService({
            name: "s4",
            sid: 4,
          });
          const missingBonobService = aService({
            name: "bonobMissing",
            sid: 88,
          });

          const device1: Device = aDevice({
            name: "device1",
            ip: "172.0.0.1",
            port: 4301,
          });

          const device2: Device = aDevice({
            name: "device2",
            ip: "172.0.0.2",
            port: 4302,
          });

          const fakeSonos: Sonos = {
            devices: () => Promise.resolve([device1, device2]),
            services: () =>
              Promise.resolve([service1, service2, service3, service4]),
            remove: () => Promise.resolve(false),
            register: () => Promise.resolve(false),
          };

          const server = makeServer(
            fakeSonos,
            missingBonobService,
            bonobUrl,
            new InMemoryMusicService()
          );

          describe("devices list", () => {
            it("should contain the devices returned from sonos", async () => {
              const res = await request(server)
                .get(bonobUrl.append({ pathname: "/" }).path())
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(200);
              expect(res.text).toMatch(`<h2>${lang("devices")} \(2\)</h2>`);
              expect(res.text).toMatch(/device1\s+\(172.0.0.1:4301\)/);
              expect(res.text).toMatch(/device2\s+\(172.0.0.2:4302\)/);
            });
          });

          describe("services", () => {
            it("should contain a list of services returned from sonos", async () => {
              const res = await request(server)
                .get(bonobUrl.append({ pathname: "/" }).path())
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(200);
              expect(res.text).toMatch(`<h2>${lang("services")} \(4\)</h2>`);
              expect(res.text).toMatch(/s1\s+\(1\)/);
              expect(res.text).toMatch(/s2\s+\(2\)/);
              expect(res.text).toMatch(/s3\s+\(3\)/);
              expect(res.text).toMatch(/s4\s+\(4\)/);
            });
          });

          describe("registration status", () => {
            it("should be not-registered", async () => {
              const res = await request(server)
                .get(bonobUrl.append({ pathname: "/" }).path())
                .set("accept-language", acceptLanguage)
                .send();
              expect(res.status).toEqual(200);
              expect(res.text).toMatch(
                `<input type="submit" value="${lang("register")}">`
              );
              expect(res.text).toMatch(`<h3>${lang("expectedConfig")}</h3>`);
              expect(res.text).toMatch(
                `<h3>${lang("noExistingServiceRegistration")}</h3>`
              );
              expect(res.text).not.toMatch(
                `<input type="submit" value="${lang("removeRegistration")}">`
              );
            });
          });
        });

        describe("when there are 2 devices and bonob is registered", () => {
          const service1 = aService();

          const service2 = aService();

          const bonobService = aService({
            name: "bonobNotMissing",
            sid: 99,
          });

          const fakeSonos: Sonos = {
            devices: () => Promise.resolve([]),
            services: () => Promise.resolve([service1, service2, bonobService]),
            remove: () => Promise.resolve(false),
            register: () => Promise.resolve(false),
          };

          const server = makeServer(
            fakeSonos,
            bonobService,
            bonobUrl,
            new InMemoryMusicService()
          );

          describe("registration status", () => {
            it("should be registered", async () => {
              const res = await request(server)
                .get(bonobUrl.append({ pathname: "/" }).path())
                .set("accept-language", acceptLanguage)
                .send();
              expect(res.status).toEqual(200);
              expect(res.text).toMatch(
                `<input type="submit" value="${lang("register")}">`
              );
              expect(res.text).toMatch(`<h3>${lang("expectedConfig")}</h3>`);
              expect(res.text).toMatch(
                `<h3>${lang("existingServiceConfig")}</h3>`
              );
              expect(res.text).toMatch(
                `<input type="submit" value="${lang("removeRegistration")}">`
              );
            });
          });
        });
      });

      describe("/about", () => {
        const sonos = {
          register: jest.fn(),
        };
        const theService = aService({
          name: "We can all live a life of service",
          sid: 999,
        });
        const server = makeServer(
          sonos as unknown as Sonos,
          theService,
          bonobUrl,
          new InMemoryMusicService()
        );

        it("should report some information about the service", async () => {
          const res = await request(server)
            .get(bonobUrl.append({ pathname: "/about" }).path())
            .send();

          expect(res.status).toEqual(200);
          expect(res.body).toEqual({
            service: {
              name: theService.name,
              sid: theService.sid,
            },
          });
        });
      });

      describe("/register", () => {
        const sonos = {
          register: jest.fn(),
          remove: jest.fn(),
        };
        const theService = aService({
          name: "We can all live a life of service",
          sid: 999,
        });
        const server = makeServer(
          sonos as unknown as Sonos,
          theService,
          bonobUrl,
          new InMemoryMusicService()
        );

        describe("registering", () => {
          describe("when is successful", () => {
            it("should return a nice message", async () => {
              sonos.register.mockResolvedValue(true);

              const res = await request(server)
                .post(bonobUrl.append({ pathname: "/registration/add" }).path())
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(200);
              expect(res.text).toMatch(`<title>${lang("success")}</title>`);
              expect(res.text).toMatch(lang("successfullyRegistered"));

              expect(sonos.register.mock.calls.length).toEqual(1);
              expect(sonos.register.mock.calls[0][0]).toBe(theService);
            });
          });

          describe("when is unsuccessful", () => {
            it("should return a failure message", async () => {
              sonos.register.mockResolvedValue(false);

              const res = await request(server)
                .post(bonobUrl.append({ pathname: "/registration/add" }).path())
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(500);
              expect(res.text).toMatch(`<title>${lang("failure")}</title>`);
              expect(res.text).toMatch(lang("registrationFailed"));

              expect(sonos.register.mock.calls.length).toEqual(1);
              expect(sonos.register.mock.calls[0][0]).toBe(theService);
            });
          });
        });

        describe("removing a registration", () => {
          describe("when is successful", () => {
            it("should return a nice message", async () => {
              sonos.remove.mockResolvedValue(true);

              const res = await request(server)
                .post(
                  bonobUrl.append({ pathname: "/registration/remove" }).path()
                )
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(200);
              expect(res.text).toMatch(`<title>${lang("success")}</title>`);
              expect(res.text).toMatch(lang("successfullyRemovedRegistration"));

              expect(sonos.remove.mock.calls.length).toEqual(1);
              expect(sonos.remove.mock.calls[0][0]).toBe(theService.sid);
            });
          });

          describe("when is unsuccessful", () => {
            it("should return a failure message", async () => {
              sonos.remove.mockResolvedValue(false);

              const res = await request(server)
                .post(
                  bonobUrl.append({ pathname: "/registration/remove" }).path()
                )
                .set("accept-language", acceptLanguage)
                .send();

              expect(res.status).toEqual(500);
              expect(res.text).toMatch(`<title>${lang("failure")}</title>`);
              expect(res.text).toMatch(lang("failedToRemoveRegistration"));

              expect(sonos.remove.mock.calls.length).toEqual(1);
              expect(sonos.remove.mock.calls[0][0]).toBe(theService.sid);
            });
          });
        });
      });

      describe("/login", () => {
        const sonos = {
          register: jest.fn(),
          remove: jest.fn(),
        };
        const theService = aService({
          name: serviceNameForLang,
        });

        const musicService = {
          generateToken: jest.fn(),
          login: jest.fn(),
        };
        const linkCodes = {
          mint: jest.fn(),
          has: jest.fn(),
          associate: jest.fn(),
          associationFor: jest.fn(),
        };
        const accessTokens = {
          mint: jest.fn(),
          authTokenFor: jest.fn(),
        };
        const clock = {
          now: jest.fn(),
        };

        const server = makeServer(
          sonos as unknown as Sonos,
          theService,
          bonobUrl,
          musicService as unknown as MusicService,
          linkCodes as unknown as LinkCodes,
          accessTokens as unknown as AccessTokens,
          clock
        );

        it("should return the login page", async () => {
          sonos.register.mockResolvedValue(true);

          const res = await request(server)
            .get(bonobUrl.append({ pathname: "/login" }).path())
            .set("accept-language", acceptLanguage)
            .send();

          expect(res.status).toEqual(200);
          expect(res.text).toMatch(`<title>${lang("login")}</title>`);
          expect(res.text).toMatch(
            `<h1 class="login one-word-per-line">${lang("logInToBonob")}</h1>`
          );
          expect(res.text).toMatch(
            `<label for="username">${lang("username")}:</label>`
          );
          expect(res.text).toMatch(
            `<label for="password">${lang("password")}:</label>`
          );
          expect(res.text).toMatch(
            `<input type="submit" value="${lang("login")}" id="submit">`
          );
        });

        describe("when the credentials are valid", () => {
          it("should return 200 ok and have associated linkCode with user", async () => {
            const username = "jane";
            const password = "password100";
            const linkCode = `linkCode-${uuid()}`;
            const authToken = {
              authToken: `authtoken-${uuid()}`,
              userId: `${username}-uid`,
              nickname: `${username}-nickname`,
            };

            linkCodes.has.mockReturnValue(true);
            musicService.generateToken.mockResolvedValue(authToken);
            linkCodes.associate.mockReturnValue(true);

            const res = await request(server)
              .post(bonobUrl.append({ pathname: "/login" }).pathname())
              .set("accept-language", acceptLanguage)
              .type("form")
              .send({ username, password, linkCode })
              .expect(200);

            expect(res.text).toContain(lang("loginSuccessful"));

            expect(musicService.generateToken).toHaveBeenCalledWith({
              username,
              password,
            });
            expect(linkCodes.has).toHaveBeenCalledWith(linkCode);
            expect(linkCodes.associate).toHaveBeenCalledWith(
              linkCode,
              authToken
            );
          });
        });

        describe("when credentials are invalid", () => {
          it("should return 403 with message", async () => {
            const username = "userDoesntExist";
            const password = "password";
            const linkCode = uuid();
            const message = `Invalid user:${username}`;

            linkCodes.has.mockReturnValue(true);
            musicService.generateToken.mockResolvedValue({ message });

            const res = await request(server)
              .post(bonobUrl.append({ pathname: "/login" }).pathname())
              .set("accept-language", acceptLanguage)
              .type("form")
              .send({ username, password, linkCode })
              .expect(403);

            expect(res.text).toContain(lang("loginFailed"));
            expect(res.text).toContain(message);
          });
        });

        describe("when linkCode is invalid", () => {
          it("should return 400 with message", async () => {
            const username = "jane";
            const password = "password100";
            const linkCode = "someLinkCodeThatDoesntExist";

            linkCodes.has.mockReturnValue(false);

            const res = await request(server)
              .post(bonobUrl.append({ pathname: "/login" }).pathname())
              .set("accept-language", acceptLanguage)
              .type("form")
              .send({ username, password, linkCode })
              .expect(400);

            expect(res.text).toContain(lang("invalidLinkCode"));
          });
        });
      });

      describe("/stream", () => {
        const musicService = {
          login: jest.fn(),
        };
        const musicLibrary = {
          stream: jest.fn(),
          scrobble: jest.fn(),
          nowPlaying: jest.fn(),
        };
        let now = dayjs();
        const accessTokens = new ExpiringAccessTokens({ now: () => now });

        const server = makeServer(
          jest.fn() as unknown as Sonos,
          aService(),
          bonobUrl,
          musicService as unknown as MusicService,
          new InMemoryLinkCodes(),
          accessTokens
        );

        const authToken = uuid();
        const trackId = uuid();
        let accessToken: string;

        beforeEach(() => {
          accessToken = accessTokens.mint(authToken);
        });

        const streamContent = (content: string) => ({
          pipe: (_: Transform) => {
            return {
              pipe: (res: Response) => {
                res.send(content);
              },
            };
          },
        });

        describe("HEAD requests", () => {
          describe("when there is no access-token", () => {
            it("should return a 401", async () => {
              const res = await request(server).head(
                bonobUrl.append({ pathname: `/stream/track/${trackId}` }).path()
              );

              expect(res.status).toEqual(401);
            });
          });

          describe("when the access-token has expired", () => {
            it("should return a 401", async () => {
              now = now.add(1, "day");

              const res = await request(server)
                .head(
                  bonobUrl
                    .append({ pathname: `/stream/track/${trackId}` })
                    .path()
                )
                .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

              expect(res.status).toEqual(401);
            });
          });

          describe("when the access-token is valid", () => {
            describe("and the track exists", () => {
              it("should return a 200", async () => {
                const trackStream = {
                  status: 200,
                  headers: {
                    "content-type": "audio/mp3; charset=utf-8",
                    "content-length": "123",
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(trackStream);

                const res = await request(server)
                  .head(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(trackStream.status);
                expect(res.headers["content-type"]).toEqual(
                  "audio/mp3; charset=utf-8"
                );
                expect(res.headers["content-length"]).toEqual("123");
                expect(res.body).toEqual({});
              });
            });

            describe("and the track doesnt exist", () => {
              it("should return a 404", async () => {
                const trackStream = {
                  status: 404,
                  headers: {},
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(trackStream);

                const res = await request(server)
                  .head(`/stream/track/${trackId}`)
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(404);
                expect(res.body).toEqual({});
              });
            });
          });
        });

        describe("GET requests", () => {
          describe("when there is no access-token", () => {
            it("should return a 401", async () => {
              const res = await request(server).get(
                bonobUrl.append({ pathname: `/stream/track/${trackId}` }).path()
              );

              expect(res.status).toEqual(401);
            });
          });

          describe("when the access-token has expired", () => {
            it("should return a 401", async () => {
              now = now.add(1, "day");

              const res = await request(server)
                .get(
                  bonobUrl
                    .append({ pathname: `/stream/track/${trackId}` })
                    .path()
                )
                .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

              expect(res.status).toEqual(401);
            });
          });

          describe("when the track doesnt exist", () => {
            it("should return a 404", async () => {
              const stream = {
                status: 404,
                headers: {},
                stream: streamContent(""),
              };

              musicService.login.mockResolvedValue(musicLibrary);
              musicLibrary.stream.mockResolvedValue(stream);

              const res = await request(server)
                .get(
                  bonobUrl
                    .append({ pathname: `/stream/track/${trackId}` })
                    .path()
                )
                .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

              expect(res.status).toEqual(404);

              expect(musicLibrary.nowPlaying).not.toHaveBeenCalled();
              expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
            });
          });

          describe("when sonos does not ask for a range", () => {
            describe("when the music service does not return a content-range, content-length or accept-ranges", () => {
              it("should return a 200 with the data, without adding the undefined headers", async () => {
                const content = "some-track";

                const stream = {
                  status: 200,
                  headers: {
                    "content-type": "audio/mp3",
                  },
                  stream: streamContent(content),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(stream.status);
                expect(res.headers["content-type"]).toEqual(
                  "audio/mp3; charset=utf-8"
                );
                expect(res.header["accept-ranges"]).toBeUndefined();
                expect(res.headers["content-length"]).toEqual(
                  `${content.length}`
                );
                expect(Object.keys(res.headers)).not.toContain("content-range");

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
              });
            });

            describe("when the music service returns undefined values for content-range, content-length or accept-ranges", () => {
              it("should return a 200 with the data, without adding the undefined headers", async () => {
                const stream = {
                  status: 200,
                  headers: {
                    "content-type": "audio/mp3",
                    "content-length": undefined,
                    "accept-ranges": undefined,
                    "content-range": undefined,
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(stream.status);
                expect(res.headers["content-type"]).toEqual(
                  "audio/mp3; charset=utf-8"
                );
                expect(res.header["accept-ranges"]).toEqual(
                  stream.headers["accept-ranges"]
                );
                expect(Object.keys(res.headers)).not.toContain("content-range");

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
              });
            });

            describe("when the music service returns a 200", () => {
              it("should return a 200 with the data", async () => {
                const stream = {
                  status: 200,
                  headers: {
                    "content-type": "audio/mp3",
                    "content-length": "222",
                    "accept-ranges": "bytes",
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(stream.status);
                expect(res.header["content-type"]).toEqual(
                  `${stream.headers["content-type"]}; charset=utf-8`
                );
                expect(res.header["accept-ranges"]).toEqual(
                  stream.headers["accept-ranges"]
                );
                expect(res.header["content-range"]).toBeUndefined();

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
              });
            });

            describe("when the music service returns a 206", () => {
              it("should return a 206 with the data", async () => {
                const stream = {
                  status: 206,
                  headers: {
                    "content-type": "audio/ogg",
                    "content-length": "333",
                    "accept-ranges": "bytez",
                    "content-range": "100-200",
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(stream.status);
                expect(res.header["content-type"]).toEqual(
                  `${stream.headers["content-type"]}; charset=utf-8`
                );
                expect(res.header["accept-ranges"]).toEqual(
                  stream.headers["accept-ranges"]
                );
                expect(res.header["content-range"]).toEqual(
                  stream.headers["content-range"]
                );

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
              });
            });
          });

          describe("when sonos does ask for a range", () => {
            describe("when the music service returns a 200", () => {
              it("should return a 200 with the data", async () => {
                const stream = {
                  status: 200,
                  headers: {
                    "content-type": "audio/mp3",
                    "content-length": "222",
                    "accept-ranges": "none",
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const requestedRange = "40-";

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken)
                  .set("Range", requestedRange);

                expect(res.status).toEqual(stream.status);
                expect(res.header["content-type"]).toEqual(
                  `${stream.headers["content-type"]}; charset=utf-8`
                );
                expect(res.header["accept-ranges"]).toEqual(
                  stream.headers["accept-ranges"]
                );
                expect(res.header["content-range"]).toBeUndefined();

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({
                  trackId,
                  range: requestedRange,
                });
              });
            });

            describe("when the music service returns a 206", () => {
              it("should return a 206 with the data", async () => {
                const stream = {
                  status: 206,
                  headers: {
                    "content-type": "audio/ogg",
                    "content-length": "333",
                    "accept-ranges": "bytez",
                    "content-range": "100-200",
                  },
                  stream: streamContent(""),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.stream.mockResolvedValue(stream);
                musicLibrary.nowPlaying.mockResolvedValue(true);

                const res = await request(server)
                  .get(
                    bonobUrl
                      .append({ pathname: `/stream/track/${trackId}` })
                      .path()
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken)
                  .set("Range", "4000-5000");

                expect(res.status).toEqual(stream.status);
                expect(res.header["content-type"]).toEqual(
                  `${stream.headers["content-type"]}; charset=utf-8`
                );
                expect(res.header["accept-ranges"]).toEqual(
                  stream.headers["accept-ranges"]
                );
                expect(res.header["content-range"]).toEqual(
                  stream.headers["content-range"]
                );

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                expect(musicLibrary.stream).toHaveBeenCalledWith({
                  trackId,
                  range: "4000-5000",
                });
              });
            });
          });
        });
      });

      describe("/art", () => {
        const musicService = {
          login: jest.fn(),
        };
        const musicLibrary = {
          coverArt: jest.fn(),
        };
        let now = dayjs();
        const accessTokens = new ExpiringAccessTokens({ now: () => now });

        const server = makeServer(
          jest.fn() as unknown as Sonos,
          aService(),
          url("http://localhost:1234"),
          musicService as unknown as MusicService,
          new InMemoryLinkCodes(),
          accessTokens
        );

        const authToken = uuid();
        const albumId = uuid();
        let accessToken: string;

        beforeEach(() => {
          accessToken = accessTokens.mint(authToken);
        });

        describe("when there is no access-token", () => {
          it("should return a 401", async () => {
            const res = await request(server).get(`/art/album/123/size/180`);

            expect(res.status).toEqual(401);
          });
        });

        describe("when the access-token has expired", () => {
          it("should return a 401", async () => {
            now = now.add(1, "day");

            const res = await request(server).get(
              `/art/album/123/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
            );

            expect(res.status).toEqual(401);
          });
        });

        describe("when there is a valid access token", () => {
          describe("some invalid art type", () => {
            it("should return a 400", async () => {
              const res = await request(server)
                .get(
                  `/art/foo/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                )
                .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

              expect(res.status).toEqual(400);
            });
          });

          describe("artist art", () => {
            ["0", "-1", "foo"].forEach((size) => {
              describe(`when the size is ${size}`, () => {
                it(`should return a 400`, async () => {
                  musicService.login.mockResolvedValue(musicLibrary);
                  const res = await request(server)
                    .get(
                      `/art/artist/${albumId}/size/${size}?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                    )
                    .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                  expect(res.status).toEqual(400);
                });
              });
            });

            describe("when there is some", () => {
              it("should return the image and a 200", async () => {
                const coverArt = {
                  status: 200,
                  contentType: "image/jpeg",
                  data: Buffer.from("some image", "ascii"),
                };

                musicService.login.mockResolvedValue(musicLibrary);

                musicLibrary.coverArt.mockResolvedValue(coverArt);

                const res = await request(server)
                  .get(
                    `/art/artist/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(coverArt.status);
                expect(res.header["content-type"]).toEqual(
                  coverArt.contentType
                );

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.coverArt).toHaveBeenCalledWith(
                  albumId,
                  "artist",
                  180
                );
              });
            });

            describe("when there isn't one", () => {
              it("should return a 404", async () => {
                musicService.login.mockResolvedValue(musicLibrary);

                musicLibrary.coverArt.mockResolvedValue(undefined);

                const res = await request(server)
                  .get(
                    `/art/artist/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(404);
              });
            });

            describe("when there is an error", () => {
              it("should return a 500", async () => {
                musicService.login.mockResolvedValue(musicLibrary);

                musicLibrary.coverArt.mockRejectedValue("Boom");

                const res = await request(server)
                  .get(
                    `/art/artist/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(500);
              });
            });
          });

          describe("album art", () => {
            ["0", "-1", "foo"].forEach((size) => {
              describe(`when the size is ${size}`, () => {
                it(`should return a 400`, async () => {
                  musicService.login.mockResolvedValue(musicLibrary);
                  const res = await request(server)
                    .get(
                      `/art/album/${albumId}/size/${size}?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                    )
                    .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                  expect(res.status).toEqual(400);
                });
              });
            });

            describe("when there is some", () => {
              it("should return the image and a 200", async () => {
                const coverArt = {
                  status: 200,
                  contentType: "image/jpeg",
                  data: Buffer.from("some image", "ascii"),
                };

                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.coverArt.mockResolvedValue(coverArt);

                const res = await request(server)
                  .get(
                    `/art/album/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(coverArt.status);
                expect(res.header["content-type"]).toEqual(
                  coverArt.contentType
                );

                expect(musicService.login).toHaveBeenCalledWith(authToken);
                expect(musicLibrary.coverArt).toHaveBeenCalledWith(
                  albumId,
                  "album",
                  180
                );
              });
            });

            describe("when there isnt any", () => {
              it("should return a 404", async () => {
                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.coverArt.mockResolvedValue(undefined);

                const res = await request(server)
                  .get(
                    `/art/album/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(404);
              });
            });

            describe("when there is an error", () => {
              it("should return a 500", async () => {
                musicService.login.mockResolvedValue(musicLibrary);
                musicLibrary.coverArt.mockRejectedValue("Boooooom");

                const res = await request(server)
                  .get(
                    `/art/album/${albumId}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${accessToken}`
                  )
                  .set(BONOB_ACCESS_TOKEN_HEADER, accessToken);

                expect(res.status).toEqual(500);
              });
            });
          });
        });
      });

      describe("/icon", () => {
        const server = makeServer(
          jest.fn() as unknown as Sonos,
          aService(),
          url("http://localhost:1234"),
          jest.fn() as unknown as MusicService,
          new InMemoryLinkCodes(),
          jest.fn() as unknown as AccessTokens
        );

        describe("invalid icon names", () => {
          [
            "..%2F..%2Ffoo",
            "%2Fetc%2Fpasswd",
            ".%2Fbob.js",
            ".",
            "..",
            "1",
            "%23%24",
            "notAValidIcon",
          ].forEach((type) => {
            describe(`trying to retrieve an icon with name ${type}`, () => {
              it(`should fail`, async () => {
                const response = await request(server).get(
                  `/icon/${type}/size/legacy`
                );

                expect(response.status).toEqual(404);
              });
            });
          });
        });

        describe("invalid size", () => {
          ["-1", "0", "59", "foo"].forEach((size) => {
            describe(`trying to retrieve an icon with size ${size}`, () => {
              it(`should fail`, async () => {
                const response = await request(server).get(
                  `/icon/artists/size/${size}`
                );

                expect(response.status).toEqual(400);
              });
            });
          });
        });

        describe("fetching", () => {
          Object.keys(ICONS).forEach((type) => {
            describe(`type=${type}`, () => {
              describe(`legacy icon`, () => {
                it("should return the png image", async () => {
                  const response = await request(server).get(
                    `/icon/${type}/size/legacy`
                  );

                  expect(response.status).toEqual(200);
                  expect(response.header["content-type"]).toEqual("image/png");
                  const image = await Image.load(response.body);
                  expect(image.width).toEqual(80);
                  expect(image.height).toEqual(80);
                });
              });

              describe("svg icon", () => {
                SONOS_RECOMMENDED_IMAGE_SIZES.forEach((size) => {
                  it(`should return an svg image for size = ${size}`, async () => {
                    const response = await request(server).get(
                      `/icon/${type}/size/${size}`
                    );

                    expect(response.status).toEqual(200);
                    expect(response.header["content-type"]).toEqual(
                      "image/svg+xml; charset=utf-8"
                    );
                    const svg = Buffer.from(response.body).toString();
                    expect(svg).toContain(`viewBox="0 0 ${size} ${size}"`);
                    expect(svg).toContain(
                      ` xmlns="http://www.w3.org/2000/svg" `
                    );
                  });
                });
              });
            });
          });
        });
      });
    });
  });
});