Fix issue where transcoded files would not play, provide support for custom clients to transcode (#194)

* Playlist icons working as rendered by ND

* remove duplication in cover art image url creation

* Remove unused ability to create collages of images

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+FROM node:20-bullseye
+
+LABEL maintainer=simojenki
+
+ENV JEST_TIMEOUT=60000
+EXPOSE 4534
+
+RUN apt-get update && \
+    apt-get -y upgrade && \
+    apt-get -y install --no-install-recommends \
+        libvips-dev \
+        python3 \
+        make \
+        git \
+        g++ \
+        vim

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+{
+    "name": "bonob",
+    "build": { 
+        "dockerfile": "Dockerfile" 
+    },
+    "containerEnv": {
+        // these env vars need to be configured appropriately for your local dev env
+        "BNB_DEV_SONOS_DEVICE_IP": "${localEnv:BNB_DEV_SONOS_DEVICE_IP}",
+        "BNB_DEV_HOST_IP": "${localEnv:BNB_DEV_HOST_IP}",
+        "BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
+    },
+    "remoteUser": "node",
+    "forwardPorts": [4534],
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {
+            "version": "latest",
+            "moby": true
+        }
+    },
+    "customizations": {
+        "vscode": {
+          "extensions": [
+            "esbenp.prettier-vscode"
+          ]
+        }
+    }
+}

.dockerignore

@@ -0,0 +1,6 @@
+.devcontainer
+.github
+.yarn/cache
+.yarn/install-state.gz
+build
+node_modules

.github/workflows/ci.yml

@@ -15,54 +15,64 @@ jobs:
   build_and_test:
     runs-on: ubuntu-latest
     steps:
-      - 
+      -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
-      - 
+      -
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: 20
-      - 
+      -
-        run: yarn install
+        run: npm install
-      - 
+      -
-        run: yarn test
+        run: npm test
 
 
   push_to_registry:
-    name: Push Docker image to Docker Hub
+    name: Push Docker image to Docker registries
     needs: build_and_test
     runs-on: ubuntu-latest
     steps:
-      - 
+      -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       -
         name: Docker meta
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v4
         with:
-          images: simojenki/bonob
+          images: |
+            simojenki/bonob
+            ghcr.io/simojenki/bonob
       -
         name: Login to DockerHub
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - 
+      -
-        name: Push to Docker Hub
+        name: Log in to GitHub Container registry
-        uses: docker/build-push-action@v2
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Push image
+        uses: docker/build-push-action@v4
         with:
           context: .
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -2,6 +2,7 @@
 .vscode
 build
 ignore
+.ignore
 node_modules
 .yarn/*
 !.yarn/patches

.npmrc

@@ -0,0 +1 @@
+fetch-timeout=60000

.nvmrc

@@ -1 +0,0 @@
-16.6.2

.yarnrc.yml

@@ -1,3 +0,0 @@
-nodeLinker: node-modules
-
-yarnPath: .yarn/releases/yarn-berry.cjs

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-bullseye as build
+FROM node:20-bullseye-slim as build
 
 WORKDIR /bonob
 
@@ -9,14 +9,13 @@ COPY typings ./typings
 COPY web ./web
 COPY tests ./tests
 COPY jest.config.js .
-COPY package.json .
 COPY register.js .
+COPY .npmrc .
 COPY tsconfig.json .
-COPY yarn.lock .
+COPY package.json .
-COPY .yarnrc.yml .
+COPY package-lock.json .
-COPY .yarn/releases ./.yarn/releases
 
-ENV JEST_TIMEOUT=30000
+ENV JEST_TIMEOUT=60000
 ENV DEBIAN_FRONTEND=noninteractive
 
 RUN apt-get update && \
@@ -29,13 +28,20 @@ RUN apt-get update && \
         g++ && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    yarn install --immutable && \
+    npm install && \
-    yarn gitinfo && \
+    npm test && \
-    yarn test --no-cache && \
+    npm run gitinfo && \
-    yarn build
+    npm run build && \
+    rm -Rf node_modules && \
+    NODE_ENV=production npm install --omit=dev
 
 
-FROM node:16-bullseye
+FROM node:20-bullseye-slim
+
+LABEL   maintainer="simojenki" \
+        org.opencontainers.image.source="https://github.com/simojenki/bonob" \
+        org.opencontainers.image.description="bonob SONOS SMAPI implementation" \
+        org.opencontainers.image.licenses="GPLv3"
 
 ENV BNB_PORT=4534
 ENV DEBIAN_FRONTEND=noninteractive
@@ -46,7 +52,7 @@ EXPOSE $BNB_PORT
 WORKDIR /bonob
 
 COPY package.json .
-COPY yarn.lock .
+COPY package-lock.json .
 
 COPY --from=build /bonob/build/src ./src
 COPY --from=build /bonob/node_modules ./node_modules
@@ -56,7 +62,10 @@ COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411
 
 RUN apt-get update && \
     apt-get -y upgrade && \
-    apt-get -y install --no-install-recommends libvips tzdata && \
+    apt-get -y install --no-install-recommends \
+        libvips \
+        tzdata \
+        wget && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 

README.md

@@ -16,16 +16,33 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
 - Search by Album, Artist, Track
 - Playlist editing through sonos app.
 - Marking of songs as favourites and with ratings through the sonos app.
-- Localization (only en-US & nl-NL supported currently, require translations for other languages).  [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/)
+- Localization (only en-US, da-DK & nl-NL supported currently, require translations for other languages).  [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
 - Auto discovery of sonos devices
 - Discovery of sonos devices using seed IP address
 - Auto registration with sonos on start
 - Multiple registrations within a single household.
-- Transcoding support for flacs using a specific player for the flac mimeType bonob/sonos
+- Transcoding within subsonic clone
+- Custom players by mime type, allowing custom transcoding rules for different file types
 
 ## Running
 
-bonob is distributed via docker and can be run in a number of ways
+bonob is packaged as an OCI image to both the docker hub registry and github registry.
+
+ie. 
+```bash
+docker pull docker.io/simojenki/bonob
+```
+or
+```bash
+docker pull ghcr.io/simojenki/bonob
+```
+
+tag | description
+--- | ---
+latest | Latest release, intended to be stable
+master | Laster build from master, probably works, however is currently under test in
+vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release
+
 
 ### Full sonos device auto-discovery and auto-registration using docker --network host
 
@@ -126,8 +143,8 @@ services:
       # ip address of your machine running bonob
       BNB_URL: http://192.168.1.111:4534  
       BNB_SECRET: changeme
-      BNB_SONOS_AUTO_REGISTER: true
+      BNB_SONOS_AUTO_REGISTER: "true"
-      BNB_SONOS_DEVICE_DISCOVERY: true
+      BNB_SONOS_DEVICE_DISCOVERY: "true"
       BNB_SONOS_SERVICE_ID: 246
       # ip address of one of your sonos devices
       BNB_SONOS_SEED_HOST: 192.168.1.121
@@ -146,14 +163,16 @@ BNB_PORT | 4534 | Default http port for bonob to listen on
 BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.**
 BNB_SECRET | bonob | secret used for encrypting credentials
 BNB_AUTH_TIMEOUT | 1h | Timeout for the sonos auth token, described in the format [ms](https://github.com/vercel/ms), ie. '5s' == 5 seconds, '11h' == 11 hours.  In the case of using Navidrome this should be less than the value for ND_SESSIONTIMEOUT
+BNB_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
+BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
 BNB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
 BNB_SONOS_DEVICE_DISCOVERY | true | Enable/Disable sonos device discovery entirely.  Setting this to 'false' will disable sonos device search, regardless of whether a seed host is specified.
 BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery
 BNB_SONOS_SERVICE_NAME | bonob | service name for sonos
 BNB_SONOS_SERVICE_ID | 246 | service id for sonos
 BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone
-BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.
+BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. Must specify by the source mime type and the transcoded mime type. For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac".  <p>However; if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.  <p>!!! Getting this configuration wrong will confuse SONOS as it will expect the wrong mime type for a track, as a result it will not play. Use with care...
-BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images as are sourced externally.  ie. Navidrome provides spotify URLs
+BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache.
 BNB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s
 BNB_REPORT_NOW_PLAYING | true | Whether to report a track as now playing
 BNB_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
@@ -188,20 +207,20 @@ Generally speaking you will not need to do this very often.  However on occassio
 
 Service should now be registered and everything should work as expected.
 
+## Multiple registrations within a single household.
+
+It's possible to register multiple Subsonic clone users for the bonob service in Sonos.
+Basically this consist of repeating the Sonos app ["Add a service"](#initialising-service-within-sonos-app) steps for each additional user.
+Afterwards the Sonos app displays a dropdown underneath the service, allowing to switch between users.
+
 ## Implementing a different music source other than a subsonic clone
 
 - Implement the MusicService/MusicLibrary interface
 - Startup bonob with your new implementation.
 
-## A note on transcoding
-
-tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track.  However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
-
-Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/).  When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
-
 ### Audio File type specific transcoding options within Subsonic
 
-In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type.  For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
+In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type.  For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
 
 In this case you could set;
 

etc/docker-compose.yaml

@@ -27,8 +27,8 @@ services:
       BNB_URL: http://192.168.1.111:4534  
       BNB_SECRET: changeme
       BNB_SONOS_SERVICE_ID: 246 
-      BNB_SONOS_AUTO_REGISTER: true
+      BNB_SONOS_AUTO_REGISTER: "true"
-      BNB_SONOS_DEVICE_DISCOVERY: true
+      BNB_SONOS_DEVICE_DISCOVERY: "true"
       # ip address of one of your sonos devices
       BNB_SONOS_SEED_HOST: 192.168.1.121
       BNB_SUBSONIC_URL: http://navidrome:4533

jest.config.js

@@ -5,5 +5,6 @@ module.exports = {
   modulePathIgnorePatterns: [
     '<rootDir>/node_modules',
     '<rootDir>/build',
-    ],
+  ],
+  testTimeout: Number.parseInt(process.env["JEST_TIMEOUT"] || "5000")
 };

package.json

@@ -6,64 +6,73 @@
   "author": "simojenki <simojenki@users.noreply.github.com>",
   "license": "GPL-3.0-only",
   "dependencies": {
-    "@svrooij/sonos": "^2.4.0",
+    "@svrooij/sonos": "^2.5.0",
-    "@types/express": "^4.17.13",
+    "@types/express": "^4.17.21",
-    "@types/fs-extra": "^9.0.13",
+    "@types/fs-extra": "^11.0.4",
-    "@types/jsonwebtoken": "^8.5.5",
+    "@types/jsonwebtoken": "^9.0.5",
-    "@types/jws": "^3.2.4",
+    "@types/jws": "^3.2.9",
-    "@types/morgan": "^1.9.3",
+    "@types/morgan": "^1.9.9",
-    "@types/node": "^16.7.13",
+    "@types/node": "^20.11.5",
-    "@types/randomstring": "^1.1.8",
+    "@types/randomstring": "^1.1.11",
-    "@types/sharp": "^0.28.6",
+    "@types/underscore": "^1.11.15",
-    "@types/underscore": "^1.11.3",
+    "@types/uuid": "^9.0.7",
-    "@types/uuid": "^8.3.1",
+    "@types/xmldom": "0.1.34",
-    "axios": "^0.21.4",
+    "axios": "^1.6.5",
-    "dayjs": "^1.10.6",
+    "dayjs": "^1.11.10",
-    "eta": "^1.12.3",
+    "eta": "^2.2.0",
-    "express": "^4.17.1",
+    "express": "^4.18.2",
-    "fp-ts": "^2.11.1",
+    "fp-ts": "^2.16.2",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^11.2.0",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.2",
     "jws": "^4.0.0",
-    "libxmljs2": "^0.28.0",
+    "libxmljs2": "^0.33.0",
     "morgan": "^1.10.0",
-    "node-html-parser": "^4.1.4",
+    "node-html-parser": "^6.1.12",
-    "randomstring": "^1.2.1",
+    "randomstring": "^1.3.0",
-    "sharp": "^0.29.1",
+    "sharp": "^0.33.2",
-    "soap": "^0.42.0",
+    "soap": "^1.0.0",
-    "ts-md5": "^1.2.9",
+    "ts-md5": "^1.3.1",
-    "typescript": "^4.4.2",
+    "typescript": "^5.3.3",
-    "underscore": "^1.13.1",
+    "underscore": "^1.13.6",
     "urn-lib": "^2.0.0",
-    "uuid": "^8.3.2",
+    "uuid": "^9.0.1",
-    "winston": "^3.3.3"
+    "winston": "^3.11.0",
+    "xmldom-ts": "^0.3.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.21",
+    "@types/chai": "^4.3.11",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^29.5.11",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.6",
-    "@types/supertest": "^2.0.11",
+    "@types/supertest": "^6.0.2",
-    "@types/tmp": "^0.2.1",
+    "@types/tmp": "^0.2.6",
-    "chai": "^4.3.4",
+    "chai": "^5.0.0",
-    "get-port": "^5.1.1",
+    "get-port": "^7.0.0",
-    "image-js": "^0.33.0",
+    "image-js": "^0.35.5",
-    "jest": "^27.1.0",
+    "jest": "^29.7.0",
-    "nodemon": "^2.0.12",
+    "nodemon": "^3.0.3",
-    "supertest": "^6.1.6",
+    "supertest": "^6.3.4",
     "tmp": "^0.2.1",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^29.1.2",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.2.1",
+    "ts-node": "^10.9.2",
     "xmldom-ts": "^0.3.1",
     "xpath-ts": "^1.3.13"
   },
+  "overrides": {
+    "axios-ntlm": "npm:dry-uninstall",
+    "axios": "$axios",
+    "@svrooij/sonos": {
+      "fast-xml-parser": "^3.21.1"
+    }
+  },
   "scripts": {
     "clean": "rm -Rf build node_modules",
     "build": "tsc",
-    "dev": "BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true nodemon -V ./src/app.ts",
+    "dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "devr": "BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true nodemon -V ./src/app.ts",
+    "devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
+    "register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
+    "testw": "jest --watch",
     "gitinfo": "git describe --tags > .gitinfo"
   }
 }

src/app.ts

@@ -4,11 +4,11 @@ import server from "./server";
 import logger from "./logger";
 
 import {
-  appendMimeTypeToClientFor,
   axiosImageFetcher,
   cachingImageFetcher,
-  DEFAULT,
   Subsonic,
+  TranscodingCustomPlayers,
+  NO_CUSTOM_PLAYERS
 } from "./subsonic";
 import { InMemoryAPITokens, sha256 } from "./api_tokens";
 import { InMemoryLinkCodes } from "./link_codes";
@@ -32,9 +32,9 @@ const bonob = bonobService(
 
 const sonosSystem = sonos(config.sonos.discovery);
 
-const streamUserAgent = config.subsonic.customClientsFor
+const customPlayers = config.subsonic.customClientsFor
-  ? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(","))
+  ? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
-  : DEFAULT;
+  : NO_CUSTOM_PLAYERS;
 
 const artistImageFetcher = config.subsonic.artistImageCache
   ? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
@@ -42,7 +42,7 @@ const artistImageFetcher = config.subsonic.artistImageCache
 
 const subsonic = new Subsonic(
   config.subsonic.url,
-  streamUserAgent,
+  customPlayers,
   artistImageFetcher
 );
 
@@ -88,14 +88,14 @@ const app = server(
     clock,
     iconColors: config.icons,
     applyContextPath: true,
-    logRequests: true,
+    logRequests: config.logRequests,
     version,
     smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout),
     externalImageResolver: artistImageFetcher
   }
 );
 
-app.listen(config.port, () => {
+const expressServer = app.listen(config.port, () => {
   logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`);
 });
 
@@ -113,6 +113,15 @@ if (config.sonos.autoRegister) {
       logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`);
     });
   });
-}
+};
+
+process.on('SIGTERM', () => {
+  logger.info('SIGTERM signal received: closing HTTP server');
+  expressServer.close(() => {
+    logger.info('HTTP server closed');
+  });
+  process.exit(0);
+});
+
 
 export default app;

src/config.ts

@@ -85,6 +85,7 @@ export default function () {
         validationPattern: COLOR,
       }),
     },
+    logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
     sonos: {
       serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
       discovery: {
@@ -97,7 +98,7 @@ export default function () {
       sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
     },
     subsonic: {
-      url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!,
+      url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
       customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
       artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
     },

src/i8n.ts

@@ -4,7 +4,7 @@ import { option as O } from "fp-ts";
 import _ from "underscore";
 
 export type LANG = "en-US" | "da-DK" | "de-DE" | "es-ES" | "fr-FR" | "it-IT" | "ja-JP" | "nb-NO" | "nl-NL" | "pt-BR" | "sv-SE" | "zh-CN"
-export type SUPPORTED_LANG = "en-US" | "nl-NL";
+export type SUPPORTED_LANG = "en-US" | "da-DK" | "fr-FR" | "nl-NL";
 export type KEY =
   | "AppLinkMessage"
   | "artists"
@@ -88,6 +88,88 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     LOVE: "Love",
     LOVE_SUCCESS: "Track loved"
   },
+  "da-DK": {
+    AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
+    artists: "Kunstnere",
+    albums: "Album",
+    tracks: "Numre",
+    playlists: "Afspilningslister",
+    genres: "Genre",
+    random: "Tilfældig",
+    topRated: "Højst vurderet",
+    recentlyAdded: "Senest tilføjet",
+    recentlyPlayed: "Senest afspillet",
+    mostPlayed: "Flest afspilninger",
+    success: "Succes",
+    failure: "Fejl",
+    expectedConfig: "Forventet konfiguration",
+    existingServiceConfig: "Eksisterende tjeneste konfiguration",
+    noExistingServiceRegistration: "Ingen eksisterende tjeneste registrering",
+    register: "Registrer",
+    removeRegistration: "Fjern registrering",
+    devices: "Enheder",
+    services: "Tjenester",
+    login: "Log på",
+    logInToBonob: "Log på $BNB_SONOS_SERVICE_NAME",
+    username: "Brugernavn",
+    password: "Adgangskode",
+    successfullyRegistered: "Registreret med succes",
+    registrationFailed: "Registrering fejlede!",
+    successfullyRemovedRegistration: "Registrering fjernet med succes",
+    failedToRemoveRegistration: "FJernelse af registrering fejlede!",
+    invalidLinkCode: "Ugyldig linkCode!",
+    loginSuccessful: "Log på succes!",
+    loginFailed: "Log på fejlede!",
+    noSonosDevices: "Ingen Sonos enheder",
+    favourites: "Favoritter",
+    STAR: "Tilføj stjerne",
+    UNSTAR: "Fjern stjerne",
+    STAR_SUCCESS: "Stjerne tilføjet",
+    UNSTAR_SUCCESS: "Stjerne fjernet",
+    LOVE: "Synes godt om",
+    LOVE_SUCCESS: "Syntes godt om"
+  },
+  "fr-FR": {
+    AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
+    artists: "Artistes",
+    albums: "Albums",
+    tracks: "Pistes",
+    playlists: "Playlists",
+    genres: "Genres",
+    random: "Aléatoire",
+    topRated: "Les mieux notés",
+    recentlyAdded: "Récemment ajouté",
+    recentlyPlayed: "Récemment joué",
+    mostPlayed: "Les plus joué",
+    success: "Succès",
+    failure: "Échec",
+    expectedConfig: "Configuration attendue",
+    existingServiceConfig: "La configuration de service existe",
+    noExistingServiceRegistration: "Aucun enregistrement de service existant",
+    register: "Inscription",
+    removeRegistration: "Supprimer l'inscription",
+    devices: "Appareils",
+    services: "Services",
+    login: "Se connecter",
+    logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
+    username: "Nom d'utilisateur",
+    password: "Mot de passe",
+    successfullyRegistered: "Connecté avec succès",
+    registrationFailed: "Échec de la connexion !",
+    successfullyRemovedRegistration: "Inscription supprimée avec succès",
+    failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
+    invalidLinkCode: "Code non valide !",
+    loginSuccessful: "Connexion réussie !",
+    loginFailed: "La connexion a échoué !",
+    noSonosDevices: "Aucun appareil Sonos",
+    favourites: "Favoris",
+    STAR: "Suivre",
+    UNSTAR: "Ne plus suivre",
+    STAR_SUCCESS: "Piste suivie",
+    UNSTAR_SUCCESS: "Piste non suivie",
+    LOVE: "Aimer",
+    LOVE_SUCCESS: "Pistes aimée"
+  },
   "nl-NL": {
     AppLinkMessage: "Sonos koppelen aan $BNB_SONOS_SERVICE_NAME",
     artists: "Artiesten",

src/logger.ts

@@ -6,7 +6,7 @@ export function debugIt<T>(thing: T): T {
 }
 
 const logger = createLogger({
-    level: 'debug',
+    level: process.env["BNB_LOG_LEVEL"] || 'info',
     format: format.combine(
       format.timestamp({
         format: 'YYYY-MM-DD HH:mm:ss'

src/music_service.ts

@@ -51,10 +51,15 @@ export type Rating = {
   stars: number;
 }
 
+export type Encoding = {
+  player: string,
+  mimeType: string
+}
+
 export type Track = {
   id: string;
   name: string;
-  mimeType: string;
+  encoding: Encoding,
   duration: number;
   number: number | undefined;
   genre: Genre | undefined;
@@ -113,7 +118,8 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
 
 export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
   id: it.id,
-  name: it.name
+  name: it.name,
+  coverArt: it.coverArt
 })
 
 export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
@@ -131,7 +137,8 @@ export type CoverArt = {
 
 export type PlaylistSummary = {
   id: string,
-  name: string
+  name: string,
+  coverArt?: BUrn | undefined
 }
 
 export type Playlist = PlaylistSummary & {

src/server.ts

@@ -31,9 +31,8 @@ import { pipe } from "fp-ts/lib/function";
 import { URLBuilder } from "./url_builder";
 import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
 import { Icon, ICONS, festivals, features } from "./icon";
-import _, { shuffle } from "underscore";
+import _ from "underscore";
 import morgan from "morgan";
-import { takeWithRepeats } from "./utils";
 import { parse } from "./burn";
 import { axiosImageFetcher, ImageFetcher } from "./subsonic";
 import {
@@ -307,13 +306,13 @@ function server(
       return `<Match propname="rating" value="${value}">
         <Ratings>
           <Rating Id="${ratingAsInt(
-            nextLove
+        nextLove
-          )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
+      )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
             <Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" />
           </Rating>
           <Rating Id="${-ratingAsInt(
-            nextStar
+        nextStar
-          )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
+      )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
             <Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" />
           </Rating>
         </Ratings>
@@ -327,9 +326,9 @@ function server(
         <Match>
           <imageSizeMap>
             ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-              (size) =>
+      (size) =>
-                `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-            ).join("")}
+    ).join("")}
           </imageSizeMap>
         </Match>
       </PresentationMap>
@@ -338,9 +337,9 @@ function server(
           <browseIconSizeMap>
               <sizeEntry size="0" substitution="/size/legacy"/>
               ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-                (size) =>
+      (size) =>
-                  `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-              ).join("")}
+    ).join("")}
             </browseIconSizeMap>
         </Match>
       </PresentationMap>
@@ -374,7 +373,7 @@ function server(
     const id = req.params["id"]!;
     const trace = uuid();
 
-    logger.info(
+    logger.debug(
       `${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify(
         req.query
       )}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}`
@@ -406,13 +405,17 @@ function server(
               trackId: id,
               range: req.headers["range"] || undefined,
             })
+            .then((stream) => {
+              res.on('close', () => {
+                stream.stream.destroy()
+              });
+              return stream;
+            })
             .then((stream) => ({ musicLibrary: it, stream }))
         )
         .then(({ musicLibrary, stream }) => {
-          logger.info(
+          logger.debug(
-            `${trace} bnb<- stream response from music service for ${id}, status=${
+            `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
-              stream.status
-            }, headers=(${JSON.stringify(stream.headers)})`
           );
 
           const sonosisfyContentType = (contentType: string) =>
@@ -435,10 +438,8 @@ function server(
             sendStream: boolean;
             nowPlaying: boolean;
           }) => {
-            logger.info(
+            logger.debug(
-              `${trace} bnb-> ${
+              `${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
-                req.path
-              }, status=${status}, headers=${JSON.stringify(headers)}`
             );
             (nowPlaying
               ? musicLibrary.nowPlaying(id)
@@ -450,8 +451,8 @@ function server(
                 .forEach(([header, value]) => {
                   res.setHeader(header, value!);
                 });
-              if (sendStream) stream.stream.pipe(filter).pipe(res);
+              if (sendStream) stream.stream.pipe(filter).pipe(res)
-              else res.send();
+              else res.send()
             });
           };
 
@@ -513,15 +514,15 @@ function server(
       const spec =
         size == "legacy"
           ? {
-              mimeType: "image/png",
+            mimeType: "image/png",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
-                sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
+              sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
-            }
+          }
           : {
-              mimeType: "image/svg+xml",
+            mimeType: "image/svg+xml",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
-                Promise.resolve(svg),
+              Promise.resolve(svg),
-            };
+          };
 
       return Promise.resolve(
         icon
@@ -556,23 +557,11 @@ function server(
     });
   });
 
-  const GRAVITY_9 = [
+  app.get("/art/:burn/size/:size", (req, res) => {
-    "north",
-    "northeast",
-    "east",
-    "southeast",
-    "south",
-    "southwest",
-    "west",
-    "northwest",
-    "centre",
-  ];
-
-  app.get("/art/:burns/size/:size", (req, res) => {
     const serviceToken = apiTokens.authTokenFor(
       req.query[BONOB_ACCESS_TOKEN_HEADER] as string
     );
-    const urns = req.params["burns"]!.split("&").map(parse);
+    const urn = parse(req.params["burn"]!);
     const size = Number.parseInt(req.params["size"]!);
 
     if (!serviceToken) {
@@ -583,55 +572,24 @@ function server(
 
     return musicService
       .login(serviceToken)
-      .then((musicLibrary) =>
+      .then((musicLibrary) => {
-        Promise.all(
+        if (urn.system == "external") {
-          urns.map((it) => {
+          return serverOpts.externalImageResolver(urn.resource);
-            if (it.system == "external") {
+        } else {
-              return serverOpts.externalImageResolver(it.resource);
+          return musicLibrary.coverArt(urn, size);
-            } else {
+        }
-              return musicLibrary.coverArt(it, size);
+      })
-            }
+      .then((coverArt) => {
-          })
+        if(coverArt) {
-        )
-      )
-      .then((coverArts) => coverArts.filter((it) => it))
-      .then(shuffle)
-      .then((coverArts) => {
-        if (coverArts.length == 1) {
-          const coverArt = coverArts[0]!;
           res.status(200);
           res.setHeader("content-type", coverArt.contentType);
           return res.send(coverArt.data);
-        } else if (coverArts.length > 1) {
-          const gravity = [...GRAVITY_9];
-          return sharp({
-            create: {
-              width: size * 3,
-              height: size * 3,
-              channels: 3,
-              background: { r: 255, g: 255, b: 255 },
-            },
-          })
-            .composite(
-              takeWithRepeats(coverArts, 9).map((art) => ({
-                input: art?.data,
-                gravity: gravity.pop(),
-              }))
-            )
-            .png()
-            .toBuffer()
-            .then((image) => sharp(image).resize(size).png().toBuffer())
-            .then((image) => {
-              res.status(200);
-              res.setHeader("content-type", "image/png");
-              return res.send(image);
-            });
         } else {
           return res.status(404).send();
         }
-      })
+    })
       .catch((e: Error) => {
-        logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, {
+        logger.error(`Failed fetching image ${urn}/size/${size}`, {
           cause: e,
         });
         return res.status(500).send();

src/smapi.ts

@@ -26,7 +26,7 @@ import { Clock } from "./clock";
 import { URLBuilder } from "./url_builder";
 import { asLANGs, I8N } from "./i8n";
 import { ICON, iconForGenre } from "./icon";
-import _, { uniq } from "underscore";
+import _ from "underscore";
 import { BUrn, formatForURL } from "./burn";
 import {
   isExpiredTokenError,
@@ -253,7 +253,7 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
   itemType: "playlist",
   id: `playlist:${playlist.id}`,
   title: playlist.name,
-  albumArtURI: playlistAlbumArtURL(bonobUrl, playlist).href(),
+  albumArtURI: coverArtURI(bonobUrl, playlist).href(),
   canPlay: true,
   attributes: {
     readOnly: false,
@@ -262,29 +262,9 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
   },
 });
 
-export const playlistAlbumArtURL = (
+export const coverArtURI = (
   bonobUrl: URLBuilder,
-  playlist: Playlist
+  { coverArt }: { coverArt?: BUrn | undefined }
-) => {
-  const burns: BUrn[] = uniq(
-    playlist.entries.filter((it) => it.coverArt != undefined),
-    (it) => it.album.id
-  ).map((it) => it.coverArt!);
-  if (burns.length == 0) {
-    return iconArtURI(bonobUrl, "error");
-  } else {
-    return bonobUrl.append({
-      pathname: `/art/${burns
-        .slice(0, 9)
-        .map((it) => encodeURIComponent(formatForURL(it)))
-        .join("&")}/size/180`,
-    });
-  }
-};
-
-export const defaultAlbumArtURI = (
-  bonobUrl: URLBuilder,
-  { coverArt }: { coverArt: BUrn | undefined }
 ) =>
   pipe(
     coverArt,
@@ -302,21 +282,6 @@ export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
     pathname: `/icon/${icon}/size/legacy`,
   });
 
-export const defaultArtistArtURI = (
-  bonobUrl: URLBuilder,
-  artist: ArtistSummary
-) =>
-  pipe(
-    artist.image,
-    O.fromNullable,
-    O.map((it) =>
-      bonobUrl.append({
-        pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
-      })
-    ),
-    O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
-  );
-
 export const sonosifyMimeType = (mimeType: string) =>
   mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
 
@@ -326,7 +291,7 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
   artist: album.artistName,
   artistId: `artist:${album.artistId}`,
   title: album.name,
-  albumArtURI: defaultAlbumArtURI(bonobUrl, album).href(),
+  albumArtURI: coverArtURI(bonobUrl, album).href(),
   canPlay: true,
   // defaults
   // canScroll: false,
@@ -337,7 +302,7 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
 export const track = (bonobUrl: URLBuilder, track: Track) => ({
   itemType: "track",
   id: `track:${track.id}`,
-  mimeType: sonosifyMimeType(track.mimeType),
+  mimeType: sonosifyMimeType(track.encoding.mimeType),
   title: track.name,
 
   trackMetadata: {
@@ -345,7 +310,7 @@ export const track = (bonobUrl: URLBuilder, track: Track) => ({
     albumId: `album:${track.album.id}`,
     albumArtist: track.artist.name,
     albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
-    albumArtURI: defaultAlbumArtURI(bonobUrl, track).href(),
+    albumArtURI: coverArtURI(bonobUrl, track).href(),
     artist: track.artist.name,
     artistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
     duration: track.duration,
@@ -363,7 +328,7 @@ export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
   id: `artist:${artist.id}`,
   artistId: artist.id,
   title: artist.name,
-  albumArtURI: defaultArtistArtURI(bonobUrl, artist).href(),
+  albumArtURI: coverArtURI(bonobUrl, { coverArt: artist.image }).href(),
 });
 
 function splitId<T>(id: string) {
@@ -868,8 +833,16 @@ function bindSmapiSoapServiceToExpress(
                       .playlists()
                       .then((it) =>
                         Promise.all(
-                          it.map((playlist) =>
+                          it.map((playlist) => {
-                            musicLibrary.playlist(playlist.id)
+                            // todo: whats this odd copy all about, can we just delete it?
+                            return {
+                              id: playlist.id,
+                              name: playlist.name,
+                              coverArt: playlist.coverArt,
+                              // todo: are these every important?
+                              entries: []
+                            };
+                           }
                           )
                         )
                       )
@@ -1066,8 +1039,9 @@ function bindSmapiSoapServiceToExpress(
 
   soapyService.log = (type, data) => {
     switch (type) {
+      // routing all soap info messages to debug so less noisy
       case "info":
-        logger.info({ level: "info", data });
+        logger.debug({ level: "info", data });
         break;
       case "warn":
         logger.warn({ level: "warn", data });

src/sonos.ts

@@ -176,7 +176,7 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
         }
       })
       .catch((e) => {
-        logger.error(`Failed looking for sonos devices`, { cause: e });
+        logger.error(`Failed looking for sonos devices - ${e}`, { cause: e });
         return [];
       });
   };

src/subsonic.ts

@@ -2,7 +2,7 @@ import { option as O, taskEither as TE } from "fp-ts";
 import * as A from "fp-ts/Array";
 import { ordString } from "fp-ts/lib/Ord";
 import { pipe } from "fp-ts/lib/function";
-import { Md5 } from "ts-md5/dist/md5";
+import { Md5 } from "ts-md5";
 import {
   Credentials,
   MusicService,
@@ -20,6 +20,8 @@ import {
   AlbumQueryType,
   Artist,
   AuthFailure,
+  PlaylistSummary,
+  Encoding,
 } from "./music_service";
 import sharp from "sharp";
 import _ from "underscore";
@@ -32,6 +34,7 @@ import { b64Encode, b64Decode } from "./b64";
 import logger from "./logger";
 import { assertSystem, BUrn } from "./burn";
 import { artist } from "./smapi";
+import { URLBuilder } from "./url_builder";
 
 export const BROWSER_HEADERS = {
   accept:
@@ -161,7 +164,8 @@ export type song = {
   duration: number | undefined;
   bitRate: number | undefined;
   suffix: string | undefined;
-  contentType: string | undefined;
+  contentType: string;
+  transcodedContentType: string | undefined;
   type: string | undefined;
   userRating: number | undefined;
   starred: string | undefined;
@@ -176,12 +180,15 @@ type GetAlbumResponse = {
 type playlist = {
   id: string;
   name: string;
+  coverArt: string | undefined;
 };
 
 type GetPlaylistResponse = {
+  // todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
   playlist: {
     id: string;
     name: string;
+    coverArt: string | undefined;
     entry: song[];
   };
 };
@@ -269,10 +276,16 @@ export const artistImageURN = (
   }
 };
 
-export const asTrack = (album: Album, song: song): Track => ({
+export const asTrack = (album: Album, song: song, customPlayers: CustomPlayers): Track => ({
   id: song.id,
   name: song.title,
-  mimeType: song.contentType!,
+  encoding: pipe(
+    customPlayers.encodingFor({ mimeType: song.contentType }),
+    O.getOrElse(() => ({ 
+      player: DEFAULT_CLIENT_APPLICATION, 
+      mimeType: song.transcodedContentType ? song.transcodedContentType : song.contentType
+    }))
+  ),
   duration: song.duration || 0,
   number: song.track || 0,
   genre: maybeAsGenre(song.genre),
@@ -304,6 +317,13 @@ const asAlbum = (album: album): Album => ({
   coverArt: coverArtURN(album.coverArt),
 });
 
+// coverArtURN
+const asPlayListSummary = (playlist: playlist): PlaylistSummary => ({
+  id: playlist.id,
+  name: playlist.name,
+  coverArt: coverArtURN(playlist.coverArt),
+});
+
 export const asGenre = (genreName: string) => ({
   id: b64Encode(genreName),
   name: genreName,
@@ -317,19 +337,53 @@ const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
     O.getOrElseW(() => undefined)
   );
 
-export type StreamClientApplication = (track: Track) => string;
+export interface CustomPlayers {
+  encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>
+}
+
+export type CustomClient = {
+  mimeType: string;
+  transcodedMimeType: string;
+};
+
+export class TranscodingCustomPlayers implements CustomPlayers {
+  transcodings: Map<string, string>;
+
+  constructor(transcodings: Map<string, string>) {
+    this.transcodings = transcodings;
+  }
+
+  static from(config: string): TranscodingCustomPlayers {
+    const parts: [string, string][] = config
+      .split(",")
+      .map((it) => it.split(">"))
+      .map((pair) => {
+        if (pair.length == 1) return [pair[0]!, pair[0]!];
+        else if (pair.length == 2) return [pair[0]!, pair[1]!];
+        else throw new Error(`Invalid configuration item ${config}`);
+      });
+    return new TranscodingCustomPlayers(new Map(parts));
+  }
+
+  encodingFor = ({ mimeType }: { mimeType: string }): O.Option<Encoding> => pipe(
+    this.transcodings.get(mimeType),
+    O.fromNullable,
+    O.map(transcodedMimeType => ({ 
+      player:`${DEFAULT_CLIENT_APPLICATION}+${mimeType}`, 
+      mimeType: transcodedMimeType
+    }))
+  )
+}
+
+export const NO_CUSTOM_PLAYERS: CustomPlayers = {
+  encodingFor(_) {
+    return O.none
+  },
+}
 
 const DEFAULT_CLIENT_APPLICATION = "bonob";
 const USER_AGENT = "bonob";
 
-export const DEFAULT: StreamClientApplication = (_: Track) =>
-  DEFAULT_CLIENT_APPLICATION;
-
-export function appendMimeTypeToClientFor(mimeTypes: string[]) {
-  return (track: Track) =>
-    mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
-}
-
 export const asURLSearchParams = (q: any) => {
   const urlSearchParams = new URLSearchParams();
   Object.keys(q).forEach((k) => {
@@ -412,17 +466,17 @@ interface SubsonicMusicLibrary extends MusicLibrary {
 }
 
 export class Subsonic implements MusicService {
-  url: string;
+  url: URLBuilder;
-  streamClientApplication: StreamClientApplication;
+  customPlayers: CustomPlayers;
   externalImageFetcher: ImageFetcher;
 
   constructor(
-    url: string,
+    url: URLBuilder,
-    streamClientApplication: StreamClientApplication = DEFAULT,
+    customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS,
     externalImageFetcher: ImageFetcher = axiosImageFetcher
   ) {
     this.url = url;
-    this.streamClientApplication = streamClientApplication;
+    this.customPlayers = customPlayers;
     this.externalImageFetcher = externalImageFetcher;
   }
 
@@ -433,7 +487,7 @@ export class Subsonic implements MusicService {
     config: AxiosRequestConfig | undefined = {}
   ) =>
     axios
-      .get(`${this.url}${path}`, {
+      .get(this.url.append({ pathname: path }).href(), {
         params: asURLSearchParams({
           u: username,
           v: "1.16.1",
@@ -617,7 +671,7 @@ export class Subsonic implements MusicService {
       .then((it) => it.song)
       .then((song) =>
         this.getAlbum(credentials, song.albumId!).then((album) =>
-          asTrack(album, song)
+          asTrack(album, song, this.customPlayers)
         )
       );
 
@@ -720,7 +774,7 @@ export class Subsonic implements MusicService {
           })
           .then((it) => it.album)
           .then((album) =>
-            (album.song || []).map((song) => asTrack(asAlbum(album), song))
+            (album.song || []).map((song) => asTrack(asAlbum(album), song, this.customPlayers))
           ),
       track: (trackId: string) => subsonic.getTrack(credentials, trackId),
       rate: (trackId: string, rating: Rating) =>
@@ -771,7 +825,7 @@ export class Subsonic implements MusicService {
               `/rest/stream`,
               {
                 id: trackId,
-                c: this.streamClientApplication(track),
+                c: track.encoding.player,
               },
               {
                 headers: pipe(
@@ -788,15 +842,15 @@ export class Subsonic implements MusicService {
                 responseType: "stream",
               }
             )
-            .then((res) => ({
+            .then((stream) => ({
-              status: res.status,
+              status: stream.status,
               headers: {
-                "content-type": res.headers["content-type"],
+                "content-type": stream.headers["content-type"],
-                "content-length": res.headers["content-length"],
+                "content-length": stream.headers["content-length"],
-                "content-range": res.headers["content-range"],
+                "content-range": stream.headers["content-range"],
-                "accept-ranges": res.headers["accept-ranges"],
+                "accept-ranges": stream.headers["accept-ranges"],
               },
-              stream: res.data,
+              stream: stream.data,
             }))
         ),
       coverArt: async (coverArtURN: BUrn, size?: number) =>
@@ -859,9 +913,7 @@ export class Subsonic implements MusicService {
         subsonic
           .getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
           .then((it) => it.playlists.playlist || [])
-          .then((playlists) =>
+          .then((playlists) => playlists.map(asPlayListSummary)),
-            playlists.map((it) => ({ id: it.id, name: it.name }))
-          ),
       playlist: async (id: string) =>
         subsonic
           .getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
@@ -873,6 +925,7 @@ export class Subsonic implements MusicService {
             return {
               id: playlist.id,
               name: playlist.name,
+              coverArt: coverArtURN(playlist.coverArt),
               entries: (playlist.entry || []).map((entry) => ({
                 ...asTrack(
                   {
@@ -884,7 +937,8 @@ export class Subsonic implements MusicService {
                     artistId: entry.artistId,
                     coverArt: coverArtURN(entry.coverArt),
                   },
-                  entry
+                  entry,
+                  this.customPlayers
                 ),
                 number: trackNumber++,
               })),
@@ -896,7 +950,12 @@ export class Subsonic implements MusicService {
             name,
           })
           .then((it) => it.playlist)
-          .then((it) => ({ id: it.id, name: it.name })),
+          // todo: why is this line so similar to other playlist lines??
+          .then((it) => ({
+            id: it.id,
+            name: it.name,
+            coverArt: coverArtURN(it.coverArt),
+          })),
       deletePlaylist: async (id: string) =>
         subsonic
           .getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
@@ -930,7 +989,7 @@ export class Subsonic implements MusicService {
               songs.map((song) =>
                 subsonic
                   .getAlbum(credentials, song.albumId!)
-                  .then((album) => asTrack(album, song))
+                  .then((album) => asTrack(album, song, this.customPlayers))
               )
             )
           ),
@@ -947,7 +1006,7 @@ export class Subsonic implements MusicService {
                 songs.map((song) =>
                   subsonic
                     .getAlbum(credentials, song.albumId!)
-                    .then((album) => asTrack(album, song))
+                    .then((album) => asTrack(album, song, this.customPlayers))
                 )
               )
             )
@@ -955,6 +1014,7 @@ export class Subsonic implements MusicService {
     };
 
     if (credentials.type == "navidrome") {
+      // todo: there does not seem to be a test for this??
       return Promise.resolve({
         ...genericSubsonic,
         flavour: () => "navidrome",
@@ -963,7 +1023,7 @@ export class Subsonic implements MusicService {
             TE.tryCatch(
               () =>
                 axios.post(
-                  `${this.url}/auth/login`,
+                  this.url.append({ pathname: "/auth/login" }).href(),
                   _.pick(credentials, "username", "password")
                 ),
               () => new AuthFailure("Failed to get bearerToken")

tests/builders.ts

@@ -173,7 +173,10 @@ export function aTrack(fields: Partial<Track> = {}): Track {
   return {
     id,
     name: `Track ${id}`,
-    mimeType: `audio/mp3-${id}`,
+    encoding: {
+      player: "bonob",
+      mimeType: `audio/mp3-${id}`
+    },
     duration: randomInt(500),
     number: randomInt(100),
     genre,

tests/config.test.ts

@@ -270,6 +270,15 @@ describe("config", () => {
       expect(config().authTimeout).toEqual("33s");
     });
   });
+  
+  describe("logRequests", () => {
+    describeBooleanConfigValue(
+      "logRequests",
+      "BNB_SERVER_LOG_REQUESTS",
+      false,
+      (config) => config.logRequests
+    );
+  });
 
   describe("sonos", () => {
     describe("serviceName", () => {
@@ -365,23 +374,31 @@ describe("config", () => {
         "BONOB_NAVIDROME_URL",
       ])("%s", (k) => {
         describe(`when ${k} is not specified`, () => {
-          it(`should default to http://${hostname()}:4533`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
-            expect(config().subsonic.url).toEqual(`http://${hostname()}:4533`);
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
           });
         });
 
         describe(`when ${k} is ''`, () => {
-          it(`should default to http://${hostname()}:4533`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
             process.env[k] = "";
-            expect(config().subsonic.url).toEqual(`http://${hostname()}:4533`);
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
           });
         });
 
         describe(`when ${k} is specified`, () => {
           it(`should use it for ${k}`, () => {
-            const url = "http://navidrome.example.com:1234";
+            const url = "http://navidrome.example.com:1234/some-context-path";
             process.env[k] = url;
-            expect(config().subsonic.url).toEqual(url);
+            expect(config().subsonic.url.href()).toEqual(url);
+          });
+        });
+
+        describe(`when ${k} is specified with trailing slash`, () => {
+          it(`should maintain the trailing slash as URLBuilder will remove it when required ${k}`, () => {
+            const url = "http://navidrome.example.com:1234/";
+            process.env[k] = url;
+            expect(config().subsonic.url.href()).toEqual(url);
           });
         });
       });

tests/i8n.test.ts

@@ -34,7 +34,7 @@ describe("i8n", () => {
 
   describe("langs", () => {
     it("should be all langs that are explicitly defined", () => {
-      expect(langs()).toEqual(["en-US", "nl-NL"]);
+      expect(langs()).toEqual(["en-US", "da-DK", "fr-FR", "nl-NL"]);
     });
   });
 

tests/server.test.ts

@@ -2,9 +2,7 @@ import { v4 as uuid } from "uuid";
 import dayjs from "dayjs";
 import request from "supertest";
 import Image from "image-js";
-import fs from "fs";
 import { either as E, taskEither as TE } from "fp-ts";
-import path from "path";
 
 import { AuthFailure, MusicService } from "../src/music_service";
 import makeServer, {
@@ -167,15 +165,13 @@ describe("RangeBytesFromFilter", () => {
 
 
 describe("server", () => {
-  jest.setTimeout(Number.parseInt(process.env["JEST_TIMEOUT"] || "2000"));
-  
   beforeEach(() => {
     jest.clearAllMocks();
     jest.resetAllMocks();
   });
 
-  const bonobUrlWithNoContextPath = url("http://bonob.localhost:1234");
+  const bonobUrlWithNoContextPath = url("http://localhost:1234");
-  const bonobUrlWithContextPath = url("http://bonob.localhost:1234/aContext");
+  const bonobUrlWithContextPath = url("http://localhost:1234/aContext");
 
   const langName = randomLang();
   const acceptLanguage = `le-ET,${langName};q=0.9,en;q=0.8`;
@@ -757,15 +753,22 @@ describe("server", () => {
         const trackId = `t-${uuid()}`;
         const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` };
 
-        const streamContent = (content: string) => ({
+        const streamContent = (content: string) => {
-          pipe: (_: Transform) => {
+          const self = {
-            return {
+            destroyed: false,
-              pipe: (res: Response) => {
+            pipe: (_: Transform) => {
-                res.send(content);
+              return {
-              },
+                pipe: (res: Response) => {
-            };
+                  res.send(content);
-          },
+                }
-        });
+              };
+            },
+            destroy: () => {
+              self.destroyed = true;
+            }
+          };
+          return self;
+        };
 
         describe("HEAD requests", () => {
           describe("when there is no Bearer token", () => {
@@ -831,6 +834,8 @@ describe("server", () => {
                 );
                 expect(res.headers["content-length"]).toEqual("123");
                 expect(res.body).toEqual({});
+
+                expect(trackStream.stream.destroyed).toBe(true);
               });
             });
 
@@ -856,6 +861,8 @@ describe("server", () => {
 
                 expect(res.status).toEqual(404);
                 expect(res.body).toEqual({});
+
+                expect(trackStream.stream.destroyed).toBe(true);
               });
             });
           });
@@ -918,6 +925,8 @@ describe("server", () => {
   
                 expect(musicLibrary.nowPlaying).not.toHaveBeenCalled();
                 expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
+
+                expect(stream.stream.destroyed).toBe(true);
               });
             });
   
@@ -961,6 +970,8 @@ describe("server", () => {
                   expect(musicService.login).toHaveBeenCalledWith(serviceToken);
                   expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                   expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
   
@@ -1002,6 +1013,8 @@ describe("server", () => {
                   expect(musicService.login).toHaveBeenCalledWith(serviceToken);
                   expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                   expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
   
@@ -1042,6 +1055,8 @@ describe("server", () => {
                   expect(musicService.login).toHaveBeenCalledWith(serviceToken);
                   expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                   expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
   
@@ -1085,6 +1100,8 @@ describe("server", () => {
                   expect(musicService.login).toHaveBeenCalledWith(serviceToken);
                   expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
                   expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
             });
@@ -1133,6 +1150,8 @@ describe("server", () => {
                     trackId,
                     range: requestedRange,
                   });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
   
@@ -1180,6 +1199,8 @@ describe("server", () => {
                     trackId,
                     range: "4000-5000",
                   });
+
+                  expect(stream.stream.destroyed).toBe(true);
                 });
               });
             });
@@ -1300,279 +1321,6 @@ describe("server", () => {
               });
             });
 
-            describe("fetching multiple images as a collage", () => {
-              const png = fs.readFileSync(
-                path.join(
-                  __dirname,
-                  "..",
-                  "docs",
-                  "images",
-                  "chartreuseFuchsia.png"
-                )
-              );
-
-              describe("fetching a collage of 4 when all are available", () => {
-                it("should return the image and a 200", async () => {
-                  const urns = [
-                    "art:1",
-                    "art:2",
-                    "art:3",
-                    "art:4",
-                  ].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  urns.forEach((_) => {
-                    musicLibrary.coverArt.mockResolvedValueOnce(
-                      coverArtResponse({
-                        data: png,
-                      })
-                    );
-                  });
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(200);
-                  expect(res.header["content-type"]).toEqual("image/png");
-
-                  expect(musicService.login).toHaveBeenCalledWith(serviceToken);
-                  urns.forEach((it) => {
-                    expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 200);
-                  });
-
-                  const image = await Image.load(res.body);
-                  expect(image.width).toEqual(200);
-                  expect(image.height).toEqual(200);
-                });
-              });
-
-              describe("fetching a collage of 4, however only 1 is available", () => {
-                it("should return the single image", async () => {
-                  const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(
-                    coverArtResponse({
-                      data: png,
-                      contentType: "image/some-mime-type",
-                    })
-                  );
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(200);
-                  expect(res.header["content-type"]).toEqual(
-                    "image/some-mime-type"
-                  );
-                });
-              });
-
-              describe("fetching a collage of 4 and all are missing", () => {
-                it("should return a 404", async () => {
-                  const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  urns.forEach((_) => {
-                    musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  });
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(404);
-                });
-              });
-
-              describe("fetching a collage of 9 when all are available", () => {
-                it("should return the image and a 200", async () => {
-                  const urns = [
-                    "artist:1",
-                    "artist:2",
-                    "coverArt:3",
-                    "artist:4",
-                    "artist:5",
-                    "artist:6",
-                    "artist:7",
-                    "artist:8",
-                    "artist:9",
-                  ].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  urns.forEach((_) => {
-                    musicLibrary.coverArt.mockResolvedValueOnce(
-                      coverArtResponse({
-                        data: png,
-                      })
-                    );
-                  });
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(200);
-                  expect(res.header["content-type"]).toEqual("image/png");
-
-                  expect(musicService.login).toHaveBeenCalledWith(serviceToken);
-                  urns.forEach((it) => {
-                    expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
-                  });
-
-                  const image = await Image.load(res.body);
-                  expect(image.width).toEqual(180);
-                  expect(image.height).toEqual(180);
-                });
-              });
-
-              describe("fetching a collage of 9 when only 2 are available", () => {
-                it("should still return an image and a 200", async () => {
-                  const urns = [
-                    "artist:1",
-                    "artist:2",
-                    "artist:3",
-                    "artist:4",
-                    "artist:5",
-                    "artist:6",
-                    "artist:7",
-                    "artist:8",
-                    "artist:9",
-                  ].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  musicLibrary.coverArt.mockResolvedValueOnce(
-                    coverArtResponse({
-                      data: png,
-                    })
-                  );
-                  musicLibrary.coverArt.mockResolvedValueOnce(
-                    coverArtResponse({
-                      data: png,
-                    })
-                  );
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-                  musicLibrary.coverArt.mockResolvedValueOnce(undefined);
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(200);
-                  expect(res.header["content-type"]).toEqual("image/png");
-
-                  expect(musicService.login).toHaveBeenCalledWith(serviceToken);
-                  urns.forEach((urn) => {
-                    expect(musicLibrary.coverArt).toHaveBeenCalledWith(urn, 180);
-                  });
-
-                  const image = await Image.load(res.body);
-                  expect(image.width).toEqual(180);
-                  expect(image.height).toEqual(180);
-                });
-              });
-
-              describe("fetching a collage of 11", () => {
-                it("should still return an image and a 200, though will only display 9", async () => {
-                  const urns = [
-                    "artist:1",
-                    "artist:2",
-                    "artist:3",
-                    "artist:4",
-                    "artist:5",
-                    "artist:6",
-                    "artist:7",
-                    "artist:8",
-                    "artist:9",
-                    "artist:10",
-                    "artist:11",
-                  ].map(resource => ({ system:"subsonic", resource }));
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-
-                  urns.forEach((_) => {
-                    musicLibrary.coverArt.mockResolvedValueOnce(
-                      coverArtResponse({
-                        data: png,
-                      })
-                    );
-                  });
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
-                        "&"
-                      )}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(200);
-                  expect(res.header["content-type"]).toEqual("image/png");
-
-                  expect(musicService.login).toHaveBeenCalledWith(serviceToken);
-                  urns.forEach((it) => {
-                    expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
-                  });
-
-                  const image = await Image.load(res.body);
-                  expect(image.width).toEqual(180);
-                  expect(image.height).toEqual(180);
-                });
-              });
-
-              describe("when the image is not available", () => {
-                it("should return a 404", async () => {
-                  const coverArtURN = { system:"subsonic", resource:"art:404"};
-
-                  musicService.login.mockResolvedValue(musicLibrary);
-                  musicLibrary.coverArt.mockResolvedValue(undefined);
-
-                  const res = await request(server)
-                    .get(
-                      `/art/${encodeURIComponent(formatForURL(coverArtURN))}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
-                    )
-                    .set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
-
-                  expect(res.status).toEqual(404);
-                });
-              });
-            });
-
             describe("when there is an error", () => {
               it("should return a 500", async () => {
                 musicService.login.mockResolvedValue(musicLibrary);

tests/smapi.test.ts

@@ -18,11 +18,9 @@ import {
   track,
   artist,
   album,
-  defaultAlbumArtURI,
+  coverArtURI,
-  defaultArtistArtURI,
   searchResult,
   iconArtURI,
-  playlistAlbumArtURL,
   sonosifyMimeType,
   ratingAsInt,
   ratingFromInt,
@@ -41,7 +39,6 @@ import {
   TRIP_HOP,
   PUNK,
   aPlaylist,
-  anAlbumSummary,
 } from "./builders";
 import { InMemoryMusicService } from "./in_memory_music_service";
 import supersoap from "./supersoap";
@@ -56,7 +53,6 @@ import dayjs from "dayjs";
 import url, { URLBuilder } from "../src/url_builder";
 import { iconForGenre } from "../src/icon";
 import { formatForURL } from "../src/burn";
-import { range } from "underscore";
 import { FixedClock } from "../src/clock";
 import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth";
 
@@ -90,8 +86,6 @@ describe("rating to and from ints", () => {
 });
 
 describe("service config", () => {
-  jest.setTimeout(Number.parseInt(process.env["JEST_TIMEOUT"] || "2000"));
-  
   const bonobWithNoContextPath = url("http://localhost:1234");
   const bonobWithContextPath = url("http://localhost:5678/some-context-path");
 
@@ -122,7 +116,7 @@ describe("service config", () => {
 
       describe(STRINGS_ROUTE, () => {
         it("should return xml for the strings", async () => {
-          const xml = await fetchStringsXml();
+          const xml: Document = await fetchStringsXml();
 
           const sonosString = (id: string, lang: string) =>
             xpath.select(
@@ -137,8 +131,8 @@ describe("service config", () => {
             "Sonos koppelen aan music land"
           );
 
-          // no fr-FR translation, so use en-US
+          // no pt-BR translation, so use en-US
-          expect(sonosString("AppLinkMessage", "fr-FR")).toEqual(
+          expect(sonosString("AppLinkMessage", "pt-BR")).toEqual(
             "Linking sonos with music land"
           );
         });
@@ -358,7 +352,10 @@ describe("track", () => {
     const someTrack = aTrack({
       id: uuid(),
       // audio/x-flac should be mapped to audio/flac
-      mimeType: "audio/x-flac",
+      encoding: {
+        player: "something",
+        mimeType: "audio/x-flac"
+      },
       name: "great song",
       duration: randomInt(1000),
       number: randomInt(100),
@@ -413,7 +410,10 @@ describe("track", () => {
       const someTrack = aTrack({
         id: uuid(),
         // audio/x-flac should be mapped to audio/flac
-        mimeType: "audio/x-flac",
+        encoding: {
+          player: "something",
+          mimeType: "audio/x-flac"
+        },
         name: "great song",
         duration: randomInt(1000),
         number: randomInt(100),
@@ -473,7 +473,7 @@ describe("album", () => {
       itemType: "album",
       id: `album:${someAlbum.id}`,
       title: someAlbum.name,
-      albumArtURI: defaultAlbumArtURI(bonobUrl, someAlbum).href(),
+      albumArtURI: coverArtURI(bonobUrl, someAlbum).href(),
       canPlay: true,
       artist: someAlbum.artistName,
       artistId: `artist:${someAlbum.artistId}`,
@@ -497,279 +497,8 @@ describe("sonosifyMimeType", () => {
   });
 });
 
-describe("playlistAlbumArtURL", () => {
-  const coverArt1 = { system: "subsonic", resource: "1" };
-  const coverArt2 = { system: "subsonic", resource: "2" };
-  const coverArt3 = { system: "subsonic", resource: "3" };
-  const coverArt4 = { system: "subsonic", resource: "4" };
-  const coverArt5 = { system: "subsonic", resource: "5" };
 
-  describe("when the playlist has no coverArt ids", () => {
+describe("coverArtURI", () => {
-    it("should return question mark icon", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({ coverArt: undefined }),
-          aTrack({ coverArt: undefined }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/icon/error/size/legacy?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has external ids", () => {
-    it("should format the url with encrypted urn", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const externalArt1 = {
-        system: "external",
-        resource: "http://example.com/image1.jpg",
-      };
-      const externalArt2 = {
-        system: "external",
-        resource: "http://example.com/image2.jpg",
-      };
-
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: externalArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: externalArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${encodeURIComponent(
-          formatForURL(externalArt1)
-        )}&${encodeURIComponent(
-          formatForURL(externalArt2)
-        )}/size/180?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has 4 tracks from 2 different albums, including some tracks that are missing coverArt urns", () => {
-    it("should use the cover art once per album", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: undefined,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: undefined,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: coverArt3,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt4,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: undefined,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${encodeURIComponent(
-          formatForURL(coverArt1)
-        )}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has 4 tracks from 2 different albums", () => {
-    it("should use the cover art once per album", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: coverArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: coverArt3,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt4,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${encodeURIComponent(
-          formatForURL(coverArt1)
-        )}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has 4 tracks from 3 different albums", () => {
-    it("should use the cover art once per album", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: coverArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: coverArt3,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt4,
-            album: anAlbumSummary({ id: "album3" }),
-          }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${encodeURIComponent(
-          formatForURL(coverArt1)
-        )}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
-          formatForURL(coverArt4)
-        )}/size/180?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has 4 tracks from 4 different albums", () => {
-    it("should return them on the url to the image", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: coverArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: coverArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-          aTrack({
-            coverArt: coverArt3,
-            album: anAlbumSummary({ id: "album3" }),
-          }),
-          aTrack({
-            coverArt: coverArt4,
-            album: anAlbumSummary({ id: "album4" }),
-          }),
-          aTrack({
-            coverArt: coverArt5,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-        ],
-      });
-
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${encodeURIComponent(
-          formatForURL(coverArt1)
-        )}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
-          formatForURL(coverArt3)
-        )}&${encodeURIComponent(formatForURL(coverArt4))}/size/180?search=yes`
-      );
-    });
-  });
-
-  describe("when the playlist has at least 9 distinct albumIds", () => {
-    it("should return the first 9 of the ids on the url", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: { system: "subsonic", resource: "1" },
-            album: anAlbumSummary({ id: "1" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "2" },
-            album: anAlbumSummary({ id: "2" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "3" },
-            album: anAlbumSummary({ id: "3" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "4" },
-            album: anAlbumSummary({ id: "4" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "5" },
-            album: anAlbumSummary({ id: "5" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "6" },
-            album: anAlbumSummary({ id: "6" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "7" },
-            album: anAlbumSummary({ id: "7" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "8" },
-            album: anAlbumSummary({ id: "8" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "9" },
-            album: anAlbumSummary({ id: "9" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "10" },
-            album: anAlbumSummary({ id: "10" }),
-          }),
-          aTrack({
-            coverArt: { system: "subsonic", resource: "11" },
-            album: anAlbumSummary({ id: "11" }),
-          }),
-        ],
-      });
-
-      const burns = range(1, 10)
-        .map((i) =>
-          encodeURIComponent(
-            formatForURL({ system: "subsonic", resource: `${i}` })
-          )
-        )
-        .join("&");
-      expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
-        `http://localhost:1234/context-path/art/${burns}/size/180?search=yes`
-      );
-    });
-  });
-});
-
-describe("defaultAlbumArtURI", () => {
   const bonobUrl = new URLBuilder(
     "http://bonob.example.com:8080/context?search=yes"
   );
@@ -779,7 +508,7 @@ describe("defaultAlbumArtURI", () => {
       it("should use it", () => {
         const coverArt = { system: "subsonic", resource: "12345" };
         expect(
-          defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href()
+          coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
         ).toEqual(
           `http://bonob.example.com:8080/context/art/${encodeURIComponent(
             formatForURL(coverArt)
@@ -795,7 +524,7 @@ describe("defaultAlbumArtURI", () => {
           resource: "http://example.com/someimage.jpg",
         };
         expect(
-          defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href()
+          coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
         ).toEqual(
           `http://bonob.example.com:8080/context/art/${encodeURIComponent(
             formatForURL(coverArt)
@@ -808,7 +537,7 @@ describe("defaultAlbumArtURI", () => {
   describe("when there is no album coverArt", () => {
     it("should return a vinly icon image", () => {
       expect(
-        defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
+        coverArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
       ).toEqual(
         "http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes"
       );
@@ -816,50 +545,6 @@ describe("defaultAlbumArtURI", () => {
   });
 });
 
-describe("defaultArtistArtURI", () => {
-  describe("when the artist has no image", () => {
-    it("should return an icon", () => {
-      const bonobUrl = url("http://localhost:1234/something?s=123");
-      const artist = anArtist({ image: undefined });
-
-      expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
-        `http://localhost:1234/something/icon/vinyl/size/legacy?s=123`
-      );
-    });
-  });
-
-  describe("when the resource is subsonic", () => {
-    it("should use the resource", () => {
-      const bonobUrl = url("http://localhost:1234/something?s=123");
-      const image = { system: "subsonic", resource: "art:1234" };
-      const artist = anArtist({ image });
-
-      expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
-        `http://localhost:1234/something/art/${encodeURIComponent(
-          formatForURL(image)
-        )}/size/180?s=123`
-      );
-    });
-  });
-
-  describe("when the resource is external", () => {
-    it("should encrypt the resource", () => {
-      const bonobUrl = url("http://localhost:1234/something?s=123");
-      const image = {
-        system: "external",
-        resource: "http://example.com/something.jpg",
-      };
-      const artist = anArtist({ image });
-
-      expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
-        `http://localhost:1234/something/art/${encodeURIComponent(
-          formatForURL(image)
-        )}/size/180?s=123`
-      );
-    });
-  });
-});
-
 describe("wsdl api", () => {
   const musicService = {
     generateToken: jest.fn(),
@@ -1653,10 +1338,10 @@ describe("wsdl api", () => {
             });
 
             describe("asking for playlists", () => {
-              const playlist1 = aPlaylist({ id: "1", name: "pl1" });
+              const playlist1 = aPlaylist({ id: "1", name: "pl1", entries: []});
-              const playlist2 = aPlaylist({ id: "2", name: "pl2" });
+              const playlist2 = aPlaylist({ id: "2", name: "pl2", entries: []});
-              const playlist3 = aPlaylist({ id: "3", name: "pl3" });
+              const playlist3 = aPlaylist({ id: "3", name: "pl3", entries: []});
-              const playlist4 = aPlaylist({ id: "4", name: "pl4" });
+              const playlist4 = aPlaylist({ id: "4", name: "pl4", entries: []});
 
               const playlists = [playlist1, playlist2, playlist3, playlist4];
 
@@ -1683,7 +1368,7 @@ describe("wsdl api", () => {
                         itemType: "playlist",
                         id: `playlist:${playlist.id}`,
                         title: playlist.name,
-                        albumArtURI: playlistAlbumArtURL(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           playlist
                         ).href(),
@@ -1715,7 +1400,7 @@ describe("wsdl api", () => {
                           itemType: "playlist",
                           id: `playlist:${playlist.id}`,
                           title: playlist.name,
-                          albumArtURI: playlistAlbumArtURL(
+                          albumArtURI: coverArtURI(
                             bonobUrlWithAccessToken,
                             playlist
                           ).href(),
@@ -1759,7 +1444,7 @@ describe("wsdl api", () => {
                           itemType: "album",
                           id: `album:${it.id}`,
                           title: it.name,
-                          albumArtURI: defaultAlbumArtURI(
+                          albumArtURI: coverArtURI(
                             bonobUrlWithAccessToken,
                             it
                           ).href(),
@@ -1796,7 +1481,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -1848,9 +1533,9 @@ describe("wsdl api", () => {
                         id: `artist:${it.id}`,
                         artistId: it.id,
                         title: it.name,
-                        albumArtURI: defaultArtistArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
-                          it
+                          { coverArt: it.image }
                         ).href(),
                       })),
                       index: 0,
@@ -1893,9 +1578,9 @@ describe("wsdl api", () => {
                         id: `artist:${it.id}`,
                         artistId: it.id,
                         title: it.name,
-                        albumArtURI: defaultArtistArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
-                          it
+                          { coverArt: it.image }
                         ).href(),
                       })),
                       index: 1,
@@ -1954,9 +1639,9 @@ describe("wsdl api", () => {
                           id: `artist:${it.id}`,
                           artistId: it.id,
                           title: it.name,
-                          albumArtURI: defaultArtistArtURI(
+                          albumArtURI: coverArtURI(
                             bonobUrlWithAccessToken,
-                            it
+                            { coverArt: it.image }
                           ).href(),
                         })),
                         index: 0,
@@ -1983,9 +1668,9 @@ describe("wsdl api", () => {
                             id: `artist:${it.id}`,
                             artistId: it.id,
                             title: it.name,
-                            albumArtURI: defaultArtistArtURI(
+                            albumArtURI: coverArtURI(
                               bonobUrlWithAccessToken,
-                              it
+                              { coverArt: it.image }
                             ).href(),
                           })
                         ),
@@ -2100,7 +1785,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2148,7 +1833,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2196,7 +1881,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2244,7 +1929,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2292,7 +1977,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2340,7 +2025,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2386,7 +2071,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2432,7 +2117,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2476,7 +2161,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2523,7 +2208,7 @@ describe("wsdl api", () => {
                         itemType: "album",
                         id: `album:${it.id}`,
                         title: it.name,
-                        albumArtURI: defaultAlbumArtURI(
+                        albumArtURI: coverArtURI(
                           bonobUrlWithAccessToken,
                           it
                         ).href(),
@@ -2900,7 +2585,7 @@ describe("wsdl api", () => {
                         id: `track:${track.id}`,
                         itemType: "track",
                         title: track.name,
-                        mimeType: track.mimeType,
+                        mimeType: track.encoding.mimeType,
                         trackMetadata: {
                           artistId: `artist:${track.artist.id}`,
                           artist: track.artist.name,
@@ -2911,7 +2596,7 @@ describe("wsdl api", () => {
                           genre: track.genre?.name,
                           genreId: track.genre?.id,
                           duration: track.duration,
-                          albumArtURI: defaultAlbumArtURI(
+                          albumArtURI: coverArtURI(
                             bonobUrlWithAccessToken,
                             track
                           ).href(),
@@ -2948,7 +2633,7 @@ describe("wsdl api", () => {
                         id: `track:${track.id}`,
                         itemType: "track",
                         title: track.name,
-                        mimeType: track.mimeType,
+                        mimeType: track.encoding.mimeType,
                         trackMetadata: {
                           artistId: `artist:${track.artist.id}`,
                           artist: track.artist.name,
@@ -2959,7 +2644,7 @@ describe("wsdl api", () => {
                           genre: track.genre?.name,
                           genreId: track.genre?.id,
                           duration: track.duration,
-                          albumArtURI: defaultAlbumArtURI(
+                          albumArtURI: coverArtURI(
                             bonobUrlWithAccessToken,
                             track
                           ).href(),
@@ -3002,7 +2687,7 @@ describe("wsdl api", () => {
                       itemType: "album",
                       id: `album:${album.id}`,
                       title: album.name,
-                      albumArtURI: defaultAlbumArtURI(
+                      albumArtURI: coverArtURI(
                         bonobUrlWithAccessToken,
                         album
                       ).href(),

tsconfig.json

@@ -50,7 +50,7 @@
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     "typeRoots": [
       "./typings",
-      "node_modules/@types"
+      "./node_modules/@types"
     ]
      /* List of folders to include type definitions from. */,
     // "types": ["src/customTypes/scale-that-svg.d.ts"],                           /* Type declaration files to be included in compilation. */