Move artists tests

* 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:23-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,28 @@
+{
+    "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",
+            "redhat.vscode-xml"
+        ]
+        }
+    }
+}

.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/setup-node@v1
+        uses: actions/checkout@v3
+      -
+        uses: actions/setup-node@v3
         with:
-          node-version: '16'
-      - 
-        run: yarn install
-      - 
-        run: yarn test
+          node-version: 20
+      -
+        run: npm install
+      -
+        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
-        uses: docker/build-push-action@v2
+      -
+        name: Log in to GitHub Container registry
+        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:23-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 .yarnrc.yml .
-COPY .yarn/releases ./.yarn/releases
+COPY package.json .
+COPY package-lock.json .
 
-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 && \
-    yarn gitinfo && \
-    yarn test --no-cache && \
-    yarn build
+    npm install && \
+    npm test && \
+    npm run gitinfo && \
+    npm run build && \
+    rm -Rf node_modules && \
+    NODE_ENV=production npm install --omit=dev
 
 
-FROM node:16-bullseye
+FROM node:23-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,17 +52,20 @@ 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
 COPY --from=build /bonob/.gitinfo ./
 COPY web ./web
-COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
+COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl
 
 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

@@ -9,23 +9,40 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
 ## Features
 
 - Integrates with Subsonic API clones (Navidrome, Gonic)
-- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums
+- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
 - Artist & Album Art
 - View Related Artists via Artist -> '...' -> Menu -> Related Arists
 - Now playing & Track Scrobbling
 - 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 & fr-FR 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 | Lastest build from master, probably works, however is currently under test
+vX.Y.Z | Fixed release versions from tags, for those that want to pin to a 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_DEVICE_DISCOVERY: true
+      BNB_SONOS_AUTO_REGISTER: "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_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images as are sourced externally.  ie. Navidrome provides spotify URLs
+BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac".  <p>However; <p>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>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
+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,34 +207,58 @@ 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
+## 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).
+### Transcode everything
 
-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.
+The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
 
-### Audio File type specific transcoding options within Subsonic
+### Audio file type specific transcoding
 
-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/)
+Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
+
+In some situations you may wish to have different 'Players' within your 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;
 
 ```bash
+# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
 BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
 ```
 
-This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'.  You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a sonos supported format, ie [Using something like this](https://stackoverflow.com/questions/41420391/ffmpeg-flac-24-bit-96khz-to-16-bit-48khz);
+This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'.  You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a sonos supported format, ie [Using something like this](https://stackoverflow.com/questions/41420391/ffmpeg-flac-24-bit-96khz-to-16-bit-48khz) or [this](https://stackoverflow.com/questions/52119489/ffmpeg-limit-audio-sample-rate):
 
 ```bash
-ffmpeg -i %s -af aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=48000 -f flac -
+ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
 ```
 
-### Changing Icon colors
+**Note for Sonos S1:** [24-bit depth is only supported by Sonos S2](https://support.sonos.com/s/article/79?language=en_US), so if your system is still on Sonos S1, transcoding should convert all FLACs to 16-bit:
+
+```bash
+ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
+```
+
+Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files.  Let's say you want to transcode them to mp3s, you could set the following;
+
+```bash
+BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
+```
+
+And then configure the 'bonob+audio/mpeg' player in your subsonic server.
+
+
+## Changing Icon colors
 
 ```bash
 -e BNB_ICON_FOREGROUND_COLOR=white \
@@ -245,6 +288,7 @@ ffmpeg -i %s -af aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=480
 
 ![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true)
 
+
 ## Credits
 
 - Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho

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,70 @@
   "author": "simojenki <simojenki@users.noreply.github.com>",
   "license": "GPL-3.0-only",
   "dependencies": {
-    "@svrooij/sonos": "^2.4.0",
-    "@types/express": "^4.17.13",
-    "@types/fs-extra": "^9.0.13",
-    "@types/jsonwebtoken": "^8.5.5",
-    "@types/jws": "^3.2.4",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^16.7.13",
-    "@types/randomstring": "^1.1.8",
-    "@types/sharp": "^0.28.6",
-    "@types/underscore": "^1.11.3",
-    "@types/uuid": "^8.3.1",
-    "axios": "^0.21.4",
-    "dayjs": "^1.10.6",
-    "eta": "^1.12.3",
-    "express": "^4.17.1",
-    "fp-ts": "^2.11.1",
-    "fs-extra": "^10.0.0",
-    "jsonwebtoken": "^8.5.1",
+    "@svrooij/sonos": "^2.6.0-beta.11",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/jws": "^3.2.10",
+    "@types/morgan": "^1.9.9",
+    "@types/node": "^20.11.5",
+    "@types/randomstring": "^1.3.0",
+    "@types/underscore": "^1.13.0",
+    "@types/uuid": "^10.0.0",
+    "@types/xmldom": "^0.1.34",
+    "@xmldom/xmldom": "^0.9.7",
+    "axios": "^1.7.8",
+    "dayjs": "^1.11.13",
+    "eta": "^2.2.0",
+    "express": "^4.18.3",
+    "fp-ts": "^2.16.9",
+    "fs-extra": "^11.2.0",
+    "jsonwebtoken": "^9.0.2",
     "jws": "^4.0.0",
-    "libxmljs2": "^0.28.0",
     "morgan": "^1.10.0",
-    "node-html-parser": "^4.1.4",
-    "randomstring": "^1.2.1",
-    "sharp": "^0.29.1",
-    "soap": "^0.42.0",
-    "ts-md5": "^1.2.9",
-    "typescript": "^4.4.2",
-    "underscore": "^1.13.1",
+    "node-html-parser": "^6.1.13",
+    "randomstring": "^1.3.0",
+    "sharp": "^0.33.5",
+    "soap": "^1.1.6",
+    "ts-md5": "^1.3.1",
+    "typescript": "^5.7.2",
+    "underscore": "^1.13.7",
     "urn-lib": "^2.0.0",
-    "uuid": "^8.3.2",
-    "winston": "^3.3.3"
+    "uuid": "^11.0.3",
+    "winston": "^3.17.0",
+    "xmldom-ts": "^0.3.1",
+    "xpath": "^0.0.34"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.21",
-    "@types/jest": "^27.0.1",
-    "@types/mocha": "^9.0.0",
-    "@types/supertest": "^2.0.11",
-    "@types/tmp": "^0.2.1",
-    "chai": "^4.3.4",
-    "get-port": "^5.1.1",
-    "image-js": "^0.33.0",
-    "jest": "^27.1.0",
-    "nodemon": "^2.0.12",
-    "supertest": "^6.1.6",
-    "tmp": "^0.2.1",
-    "ts-jest": "^27.0.5",
+    "@types/chai": "^5.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/mocha": "^10.0.10",
+    "@types/supertest": "^6.0.2",
+    "@types/tmp": "^0.2.6",
+    "chai": "^5.1.2",
+    "get-port": "^7.1.0",
+    "image-js": "^0.35.6",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.7",
+    "supertest": "^7.0.0",
+    "tmp": "^0.2.3",
+    "ts-jest": "^29.2.5",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.2.1",
-    "xmldom-ts": "^0.3.1",
+    "ts-node": "^10.9.2",
     "xpath-ts": "^1.3.13"
   },
+  "overrides": {
+    "axios-ntlm": "npm:dry-uninstall",
+    "axios": "$axios"
+  },
   "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",
-    "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",
-    "register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
+    "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_LOG_LEVEL=debug BNB_DEBUG=true BNB_ICON_FOREGROUND_COLOR=deeppink BNB_ICON_BACKGROUND_COLOR=darkslategray 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://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
+    "testw": "jest --watch",
     "gitinfo": "git describe --tags > .gitinfo"
   }
 }

src/Sonoswsdl-1.19.6-20231024.wsdl

@@ -97,7 +97,7 @@
                 <xs:complexType>
                     <xs:sequence>
                         <xs:element name="token" type="xs:string"/>
-                        <xs:element name="key" type="xs:string"/>
+                        <xs:element name="key" type="xs:string" minOccurs="0"/>
                         <xs:element name="householdId" type="xs:string"/>
                     </xs:sequence>
                 </xs:complexType>
@@ -111,11 +111,12 @@
                 </xs:simpleType>
             </xs:element>
 
-            <xs:simpleType name="userAccountType">
+            <xs:simpleType name="userAccountTier">
                 <xs:restriction base="xs:string">
-                    <xs:enumeration value="premium"/>
-                    <xs:enumeration value="trial"/>
+                    <xs:enumeration value="paidPremium"/>
+                    <xs:enumeration value="paidLimited"/>
                     <xs:enumeration value="free"/>
+                    <xs:enumeration value="none"/>
                 </xs:restriction>
             </xs:simpleType>
 
@@ -239,6 +240,12 @@
                 </xs:simpleContent>
             </xs:complexType>
 
+            <xs:complexType name="contentKeys">
+                <xs:sequence>
+                    <xs:element name="contentKey" type="tns:contentKey" maxOccurs="8"/>
+                </xs:sequence>
+            </xs:complexType>
+
             <xs:simpleType name="mediaUriAction">
                 <xs:restriction base="xs:string">
                     <xs:enumeration value="IMPLICIT"/>
@@ -355,13 +362,11 @@
 
             <xs:complexType name="userInfo">
                 <xs:sequence>
-                    <!-- Everything except userIdHashCode and nickname are for future use -->
+                    <!--  accountStatus potentially for future use -->
                     <xs:element name="userIdHashCode" type="xs:string" minOccurs="1"/>
-                    <xs:element name="accountType" type="tns:userAccountType" minOccurs="0"/>
+                    <xs:element name="accountTier" type="tns:userAccountTier" minOccurs="0"/>
                     <xs:element name="accountStatus" type="tns:userAccountStatus" minOccurs="0"/>
                     <xs:element ref="tns:nickname" minOccurs="0"/>
-                    <xs:element name="profileUrl" type="tns:sonosUri" minOccurs="0"/>
-                    <xs:element name="pictureUrl" type="tns:sonosUri" minOccurs="0"/>
                 </xs:sequence>
             </xs:complexType>
 
@@ -888,7 +893,10 @@
                         <xs:element name="getMediaURIResult" type="xs:anyURI"/>
                         <xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="deviceSessionKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
-                        <xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
+                        <xs:choice minOccurs="0">
+                            <xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
+                            <xs:element name="contentKeys" type="tns:contentKeys" minOccurs="0" maxOccurs="1"/>
+                        </xs:choice>
                         <xs:element name="httpHeaders" type="tns:httpHeaders" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="uriTimeout" type="xs:int" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="positionInformation" type="tns:positionInformation" minOccurs="0" maxOccurs="1"/>
@@ -2059,7 +2067,7 @@
 
     <wsdl:service name="Sonos">
         <wsdl:port name="SonosSoap" binding="tns:SonosSoap">
-		<soap:address location="/about"/>
+		<soap:address location="http://moapi.sonos.com/Test/TestService.php"/>
         </wsdl:port>
     </wsdl:service>
 

src/app.ts

@@ -4,17 +4,18 @@ import server from "./server";
 import logger from "./logger";
 
 import {
-  appendMimeTypeToClientFor,
   axiosImageFetcher,
   cachingImageFetcher,
-  DEFAULT,
-  Subsonic,
+  TranscodingCustomPlayers,
+  NO_CUSTOM_PLAYERS,
+  Subsonic
 } from "./subsonic";
+import { SubsonicMusicService} from "./subsonic_music_library";
 import { InMemoryAPITokens, sha256 } from "./api_tokens";
 import { InMemoryLinkCodes } from "./link_codes";
 import readConfig from "./config";
 import sonos, { bonobService } from "./sonos";
-import { MusicService } from "./music_service";
+import { MusicService } from "./music_library";
 import { SystemClock } from "./clock";
 import { JWTSmapiLoginTokens } from "./smapi_auth";
 
@@ -32,18 +33,21 @@ const bonob = bonobService(
 
 const sonosSystem = sonos(config.sonos.discovery);
 
-const streamUserAgent = config.subsonic.customClientsFor
-  ? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(","))
-  : DEFAULT;
+const customPlayers = config.subsonic.customClientsFor
+  ? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
+  : NO_CUSTOM_PLAYERS;
 
 const artistImageFetcher = config.subsonic.artistImageCache
   ? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
   : axiosImageFetcher;
 
-const subsonic = new Subsonic(
-  config.subsonic.url,
-  streamUserAgent,
-  artistImageFetcher
+const subsonic = new SubsonicMusicService(
+  new Subsonic(
+    config.subsonic.url,
+    customPlayers,
+    artistImageFetcher
+  ),
+  customPlayers
 );
 
 const featureFlagAwareMusicService: MusicService = {
@@ -88,14 +92,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 +117,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/burn.ts

@@ -1,6 +1,8 @@
 import _ from "underscore";
 import { createUrnUtil } from "urn-lib";
 import randomstring from "randomstring";
+import { pipe } from "fp-ts/lib/function";
+import { either as E } from "fp-ts";
 
 import jwsEncryption from "./encryption";
 
@@ -78,7 +80,13 @@ export const parse = (burn: string): BUrn => {
     resource: result.resource as string,
   };
   if(x.system == "encrypted") {
-    return parse(encryptor.decrypt(x.resource));
+    return pipe(
+      encryptor.decrypt(x.resource),
+      E.match(
+        (err) => { throw new Error(err) },
+        (z) => parse(z)
+      )
+    );
   } else {
     return x;
   }

src/clock.ts

@@ -1,13 +1,38 @@
 import dayjs, { Dayjs } from "dayjs";
 
-export const isChristmas = (clock: Clock = SystemClock) => clock.now().month() == 11 && clock.now().date() == 25;
-export const isMay4 = (clock: Clock = SystemClock) => clock.now().month() == 4 && clock.now().date() == 4;
-export const isHalloween = (clock: Clock = SystemClock) => clock.now().month() == 9 && clock.now().date() == 31
-export const isHoli = (clock: Clock = SystemClock) => ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].map(dayjs).find(it => it.isSame(clock.now())) != undefined
-export const isCNY = (clock: Clock = SystemClock) => ["2022/02/01", "2023/01/22", "2024/02/10", "2025/02/29"].map(dayjs).find(it => it.isSame(clock.now())) != undefined
-export const isCNY_2022 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2022/02/01"))
-export const isCNY_2023 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2023/01/22"))
-export const isCNY_2024 = (clock: Clock = SystemClock) => clock.now().isSame(dayjs("2024/02/10"))
+function fixedDateMonthEvent(dateMonth: string) {
+  const date = Number.parseInt(dateMonth.split("/")[0]!);
+  const month = Number.parseInt(dateMonth.split("/")[1]!);
+  return (clock: Clock = SystemClock) => {
+    return clock.now().date() == date && clock.now().month() == month - 1;
+  };
+}
+
+function fixedDateEvent(date: string) {
+  const dayjsDate = dayjs(date);
+  return (clock: Clock = SystemClock) => {
+    return clock.now().isSame(dayjsDate, "day");
+  };
+}
+
+function anyOf(rules: ((clock: Clock) => boolean)[]) {
+  return (clock: Clock = SystemClock) => {
+    return rules.find((rule) => rule(clock)) != undefined;
+  };
+}
+
+export const isChristmas = fixedDateMonthEvent("25/12");
+export const isMay4 = fixedDateMonthEvent("04/05");
+export const isHalloween = fixedDateMonthEvent("31/10");
+export const isHoli = anyOf(
+  ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].map(fixedDateEvent)
+)
+
+export const isCNY_2022 = fixedDateEvent("2022/02/01");
+export const isCNY_2023 = fixedDateEvent("2023/01/22");
+export const isCNY_2024 = fixedDateEvent("2024/02/10");
+export const isCNY_2025 = fixedDateEvent("2025/02/29");
+export const isCNY = anyOf([isCNY_2022, isCNY_2023, isCNY_2024, isCNY_2025]);
 
 export interface Clock {
   now(): Dayjs;
@@ -17,12 +42,13 @@ export const SystemClock = { now: () => dayjs() };
 
 export class FixedClock implements Clock {
   time: Dayjs;
-  
+
   constructor(time: Dayjs = dayjs()) {
     this.time = time;
   }
 
-  add = (t: number, unit: dayjs.UnitTypeShort) => this.time = this.time.add(t, unit)
+  add = (t: number, unit: dayjs.UnitTypeShort) =>
+    (this.time = this.time.add(t, unit));
 
   now = () => this.time;
-}
+}

src/config.ts

@@ -5,20 +5,22 @@ import url from "./url_builder";
 export const WORD = /^\w+$/;
 export const COLOR = /^#?\w+$/;
 
-type EnvVarOpts = {
-  default: string | undefined;
+type EnvVarOpts<T> = {
+  default: T | undefined;
   legacy: string[] | undefined;
   validationPattern: RegExp | undefined;
+  parser: ((value: string) => T) | undefined
 };
 
-export function envVar(
+export function envVar<T>(
   name: string,
-  opts: Partial<EnvVarOpts> = {
+  opts: Partial<EnvVarOpts<T>> = {
     default: undefined,
     legacy: undefined,
     validationPattern: undefined,
+    parser: undefined
   }
-) {
+): T {
   const result = [name, ...(opts.legacy || [])]
     .map((it) => ({ key: it, value: process.env[it] }))
     .find((it) => it.value);
@@ -36,17 +38,28 @@ export function envVar(
     logger.warn(`Configuration key '${result.key}' is deprecated, replace with '${name}'`)
   }
 
-  return result?.value || opts.default;
+  let value: T | undefined = undefined;
+
+  if(result?.value && opts.parser) {
+    value = opts.parser(result?.value)
+  } else if(result?.value)
+    value = result?.value as any as T
+
+  return value == undefined ? opts.default as T : value;
 }
 
-export const bnbEnvVar = (key: string, opts: Partial<EnvVarOpts> = {}) =>
+export const bnbEnvVar = <T>(key: string, opts: Partial<EnvVarOpts<T>> = {}) =>
   envVar(`BNB_${key}`, {
     ...opts,
     legacy: [`BONOB_${key}`, ...(opts.legacy || [])],
   });
 
+const asBoolean = (value: string) => value == "true";
+
+const asInt = (value: string) => Number.parseInt(value);
+
 export default function () {
-  const port = +bnbEnvVar("PORT", { default: "4534" })!;
+  const port = bnbEnvVar<number>("PORT", { default: 4534, parser: asInt })!;
   const bonobUrl = bnbEnvVar("URL", {
     legacy: ["BONOB_WEB_ADDRESS"],
     default: `http://${hostname()}:${port}`,
@@ -62,34 +75,35 @@ export default function () {
   return {
     port,
     bonobUrl: url(bonobUrl),
-    secret: bnbEnvVar("SECRET", { default: "bonob" })!,
-    authTimeout: bnbEnvVar("AUTH_TIMEOUT", { default: "1h" })!,
+    secret: bnbEnvVar<string>("SECRET", { default: "bonob" })!,
+    authTimeout: bnbEnvVar<string>("AUTH_TIMEOUT", { default: "1h" })!,
     icons: {
-      foregroundColor: bnbEnvVar("ICON_FOREGROUND_COLOR", {
+      foregroundColor: bnbEnvVar<string>("ICON_FOREGROUND_COLOR", {
         validationPattern: COLOR,
       }),
-      backgroundColor: bnbEnvVar("ICON_BACKGROUND_COLOR", {
+      backgroundColor: bnbEnvVar<string>("ICON_BACKGROUND_COLOR", {
         validationPattern: COLOR,
       }),
     },
+    logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
     sonos: {
-      serviceName: bnbEnvVar("SONOS_SERVICE_NAME", { default: "bonob" })!,
+      serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
       discovery: {
         enabled:
-          bnbEnvVar("SONOS_DEVICE_DISCOVERY", { default: "true" }) == "true",
-        seedHost: bnbEnvVar("SONOS_SEED_HOST"),
+          bnbEnvVar<boolean>("SONOS_DEVICE_DISCOVERY", { default: true, parser: asBoolean }),
+        seedHost: bnbEnvVar<string>("SONOS_SEED_HOST"),
       },
       autoRegister:
-        bnbEnvVar("SONOS_AUTO_REGISTER", { default: "false" }) == "true",
-      sid: Number(bnbEnvVar("SONOS_SERVICE_ID", { default: "246" })),
+        bnbEnvVar<boolean>("SONOS_AUTO_REGISTER", { default: false, parser: asBoolean }),
+      sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
     },
     subsonic: {
-      url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!,
-      customClientsFor: bnbEnvVar("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
-      artistImageCache: bnbEnvVar("SUBSONIC_ARTIST_IMAGE_CACHE"),
+      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"),
     },
-    scrobbleTracks: bnbEnvVar("SCROBBLE_TRACKS", { default: "true" }) == "true",
+    scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }),
     reportNowPlaying:
-      bnbEnvVar("REPORT_NOW_PLAYING", { default: "true" }) == "true",
+      bnbEnvVar<boolean>("REPORT_NOW_PLAYING", { default: true, parser: asBoolean }),
   };
 }

src/encryption.ts

@@ -4,13 +4,14 @@ import {
   randomBytes,
   createHash,
 } from "crypto";
-
+import { option as O, either as E } from "fp-ts";
+import { Either, left, right } from 'fp-ts/Either'
+import { pipe } from "fp-ts/lib/function";
 import jws from "jws";
 
 const ALGORITHM = "aes-256-cbc";
 const IV = randomBytes(16);
 
-
 export type Hash = {
   iv: string;
   encryptedData: string;
@@ -18,7 +19,7 @@ export type Hash = {
 
 export type Encryption = {
   encrypt: (value: string) => string;
-  decrypt: (value: string) => string;
+  decrypt: (value: string) => Either<string, string>;
 };
 
 export const jwsEncryption = (secret: string): Encryption => {
@@ -28,7 +29,15 @@ export const jwsEncryption = (secret: string): Encryption => {
       payload: value,
       secret: secret,
     }),
-    decrypt: (value: string) => jws.decode(value).payload
+    decrypt: (value: string) => pipe(
+      jws.decode(value),
+      O.fromNullable,
+      O.map(it => it.payload),
+      O.match(
+        () => left("Failed to decrypt jws"),
+        (payload) => right(payload)
+      )
+    )
   }
 }
 
@@ -36,7 +45,8 @@ export const cryptoEncryption = (secret: string): Encryption => {
   const key = createHash("sha256")
     .update(String(secret))
     .digest("base64")
-    .substr(0, 32);
+    .substring(0, 32);
+
   return {
     encrypt: (value: string) => {
       const cipher = createCipheriv(ALGORITHM, key, IV);
@@ -45,20 +55,23 @@ export const cryptoEncryption = (secret: string): Encryption => {
         cipher.final(),
       ]).toString("hex")}`;
     },
-    decrypt: (value: string) => {
-      const parts = value.split(".");
-      if(parts.length != 2) throw `Invalid value to decrypt`;
-
-      const decipher = createDecipheriv(
-        ALGORITHM,
-        key,
-        Buffer.from(parts[0]!, "hex")
-      );
-      return Buffer.concat([
-        decipher.update(Buffer.from(parts[1]!, "hex")),
-        decipher.final(),
-      ]).toString();
-    },
+    decrypt: (value: string) => pipe(
+      right(value),
+      E.map(it => it.split(".")),
+      E.flatMap(it => it.length == 2 ? right({ iv: it[0]!, data: it[1]! }) : left("Invalid value to decrypt")),
+      E.map(it => ({
+        hash: it,
+        decipher: createDecipheriv(
+          ALGORITHM,
+          key,
+          Buffer.from(it.iv, "hex")
+        )
+      })),
+      E.map(it => Buffer.concat([
+        it.decipher.update(Buffer.from(it.hash.data, "hex")),
+        it.decipher.final(),
+      ]).toString())
+    ),
   };
 };
 

src/i8n.ts

@@ -4,11 +4,12 @@ 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"
   | "albums"
+  | "internetRadio"  
   | "playlists"
   | "genres"
   | "random"
@@ -39,6 +40,7 @@ export type KEY =
   | "loginFailed" 
   | "noSonosDevices" 
   | "favourites"
+  | "years"
   | "LOVE"
   | "LOVE_SUCCESS"
   | "STAR" 
@@ -51,6 +53,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     AppLinkMessage: "Linking sonos with $BNB_SONOS_SERVICE_NAME",
     artists: "Artists",
     albums: "Albums",
+    internetRadio: "Internet Radio",
     tracks: "Tracks",
     playlists: "Playlists",
     genres: "Genres",
@@ -81,6 +84,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginFailed: "Login failed!",
     noSonosDevices: "No sonos devices",
     favourites: "Favourites",
+    years: "Years",
     STAR: "Star",
     UNSTAR: "Un-star",
     STAR_SUCCESS: "Track starred",
@@ -88,10 +92,97 @@ 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",
+    internetRadio: "Internet Radio",
+    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",
+    years: "Flere år",
+    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",
+    internetRadio: "Radio Internet",
+    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",
+    years: "Années",
+    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",
     albums: "Albums",
+    internetRadio: "Internet Radio",
     tracks: "Nummers",
     playlists: "Afspeellijsten",
     genres: "Genres",
@@ -122,6 +213,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
     loginFailed: "Inloggen mislukt!",
     noSonosDevices: "Geen Sonos-apparaten",
     favourites: "Favorieten",
+    years: "Jaren",
     STAR: "Ster ",
     UNSTAR: "Een ster",
     STAR_SUCCESS: "Nummer met ster",

src/icon.ts

@@ -1,4 +1,5 @@
-import libxmljs, { Element, Attribute } from "libxmljs2";
+import * as xpath from "xpath";
+import { DOMParser, Node } from '@xmldom/xmldom';
 import _ from "underscore";
 import fs from "fs";
 
@@ -13,11 +14,10 @@ import {
   isMay4,
   SystemClock,
 } from "./clock";
+import { xmlTidy } from "./utils";
 import path from "path";
 
-const SVG_NS = {
-  svg: "http://www.w3.org/2000/svg",
-};
+const SVG_NS = "http://www.w3.org/2000/svg";
 
 class ViewBox {
   minX: number;
@@ -48,8 +48,16 @@ export type IconFeatures = {
   viewPortIncreasePercent: number | undefined;
   backgroundColor: string | undefined;
   foregroundColor: string | undefined;
+  text: string | undefined;
 };
 
+export const NO_FEATURES: IconFeatures = {
+  viewPortIncreasePercent: undefined,
+  backgroundColor: undefined,
+  foregroundColor: undefined,
+  text: undefined
+}
+
 export type IconSpec = {
   svg: string | undefined;
   features: Partial<IconFeatures> | undefined;
@@ -93,17 +101,11 @@ export class SvgIcon implements Icon {
 
   constructor(
     svg: string,
-    features: Partial<IconFeatures> = {
-      viewPortIncreasePercent: undefined,
-      backgroundColor: undefined,
-      foregroundColor: undefined,
-    }
+    features: Partial<IconFeatures> = {}
   ) {
     this.svg = svg;
     this.features = {
-      viewPortIncreasePercent: undefined,
-      backgroundColor: undefined,
-      foregroundColor: undefined,
+      ...NO_FEATURES,
       ...features,
     };
   }
@@ -117,38 +119,44 @@ export class SvgIcon implements Icon {
     });
 
   public toString = () => {
-    const xml = libxmljs.parseXmlString(this.svg, {
-      noblanks: true,
-      net: false,
-    });
-    const viewBoxAttr = xml.get("//svg:svg/@viewBox", SVG_NS) as Attribute;
-    let viewBox = new ViewBox(viewBoxAttr.value());
+    const doc = new DOMParser().parseFromString(this.svg, 'text/xml') as unknown as Document;
+    const select = xpath.useNamespaces({ svg: SVG_NS });
+
+    const elements = (path: string) => (select(path, doc) as Element[])
+    const element = (path: string) => elements(path)[0]!
+
+    let viewBox = new ViewBox(select("string(//svg:svg/@viewBox)", doc) as string);
     if (
       this.features.viewPortIncreasePercent &&
       this.features.viewPortIncreasePercent > 0
     ) {
       viewBox = viewBox.increasePercent(this.features.viewPortIncreasePercent);
-      viewBoxAttr.value(viewBox.toString());
+      element("//svg:svg").setAttribute("viewBox", viewBox.toString());
     }
-    if (this.features.backgroundColor) {
-      (xml.get("//svg:svg/*[1]", SVG_NS) as Element).addPrevSibling(
-        new Element(xml, "rect").attr({
-          x: `${viewBox.minX}`,
-          y: `${viewBox.minY}`,
-          width: `${Math.abs(viewBox.minX) + viewBox.width}`,
-          height: `${Math.abs(viewBox.minY) + viewBox.height}`,
-          fill: this.features.backgroundColor,
-        })
-      );
-    }
-    if (this.features.foregroundColor) {
-      (xml.find("//svg:path", SVG_NS) as Element[]).forEach((path) => {
-        if (path.attr("fill"))
-          path.attr({ stroke: this.features.foregroundColor! });
-        else path.attr({ fill: this.features.foregroundColor! });
+    if(this.features.text) {
+      elements("//svg:text").forEach((text) => {
+        text.textContent = this.features.text!
       });
     }
-    return xml.toString();
+    if (this.features.foregroundColor) {
+      elements("//svg:path|//svg:text").forEach((path) => {
+        if (path.getAttribute("fill")) path.setAttribute("stroke", this.features.foregroundColor!);
+        else path.setAttribute("fill", this.features.foregroundColor!);
+      });
+    }
+    if (this.features.backgroundColor) {
+      const rect = doc.createElementNS(SVG_NS, "rect");
+      rect.setAttribute("x", `${viewBox.minX}`);
+      rect.setAttribute("y", `${viewBox.minY}`);
+      rect.setAttribute("width", `${Math.abs(viewBox.minX) + viewBox.width}`);
+      rect.setAttribute("height", `${Math.abs(viewBox.minY) + viewBox.height}`);
+      rect.setAttribute("fill", this.features.backgroundColor);
+      
+      const svg = element("//svg:svg")
+      svg.insertBefore(rect, svg.childNodes[0]!);
+    }
+    
+    return xmlTidy(doc as unknown as Node);
   };
 }
 
@@ -163,6 +171,7 @@ export const HOLI_COLORS = [
 export type ICON =
   | "artists"
   | "albums"
+  | "radio"
   | "playlists"
   | "genres"
   | "random"
@@ -228,19 +237,24 @@ export type ICON =
   | "yoda" 
   | "heart"
   | "star" 
-  | "solidStar";
+  | "solidStar"
+  | "yy"
+  | "yyyy";
 
-const iconFrom = (name: string) =>
+const svgFrom = (name: string) =>
   new SvgIcon(
     fs
       .readFileSync(path.resolve(__dirname, "..", "web", "icons", name))
       .toString()
   );
 
+const iconFrom = (name: string) => svgFrom(name).with({ features: { viewPortIncreasePercent: 80 } });
+    
 export const ICONS: Record<ICON, SvgIcon> = {
   artists: iconFrom("navidrome-artists.svg"),
   albums: iconFrom("navidrome-all.svg"),
-  blank: iconFrom("blank.svg"),
+  radio: iconFrom("navidrome-radio.svg"),
+  blank: svgFrom("blank.svg"),
   playlists: iconFrom("navidrome-playlists.svg"),
   genres: iconFrom("Theatre-Mask-111172.svg"),
   random: iconFrom("navidrome-random.svg"),
@@ -305,7 +319,9 @@ export const ICONS: Record<ICON, SvgIcon> = {
   yoda: iconFrom("Yoda-68107.svg"),
   heart: iconFrom("Heart-85038.svg"),
   star: iconFrom("Star-16101.svg"),
-  solidStar: iconFrom("Star-43879.svg")
+  solidStar: iconFrom("Star-43879.svg"),
+  yy: svgFrom("yy.svg"),
+  yyyy: svgFrom("yyyy.svg"),
 };
 
 export const STAR_WARS = [ICONS.c3po, ICONS.chewy, ICONS.darth, ICONS.skywalker, ICONS.leia, ICONS.r2d2, ICONS.yoda];

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_library.ts

@@ -23,7 +23,8 @@ export type ArtistSummary = {
 
 export type SimilarArtist = ArtistSummary & { inLibrary: boolean };
 
-export type Artist = ArtistSummary & {
+// todo: maybe is should be artist.summary rather than an artist also being a summary?
+export type Artist = Pick<ArtistSummary, "id" | "name" | "image">  & {
   albums: AlbumSummary[];
   similarArtists: SimilarArtist[]
 };
@@ -34,36 +35,54 @@ export type AlbumSummary = {
   year: string | undefined;
   genre: Genre | undefined;
   coverArt: BUrn | undefined;
-
   artistName: string | undefined;
   artistId: string | undefined;
 };
 
-export type Album = AlbumSummary & {};
+export type Album = Pick<AlbumSummary, "id" | "name" | "year" | "genre" | "coverArt" | "artistName" | "artistId"> & { tracks: Track[] };
 
 export type Genre = {
   name: string;
   id: string;
 }
 
+export type Year = {
+  year: string;
+}
+
 export type Rating = {
   love: boolean;
   stars: number;
 }
 
-export type Track = {
+export type Encoding = {
+  player: string,
+  mimeType: string
+}
+
+export type TrackSummary = {
   id: string;
   name: string;
-  mimeType: string;
+  encoding: Encoding,
   duration: number;
   number: number | undefined;
   genre: Genre | undefined;
   coverArt: BUrn | undefined;
-  album: AlbumSummary;
   artist: ArtistSummary;
   rating: Rating;
+}
+
+export type Track = TrackSummary & {
+  album: AlbumSummary;
 };
 
+export type RadioStation = {
+  id: string,
+  name: string,
+  url: string,
+  homePage?: string
+}
+
 export type Paging = {
   _index: number;
   _count: number;
@@ -88,11 +107,13 @@ export const asResult = <T>([results, total]: [T[], number]) => ({
 
 export type ArtistQuery = Paging;
 
-export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
+export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'byYear' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
 
 export type AlbumQuery = Paging & {
   type: AlbumQueryType;
   genre?: string;
+  fromYear?: string;
+  toYear?: string;
 };
 
 export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
@@ -111,9 +132,22 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
   coverArt: it.coverArt
 });
 
+export const trackToTrackSummary = (it: Track): TrackSummary => ({
+  id: it.id,
+  name: it.name,
+  encoding: it.encoding,
+  duration: it.duration,
+  number: it.number,
+  genre: it.genre,
+  coverArt: it.coverArt,
+  artist: it.artist,
+  rating: it.rating
+});
+
 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 +165,8 @@ export type CoverArt = {
 
 export type PlaylistSummary = {
   id: string,
-  name: string
+  name: string,
+  coverArt?: BUrn | undefined
 }
 
 export type Playlist = PlaylistSummary & {
@@ -156,9 +191,9 @@ export interface MusicLibrary {
   artist(id: string): Promise<Artist>;
   albums(q: AlbumQuery): Promise<Result<AlbumSummary>>;
   album(id: string): Promise<Album>;
-  tracks(albumId: string): Promise<Track[]>;
   track(trackId: string): Promise<Track>;
   genres(): Promise<Genre[]>;
+  years(): Promise<Year[]>;
   stream({
     trackId,
     range,
@@ -179,6 +214,8 @@ export interface MusicLibrary {
   deletePlaylist(id: string): Promise<boolean>
   addToPlaylist(playlistId: string, trackId: string): Promise<boolean>
   removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
-  similarSongs(id: string): Promise<Track[]>;
-  topSongs(artistId: string): Promise<Track[]>;
+  similarSongs(id: string): Promise<TrackSummary[]>;
+  topSongs(artistId: string): Promise<TrackSummary[]>;
+  radioStation(id: string): Promise<RadioStation>
+  radioStations(): Promise<RadioStation[]>
 }

src/server.ts

@@ -22,7 +22,7 @@ import {
   ratingAsInt,
 } from "./smapi";
 import { LinkCodes, InMemoryLinkCodes } from "./link_codes";
-import { MusicService, AuthFailure, AuthSuccess } from "./music_service";
+import { MusicService, AuthFailure, AuthSuccess } from "./music_library";
 import bindSmapiSoapServiceToExpress from "./smapi";
 import { APITokens, InMemoryAPITokens } from "./api_tokens";
 import logger from "./logger";
@@ -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
-          )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
+        nextLove
+      )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
             <Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" />
           </Rating>
           <Rating Id="${-ratingAsInt(
-            nextStar
-          )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
+        nextStar
+      )}" 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) =>
-                `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-            ).join("")}
+      (size) =>
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+    ).join("")}
           </imageSizeMap>
         </Match>
       </PresentationMap>
@@ -338,9 +337,9 @@ function server(
           <browseIconSizeMap>
               <sizeEntry size="0" substitution="/size/legacy"/>
               ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
-                (size) =>
-                  `<sizeEntry size="${size}" substitution="/size/${size}"/>`
-              ).join("")}
+      (size) =>
+        `<sizeEntry size="${size}" substitution="/size/${size}"/>`
+    ).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(
-            `${trace} bnb<- stream response from music service for ${id}, status=${
-              stream.status
-            }, headers=(${JSON.stringify(stream.headers)})`
+          logger.debug(
+            `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
           );
 
           const sonosisfyContentType = (contentType: string) =>
@@ -435,10 +438,8 @@ function server(
             sendStream: boolean;
             nowPlaying: boolean;
           }) => {
-            logger.info(
-              `${trace} bnb-> ${
-                req.path
-              }, status=${status}, headers=${JSON.stringify(headers)}`
+            logger.debug(
+              `${trace} bnb-> ${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);
-              else res.send();
+              if (sendStream) stream.stream.pipe(filter).pipe(res)
+              else res.send()
             });
           };
 
@@ -497,38 +498,40 @@ function server(
     }
   });
 
-  app.get("/icon/:type/size/:size", (req, res) => {
-    const type = req.params["type"]!;
+  app.get("/icon/:type_text/size/:size", (req, res) => {
+    const match = (req.params["type_text"] || "")!.match("^([A-Za-z0-9]+)(?:\:([A-Za-z0-9]+))?$")
+    if (!match)
+      return res.status(400).send();
+    
+    const type = match[1]!
+    const text = match[2]
     const size = req.params["size"]!;
 
     if (!Object.keys(ICONS).includes(type)) {
       return res.status(404).send();
-    } else if (
-      size != "legacy" &&
-      !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)
-    ) {
+    } else if (size != "legacy" && !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)) {
       return res.status(400).send();
     } else {
       let icon = (ICONS as any)[type]! as Icon;
       const spec =
         size == "legacy"
           ? {
-              mimeType: "image/png",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
-                sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
-            }
+            mimeType: "image/png",
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
+              sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
+          }
           : {
-              mimeType: "image/svg+xml",
-              responseFormatter: (svg: string): Promise<Buffer | string> =>
-                Promise.resolve(svg),
-            };
+            mimeType: "image/svg+xml",
+            responseFormatter: (svg: string): Promise<Buffer | string> =>
+              Promise.resolve(svg),
+          };
 
       return Promise.resolve(
         icon
           .apply(
             features({
-              viewPortIncreasePercent: 80,
               ...serverOpts.iconColors,
+              text: text
             })
           )
           .apply(festivals(clock))
@@ -556,23 +559,11 @@ function server(
     });
   });
 
-  const GRAVITY_9 = [
-    "north",
-    "northeast",
-    "east",
-    "southeast",
-    "south",
-    "southwest",
-    "west",
-    "northwest",
-    "centre",
-  ];
-
-  app.get("/art/:burns/size/:size", (req, res) => {
+  app.get("/art/:burn/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 +574,24 @@ function server(
 
     return musicService
       .login(serviceToken)
-      .then((musicLibrary) =>
-        Promise.all(
-          urns.map((it) => {
-            if (it.system == "external") {
-              return serverOpts.externalImageResolver(it.resource);
-            } else {
-              return musicLibrary.coverArt(it, size);
-            }
-          })
-        )
-      )
-      .then((coverArts) => coverArts.filter((it) => it))
-      .then(shuffle)
-      .then((coverArts) => {
-        if (coverArts.length == 1) {
-          const coverArt = coverArts[0]!;
+      .then((musicLibrary) => {
+        if (urn.system == "external") {
+          return serverOpts.externalImageResolver(urn.resource);
+        } else {
+          return musicLibrary.coverArt(urn, size);
+        }
+      })
+      .then((coverArt) => {
+        if(coverArt) {
           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

@@ -10,23 +10,24 @@ import logger from "./logger";
 
 import { LinkCodes } from "./link_codes";
 import {
-  Album,
   AlbumQuery,
   AlbumSummary,
   ArtistSummary,
   Genre,
+  Year,
   MusicService,
   Playlist,
+  RadioStation,
   Rating,
   slice2,
   Track,
-} from "./music_service";
+} from "./music_library";
 import { APITokens } from "./api_tokens";
 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,
@@ -60,7 +61,7 @@ export const SONOS_RECOMMENDED_IMAGE_SIZES = [
 
 const WSDL_FILE = path.resolve(
   __dirname,
-  "Sonoswsdl-1.19.4-20190411.142401-3.wsdl"
+  "Sonoswsdl-1.19.6-20231024.wsdl"
 );
 
 export type Credentials = {
@@ -243,17 +244,25 @@ export type Container = {
 };
 
 const genre = (bonobUrl: URLBuilder, genre: Genre) => ({
-  itemType: "container",
+  itemType: "albumList",
   id: `genre:${genre.id}`,
   title: genre.name,
   albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(),
 });
 
+const yyyy = (bonobUrl: URLBuilder, year: Year) => ({
+  itemType: "albumList",
+  id: `year:${year.year}`,
+  title: year.year,
+  // todo: maybe year.year should be nullable?
+  albumArtURI: year.year !== "?" ? iconArtURI(bonobUrl, "yyyy", year.year).href() : iconArtURI(bonobUrl, "music").href(),
+});
+
 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 +271,9 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
   },
 });
 
-export const playlistAlbumArtURL = (
+export const coverArtURI = (
   bonobUrl: URLBuilder,
-  playlist: Playlist
-) => {
-  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 }
+  { coverArt }: { coverArt?: BUrn | undefined }
 ) =>
   pipe(
     coverArt,
@@ -297,26 +286,11 @@ export const defaultAlbumArtURI = (
     O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
   );
 
-export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
+export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON, text: string | undefined = undefined) =>
   bonobUrl.append({
-    pathname: `/icon/${icon}/size/legacy`,
+    pathname: `/icon/${text == undefined ? icon : `${icon}:${text}`}/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 +300,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,
@@ -334,10 +308,17 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
   // canAddToFavorites: true
 });
 
+export const internetRadioStation = (station: RadioStation) => ({
+  itemType: "stream",
+  id: `internetRadioStation:${station.id}`,
+  title: station.name,
+  mimeType: "audio/mpeg",
+});
+
 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 +326,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 +344,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) {
@@ -461,9 +442,7 @@ function bindSmapiSoapServiceToExpress(
             },
           },
         })),
-        TE.getOrElse(() =>
-          T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED)
-        )
+        TE.getOrElse(() => T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED))
       )();
     } else {
       throw authOrFail.toSmapiFault();
@@ -522,27 +501,38 @@ function bindSmapiSoapServiceToExpress(
           ) =>
             login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(({ credentials, type, typeId }) => ({
-                getMediaURIResult: bonobUrl
-                  .append({
-                    pathname: `/stream/${type}/${typeId}`,
-                  })
-                  .href(),
-                httpHeaders: [
-                  {
-                    httpHeader: {
-                      header: "bnbt",
-                      value: credentials.loginToken.token,
-                    },
-                  },
-                  {
-                    httpHeader: {
-                      header: "bnbk",
-                      value: credentials.loginToken.key,
-                    },
-                  },
-                ],
-              })),
+              .then(({ musicLibrary, credentials, type, typeId }) => {
+                switch (type) {
+                  case "internetRadioStation":
+                    return musicLibrary.radioStation(typeId).then((it) => ({
+                      getMediaURIResult: it.url,
+                    }));
+                  case "track":
+                    return {
+                      getMediaURIResult: bonobUrl
+                        .append({
+                          pathname: `/stream/${type}/${typeId}`,
+                        })
+                        .href(),
+                      httpHeaders: [
+                        {
+                          httpHeader: {
+                            header: "bnbt",
+                            value: credentials.loginToken.token,
+                          },
+                        },
+                        {
+                          httpHeader: {
+                            header: "bnbk",
+                            value: credentials.loginToken.key,
+                          },
+                        },
+                      ],
+                    };
+                  default:
+                    throw `Unsupported type:${type}`;
+                  }
+              }),
           getMediaMetadata: async (
             { id }: { id: string },
             _,
@@ -550,11 +540,20 @@ function bindSmapiSoapServiceToExpress(
           ) =>
             login(soapyHeaders?.credentials)
               .then(splitId(id))
-              .then(async ({ musicLibrary, apiKey, typeId }) =>
-                musicLibrary.track(typeId!).then((it) => ({
-                  getMediaMetadataResult: track(urlWithToken(apiKey), it),
-                }))
-              ),
+              .then(async ({ musicLibrary, apiKey, type, typeId }) => {
+                switch (type) {
+                  case "internetRadioStation":
+                    return musicLibrary.radioStation(typeId).then((it) => ({
+                      getMediaMetadataResult: internetRadioStation(it),
+                    }));
+                  case "track":
+                    return musicLibrary.track(typeId!).then((it) => ({
+                      getMediaMetadataResult: track(urlWithToken(apiKey), it),
+                    }));
+                  default:
+                    throw `Unsupported type:${type}`;
+                }
+              }),
           search: async (
             { id, term }: { id: string; term: string },
             _,
@@ -612,7 +611,7 @@ function bindSmapiSoapServiceToExpress(
                 switch (type) {
                   case "artist":
                     return musicLibrary.artist(typeId).then((artist) => {
-                      const [page, total] = slice2<Album>(paging)(
+                      const [page, total] = slice2<AlbumSummary>(paging)(
                         artist.albums
                       );
                       return {
@@ -749,6 +748,12 @@ function bindSmapiSoapServiceToExpress(
                           albumArtURI: iconArtURI(bonobUrl, "genres").href(),
                           itemType: "container",
                         },
+                        {
+                          id: "years",
+                          title: lang("years"),
+                          albumArtURI: iconArtURI(bonobUrl, "music").href(),
+                          itemType: "container",
+                        },
                         {
                           id: "recentlyAdded",
                           title: lang("recentlyAdded"),
@@ -776,6 +781,12 @@ function bindSmapiSoapServiceToExpress(
                           ).href(),
                           itemType: "albumList",
                         },
+                        {
+                          id: "internetRadio",
+                          title: lang("internetRadio"),
+                          albumArtURI: iconArtURI(bonobUrl, "radio").href(),
+                          itemType: "stream",
+                        },
                       ],
                     });
                   case "search":
@@ -820,6 +831,13 @@ function bindSmapiSoapServiceToExpress(
                       genre: typeId,
                       ...paging,
                     });
+                  case "year":
+                    return albums({
+                      type: "byYear",
+                      fromYear: typeId,
+                      toYear: typeId,
+                      ...paging,
+                    });
                   case "randomAlbums":
                     return albums({
                       type: "random",
@@ -850,6 +868,32 @@ function bindSmapiSoapServiceToExpress(
                       type: "mostPlayed",
                       ...paging,
                     });
+                  case "internetRadio":
+                    return musicLibrary
+                      .radioStations()
+                      .then(slice2(paging))
+                      .then(([page, total]) =>
+                        getMetadataResult({
+                          mediaMetadata: page.map((it) =>
+                            internetRadioStation(it)
+                          ),
+                          index: paging._index,
+                          total,
+                        })
+                      );
+                  case "years":
+                    return musicLibrary
+                      .years()
+                      .then(slice2(paging))
+                      .then(([page, total]) =>
+                        getMetadataResult({
+                          mediaCollection: page.map((it) =>
+                            yyyy(bonobUrl, it)
+                          ),
+                          index: paging._index,
+                          total,
+                        })
+                      );
                   case "genres":
                     return musicLibrary
                       .genres()
@@ -868,9 +912,16 @@ function bindSmapiSoapServiceToExpress(
                       .playlists()
                       .then((it) =>
                         Promise.all(
-                          it.map((playlist) =>
-                            musicLibrary.playlist(playlist.id)
-                          )
+                          it.map((playlist) => {
+                            // 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: [],
+                            };
+                          })
                         )
                       )
                       .then(slice2(paging))
@@ -902,15 +953,15 @@ function bindSmapiSoapServiceToExpress(
                       .artist(typeId!)
                       .then((artist) => artist.albums)
                       .then(slice2(paging))
-                      .then(([page, total]) => {
-                        return getMetadataResult({
+                      .then(([page, total]) =>
+                        getMetadataResult({
                           mediaCollection: page.map((it) =>
                             album(urlWithToken(apiKey), it)
                           ),
                           index: paging._index,
                           total,
-                        });
-                      });
+                        })
+                      );
                   case "relatedArtists":
                     return musicLibrary
                       .artist(typeId!)
@@ -930,7 +981,8 @@ function bindSmapiSoapServiceToExpress(
                       });
                   case "album":
                     return musicLibrary
-                      .tracks(typeId!)
+                      .album(typeId!)
+                      .then(it => it.tracks)
                       .then(slice2(paging))
                       .then(([page, total]) => {
                         return getMetadataResult({
@@ -1066,8 +1118,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,25 +2,21 @@ 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,
   Album,
-  Result,
-  slice2,
   AlbumQuery,
-  ArtistQuery,
-  MusicLibrary,
   AlbumSummary,
   Genre,
   Track,
   CoverArt,
-  Rating,
   AlbumQueryType,
-  Artist,
-  AuthFailure,
-} from "./music_service";
+  Encoding,
+  albumToAlbumSummary,
+  TrackSummary,
+  AuthFailure
+} from "./music_library";
 import sharp from "sharp";
 import _ from "underscore";
 import fse from "fs-extra";
@@ -29,9 +25,9 @@ import path from "path";
 import axios, { AxiosRequestConfig } from "axios";
 import randomstring from "randomstring";
 import { b64Encode, b64Decode } from "./b64";
-import logger from "./logger";
-import { assertSystem, BUrn } from "./burn";
-import { artist } from "./smapi";
+import { BUrn } from "./burn";
+import { album, artist } from "./smapi";
+import { URLBuilder } from "./url_builder";
 
 export const BROWSER_HEADERS = {
   accept:
@@ -105,7 +101,7 @@ type genre = {
   value: string;
 };
 
-type GetGenresResponse = SubsonicResponse & {
+export type GetGenresResponse = SubsonicResponse & {
   genres: {
     genre: genre[];
   };
@@ -161,48 +157,74 @@ 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;
+  // todo: this field shouldnt be on song?
   starred: string | undefined;
 };
 
-type GetAlbumResponse = {
+export type GetAlbumResponse = {
   album: album & {
     song: song[];
   };
 };
 
-type playlist = {
-  id: string;
-  name: string;
-};
-
-type GetPlaylistResponse = {
+export type GetPlaylistResponse = {
+  // todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
   playlist: {
     id: string;
     name: string;
     entry: song[];
+
+    // todo: this is an ND specific field?
+    coverArt: string | undefined;
   };
 };
 
-type GetPlaylistsResponse = {
-  playlists: { playlist: playlist[] };
+export type GetPlaylistsResponse = {
+  playlists: { 
+    playlist: {
+      id: string;
+      name: string;
+      //owner: string,
+      //public: boolean,
+      //created: string,
+      //changed: string,
+      //songCount: int,
+      //duration: int,
+
+      // todo: this is an ND specific field.
+      coverArt: string | undefined;
+    }[] 
+  };
 };
 
-type GetSimilarSongsResponse = {
+export type GetSimilarSongsResponse = {
   similarSongs2: { song: song[] };
 };
 
-type GetTopSongsResponse = {
+export type GetTopSongsResponse = {
   topSongs: { song: song[] };
 };
 
-type GetSongResponse = {
+export type GetInternetRadioStationsResponse = {
+  internetRadioStations: {
+    internetRadioStation: {
+      id: string;
+      name: string;
+      streamUrl: string;
+      homePageUrl?: string;
+    }[];
+  };
+};
+
+export type GetSongResponse = {
   song: song;
 };
 
-type GetStarredResponse = {
+export type GetStarredResponse = {
   starred2: {
     song: song[];
     album: album[];
@@ -216,7 +238,7 @@ export type PingResponse = {
   serverVersion: string;
 };
 
-type Search3Response = SubsonicResponse & {
+export type Search3Response = SubsonicResponse & {
   searchResult3: {
     artist: artist[];
     album: album[];
@@ -230,12 +252,12 @@ export function isError(
   return (subsonicResponse as SubsonicError).error !== undefined;
 }
 
-type IdName = {
+export type IdName = {
   id: string;
   name: string;
 };
 
-const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
+export const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
   pipe(
     coverArt,
     O.fromNullable,
@@ -269,15 +291,25 @@ export const artistImageURN = (
   }
 };
 
-export const asTrack = (album: Album, song: song): Track => ({
+export const asTrackSummary = (
+  song: song,
+  customPlayers: CustomPlayers
+): TrackSummary => ({
   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),
   coverArt: coverArtURN(song.coverArt),
-  album,
   artist: {
     id: song.artistId,
     name: song.artist ? song.artist : "?",
@@ -294,7 +326,16 @@ export const asTrack = (album: Album, song: song): Track => ({
   },
 });
 
-const asAlbum = (album: album): Album => ({
+export const asTrack = (
+  album: AlbumSummary,
+  song: song,
+  customPlayers: CustomPlayers
+): Track => ({
+  ...asTrackSummary(song, customPlayers),
+  album: album,
+});
+
+export const asAlbumSummary = (album: album): AlbumSummary => ({
   id: album.id,
   name: album.name,
   year: album.year,
@@ -309,7 +350,9 @@ export const asGenre = (genreName: string) => ({
   name: genreName,
 });
 
-const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
+export const maybeAsGenre = (
+  genreName: string | undefined
+): Genre | undefined =>
   pipe(
     genreName,
     O.fromNullable,
@@ -317,19 +360,58 @@ const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
     O.getOrElseW(() => undefined)
   );
 
-export type StreamClientApplication = (track: Track) => string;
+export const asYear = (year: string) => ({
+  year: year,
+});
 
-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 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;
+  },
+};
+
+export const DEFAULT_CLIENT_APPLICATION = "bonob";
+export const USER_AGENT = "bonob";
+
 export const asURLSearchParams = (q: any) => {
   const urlSearchParams = new URLSearchParams();
   Object.keys(q).forEach((k) => {
@@ -343,7 +425,7 @@ export const asURLSearchParams = (q: any) => {
 export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
 
 export const cachingImageFetcher =
-  (cacheDir: string, delegate: ImageFetcher) =>
+  (cacheDir: string, delegate: ImageFetcher, makeSharp = sharp) =>
   async (url: string): Promise<CoverArt | undefined> => {
     const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
     return fse
@@ -352,7 +434,7 @@ export const cachingImageFetcher =
       .catch(() =>
         delegate(url).then((image) => {
           if (image) {
-            return sharp(image.data)
+            return makeSharp(image.data)
               .png()
               .toBuffer()
               .then((png) => {
@@ -383,6 +465,7 @@ const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
   alphabeticalByArtist: "alphabeticalByArtist",
   alphabeticalByName: "alphabeticalByName",
   byGenre: "byGenre",
+  byYear: "byYear",
   random: "random",
   recentlyPlayed: "recent",
   mostPlayed: "frequent",
@@ -401,39 +484,33 @@ type SubsonicCredentials = Credentials & {
 
 export const asToken = (credentials: SubsonicCredentials) =>
   b64Encode(JSON.stringify(credentials));
+
 export const parseToken = (token: string): SubsonicCredentials =>
   JSON.parse(b64Decode(token));
 
-interface SubsonicMusicLibrary extends MusicLibrary {
-  flavour(): string;
-  bearerToken(
-    credentials: Credentials
-  ): TE.TaskEither<Error, string | undefined>;
-}
-
-export class Subsonic implements MusicService {
-  url: string;
-  streamClientApplication: StreamClientApplication;
+export class Subsonic {
+  url: URLBuilder;
+  customPlayers: CustomPlayers;
   externalImageFetcher: ImageFetcher;
 
   constructor(
-    url: string,
-    streamClientApplication: StreamClientApplication = DEFAULT,
+    url: URLBuilder,
+    customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS,
     externalImageFetcher: ImageFetcher = axiosImageFetcher
   ) {
     this.url = url;
-    this.streamClientApplication = streamClientApplication;
+    this.customPlayers = customPlayers;
     this.externalImageFetcher = externalImageFetcher;
   }
 
-  get = async (
+  private get = async (
     { username, password }: Credentials,
     path: string,
     q: {} = {},
     config: AxiosRequestConfig | undefined = {}
   ) =>
     axios
-      .get(`${this.url}${path}`, {
+      .get(this.url.append({ pathname: path }).href(), {
         params: asURLSearchParams({
           u: username,
           v: "1.16.1",
@@ -455,7 +532,9 @@ export class Subsonic implements MusicService {
         } else return response;
       });
 
-  getJSON = async <T>(
+  // todo: should I put a catch in here and force a subsonic fail status?
+  // or there is a catch above, that then throws, perhaps can go in there?
+  private getJSON = async <T>(
     { username, password }: Credentials,
     path: string,
     q: {} = {}
@@ -468,40 +547,16 @@ export class Subsonic implements MusicService {
         else return json as unknown as T;
       });
 
-  generateToken = (credentials: Credentials) =>
-    pipe(
-      TE.tryCatch(
-        () =>
-          this.getJSON<PingResponse>(
-            _.pick(credentials, "username", "password"),
-            "/rest/ping.view"
-          ),
-        (e) => new AuthFailure(e as string)
-      ),
-      TE.chain(({ type }) =>
-        pipe(
-          TE.tryCatch(
-            () => this.libraryFor({ ...credentials, type }),
-            () => new AuthFailure("Failed to get library")
-          ),
-          TE.map((library) => ({ type, library }))
-        )
-      ),
-      TE.chain(({ library, type }) =>
-        pipe(
-          library.bearerToken(credentials),
-          TE.map((bearer) => ({ bearer, type }))
-        )
-      ),
-      TE.map(({ bearer, type }) => ({
-        serviceToken: asToken({ ...credentials, bearer, type }),
-        userId: credentials.username,
-        nickname: credentials.username,
-      }))
-    );
-
-  refreshToken = (serviceToken: string) =>
-    this.generateToken(parseToken(serviceToken));
+  ping = (credentials: Credentials): TE.TaskEither<AuthFailure, { authenticated: Boolean, type: string}> => 
+    TE.tryCatch(
+      () => this.getJSON<PingResponse>(credentials, "/rest/ping.view")
+      .then(it => ({
+        authenticated: it.status == "ok",
+        type: it.type
+      })),
+      (e) => new AuthFailure(e as string)
+    )
+    
 
   getArtists = (
     credentials: Credentials
@@ -520,6 +575,7 @@ export class Subsonic implements MusicService {
         }))
       );
 
+      // todo: should be getArtistInfo2?
   getArtistInfo = (
     credentials: Credentials,
     id: string
@@ -543,30 +599,43 @@ export class Subsonic implements MusicService {
           m: it.mediumImageUrl,
           l: it.largeImageUrl,
         },
+        //todo: this does seem to be in OpenSubsonic?? it is also singular
         similarArtist: (it.similarArtist || []).map((artist) => ({
           id: `${artist.id}`,
           name: artist.name,
+          // todo: whats this inLibrary used for? it probably should be filtered on??
           inLibrary: artistIsInLibrary(artist.id),
           image: artistImageURN({
             artistId: artist.id,
             artistImageURL: artist.artistImageUrl,
           }),
         })),
-      }));
+        })
+      );
 
-  getAlbum = (credentials: Credentials, id: string): Promise<Album> =>
+  getAlbum = (credentials: Credentials, id: string): Promise<Album>  =>
     this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id })
       .then((it) => it.album)
-      .then((album) => ({
-        id: album.id,
-        name: album.name,
-        year: album.year,
-        genre: maybeAsGenre(album.genre),
-        artistId: album.artistId,
-        artistName: album.artist,
-        coverArt: coverArtURN(album.coverArt),
-      }));
-
+      .then((album) => {
+        const x: AlbumSummary = {
+          id: album.id,
+          name: album.name,
+          year: album.year,
+          genre: maybeAsGenre(album.genre),
+          artistId: album.artistId,
+          artistName: album.artist,
+          coverArt: coverArtURN(album.coverArt)
+        }
+        return { summary: x, songs: album.song }
+      }).then(({ summary, songs }) => {
+        const x: AlbumSummary = summary
+        const y: Track[] = songs.map((it) => asTrack(summary, it, this.customPlayers))
+        return {
+          ...x,
+          tracks: y
+        };
+      });
+   
   getArtist = (
     credentials: Credentials,
     id: string
@@ -584,26 +653,6 @@ export class Subsonic implements MusicService {
         albums: this.toAlbumSummary(it.album || []),
       }));
 
-  getArtistWithInfo = (credentials: Credentials, id: string) =>
-    Promise.all([
-      this.getArtist(credentials, id),
-      this.getArtistInfo(credentials, id),
-    ]).then(([artist, artistInfo]) => ({
-      id: artist.id,
-      name: artist.name,
-      image: artistImageURN({
-        artistId: artist.id,
-        artistImageURL: [
-          artist.artistImageUrl,
-          artistInfo.images.l,
-          artistInfo.images.m,
-          artistInfo.images.s,
-        ].find(isValidImage),
-      }),
-      albums: artist.albums,
-      similarArtists: artistInfo.similarArtist,
-    }));
-
   getCoverArt = (credentials: Credentials, id: string, size?: number) =>
     this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, {
       headers: { "User-Agent": "bonob" },
@@ -617,7 +666,7 @@ export class Subsonic implements MusicService {
       .then((it) => it.song)
       .then((song) =>
         this.getAlbum(credentials, song.albumId!).then((album) =>
-          asTrack(album, song)
+          asTrack(albumToAlbumSummary(album), song, this.customPlayers)
         )
       );
 
@@ -657,6 +706,8 @@ export class Subsonic implements MusicService {
       this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
         type: AlbumQueryTypeToSubsonicType[q.type],
         ...(q.genre ? { genre: b64Decode(q.genre) } : {}),
+        ...(q.fromYear ? { fromYear: q.fromYear } : {}),
+        ...(q.toYear ? { toYear: q.toYear } : {}),
         size: 500,
         offset: q._index,
       })
@@ -667,312 +718,176 @@ export class Subsonic implements MusicService {
       total: albums.length == 500 ? total : q._index + albums.length,
     }));
 
-  // getStarred2 = (credentials: Credentials): Promise<{ albums: Album[] }> =>
-  //   this.getJSON<GetStarredResponse>(credentials, "/rest/getStarred2")
-  //     .then((it) => it.starred2)
-  //     .then((it) => ({
-  //       albums: it.album.map(asAlbum),
-  //     }));
+  getGenres = (credentials: Credentials) =>
+    this.getJSON<GetGenresResponse>(credentials, "/rest/getGenres").then((it) =>
+      pipe(
+        it.genres.genre || [],
+        A.filter((it) => it.albumCount > 0),
+        A.map((it) => it.value),
+        A.sort(ordString),
+        A.map(maybeAsGenre),
+        A.filter((it) => it != undefined)
+      )
+    );
 
-  login = async (token: string) => this.libraryFor(parseToken(token));
+  private st4r = (credentials: Credentials, action: string,  { id } : { id: string }) => 
+    this.getJSON<SubsonicResponse>(credentials, `/rest/${action}`, { id }).then(it => 
+      it.status == "ok"
+    );
 
-  private libraryFor = (
-    credentials: Credentials & { type: string }
-  ): Promise<SubsonicMusicLibrary> => {
-    const subsonic = this;
+  star = (credentials: Credentials, ids : { id: string }) => 
+    this.st4r(credentials, "star", ids)
 
-    const genericSubsonic: SubsonicMusicLibrary = {
-      flavour: () => "subsonic",
-      bearerToken: (_: Credentials) => TE.right(undefined),
-      artists: (q: ArtistQuery): Promise<Result<ArtistSummary>> =>
-        subsonic
-          .getArtists(credentials)
-          .then(slice2(q))
-          .then(([page, total]) => ({
-            total,
-            results: page.map((it) => ({
-              id: it.id,
-              name: it.name,
-              image: it.image,
-            })),
+  unstar = (credentials: Credentials, ids : { id: string }) => 
+    this.st4r(credentials, "unstar", ids)
+
+  setRating = (credentials: Credentials, id: string, rating: number) => 
+    this.getJSON<SubsonicResponse>(credentials, `/rest/setRating`, {
+      id,
+      rating,
+    })
+    .then(it => it.status == "ok");
+
+  scrobble = (credentials: Credentials, id: string, submission: boolean) =>
+    this.getJSON<SubsonicResponse>(credentials, `/rest/scrobble`, {
+        id,
+        submission,
+      })
+      .then(it => it.status == "ok")
+
+  stream = (credentials: Credentials, id: string, c: string, range: string | undefined) =>
+    this.get(
+      credentials,
+      `/rest/stream`,
+      {
+        id,
+        c,
+      },
+      {
+        headers: pipe(
+          range,
+          O.fromNullable,
+          O.map((range) => ({
+            "User-Agent": USER_AGENT,
+            Range: range,
           })),
-      artist: async (id: string): Promise<Artist> =>
-        subsonic.getArtistWithInfo(credentials, id),
-      albums: async (q: AlbumQuery): Promise<Result<AlbumSummary>> =>
-        subsonic.getAlbumList2(credentials, q),
-      album: (id: string): Promise<Album> => subsonic.getAlbum(credentials, id),
-      genres: () =>
-        subsonic
-          .getJSON<GetGenresResponse>(credentials, "/rest/getGenres")
-          .then((it) =>
-            pipe(
-              it.genres.genre || [],
-              A.filter((it) => it.albumCount > 0),
-              A.map((it) => it.value),
-              A.sort(ordString),
-              A.map((it) => ({ id: b64Encode(it), name: it }))
-            )
-          ),
-      tracks: (albumId: string) =>
-        subsonic
-          .getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", {
-            id: albumId,
-          })
-          .then((it) => it.album)
-          .then((album) =>
-            (album.song || []).map((song) => asTrack(asAlbum(album), song))
-          ),
-      track: (trackId: string) => subsonic.getTrack(credentials, trackId),
-      rate: (trackId: string, rating: Rating) =>
-        Promise.resolve(true)
-          .then(() => {
-            if (rating.stars >= 0 && rating.stars <= 5) {
-              return subsonic.getTrack(credentials, trackId);
-            } else {
-              throw `Invalid rating.stars value of ${rating.stars}`;
-            }
-          })
-          .then((track) => {
-            const thingsToUpdate = [];
-            if (track.rating.love != rating.love) {
-              thingsToUpdate.push(
-                subsonic.getJSON(
-                  credentials,
-                  `/rest/${rating.love ? "star" : "unstar"}`,
-                  {
-                    id: trackId,
-                  }
-                )
-              );
-            }
-            if (track.rating.stars != rating.stars) {
-              thingsToUpdate.push(
-                subsonic.getJSON(credentials, `/rest/setRating`, {
-                  id: trackId,
-                  rating: rating.stars,
-                })
-              );
-            }
-            return Promise.all(thingsToUpdate);
-          })
-          .then(() => true)
-          .catch(() => false),
-      stream: async ({
-        trackId,
-        range,
-      }: {
-        trackId: string;
-        range: string | undefined;
-      }) =>
-        subsonic.getTrack(credentials, trackId).then((track) =>
-          subsonic
-            .get(
-              credentials,
-              `/rest/stream`,
-              {
-                id: trackId,
-                c: this.streamClientApplication(track),
-              },
-              {
-                headers: pipe(
-                  range,
-                  O.fromNullable,
-                  O.map((range) => ({
-                    "User-Agent": USER_AGENT,
-                    Range: range,
-                  })),
-                  O.getOrElse(() => ({
-                    "User-Agent": USER_AGENT,
-                  }))
-                ),
-                responseType: "stream",
-              }
-            )
-            .then((res) => ({
-              status: res.status,
-              headers: {
-                "content-type": res.headers["content-type"],
-                "content-length": res.headers["content-length"],
-                "content-range": res.headers["content-range"],
-                "accept-ranges": res.headers["accept-ranges"],
-              },
-              stream: res.data,
-            }))
-        ),
-      coverArt: async (coverArtURN: BUrn, size?: number) =>
-        Promise.resolve(coverArtURN)
-          .then((it) => assertSystem(it, "subsonic"))
-          .then((it) => it.resource.split(":")[1]!)
-          .then((it) => subsonic.getCoverArt(credentials, it, size))
-          .then((res) => ({
-            contentType: res.headers["content-type"],
-            data: Buffer.from(res.data, "binary"),
+          O.getOrElse(() => ({
+            "User-Agent": USER_AGENT,
           }))
-          .catch((e) => {
-            logger.error(
-              `Failed getting coverArt for urn:'${coverArtURN}': ${e}`
-            );
-            return undefined;
-          }),
-      scrobble: async (id: string) =>
-        subsonic
-          .getJSON(credentials, `/rest/scrobble`, {
-            id,
-            submission: true,
-          })
-          .then((_) => true)
-          .catch(() => false),
-      nowPlaying: async (id: string) =>
-        subsonic
-          .getJSON(credentials, `/rest/scrobble`, {
-            id,
-            submission: false,
-          })
-          .then((_) => true)
-          .catch(() => false),
-      searchArtists: async (query: string) =>
-        subsonic
-          .search3(credentials, { query, artistCount: 20 })
-          .then(({ artists }) =>
-            artists.map((artist) => ({
-              id: artist.id,
-              name: artist.name,
-              image: artistImageURN({
-                artistId: artist.id,
-                artistImageURL: artist.artistImageUrl,
-              }),
-            }))
-          ),
-      searchAlbums: async (query: string) =>
-        subsonic
-          .search3(credentials, { query, albumCount: 20 })
-          .then(({ albums }) => subsonic.toAlbumSummary(albums)),
-      searchTracks: async (query: string) =>
-        subsonic
-          .search3(credentials, { query, songCount: 20 })
-          .then(({ songs }) =>
-            Promise.all(
-              songs.map((it) => subsonic.getTrack(credentials, it.id))
-            )
-          ),
-      playlists: async () =>
-        subsonic
-          .getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
-          .then((it) => it.playlists.playlist || [])
-          .then((playlists) =>
-            playlists.map((it) => ({ id: it.id, name: it.name }))
-          ),
-      playlist: async (id: string) =>
-        subsonic
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
-            id,
-          })
-          .then((it) => it.playlist)
-          .then((playlist) => {
-            let trackNumber = 1;
-            return {
-              id: playlist.id,
-              name: playlist.name,
-              entries: (playlist.entry || []).map((entry) => ({
-                ...asTrack(
-                  {
-                    id: entry.albumId!,
-                    name: entry.album!,
-                    year: entry.year,
-                    genre: maybeAsGenre(entry.genre),
-                    artistName: entry.artist,
-                    artistId: entry.artistId,
-                    coverArt: coverArtURN(entry.coverArt),
-                  },
-                  entry
-                ),
-                number: trackNumber++,
-              })),
-            };
-          }),
-      createPlaylist: async (name: string) =>
-        subsonic
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
-            name,
-          })
-          .then((it) => it.playlist)
-          .then((it) => ({ id: it.id, name: it.name })),
-      deletePlaylist: async (id: string) =>
-        subsonic
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
-            id,
-          })
-          .then((_) => true),
-      addToPlaylist: async (playlistId: string, trackId: string) =>
-        subsonic
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
-            playlistId,
-            songIdToAdd: trackId,
-          })
-          .then((_) => true),
-      removeFromPlaylist: async (playlistId: string, indicies: number[]) =>
-        subsonic
-          .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
-            playlistId,
-            songIndexToRemove: indicies,
-          })
-          .then((_) => true),
-      similarSongs: async (id: string) =>
-        subsonic
-          .getJSON<GetSimilarSongsResponse>(
-            credentials,
-            "/rest/getSimilarSongs2",
-            { id, count: 50 }
-          )
-          .then((it) => it.similarSongs2.song || [])
-          .then((songs) =>
-            Promise.all(
-              songs.map((song) =>
-                subsonic
-                  .getAlbum(credentials, song.albumId!)
-                  .then((album) => asTrack(album, song))
-              )
-            )
-          ),
-      topSongs: async (artistId: string) =>
-        subsonic.getArtist(credentials, artistId).then(({ name }) =>
-          subsonic
-            .getJSON<GetTopSongsResponse>(credentials, "/rest/getTopSongs", {
-              artist: name,
-              count: 50,
-            })
-            .then((it) => it.topSongs.song || [])
-            .then((songs) =>
-              Promise.all(
-                songs.map((song) =>
-                  subsonic
-                    .getAlbum(credentials, song.albumId!)
-                    .then((album) => asTrack(album, song))
-                )
-              )
-            )
         ),
-    };
+        responseType: "stream",
+      }
+    )
+    .then((stream) => ({
+      status: stream.status,
+      headers: {
+        "content-type": stream.headers["content-type"],
+        "content-length": stream.headers["content-length"],
+        "content-range": stream.headers["content-range"],
+        "accept-ranges": stream.headers["accept-ranges"],
+      },
+      stream: stream.data,
+    }));
 
-    if (credentials.type == "navidrome") {
-      return Promise.resolve({
-        ...genericSubsonic,
-        flavour: () => "navidrome",
-        bearerToken: (credentials: Credentials) =>
-          pipe(
-            TE.tryCatch(
-              () =>
-                axios.post(
-                  `${this.url}/auth/login`,
-                  _.pick(credentials, "username", "password")
-                ),
-              () => new AuthFailure("Failed to get bearerToken")
-            ),
-            TE.map((it) => it.data.token as string | undefined)
+  playlists = (credentials: Credentials) =>
+    this.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
+    .then(({ playlists }) => (playlists.playlist || []).map( it => ({
+        id: it.id,
+        name: it.name,
+        coverArt: coverArtURN(it.coverArt),
+      }))
+    );
+
+  playlist = (credentials: Credentials, id: string) =>
+    this.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
+      id,
+    })
+    .then(({ playlist }) => {
+      let trackNumber = 1;
+      return {
+        id: playlist.id,
+        name: playlist.name,
+        coverArt: coverArtURN(playlist.coverArt),
+        entries: (playlist.entry || []).map((entry) => ({
+          ...asTrack(
+            {
+              id: entry.albumId!,
+              name: entry.album!,
+              year: entry.year,
+              genre: maybeAsGenre(entry.genre),
+              artistName: entry.artist,
+              artistId: entry.artistId,
+              coverArt: coverArtURN(entry.coverArt),
+            },
+            entry,
+            this.customPlayers
           ),
-      });
-    } else {
-      return Promise.resolve(genericSubsonic);
-    }
-  };
-}
+          number: trackNumber++,
+        })),
+      };
+    });
+
+    createPlayList = (credentials: Credentials, name: string) =>
+      this.getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
+        name,
+      })
+      .then(({ playlist }) => ({
+        id: playlist.id,
+        name: playlist.name,
+        coverArt: coverArtURN(playlist.coverArt),
+      }));
+
+    deletePlayList = (credentials: Credentials, id: string) => 
+      this.getJSON<SubsonicResponse>(credentials, "/rest/deletePlaylist", {
+        id,
+      })
+      .then(it => it.status == "ok");
+
+    updatePlaylist = (
+      credentials: Credentials, 
+      playlistId: string, 
+      changes : Partial<{ songIdToAdd: string | undefined, songIndexToRemove: number[] | undefined }> = {}
+    ) => 
+      this.getJSON<SubsonicResponse>(credentials, "/rest/updatePlaylist", {
+        playlistId,
+        ...changes
+      })
+      .then(it => it.status == "ok");
+
+    getSimilarSongs2 = (credentials: Credentials, id: string) =>
+      this.getJSON<GetSimilarSongsResponse>(
+        credentials,
+        "/rest/getSimilarSongs2",
+        //todo: remove this hard coded 50?
+        { id, count: 50 }
+      )
+      .then((it) => 
+        (it.similarSongs2.song || []).map(it => asTrackSummary(it, this.customPlayers))
+      );
+
+    getTopSongs = (credentials: Credentials, artist: string) =>
+      this.getJSON<GetTopSongsResponse>(
+        credentials,
+        "/rest/getTopSongs",
+        //todo: remove this hard coded 50?
+        { artist, count: 50 }
+      )
+      .then((it) => 
+        (it.topSongs.song || []).map(it => asTrackSummary(it, this.customPlayers))
+      );
+
+  getInternetRadioStations = (credentials: Credentials) =>
+    this.getJSON<GetInternetRadioStationsResponse>(
+      credentials,
+      "/rest/getInternetRadioStations"
+    )
+    .then((it) => it.internetRadioStations.internetRadioStation || [])
+    .then((stations) =>
+      stations.map((it) => ({
+        id: it.id,
+        name: it.name,
+        url: it.streamUrl,
+        homePage: it.homePageUrl,
+      }))
+    ); 
+};

src/subsonic_music_library.ts

@@ -0,0 +1,320 @@
+import { taskEither as TE } from "fp-ts";
+import { pipe } from "fp-ts/lib/function";
+import {
+  Credentials,
+  MusicService,
+  ArtistSummary,
+  Result,
+  slice2,
+  AlbumQuery,
+  ArtistQuery,
+  MusicLibrary,
+  Album,
+  AlbumSummary,
+  Rating,
+  Artist,
+  AuthFailure,
+  AuthSuccess,
+} from "./music_library";
+import {
+  Subsonic,
+  CustomPlayers,
+  NO_CUSTOM_PLAYERS,
+  asToken,
+  parseToken,
+  artistImageURN,
+  asYear,
+  isValidImage
+} from "./subsonic";
+import _ from "underscore";
+
+import axios from "axios";
+import logger from "./logger";
+import { assertSystem, BUrn } from "./burn";
+
+export class SubsonicMusicService implements MusicService {
+  subsonic: Subsonic;
+  customPlayers: CustomPlayers;
+
+  constructor(
+    subsonic: Subsonic,
+    customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS
+  ) {
+    this.subsonic = subsonic;
+    this.customPlayers = customPlayers;
+  }
+
+  generateToken = (
+    credentials: Credentials
+  ): TE.TaskEither<AuthFailure, AuthSuccess> => 
+    pipe(
+      this.subsonic.ping(credentials),
+      TE.flatMap(({ type }) => TE.tryCatch(
+        () => this.libraryFor({ ...credentials, type }).then(library => ({ type, library })),
+        () => new AuthFailure("Failed to get library")
+      )),
+      TE.flatMap(({ library, type }) => pipe(
+        library.bearerToken(credentials),
+        TE.map(bearer => ({ bearer, type }))
+      )),
+      TE.map(({ bearer, type}) => ({
+        serviceToken: asToken({ ...credentials, bearer, type }),
+        userId: credentials.username,
+        nickname: credentials.username,
+      }))
+    );
+
+  refreshToken = (serviceToken: string) =>
+    this.generateToken(parseToken(serviceToken));
+
+  login = async (token: string) => this.libraryFor(parseToken(token));
+
+  private libraryFor = (
+    credentials: Credentials & { type: string }
+  ): Promise<SubsonicMusicLibrary> => {
+    const genericSubsonic = new SubsonicMusicLibrary(
+      this.subsonic,
+      credentials,
+      this.customPlayers
+    );
+    // return Promise.resolve(genericSubsonic);
+
+    if (credentials.type == "navidrome") {
+      // todo: there does not seem to be a test for this??
+      const nd: SubsonicMusicLibrary = {
+        ...genericSubsonic,
+        flavour: () => "navidrome",
+        bearerToken: (credentials: Credentials) =>
+          pipe(
+            TE.tryCatch(
+              () =>
+                axios.post(
+                  this.subsonic.url.append({ pathname: "/auth/login" }).href(),
+                  _.pick(credentials, "username", "password")
+                ),
+              () => new AuthFailure("Failed to get bearerToken")
+            ),
+            TE.map((it) => it.data.token as string | undefined)
+          ),
+      };
+      return Promise.resolve(nd);
+    } else {
+      return Promise.resolve(genericSubsonic);
+    }
+  };
+}
+
+export class SubsonicMusicLibrary implements MusicLibrary {
+  subsonic: Subsonic;
+  credentials: Credentials;
+  customPlayers: CustomPlayers;
+
+  constructor(
+    subsonic: Subsonic,
+    credentials: Credentials,
+    customPlayers: CustomPlayers
+  ) {
+    this.subsonic = subsonic;
+    this.credentials = credentials;
+    this.customPlayers = customPlayers;
+  }
+
+  flavour = () => "subsonic";
+
+  bearerToken = (_: Credentials) =>
+    TE.right<AuthFailure, string | undefined>(undefined);
+
+  // todo: q needs to support greater than the max page size supported by subsonic
+  // maybe subsonic should error?
+  artists = (q: ArtistQuery): Promise<Result<ArtistSummary>> =>
+    this.subsonic
+      .getArtists(this.credentials)
+      .then(slice2(q))
+      .then(([page, total]) => ({
+        total,
+        results: page,
+      }));
+
+  artist = async (id: string): Promise<Artist> =>
+    Promise.all([
+      this.subsonic.getArtist(this.credentials, id),
+      this.subsonic.getArtistInfo(this.credentials, id),
+    ]).then(([artist, artistInfo]) => ({
+      id: artist.id,
+      name: artist.name,
+      image: artistImageURN({
+        artistId: artist.id,
+        artistImageURL: [
+          artist.artistImageUrl,
+          // todo: subsonic.artistInfo should just return a valid image or undefined, then the music lib just chooses first undefined
+          // out of artist.image and artistInfo.image
+          artistInfo.images.l,
+          artistInfo.images.m,
+          artistInfo.images.s,
+          // todo: do we still need this isValidImage?
+        ].find(isValidImage),
+      }),
+      albums: artist.albums,
+      similarArtists: artistInfo.similarArtist,
+    }));
+
+  albums = async (q: AlbumQuery): Promise<Result<AlbumSummary>> =>
+    this.subsonic.getAlbumList2(this.credentials, q);
+
+  album = (id: string): Promise<Album> =>
+    this.subsonic.getAlbum(this.credentials, id);
+
+  genres = () => 
+    this.subsonic.getGenres(this.credentials);
+
+  track = (trackId: string) =>
+    this.subsonic.getTrack(this.credentials, trackId);
+
+  rate = (trackId: string, rating: Rating) => 
+    // todo: this is a bit odd
+    Promise.resolve(true)
+      .then(() => {
+        if (rating.stars >= 0 && rating.stars <= 5) {
+          return this.subsonic.getTrack(this.credentials, trackId);
+        } else {
+          throw `Invalid rating.stars value of ${rating.stars}`;
+        }
+      })
+      .then((track) => {
+        const thingsToUpdate = [];
+        if (track.rating.love != rating.love) {
+          thingsToUpdate.push(
+            (rating.love ? this.subsonic.star : this.subsonic.unstar)(this.credentials,{ id: trackId })
+          );
+        }
+        if (track.rating.stars != rating.stars) {
+          thingsToUpdate.push(
+            this.subsonic.setRating(this.credentials, trackId, rating.stars)
+          );
+        }
+        return Promise.all(thingsToUpdate);
+      })
+      .then(() => true)
+      .catch(() => false);
+
+  stream = async ({
+    trackId,
+    range,
+  }: {
+    trackId: string;
+    range: string | undefined;
+  }) =>
+    this.subsonic
+      .getTrack(this.credentials, trackId)
+      .then((track) =>
+        this.subsonic.stream(this.credentials, trackId, track.encoding.player, range)
+      );
+
+  coverArt = async (coverArtURN: BUrn, size?: number) =>
+    Promise.resolve(coverArtURN)
+      .then((it) => assertSystem(it, "subsonic"))
+      .then((it) =>
+        this.subsonic.getCoverArt(
+          this.credentials,
+          it.resource.split(":")[1]!,
+          size
+        )
+      )
+      .then((res) => ({
+        contentType: res.headers["content-type"],
+        data: Buffer.from(res.data, "binary"),
+      }))
+      .catch((e) => {
+        logger.error(`Failed getting coverArt for urn:'${coverArtURN}': ${e}`);
+        return undefined;
+      });
+
+  // todo: unit test the difference between scrobble and nowPlaying
+  scrobble = async (id: string) =>
+    this.subsonic.scrobble(this.credentials, id, true);
+
+  nowPlaying = async (id: string) =>
+    this.subsonic.scrobble(this.credentials, id, false);
+
+  searchArtists = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, artistCount: 20 })
+      .then(({ artists }) =>
+        artists.map((artist) => ({
+          id: artist.id,
+          name: artist.name,
+          image: artistImageURN({
+            artistId: artist.id,
+            artistImageURL: artist.artistImageUrl,
+          }),
+        }))
+      );
+
+  searchAlbums = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, albumCount: 20 })
+      .then(({ albums }) => this.subsonic.toAlbumSummary(albums));
+
+  searchTracks = async (query: string) =>
+    this.subsonic
+      .search3(this.credentials, { query, songCount: 20 })
+      .then(({ songs }) =>
+        Promise.all(
+          songs.map((it) => this.subsonic.getTrack(this.credentials, it.id))
+        )
+      );
+
+  playlists = async () =>
+    this.subsonic.playlists(this.credentials);
+
+  playlist = async (id: string) =>
+    this.subsonic.playlist(this.credentials, id);
+
+  createPlaylist = async (name: string) =>
+    this.subsonic.createPlayList(this.credentials, name);
+
+  deletePlaylist = async (id: string) =>
+    this.subsonic.deletePlayList(this.credentials, id);
+
+  addToPlaylist = async (playlistId: string, trackId: string) =>
+    this.subsonic.updatePlaylist(this.credentials, playlistId, { songIdToAdd: trackId });
+
+  removeFromPlaylist = async (playlistId: string, indicies: number[]) =>
+    this.subsonic.updatePlaylist(this.credentials, playlistId, { songIndexToRemove: indicies });
+
+  similarSongs = async (id: string) => 
+    this.subsonic.getSimilarSongs2(this.credentials, id)
+
+  topSongs = async (artistId: string) =>
+    this.subsonic.getArtist(this.credentials, artistId)
+      .then(({ name }) =>
+        this.subsonic.getTopSongs(this.credentials, name)
+      );
+
+  radioStations = async () =>
+    this.subsonic.getInternetRadioStations(this.credentials);
+
+  radioStation = async (id: string) =>
+    this.radioStations().then((it) => it.find((station) => station.id === id)!);
+
+  years = async () => {
+    const q: AlbumQuery = {
+      _index: 0,
+      _count: 100000, // FIXME: better than this, probably doesnt work anyway as max _count is 500 or something
+      type: "alphabeticalByArtist",
+    };
+    const years = this.subsonic
+      .getAlbumList2(this.credentials, q)
+      .then(({ results }) =>
+        results
+          .map((album) => album.year || "?")
+          .filter((item, i, ar) => ar.indexOf(item) === i)
+          .sort()
+          .map((year) => ({
+            ...asYear(year),
+          }))
+          .reverse()
+      );
+    return years;
+  };
+}

src/utils.ts

@@ -1,7 +1,34 @@
+import { DOMParser, XMLSerializer, Node } from '@xmldom/xmldom';
+
 export function takeWithRepeats<T>(things:T[], count: number) {
   const result = [];
   for(let i = 0; i < count; i++) {
     result.push(things[i % things.length])
   }
   return result;
-}
+}
+
+function xmlRemoveWhitespaceNodes(node: Node) {
+  let child = node.firstChild;
+  while (child) {
+      const nextSibling = child.nextSibling;
+      if (child.nodeType === 3 && !child.nodeValue?.trim()) {
+          // Remove empty text nodes
+          node.removeChild(child);
+      } else {
+          // Recursively process child nodes
+          xmlRemoveWhitespaceNodes(child);
+      }
+      child = nextSibling;
+  }
+}
+
+export function xmlTidy(xml: string | Node) {
+  const xmlToString = new XMLSerializer().serializeToString
+
+  const xmlString = xml instanceof Node ? xmlToString(xml as any) : xml
+  const doc = new DOMParser().parseFromString(xmlString, 'text/xml') as unknown as Node;
+  xmlRemoveWhitespaceNodes(doc);
+  return xmlToString(doc as any);
+}
+

tests/builders.ts

@@ -8,13 +8,14 @@ import {
   Album,
   Artist,
   Track,
-  albumToAlbumSummary,
-  artistToArtistSummary,
   PlaylistSummary,
   Playlist,
   SimilarArtist,
   AlbumSummary,
-} from "../src/music_service";
+  RadioStation,
+  ArtistSummary,
+  TrackSummary
+} from "../src/music_library";
 
 import { b64Encode } from "../src/b64";
 import { artistImageURN } from "../src/subsonic";
@@ -115,13 +116,26 @@ export function aSimilarArtist(
   };
 }
 
-export function anArtist(fields: Partial<Artist> = {}): Artist {
+export function anArtistSummary(fields: Partial<ArtistSummary> = {}): ArtistSummary {
   const id = fields.id || uuid();
-  const artist = {
+  return {
     id,
     name: `Artist ${id}`,
-    albums: [anAlbum(), anAlbum(), anAlbum()],
     image: { system: "subsonic", resource: `art:${id}` },
+  }
+}
+
+export function anArtist(fields: Partial<Artist> = {}): Artist {
+  const id = fields.id || uuid();
+  const name = `Artist ${randomstring.generate()}`
+  const albums = fields.albums || [
+    anAlbumSummary({ artistId: id, artistName: name }), 
+    anAlbumSummary({ artistId: id, artistName: name }), 
+    anAlbumSummary({ artistId: id, artistName: name })
+  ];
+  const artist = {
+    ...anArtistSummary({ id, name }),
+    albums,
     similarArtists: [
       aSimilarArtist({ id: uuid(), name: "Similar artist1", inLibrary: true }),
       aSimilarArtist({ id: uuid(), name: "Similar artist2", inLibrary: true }),
@@ -165,39 +179,35 @@ export const SAMPLE_GENRES = [
 ];
 export const randomGenre = () => SAMPLE_GENRES[randomInt(SAMPLE_GENRES.length)];
 
-export function aTrack(fields: Partial<Track> = {}): Track {
+export function aTrackSummary(fields: Partial<TrackSummary> = {}): TrackSummary {
   const id = uuid();
-  const artist = anArtist();
+  const artist = fields.artist || anArtistSummary();
   const genre = fields.genre || randomGenre();
   const rating = { love: false, stars: Math.floor(Math.random() * 5) };
   return {
     id,
     name: `Track ${id}`,
-    mimeType: `audio/mp3-${id}`,
+    encoding: {
+      player: "bonob",
+      mimeType: `audio/mp3-${id}`
+    },
     duration: randomInt(500),
     number: randomInt(100),
     genre,
-    artist: artistToArtistSummary(artist),
-    album: albumToAlbumSummary(
-      anAlbum({ artistId: artist.id, artistName: artist.name, genre })
-    ),
+    artist,
     coverArt: { system: "subsonic", resource: `art:${uuid()}`},
     rating,
     ...fields,
   };
-}
+};
 
-export function anAlbum(fields: Partial<Album> = {}): Album {
-  const id = uuid();
+export function aTrack(fields: Partial<Track> = {}): Track {
+  const summary = aTrackSummary(fields);
+  const album = fields.album || anAlbumSummary({ artistId: summary.artist.id, artistName: summary.artist.name, genre: summary.genre })
   return {
-    id,
-    name: `Album ${id}`,
-    genre: randomGenre(),
-    year: `19${randomInt(99)}`,
-    artistId: `Artist ${uuid()}`,
-    artistName: `Artist ${randomstring.generate()}`,
-    coverArt: { system: "subsonic", resource: `art:${uuid()}` },
-    ...fields,
+    ...summary,
+    album,
+    ...fields
   };
 };
 
@@ -212,9 +222,38 @@ export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary
     artistId: `Artist ${uuid()}`,
     artistName: `Artist ${randomstring.generate()}`,
     ...fields
-  }
+  };
 };
 
+export function anAlbum(fields: Partial<Album> = {}): Album {
+  const albumSummary = anAlbumSummary()
+  const album = {
+    ...albumSummary,
+    tracks: [],
+    ...fields,
+  };
+  const artistSummary = anArtistSummary({ id: album.artistId, name: album.artistName })
+  const tracks = fields.tracks || [ 
+    aTrack({ album: albumSummary, artist: artistSummary }),
+    aTrack({ album: albumSummary, artist: artistSummary }) 
+  ]
+  return {
+    ...album,
+    tracks
+  };
+};
+
+export function aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
+  const id = uuid()
+  const name = `Station-${id}`;
+  return {
+    id,
+    name,
+    url: `http://example.com/${name}`,
+    ...fields
+  }
+}
+
 export const BLONDIE_ID = uuid();
 export const BLONDIE_NAME = "Blondie";
 export const BLONDIE: Artist = {

tests/clock.test.ts

@@ -1,58 +1,85 @@
-import dayjs from "dayjs";
-import { isChristmas, isCNY, isHalloween, isHoli } from "../src/clock";
+import { randomInt } from "crypto";
+import dayjs, { Dayjs } from "dayjs";
+import timezone from "dayjs/plugin/timezone";
+dayjs.extend(timezone);
 
-describe("isChristmas", () => {
-  ["2000/12/25", "2022/12/25", "2030/12/25"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isChristmas({ now: () => dayjs(date) })).toEqual(true);
+import { Clock, isChristmas, isCNY, isCNY_2022, isCNY_2023, isCNY_2024, isCNY_2025, isHalloween, isHoli, isMay4 } from "../src/clock";
+
+
+
+const randomDate = () => dayjs().subtract(randomInt(1, 1000), 'days');
+const randomDates = (count: number, exclude: string[]) => {
+  const result: Dayjs[] = [];
+  while(result.length < count) {
+    const next = randomDate();
+    if(!exclude.find(it => dayjs(it).isSame(next, 'date'))) {
+      result.push(next)
+    }
+  }
+  return result
+}
+
+function describeFixedDateMonthEvent(
+  name: string, 
+  dateMonth: string,
+  f: (clock: Clock) => boolean
+) {
+  const randomYear = randomInt(2020, 3000);
+  const date = dateMonth.split("/")[0];
+  const month = dateMonth.split("/")[1];
+
+  describe(name, () => {
+    it(`should return true for ${randomYear}-${month}-${date}T00:00:00 ragardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T00:00:00Z`) })).toEqual(true);
+    });
+  
+    it(`should return true for ${randomYear}-${month}-${date}T12:00:00 regardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T12:00:00Z`) })).toEqual(true);
+    });
+  
+    it(`should return true for ${randomYear}-${month}-${date}T23:59:00 regardless of year`, () => {
+      expect(f({ now: () => dayjs(`${randomYear}-${month}-${date}T23:59:00`) })).toEqual(true);
+    });
+  
+    ["2000/12/24", "2000/12/26", "2021/01/01"].forEach((date) => {
+      it(`should return false for ${date}`, () => {
+        expect(f({ now: () => dayjs(date) })).toEqual(false);
+      });
     });
   });
+}
 
-  ["2000/12/24", "2000/12/26", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isChristmas({ now: () => dayjs(date) })).toEqual(false);
+function describeFixedDateEvent(
+  name: string,
+  dates: string[],
+  f: (clock: Clock) => boolean
+) {
+  describe(name, () => {
+    dates.forEach((date) => {
+      it(`should return true for ${date}T00:00:00`, () => {
+        expect(f({ now: () => dayjs(`${date}T00:00:00`) })).toEqual(true);
+      });
+  
+      it(`should return true for ${date}T23:59:59`, () => {
+        expect(f({ now: () => dayjs(`${date}T23:59:59`) })).toEqual(true);
+      });
+    });
+    
+    randomDates(10, dates).forEach((date) => {
+      it(`should return false for ${date}`, () => {
+        expect(f({ now: () => dayjs(date) })).toEqual(false);
+      });
     });
   });
-});
+}
 
-describe("isHalloween", () => {
-  ["2000/10/31", "2022/10/31", "2030/10/31"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
+describeFixedDateMonthEvent("christmas", "25/12", isChristmas);
+describeFixedDateMonthEvent("halloween", "31/10", isHalloween);
+describeFixedDateMonthEvent("may4", "04/05", isMay4);
 
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isHalloween({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});
-
-describe("isHoli", () => {
-  ["2022/03/18", "2023/03/07", "2024/03/25", "2025/03/14"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isHoli({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
-
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isHoli({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});
-
-describe("isCNY", () => {
-  ["2022/02/01", "2023/01/22", "2024/02/10", "2025/02/29"].forEach((date) => {
-    it(`should return true for ${date} regardless of year`, () => {
-      expect(isCNY({ now: () => dayjs(date) })).toEqual(true);
-    });
-  });
-
-  ["2000/09/31", "2000/10/30", "2021/01/01"].forEach((date) => {
-    it(`should return false for ${date} regardless of year`, () => {
-      expect(isCNY({ now: () => dayjs(date) })).toEqual(false);
-    });
-  });
-});
+describeFixedDateEvent("holi", ["2022-03-18", "2023-03-07", "2024-03-25", "2025-03-14"], isHoli);
+describeFixedDateEvent("cny", ["2022-02-01", "2023-01-22", "2024-02-10", "2025-02-29"], isCNY);
+describeFixedDateEvent("cny 2022", ["2022-02-01"], isCNY_2022);
+describeFixedDateEvent("cny 2023", ["2023/01/22"], isCNY_2023);
+describeFixedDateEvent("cny 2024", ["2024/02/10"], isCNY_2024);
+describeFixedDateEvent("cny 2025", ["2025/02/29"], isCNY_2025);

tests/config.test.ts

@@ -96,42 +96,35 @@ describe("config", () => {
     propertyGetter: (config: any) => any
   ) {
     describe(name, () => {
-      function expecting({
-        value,
-        expected,
-      }: {
-        value: string;
-        expected: boolean;
-      }) {
-        describe(`when value is '${value}'`, () => {
-          it(`should be ${expected}`, () => {
-            process.env[envVar] = value;
-            expect(propertyGetter(config())).toEqual(expected);
-          });
-        });
-      }
-
-      expecting({ value: "", expected: expectedDefault });
-      expecting({ value: "true", expected: true });
-      expecting({ value: "false", expected: false });
-      expecting({ value: "foo", expected: false });
+      it.each([
+        [expectedDefault, ""],
+        [expectedDefault, undefined],
+        [true, "true"],
+        [false, "false"],
+        [false, "foo"],
+      ])("should be %s when env var is '%s'", (expected, value) => {
+        process.env[envVar] = value;
+        expect(propertyGetter(config())).toEqual(expected);
+      })
     });
   }
 
   describe("bonobUrl", () => {
-    ["BNB_URL", "BONOB_URL", "BONOB_WEB_ADDRESS"].forEach((key) => {
-      describe(`when ${key} is specified`, () => {
+      describe.each([
+        "BNB_URL", 
+        "BONOB_URL", 
+        "BONOB_WEB_ADDRESS"
+      ])("when %s is specified", (k) => {
         it("should be used", () => {
           const url = "http://bonob1.example.com:8877/";
 
           process.env["BNB_URL"] = "";
           process.env["BONOB_URL"] = "";
           process.env["BONOB_WEB_ADDRESS"] = "";
-          process.env[key] = url;
+          process.env[k] = url;
 
           expect(config().bonobUrl.href()).toEqual(url);
         });
-      });
     });
 
     describe("when none of BNB_URL, BONOB_URL, BONOB_WEB_ADDRESS are specified", () => {
@@ -165,87 +158,89 @@ describe("config", () => {
 
   describe("icons", () => {
     describe("foregroundColor", () => {
-      ["BNB_ICON_FOREGROUND_COLOR", "BONOB_ICON_FOREGROUND_COLOR"].forEach(
-        (k) => {
-          describe(`when ${k} is not specified`, () => {
-            it(`should default to undefined`, () => {
-              expect(config().icons.foregroundColor).toEqual(undefined);
-            });
+      describe.each([
+        "BNB_ICON_FOREGROUND_COLOR",
+        "BONOB_ICON_FOREGROUND_COLOR",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to undefined`, () => {
+            expect(config().icons.foregroundColor).toEqual(undefined);
           });
+        });
 
-          describe(`when ${k} is ''`, () => {
-            it(`should default to undefined`, () => {
-              process.env[k] = "";
-              expect(config().icons.foregroundColor).toEqual(undefined);
-            });
+        describe(`when ${k} is ''`, () => {
+          it(`should default to undefined`, () => {
+            process.env[k] = "";
+            expect(config().icons.foregroundColor).toEqual(undefined);
           });
+        });
 
-          describe(`when ${k} is specified as a color`, () => {
-            it(`should use it`, () => {
-              process.env[k] = "pink";
-              expect(config().icons.foregroundColor).toEqual("pink");
-            });
+        describe(`when ${k} is specified as a color`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "pink";
+            expect(config().icons.foregroundColor).toEqual("pink");
           });
+        });
 
-          describe(`when ${k} is specified as hex`, () => {
-            it(`should use it`, () => {
-              process.env[k] = "#1db954";
-              expect(config().icons.foregroundColor).toEqual("#1db954");
-            });
+        describe(`when ${k} is specified as hex`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "#1db954";
+            expect(config().icons.foregroundColor).toEqual("#1db954");
           });
+        });
 
-          describe(`when ${k} is an invalid string`, () => {
-            it(`should blow up`, () => {
-              process.env[k] = "!dfasd";
-              expect(() => config()).toThrow(
-                `Invalid value specified for 'BNB_ICON_FOREGROUND_COLOR', must match ${COLOR}`
-              );
-            });
+        describe(`when ${k} is an invalid string`, () => {
+          it(`should blow up`, () => {
+            process.env[k] = "!dfasd";
+            expect(() => config()).toThrow(
+              `Invalid value specified for 'BNB_ICON_FOREGROUND_COLOR', must match ${COLOR}`
+            );
           });
-        }
-      );
+        });
+      });
     });
 
     describe("backgroundColor", () => {
-      ["BNB_ICON_BACKGROUND_COLOR", "BONOB_ICON_BACKGROUND_COLOR"].forEach(
-        (k) => {
-          describe(`when ${k} is not specified`, () => {
-            it(`should default to undefined`, () => {
-              expect(config().icons.backgroundColor).toEqual(undefined);
-            });
+      describe.each([
+        "BNB_ICON_BACKGROUND_COLOR",
+        "BONOB_ICON_BACKGROUND_COLOR",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to undefined`, () => {
+            expect(config().icons.backgroundColor).toEqual(undefined);
           });
+        });
 
-          describe(`when ${k} is ''`, () => {
-            it(`should default to undefined`, () => {
-              process.env[k] = "";
-              expect(config().icons.backgroundColor).toEqual(undefined);
-            });
+        describe(`when ${k} is ''`, () => {
+          it(`should default to undefined`, () => {
+            process.env[k] = "";
+            expect(config().icons.backgroundColor).toEqual(undefined);
           });
+        });
 
-          describe(`when ${k} is specified as a color`, () => {
-            it(`should use it`, () => {
-              process.env[k] = "blue";
-              expect(config().icons.backgroundColor).toEqual("blue");
-            });
+        describe(`when ${k} is specified as a color`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "blue";
+            expect(config().icons.backgroundColor).toEqual("blue");
           });
+        });
 
-          describe(`when ${k} is specified as hex`, () => {
-            it(`should use it`, () => {
-              process.env[k] = "#1db954";
-              expect(config().icons.backgroundColor).toEqual("#1db954");
-            });
+        describe(`when ${k} is specified as hex`, () => {
+          it(`should use it`, () => {
+            process.env[k] = "#1db954";
+            expect(config().icons.backgroundColor).toEqual("#1db954");
           });
+        });
 
-          describe(`when ${k} is an invalid string`, () => {
-            it(`should blow up`, () => {
-              process.env[k] = "!red";
-              expect(() => config()).toThrow(
-                `Invalid value specified for 'BNB_ICON_BACKGROUND_COLOR', must match ${COLOR}`
-              );
-            });
+        describe(`when ${k} is an invalid string`, () => {
+          it(`should blow up`, () => {
+            process.env[k] = "!red";
+            expect(() => config()).toThrow(
+              `Invalid value specified for 'BNB_ICON_BACKGROUND_COLOR', must match ${COLOR}`
+            );
           });
-        }
-      );
+        });
+      });
     });
   });
 
@@ -254,9 +249,12 @@ describe("config", () => {
       expect(config().secret).toEqual("bonob");
     });
 
-    ["BNB_SECRET", "BONOB_SECRET"].forEach((key) => {
-      it(`should be overridable using ${key}`, () => {
-        process.env[key] = "new secret";
+    describe.each([
+      "BNB_SECRET", 
+      "BONOB_SECRET"
+    ])("%s", (k) => {
+      it(`should be overridable using ${k}`, () => {
+        process.env[k] = "new secret";
         expect(config().secret).toEqual("new secret");
       });
     });
@@ -271,7 +269,16 @@ describe("config", () => {
       process.env["BNB_AUTH_TIMEOUT"] = "33s";
       expect(config().authTimeout).toEqual("33s");
     });
-});
+  });
+  
+  describe("logRequests", () => {
+    describeBooleanConfigValue(
+      "logRequests",
+      "BNB_SERVER_LOG_REQUESTS",
+      false,
+      (config) => config.logRequests
+    );
+  });
 
   describe("sonos", () => {
     describe("serviceName", () => {
@@ -279,91 +286,122 @@ describe("config", () => {
         expect(config().sonos.serviceName).toEqual("bonob");
       });
 
-      ["BNB_SONOS_SERVICE_NAME", "BONOB_SONOS_SERVICE_NAME"].forEach((k) => {
-        it("should be overridable", () => {
-          process.env[k] = "foobar1000";
-          expect(config().sonos.serviceName).toEqual("foobar1000");
-        });
-      });
+      describe.each([
+        "BNB_SONOS_SERVICE_NAME", 
+        "BONOB_SONOS_SERVICE_NAME"
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "foobar1000";
+            expect(config().sonos.serviceName).toEqual("foobar1000");
+          });
+        }
+      );
     });
 
-    ["BNB_SONOS_DEVICE_DISCOVERY", "BONOB_SONOS_DEVICE_DISCOVERY"].forEach(
-      (k) => {
-        describeBooleanConfigValue(
-          "deviceDiscovery",
-          k,
-          true,
-          (config) => config.sonos.discovery.enabled
-        );
-      }
-    );
+    describe.each([
+      "BNB_SONOS_DEVICE_DISCOVERY",
+      "BONOB_SONOS_DEVICE_DISCOVERY",
+    ])("%s", (k) => {
+      describeBooleanConfigValue(
+        "deviceDiscovery",
+        k,
+        true,
+        (config) => config.sonos.discovery.enabled
+      );
+    });
 
     describe("seedHost", () => {
       it("should default to undefined", () => {
         expect(config().sonos.discovery.seedHost).toBeUndefined();
       });
 
-      ["BNB_SONOS_SEED_HOST", "BONOB_SONOS_SEED_HOST"].forEach((k) => {
-        it("should be overridable", () => {
-          process.env[k] = "123.456.789.0";
-          expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
-        });
-      });
-    });
-
-    ["BNB_SONOS_AUTO_REGISTER", "BONOB_SONOS_AUTO_REGISTER"].forEach((k) => {
-      describeBooleanConfigValue(
-        "autoRegister",
-        k,
-        false,
-        (config) => config.sonos.autoRegister
+      describe.each([
+        "BNB_SONOS_SEED_HOST", 
+        "BONOB_SONOS_SEED_HOST"
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "123.456.789.0";
+            expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
+          });
+        }
       );
     });
 
+    describe.each([
+      "BNB_SONOS_AUTO_REGISTER", 
+      "BONOB_SONOS_AUTO_REGISTER"
+    ])(
+      "%s",
+      (k) => {
+        describeBooleanConfigValue(
+          "autoRegister",
+          k,
+          false,
+          (config) => config.sonos.autoRegister
+        );
+      }
+    );
+
     describe("sid", () => {
       it("should default to 246", () => {
         expect(config().sonos.sid).toEqual(246);
       });
 
-      ["BNB_SONOS_SERVICE_ID", "BONOB_SONOS_SERVICE_ID"].forEach((k) => {
-        it("should be overridable", () => {
-          process.env[k] = "786";
-          expect(config().sonos.sid).toEqual(786);
-        });
-      });
+      describe.each([
+        "BNB_SONOS_SERVICE_ID", 
+        "BONOB_SONOS_SERVICE_ID"
+      ])(
+        "%s",
+        (k) => {
+          it("should be overridable", () => {
+            process.env[k] = "786";
+            expect(config().sonos.sid).toEqual(786);
+          });
+        }
+      );
     });
   });
 
   describe("subsonic", () => {
     describe("url", () => {
-      ["BNB_SUBSONIC_URL", "BONOB_SUBSONIC_URL", "BONOB_NAVIDROME_URL"].forEach(
-        (k) => {
-          describe(`when ${k} is not specified`, () => {
-            it(`should default to http://${hostname()}:4533`, () => {
-              expect(config().subsonic.url).toEqual(
-                `http://${hostname()}:4533`
-              );
-            });
+      describe.each([
+        "BNB_SUBSONIC_URL",
+        "BONOB_SUBSONIC_URL",
+        "BONOB_NAVIDROME_URL",
+      ])("%s", (k) => {
+        describe(`when ${k} is not specified`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
+            expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
           });
+        });
 
-          describe(`when ${k} is ''`, () => {
-            it(`should default to http://${hostname()}:4533`, () => {
-              process.env[k] = "";
-              expect(config().subsonic.url).toEqual(
-                `http://${hostname()}:4533`
-              );
-            });
+        describe(`when ${k} is ''`, () => {
+          it(`should default to http://${hostname()}:4533/`, () => {
+            process.env[k] = "";
+            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";
-              process.env[k] = url;
-              expect(config().subsonic.url).toEqual(url);
-            });
+        describe(`when ${k} is specified`, () => {
+          it(`should use it for ${k}`, () => {
+            const url = "http://navidrome.example.com:1234/some-context-path";
+            process.env[k] = 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);
+          });
+        });
+      });
     });
 
     describe("customClientsFor", () => {
@@ -371,11 +409,11 @@ describe("config", () => {
         expect(config().subsonic.customClientsFor).toBeUndefined();
       });
 
-      [
+      describe.each([
         "BNB_SUBSONIC_CUSTOM_CLIENTS",
         "BONOB_SUBSONIC_CUSTOM_CLIENTS",
         "BONOB_NAVIDROME_CUSTOM_CLIENTS",
-      ].forEach((k) => {
+      ])("%s", (k) => {
         it(`should be overridable for ${k}`, () => {
           process.env[k] = "whoop/whoop";
           expect(config().subsonic.customClientsFor).toEqual("whoop/whoop");
@@ -395,7 +433,10 @@ describe("config", () => {
     });
   });
 
-  ["BNB_SCROBBLE_TRACKS", "BONOB_SCROBBLE_TRACKS"].forEach((k) => {
+  describe.each([
+    "BNB_SCROBBLE_TRACKS", 
+    "BONOB_SCROBBLE_TRACKS"
+  ])("%s", (k) => {
     describeBooleanConfigValue(
       "scrobbleTracks",
       k,
@@ -404,12 +445,18 @@ describe("config", () => {
     );
   });
 
-  ["BNB_REPORT_NOW_PLAYING", "BONOB_REPORT_NOW_PLAYING"].forEach((k) => {
-    describeBooleanConfigValue(
-      "reportNowPlaying",
-      k,
-      true,
-      (config) => config.reportNowPlaying
-    );
-  });
+  describe.each([
+    "BNB_REPORT_NOW_PLAYING", 
+    "BONOB_REPORT_NOW_PLAYING"
+  ])(
+    "%s",
+    (k) => {
+      describeBooleanConfigValue(
+        "reportNowPlaying",
+        k,
+        true,
+        (config) => config.reportNowPlaying
+      );
+    }
+  );
 });

tests/encryption.test.ts

@@ -1,3 +1,5 @@
+import { left, right } from 'fp-ts/Either'
+
 import { cryptoEncryption, jwsEncryption } from '../src/encryption';
 
 describe("jwsEncryption", () => {
@@ -7,7 +9,7 @@ describe("jwsEncryption", () => {
     const value = "bobs your uncle"
     const hash = e.encrypt(value)
     expect(hash).not.toContain(value);
-    expect(e.decrypt(hash)).toEqual(value);
+    expect(e.decrypt(hash)).toEqual(right(value));
   });
 
   it("returns different values for different secrets", () => {
@@ -29,7 +31,7 @@ describe("cryptoEncryption", () => {
     const value = "bobs your uncle"
     const hash = e.encrypt(value)
     expect(hash).not.toContain(value);
-    expect(e.decrypt(hash)).toEqual(value);
+    expect(e.decrypt(hash)).toEqual(right(value));
   });
 
   it("returns different values for different secrets", () => {
@@ -42,4 +44,10 @@ describe("cryptoEncryption", () => {
 
     expect(h1).not.toEqual(h2);
   });
+  
+  it("should return left on invalid value", () => {
+    const e = cryptoEncryption("secret squirrel");
+
+    expect(e.decrypt("not-valid")).toEqual(left("Invalid value to decrypt"));
+  });
 })

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/icon.test.ts

@@ -1,6 +1,6 @@
 import dayjs from "dayjs";
-import libxmljs from "libxmljs2";
 import { FixedClock } from "../src/clock";
+import { xmlTidy } from "../src/utils";
 
 import {
   contains,
@@ -20,17 +20,17 @@ import {
   allOf,
   features,
   STAR_WARS,
+  NO_FEATURES,
 } from "../src/icon";
 
 describe("SvgIcon", () => {
-  const xmlTidy = (xml: string) =>
-    libxmljs.parseXmlString(xml, { noblanks: true, net: false }).toString();
-
   const svgIcon24 = `<?xml version="1.0" encoding="UTF-8"?>
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
   <path d="path1"/>
   <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">80's</text>
   <path d="path3"/>
+  <text font-size="25">80's</text>
 </svg>
 `;
 
@@ -61,7 +61,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
           `)
           );
@@ -110,7 +112,9 @@ describe("SvgIcon", () => {
               <rect x="0" y="0" width="24" height="24" fill="red"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -134,7 +138,9 @@ describe("SvgIcon", () => {
               <rect x="-4" y="-4" width="36" height="36" fill="pink"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -152,7 +158,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -172,7 +180,9 @@ describe("SvgIcon", () => {
               <rect x="0" y="0" width="24" height="24" fill="red"/>
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>
               <path d="path3"/>
+              <text font-size="25">80's</text>
             </svg>
         `)
         );
@@ -182,7 +192,7 @@ describe("SvgIcon", () => {
 
   describe("foreground color", () => {
     describe("with no viewPort increase", () => {
-      it("should add a rectangle the same size as the original viewPort", () => {
+      it("should change the fill values", () => {
         expect(
           new SvgIcon(svgIcon24)
             .with({ features: { foregroundColor: "red" } })
@@ -192,7 +202,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1" fill="red"/>
               <path d="path2" fill="none" stroke="red"/>
+              <text font-size="25" fill="none" stroke="red">80's</text>
               <path d="path3" fill="red"/>
+              <text font-size="25" fill="red">80's</text>
             </svg>
         `)
         );
@@ -200,7 +212,7 @@ describe("SvgIcon", () => {
     });
 
     describe("with a viewPort increase", () => {
-      it("should add a rectangle the same size as the original viewPort", () => {
+      it("should change the fill values", () => {
         expect(
           new SvgIcon(svgIcon24)
             .with({
@@ -215,7 +227,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
               <path d="path1" fill="pink"/>
               <path d="path2" fill="none" stroke="pink"/>
+              <text font-size="25" fill="none" stroke="pink">80's</text>
               <path d="path3" fill="pink"/>
+              <text font-size="25" fill="pink">80's</text>
             </svg>
         `)
         );
@@ -233,7 +247,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1"/>
               <path d="path2" fill="none" stroke="#000"/>
+              <text font-size="25" fill="none">80's</text>              
               <path d="path3"/>
+              <text font-size="25">80's</text>              
             </svg>
         `)
         );
@@ -252,7 +268,9 @@ describe("SvgIcon", () => {
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
               <path d="path1" fill="red"/>
               <path d="path2" fill="none" stroke="red"/>
+              <text font-size="25" fill="none" stroke="red">80's</text>              
               <path d="path3" fill="red"/>
+              <text font-size="25" fill="red">80's</text>              
             </svg>
         `)
         );
@@ -260,6 +278,48 @@ describe("SvgIcon", () => {
     });
   });
 
+  describe("text", () => {
+    describe("when text value specified", () => {
+      it("should change the text values", () => {
+        expect(
+          new SvgIcon(svgIcon24)
+            .with({ features: { text: "yipppeeee" } })
+            .toString()
+        ).toEqual(
+          xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+  <path d="path1"/>
+  <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">yipppeeee</text>
+  <path d="path3"/>
+  <text font-size="25">yipppeeee</text>
+</svg>
+        `)
+        );
+      });
+    });
+
+    describe("of undefined", () => {
+      it("should not do anything", () => {
+        expect(
+          new SvgIcon(svgIcon24)
+            .with({ features: { text: undefined } })
+            .toString()
+        ).toEqual(
+          xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+  <path d="path1"/>
+  <path d="path2" fill="none" stroke="#000"/>
+  <text font-size="25" fill="none">80's</text>
+  <path d="path3"/>
+  <text font-size="25">80's</text>
+</svg>
+        `)
+        );
+      });
+    });
+  });
+
   describe("swapping the svg", () => {
     describe("with no other changes", () => {
       it("should swap out the svg, but maintain the IconFeatures", () => {
@@ -318,10 +378,14 @@ describe("SvgIcon", () => {
 
 class DummyIcon implements Icon {
   svg: string;
-  features: Partial<IconFeatures>;
+  features: IconFeatures;
+
   constructor(svg: string, features: Partial<IconFeatures>) {
     this.svg = svg;
-    this.features = features;
+    this.features = {
+      ...NO_FEATURES,
+      ...features
+    };
   }
 
   public apply = (transformer: Transformer): Icon => transformer(this);
@@ -350,6 +414,7 @@ describe("transform", () => {
             viewPortIncreasePercent: 100,
             foregroundColor: "blue",
             backgroundColor: "blue",
+            text: "a",
           },
         })
         .apply(
@@ -357,6 +422,7 @@ describe("transform", () => {
             features: {
               foregroundColor: "override1",
               backgroundColor: "override2",
+              text: "b",
             },
           })
         ) as DummyIcon;
@@ -366,6 +432,7 @@ describe("transform", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "override1",
         backgroundColor: "override2",
+        text: "b",
       });
     });
   });
@@ -382,6 +449,7 @@ describe("transform", () => {
             viewPortIncreasePercent: 100,
             foregroundColor: "blue",
             backgroundColor: "blue",
+            text: "bob",
           },
         })
         .apply(
@@ -395,6 +463,7 @@ describe("transform", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "blue",
         backgroundColor: "blue",
+        text: "bob"
       });
     });
   });
@@ -411,6 +480,7 @@ describe("features", () => {
         viewPortIncreasePercent: 100,
         foregroundColor: "blue",
         backgroundColor: "blue",
+        text: "foobar"
       })
     ) as DummyIcon;
 
@@ -418,6 +488,7 @@ describe("features", () => {
       viewPortIncreasePercent: 100,
       foregroundColor: "blue",
       backgroundColor: "blue",
+      text: "foobar"
     });
   });
 });

tests/in_memory_music_service.test.ts

@@ -5,8 +5,7 @@ import { InMemoryMusicService } from "./in_memory_music_service";
 import {
   MusicLibrary,
   artistToArtistSummary,
-  albumToAlbumSummary,
-} from "../src/music_service";
+} from "../src/music_library";
 import { v4 as uuid } from "uuid";
 import {
   anArtist,
@@ -17,6 +16,7 @@ import {
   METAL,
   HIP_HOP,
   SKA,
+  anAlbumSummary,
 } from "./builders";
 import _ from "underscore";
 
@@ -167,23 +167,6 @@ describe("InMemoryMusicService", () => {
         service.hasTracks(track1, track2, track3, track4);
       });
 
-      describe("fetching tracks for an album", () => {
-        it("should return only tracks on that album", async () => {
-          expect(await musicLibrary.tracks(artist1Album1.id)).toEqual([
-            { ...track1, rating: { love: false, stars: 0 } },
-            { ...track2, rating: { love: false, stars: 0 } },
-          ]);
-        });
-      });
-
-      describe("fetching tracks for an album that doesnt exist", () => {
-        it("should return empty array", async () => {
-          expect(await musicLibrary.tracks("non existant album id")).toEqual(
-            []
-          );
-        });
-      });
-
       describe("fetching a single track", () => {
         describe("when it exists", () => {
           it("should return the track", async () => {
@@ -194,16 +177,16 @@ describe("InMemoryMusicService", () => {
     });
 
     describe("albums", () => {
-      const artist1_album1 = anAlbum({ genre: POP });
-      const artist1_album2 = anAlbum({ genre: ROCK });
-      const artist1_album3 = anAlbum({ genre: METAL });
-      const artist1_album4 = anAlbum({ genre: POP });
-      const artist1_album5 = anAlbum({ genre: POP });
+      const artist1_album1 = anAlbumSummary({ genre: POP });
+      const artist1_album2 = anAlbumSummary({ genre: ROCK });
+      const artist1_album3 = anAlbumSummary({ genre: METAL });
+      const artist1_album4 = anAlbumSummary({ genre: POP });
+      const artist1_album5 = anAlbumSummary({ genre: POP });
 
-      const artist2_album1 = anAlbum({ genre: METAL });
+      const artist2_album1 = anAlbumSummary({ genre: METAL });
 
-      const artist3_album1 = anAlbum({ genre: HIP_HOP });
-      const artist3_album2 = anAlbum({ genre: POP });
+      const artist3_album1 = anAlbumSummary({ genre: HIP_HOP });
+      const artist3_album2 = anAlbumSummary({ genre: POP });
 
       const artist1 = anArtist({
         name: "artist1",
@@ -212,8 +195,8 @@ describe("InMemoryMusicService", () => {
           artist1_album2,
           artist1_album3,
           artist1_album4,
-          artist1_album5,
-        ],
+          artist1_album5
+        ]
       });
       const artist2 = anArtist({ name: "artist2", albums: [artist2_album1] });
       const artist3 = anArtist({
@@ -275,16 +258,16 @@ describe("InMemoryMusicService", () => {
                   })
                 ).toEqual({
                   results: [
-                    albumToAlbumSummary(artist1_album1),
-                    albumToAlbumSummary(artist1_album2),
-                    albumToAlbumSummary(artist1_album3),
-                    albumToAlbumSummary(artist1_album4),
-                    albumToAlbumSummary(artist1_album5),
+                    artist1_album1,
+                    artist1_album2,
+                    artist1_album3,
+                    artist1_album4,
+                    artist1_album5,
 
-                    albumToAlbumSummary(artist2_album1),
+                    artist2_album1,
 
-                    albumToAlbumSummary(artist3_album1),
-                    albumToAlbumSummary(artist3_album2),
+                    artist3_album1,
+                    artist3_album2,
                   ],
                   total: totalAlbumCount,
                 });
@@ -300,7 +283,7 @@ describe("InMemoryMusicService", () => {
                     type: "alphabeticalByName",
                   })
                 ).toEqual({
-                  results: _.sortBy(allAlbums, "name").map(albumToAlbumSummary),
+                  results: _.sortBy(allAlbums, "name"),
                   total: totalAlbumCount,
                 });
               });
@@ -317,9 +300,9 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist1_album5),
-                  albumToAlbumSummary(artist2_album1),
-                  albumToAlbumSummary(artist3_album1),
+                  artist1_album5,
+                  artist2_album1,
+                  artist3_album1,
                 ],
                 total: totalAlbumCount,
               });
@@ -336,8 +319,8 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist3_album1),
-                  albumToAlbumSummary(artist3_album2),
+                  artist3_album1,
+                  artist3_album2,
                 ],
                 total: totalAlbumCount,
               });
@@ -357,10 +340,10 @@ describe("InMemoryMusicService", () => {
                 })
               ).toEqual({
                 results: [
-                  albumToAlbumSummary(artist1_album1),
-                  albumToAlbumSummary(artist1_album4),
-                  albumToAlbumSummary(artist1_album5),
-                  albumToAlbumSummary(artist3_album2),
+                  artist1_album1,
+                  artist1_album4,
+                  artist1_album5,
+                  artist3_album2,
                 ],
                 total: 4,
               });
@@ -379,8 +362,8 @@ describe("InMemoryMusicService", () => {
                   })
                 ).toEqual({
                   results: [
-                    albumToAlbumSummary(artist1_album4),
-                    albumToAlbumSummary(artist1_album5),
+                    artist1_album4,
+                    artist1_album5,
                   ],
                   total: 4,
                 });
@@ -397,7 +380,7 @@ describe("InMemoryMusicService", () => {
                     _count: 100,
                   })
                 ).toEqual({
-                  results: [albumToAlbumSummary(artist3_album2)],
+                  results: [artist3_album2],
                   total: 4,
                 });
               });
@@ -424,7 +407,10 @@ describe("InMemoryMusicService", () => {
         describe("when it exists", () => {
           it("should provide an album", async () => {
             expect(await musicLibrary.album(artist1_album5.id)).toEqual(
-              artist1_album5
+              {
+                ...artist1_album5,
+                tracks: []
+              }
             );
           });
         });

tests/in_memory_music_service.ts

@@ -19,11 +19,10 @@ import {
   slice2,
   asResult,
   artistToArtistSummary,
-  albumToAlbumSummary,
   Track,
   Genre,
   Rating,
-} from "../src/music_service";
+} from "../src/music_library";
 import { BUrn } from "../src/burn";
 
 export class InMemoryMusicService implements MusicService {
@@ -97,14 +96,13 @@ export class InMemoryMusicService implements MusicService {
             }
           })
           .then((matches) => matches.map((it) => it.album))
-          .then((it) => it.map(albumToAlbumSummary))
           .then(slice2(q))
           .then(asResult),
       album: (id: string) =>
         pipe(
           this.artists.flatMap((it) => it.albums).find((it) => it.id === id),
           O.fromNullable,
-          O.map((it) => Promise.resolve(it)),
+          O.map((it) => Promise.resolve({ ...it, tracks: [] })),
           O.getOrElse(() => Promise.reject(`No album with id '${id}'`))
         ),
       genres: () =>
@@ -119,12 +117,6 @@ export class InMemoryMusicService implements MusicService {
             A.sort(fromCompare<Genre>((x, y) => ordString.compare(x.id, y.id)))
           )
         ),
-      tracks: (albumId: string) =>
-        Promise.resolve(
-          this.tracks
-            .filter((it) => it.album.id === albumId)
-            .map((it) => ({ ...it, rating: { love: false, stars: 0 } }))
-        ),
       rate: (_: string, _2: Rating) => Promise.resolve(false),
       track: (trackId: string) =>
         pipe(
@@ -161,6 +153,9 @@ export class InMemoryMusicService implements MusicService {
         Promise.reject("Unsupported operation"),
       similarSongs: async (_: string) => Promise.resolve([]),
       topSongs: async (_: string) => Promise.resolve([]),
+      radioStations: async () => Promise.resolve([]),
+      radioStation: async (_: string) => Promise.reject("Unsupported operation"),
+      years: async () => Promise.resolve([]),
     });
   }
 

tests/music_library.test.ts

@@ -1,7 +1,7 @@
 import { v4 as uuid } from "uuid";
 
 import { anArtist } from "./builders";
-import { artistToArtistSummary } from "../src/music_service";
+import { artistToArtistSummary } from "../src/music_library";
 
 describe("artistToArtistSummary", () => {
   it("should map fields correctly", () => {

tests/scenarios.test.ts

@@ -18,7 +18,7 @@ import {
 } from "./builders";
 import { InMemoryMusicService } from "./in_memory_music_service";
 import { InMemoryLinkCodes } from "../src/link_codes";
-import { Credentials } from "../src/music_service";
+import { Credentials } from "../src/music_library";
 import makeServer from "../src/server";
 import { Service, bonobService, Sonos } from "../src/sonos";
 import supersoap from "./supersoap";

tests/server.test.ts

@@ -2,11 +2,9 @@ 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 { AuthFailure, MusicService } from "../src/music_library";
 import makeServer, {
   BONOB_ACCESS_TOKEN_HEADER,
   RangeBytesFromFilter,
@@ -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 bonobUrlWithContextPath = url("http://bonob.localhost:1234/aContext");
+  const bonobUrlWithNoContextPath = url("http://localhost:1234");
+  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) => ({
-          pipe: (_: Transform) => {
-            return {
-              pipe: (res: Response) => {
-                res.send(content);
-              },
-            };
-          },
-        });
+        const streamContent = (content: string) => {
+          const self = {
+            destroyed: false,
+            pipe: (_: Transform) => {
+              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);
@@ -1618,11 +1366,25 @@ describe("server", () => {
             "..%2F..%2Ffoo",
             "%2Fetc%2Fpasswd",
             ".%2Fbob.js",
-            ".",
-            "..",
-            "1",
             "%23%24",
+          ].forEach((type) => {
+            describe(`trying to retrieve an icon with name ${type}`, () => {
+              it(`should fail`, async () => {
+                const response = await request(server()).get(
+                  `/icon/${type}/size/legacy`
+                );
+
+                expect(response.status).toEqual(400);
+              });
+            });
+          });
+        });
+
+        describe("missing icons", () => {
+          [
+            "1",
             "notAValidIcon",
+            "notAValidIcon:withSomeText"
           ].forEach((type) => {
             describe(`trying to retrieve an icon with name ${type}`, () => {
               it(`should fail`, async () => {
@@ -1650,6 +1412,20 @@ describe("server", () => {
           });
         });
 
+        describe("invalid text", () => {
+          ["..", "foobar.123", "_dog_", "{ whoop }"].forEach((text) => {
+            describe(`trying to retrieve an icon with text ${text}`, () => {
+              it(`should fail`, async () => {
+                const response = await request(server()).get(
+                  `/icon/yyyy:${text}/size/60`
+                );
+
+                expect(response.status).toEqual(400);
+              });
+            });
+          });
+        });        
+
         describe("fetching", () => {
           [
             "artists",
@@ -1779,6 +1555,41 @@ describe("server", () => {
             });
           });
         });
+
+        describe("specifing some text", () => {
+          const text = "somethingWicked"
+
+          describe(`legacy icon`, () => {
+            it("should return the png image", async () => {
+              const response = await request(server()).get(
+                `/icon/yyyy:${text}/size/legacy`
+              );
+
+              expect(response.status).toEqual(200);
+              expect(response.header["content-type"]).toEqual("image/png");
+              const image = await Image.load(response.body);
+              expect(image.width).toEqual(80);
+              expect(image.height).toEqual(80);
+            });
+          });
+
+          describe("svg icon", () => {
+            it(`should return an svg image with the text replaced`, async () => {
+              const response = await request(server()).get(
+                `/icon/yyyy:${text}/size/60`
+              );
+
+              expect(response.status).toEqual(200);
+              expect(response.header["content-type"]).toEqual(
+                "image/svg+xml; charset=utf-8"
+              );
+              const svg = Buffer.from(response.body).toString();
+              expect(svg).toContain(
+                `>${text}</text>`
+              );
+            });
+          });
+        });
       });
     });
   });

tsconfig.json

@@ -50,11 +50,11 @@
     // "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. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

web/icons/navidrome-radio.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+    <path d="M20 6H8.3l8.26-3.34L15.88 1 3.24 6.15C2.51 6.43 2 7.17 2 8v12c0 1.1.89 2 2 2h16c1.11 0 2-.9 2-2V8c0-1.11-.89-2-2-2zm0 2v3h-2V9h-2v2H4V8h16zM4 20v-7h16v7H4z"></path>
+    <circle cx="8" cy="16.48" r="2.5"></circle>
+</svg>

web/icons/yy.svg

@@ -0,0 +1,3 @@
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
+  <text x="50" y="75" font-size="65" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">80s</text>
+</svg>

web/icons/yyyy.svg

@@ -0,0 +1,3 @@
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
+  <text x="50" y="65" font-size="35" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">1980</text>
+</svg>