wkulhanek/bonob
1
0
Fork 0
mirror of https://github.com/wkulhanek/bonob.git synced 2025-12-22 09:53:32 +01:00
Code Issues 1 Packages Projects Releases Wiki Activity

Compare commits

base: wkulhanek:feature/noodles2
Branches Tags
wkulhanek:master wkulhanek:sonos80 wkulhanek:feature/noodles2 wkulhanek:feature/v6 wkulhanek:feature/years-svg wkulhanek:feature/sonosify-mime-type-fix wkulhanek:dependabot/npm_and_yarn/follow-redirects-1.15.4 wkulhanek:dependabot/npm_and_yarn/axios-1.6.0 wkulhanek:dependabot/npm_and_yarn/babel/traverse-7.23.2 wkulhanek:feature/ndAlbums wkulhanek:feature/artistRadio
wkulhanek:v0.9.0 wkulhanek:v0.8.0 wkulhanek:v0.7.0 wkulhanek:v0.6.11 wkulhanek:v0.6.10 wkulhanek:v0.6.9 wkulhanek:v0.6.8 wkulhanek:v0.6.7 wkulhanek:v0.6.6 wkulhanek:v0.6.5 wkulhanek:v0.6.4 wkulhanek:v0.6.3 wkulhanek:v0.6.2 wkulhanek:v0.6.1 wkulhanek:v0.6.0 wkulhanek:v0.5.0 wkulhanek:v0.4.0 wkulhanek:v0.3.0 wkulhanek:v0.2.2 wkulhanek:v0.2.1 wkulhanek:v0.2.0 wkulhanek:v0.1.0
..
compare: wkulhanek:dependabot/npm_and_yarn/axios-1.6.0
Branches Tags
wkulhanek:sonos80 wkulhanek:feature/noodles2 wkulhanek:master wkulhanek:feature/v6 wkulhanek:feature/years-svg wkulhanek:feature/sonosify-mime-type-fix wkulhanek:dependabot/npm_and_yarn/follow-redirects-1.15.4 wkulhanek:dependabot/npm_and_yarn/axios-1.6.0 wkulhanek:dependabot/npm_and_yarn/babel/traverse-7.23.2 wkulhanek:feature/ndAlbums wkulhanek:feature/artistRadio
wkulhanek:v0.9.0 wkulhanek:v0.8.0 wkulhanek:v0.7.0 wkulhanek:v0.6.11 wkulhanek:v0.6.10 wkulhanek:v0.6.9 wkulhanek:v0.6.8 wkulhanek:v0.6.7 wkulhanek:v0.6.6 wkulhanek:v0.6.5 wkulhanek:v0.6.4 wkulhanek:v0.6.3 wkulhanek:v0.6.2 wkulhanek:v0.6.1 wkulhanek:v0.6.0 wkulhanek:v0.5.0 wkulhanek:v0.4.0 wkulhanek:v0.3.0 wkulhanek:v0.2.2 wkulhanek:v0.2.1 wkulhanek:v0.2.0 wkulhanek:v0.1.0

1 Commits
feature/no ... dependabot

Author SHA1 Message Date
dependabot[bot]
e522caeb29 Bump axios from 1.5.1 to 1.6.0 
Bumps [axios](https://github.com/axios/axios) from 1.5.1 to 1.6.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v1.5.1...v1.6.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
 2023-11-11 10:51:37 +00:00
39 changed files with 158267 additions and 14393 deletions
Expand all files Collapse all files

2
.devcontainer/Dockerfile
View File

@@ -1,4 +1,4 @@
FROM node:23-bullseye FROM node:16-bullseye
LABEL maintainer=simojenki LABEL maintainer=simojenki

11
.devcontainer/devcontainer.json
View File

@@ -10,19 +10,10 @@
"BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}" "BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
}, },
"remoteUser": "node", "remoteUser": "node",
"forwardPorts": [4534],
"features": { "features": {
"ghcr.io/devcontainers/features/docker-in-docker:2": { "ghcr.io/devcontainers/features/docker-in-docker:1": {
"version": "latest", "version": "latest",
"moby": true "moby": true
} }
},
"customizations": {
"vscode": {
"extensions": [
"esbenp.prettier-vscode",
"redhat.vscode-xml"
]
}
} }
} }

6
.github/workflows/ci.yml vendored
View File

@@ -21,11 +21,11 @@ jobs:
- -
uses: actions/setup-node@v3 uses: actions/setup-node@v3
with: with:
node-version: 20 node-version: '16'
- -
run: npm install run: yarn install
- -
run: npm test run: yarn test
push_to_registry: push_to_registry:

1
.npmrc
View File

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

1
.nvmrc Normal file
View File

@@ -0,0 +1 @@
16.6.2

147529
.yarn/releases/yarn-1.22.19.cjs vendored Executable file
View File

File diff suppressed because one or more lines are too long

3
.yarnrc.yml Normal file
View File

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

36
Dockerfile
View File

@@ -1,4 +1,4 @@
FROM node:23-bullseye-slim AS build FROM node:16-bullseye-slim as build
WORKDIR /bonob WORKDIR /bonob
@@ -9,11 +9,12 @@ COPY typings ./typings
COPY web ./web COPY web ./web
COPY tests ./tests COPY tests ./tests
COPY jest.config.js . COPY jest.config.js .
COPY register.js .
COPY .npmrc .
COPY tsconfig.json .
COPY package.json . COPY package.json .
COPY package-lock.json . COPY register.js .
COPY tsconfig.json .
COPY yarn.lock .
COPY .yarnrc.yml .
COPY .yarn/releases ./.yarn/releases
ENV JEST_TIMEOUT=60000 ENV JEST_TIMEOUT=60000
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
@@ -28,15 +29,24 @@ RUN apt-get update && \
g++ && \ g++ && \
apt-get clean && \ apt-get clean && \
rm -rf /var/lib/apt/lists/* && \ rm -rf /var/lib/apt/lists/* && \
npm install && \ yarn config set network-timeout 600000 -g && \
npm test && \ yarn install \
npm run gitinfo && \ --prefer-offline \
npm run build && \ --frozen-lockfile \
--non-interactive \
--production=false && \
yarn test --no-cache && \
yarn gitinfo && \
yarn build && \
rm -Rf node_modules && \ rm -Rf node_modules && \
NODE_ENV=production npm install --omit=dev NODE_ENV=production yarn install \
--prefer-offline \
--pure-lockfile \
--non-interactive \
--production=true
FROM node:23-bullseye-slim FROM node:16-bullseye-slim
LABEL maintainer="simojenki" \ LABEL maintainer="simojenki" \
org.opencontainers.image.source="https://github.com/simojenki/bonob" \ org.opencontainers.image.source="https://github.com/simojenki/bonob" \
@@ -52,13 +62,13 @@ EXPOSE $BNB_PORT
WORKDIR /bonob WORKDIR /bonob
COPY package.json . COPY package.json .
COPY package-lock.json . COPY yarn.lock .
COPY --from=build /bonob/build/src ./src COPY --from=build /bonob/build/src ./src
COPY --from=build /bonob/node_modules ./node_modules COPY --from=build /bonob/node_modules ./node_modules
COPY --from=build /bonob/.gitinfo ./ COPY --from=build /bonob/.gitinfo ./
COPY web ./web COPY web ./web
COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
RUN apt-get update && \ RUN apt-get update && \
apt-get -y upgrade && \ apt-get -y upgrade && \

39
README.md
View File

@@ -9,20 +9,19 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
## Features ## Features
- Integrates with Subsonic API clones (Navidrome, Gonic) - Integrates with Subsonic API clones (Navidrome, Gonic)
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums - Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums
- Artist & Album Art - Artist & Album Art
- View Related Artists via Artist -> '...' -> Menu -> Related Arists - View Related Artists via Artist -> '...' -> Menu -> Related Arists
- Now playing & Track Scrobbling - Now playing & Track Scrobbling
- Search by Album, Artist, Track - Search by Album, Artist, Track
- Playlist editing through sonos app. - Playlist editing through sonos app.
- Marking of songs as favourites and with ratings through the sonos app. - Marking of songs as favourites and with ratings through the sonos app.
- 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) - Localization (only en-US, da-DK & 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/)
- Auto discovery of sonos devices - Auto discovery of sonos devices
- Discovery of sonos devices using seed IP address - Discovery of sonos devices using seed IP address
- Auto registration with sonos on start - Auto registration with sonos on start
- Multiple registrations within a single household. - Multiple registrations within a single household.
- Transcoding within subsonic clone - Transcoding support for flacs using a specific player for the flac mimeType bonob/sonos
- Custom players by mime type, allowing custom transcoding rules for different file types
## Running ## Running
@@ -40,8 +39,8 @@ docker pull ghcr.io/simojenki/bonob
tag | description tag | description
--- | --- --- | ---
latest | Latest release, intended to be stable latest | Latest release, intended to be stable
master | Lastest build from master, probably works, however is currently under test master | Laster build from master, probably works, however is currently under test in
vX.Y.Z | Fixed release versions from tags, for those that want to pin to a specific release vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release
### Full sonos device auto-discovery and auto-registration using docker --network host ### Full sonos device auto-discovery and auto-registration using docker --network host
@@ -164,6 +163,7 @@ BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos
BNB_SECRET | bonob | secret used for encrypting credentials 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_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_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
BNB_DISABLE_PLAYLIST_ART | undefined | Disables playlist art generation, ie. when there are many playlists and art generation takes too long
BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests 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_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_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.
@@ -171,7 +171,7 @@ BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommit
BNB_SONOS_SERVICE_NAME | bonob | service name for sonos BNB_SONOS_SERVICE_NAME | bonob | service name for sonos
BNB_SONOS_SERVICE_ID | 246 | service id for sonos BNB_SONOS_SERVICE_ID | 246 | service id for sonos
BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone 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. <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_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 that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache. 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_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_REPORT_NOW_PLAYING | true | Whether to report a track as now playing
@@ -218,22 +218,19 @@ Afterwards the Sonos app displays a dropdown underneath the service, allowing to
- Implement the MusicService/MusicLibrary interface - Implement the MusicService/MusicLibrary interface
- Startup bonob with your new implementation. - Startup bonob with your new implementation.
## Transcoding ## A note on transcoding
### Transcode everything 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).
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) Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/). When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
### Audio file type specific transcoding ### Audio File type specific transcoding options within Subsonic
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 you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
In some situations you may wish to have different 'Players' within 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; In this case you could set;
```bash ```bash
# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac" BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
``` ```
@@ -249,16 +246,7 @@ ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac - 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; ### Changing Icon colors
```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 ```bash
-e BNB_ICON_FOREGROUND_COLOR=white \ -e BNB_ICON_FOREGROUND_COLOR=white \
@@ -288,7 +276,6 @@ And then configure the 'bonob+audio/mpeg' player in your subsonic server.
![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true) ![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true)
## Credits ## Credits
- Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho - Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho

7472
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

92
package.json
View File

@@ -6,70 +6,66 @@
"author": "simojenki <simojenki@users.noreply.github.com>", "author": "simojenki <simojenki@users.noreply.github.com>",
"license": "GPL-3.0-only", "license": "GPL-3.0-only",
"dependencies": { "dependencies": {
"@svrooij/sonos": "^2.6.0-beta.11", "@svrooij/sonos": "^2.5.0",
"@types/express": "^4.17.21", "@types/express": "^4.17.19",
"@types/fs-extra": "^11.0.4", "@types/fs-extra": "^11.0.2",
"@types/jsonwebtoken": "^9.0.7", "@types/jsonwebtoken": "^9.0.3",
"@types/jws": "^3.2.10", "@types/jws": "^3.2.6",
"@types/morgan": "^1.9.9", "@types/morgan": "^1.9.6",
"@types/node": "^20.11.5", "@types/node": "^16.11.7",
"@types/randomstring": "^1.3.0", "@types/randomstring": "^1.1.9",
"@types/underscore": "^1.13.0", "@types/underscore": "^1.11.11",
"@types/uuid": "^10.0.0", "@types/uuid": "^9.0.5",
"@types/xmldom": "^0.1.34", "@types/xmldom": "0.1.32",
"@xmldom/xmldom": "^0.9.7", "axios": "^1.6.0",
"axios": "^1.7.8", "dayjs": "^1.11.10",
"dayjs": "^1.11.13", "eta": "^2.0.1",
"eta": "^2.2.0", "express": "^4.18.2",
"express": "^4.18.3", "fp-ts": "^2.16.1",
"fp-ts": "^2.16.9", "fs-extra": "^11.1.1",
"fs-extra": "^11.2.0",
"jsonwebtoken": "^9.0.2", "jsonwebtoken": "^9.0.2",
"jws": "^4.0.0", "jws": "^4.0.0",
"libxmljs2": "^0.32.0",
"morgan": "^1.10.0", "morgan": "^1.10.0",
"node-html-parser": "^6.1.13", "node-html-parser": "^6.1.10",
"randomstring": "^1.3.0", "randomstring": "^1.3.0",
"sharp": "^0.33.5", "sharp": "^0.32.6",
"soap": "^1.1.6", "soap": "^1.0.0",
"ts-md5": "^1.3.1", "ts-md5": "^1.3.1",
"typescript": "^5.7.2", "typescript": "^5.2.2",
"underscore": "^1.13.7", "underscore": "^1.13.6",
"urn-lib": "^2.0.0", "urn-lib": "^2.0.0",
"uuid": "^11.0.3", "uuid": "^9.0.1",
"winston": "^3.17.0", "winston": "^3.11.0",
"xmldom-ts": "^0.3.1", "xmldom-ts": "^0.3.1"
"xpath": "^0.0.34"
}, },
"devDependencies": { "devDependencies": {
"@types/chai": "^5.0.1", "@types/chai": "^4.3.7",
"@types/jest": "^29.5.14", "@types/jest": "^29.5.5",
"@types/mocha": "^10.0.10", "@types/mocha": "^10.0.2",
"@types/supertest": "^6.0.2", "@types/supertest": "^2.0.14",
"@types/tmp": "^0.2.6", "@types/tmp": "^0.2.4",
"chai": "^5.1.2", "chai": "^4.3.10",
"get-port": "^7.1.0", "get-port": "^7.0.0",
"image-js": "^0.35.6", "image-js": "^0.35.4",
"jest": "^29.7.0", "jest": "^29.7.0",
"nodemon": "^3.1.7", "nodemon": "^3.0.1",
"supertest": "^7.0.0", "supertest": "^6.3.3",
"tmp": "^0.2.3", "tmp": "^0.2.1",
"ts-jest": "^29.2.5", "ts-jest": "^29.1.1",
"ts-mockito": "^2.6.1", "ts-mockito": "^2.6.1",
"ts-node": "^10.9.2", "ts-node": "^10.9.1",
"xmldom-ts": "^0.3.1",
"xpath-ts": "^1.3.13" "xpath-ts": "^1.3.13"
}, },
"overrides": {
"axios-ntlm": "npm:dry-uninstall",
"axios": "$axios"
},
"scripts": { "scripts": {
"clean": "rm -Rf build node_modules", "clean": "rm -Rf build node_modules",
"build": "tsc", "build": "tsc",
"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", "dev": "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", "devr": "BNB_DISABLE_PLAYLIST_ART=true BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey 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", "register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
"test": "jest", "test": "jest",
"testw": "jest --watch",
"gitinfo": "git describe --tags > .gitinfo" "gitinfo": "git describe --tags > .gitinfo"
} },
"packageManager": "yarn@1.22.19"
} }

26
src/Sonoswsdl-1.19.6-20231024.wsdl → src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
View File

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

22
src/app.ts
View File

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

10
src/burn.ts
View File

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

47
src/encryption.ts
View File

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

10
src/i8n.ts
View File

@@ -9,7 +9,6 @@ export type KEY =
| "AppLinkMessage" | "AppLinkMessage"
| "artists" | "artists"
| "albums" | "albums"
| "internetRadio"
| "playlists" | "playlists"
| "genres" | "genres"
| "random" | "random"
@@ -40,7 +39,6 @@ export type KEY =
| "loginFailed" | "loginFailed"
| "noSonosDevices" | "noSonosDevices"
| "favourites" | "favourites"
| "years"
| "LOVE" | "LOVE"
| "LOVE_SUCCESS" | "LOVE_SUCCESS"
| "STAR" | "STAR"
@@ -53,7 +51,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
AppLinkMessage: "Linking sonos with $BNB_SONOS_SERVICE_NAME", AppLinkMessage: "Linking sonos with $BNB_SONOS_SERVICE_NAME",
artists: "Artists", artists: "Artists",
albums: "Albums", albums: "Albums",
internetRadio: "Internet Radio",
tracks: "Tracks", tracks: "Tracks",
playlists: "Playlists", playlists: "Playlists",
genres: "Genres", genres: "Genres",
@@ -84,7 +81,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Login failed!", loginFailed: "Login failed!",
noSonosDevices: "No sonos devices", noSonosDevices: "No sonos devices",
favourites: "Favourites", favourites: "Favourites",
years: "Years",
STAR: "Star", STAR: "Star",
UNSTAR: "Un-star", UNSTAR: "Un-star",
STAR_SUCCESS: "Track starred", STAR_SUCCESS: "Track starred",
@@ -96,7 +92,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME", AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
artists: "Kunstnere", artists: "Kunstnere",
albums: "Album", albums: "Album",
internetRadio: "Internet Radio",
tracks: "Numre", tracks: "Numre",
playlists: "Afspilningslister", playlists: "Afspilningslister",
genres: "Genre", genres: "Genre",
@@ -127,7 +122,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Log på fejlede!", loginFailed: "Log på fejlede!",
noSonosDevices: "Ingen Sonos enheder", noSonosDevices: "Ingen Sonos enheder",
favourites: "Favoritter", favourites: "Favoritter",
years: "Flere år",
STAR: "Tilføj stjerne", STAR: "Tilføj stjerne",
UNSTAR: "Fjern stjerne", UNSTAR: "Fjern stjerne",
STAR_SUCCESS: "Stjerne tilføjet", STAR_SUCCESS: "Stjerne tilføjet",
@@ -139,7 +133,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME", AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
artists: "Artistes", artists: "Artistes",
albums: "Albums", albums: "Albums",
internetRadio: "Radio Internet",
tracks: "Pistes", tracks: "Pistes",
playlists: "Playlists", playlists: "Playlists",
genres: "Genres", genres: "Genres",
@@ -170,7 +163,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "La connexion a échoué !", loginFailed: "La connexion a échoué !",
noSonosDevices: "Aucun appareil Sonos", noSonosDevices: "Aucun appareil Sonos",
favourites: "Favoris", favourites: "Favoris",
years: "Années",
STAR: "Suivre", STAR: "Suivre",
UNSTAR: "Ne plus suivre", UNSTAR: "Ne plus suivre",
STAR_SUCCESS: "Piste suivie", STAR_SUCCESS: "Piste suivie",
@@ -182,7 +174,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
AppLinkMessage: "Sonos koppelen aan $BNB_SONOS_SERVICE_NAME", AppLinkMessage: "Sonos koppelen aan $BNB_SONOS_SERVICE_NAME",
artists: "Artiesten", artists: "Artiesten",
albums: "Albums", albums: "Albums",
internetRadio: "Internet Radio",
tracks: "Nummers", tracks: "Nummers",
playlists: "Afspeellijsten", playlists: "Afspeellijsten",
genres: "Genres", genres: "Genres",
@@ -213,7 +204,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Inloggen mislukt!", loginFailed: "Inloggen mislukt!",
noSonosDevices: "Geen Sonos-apparaten", noSonosDevices: "Geen Sonos-apparaten",
favourites: "Favorieten", favourites: "Favorieten",
years: "Jaren",
STAR: "Ster ", STAR: "Ster ",
UNSTAR: "Een ster", UNSTAR: "Een ster",
STAR_SUCCESS: "Nummer met ster", STAR_SUCCESS: "Nummer met ster",

96
src/icon.ts
View File

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

61
src/music_library.ts → src/music_service.ts
View File

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

82
src/server.ts
View File

@@ -22,7 +22,7 @@ import {
ratingAsInt, ratingAsInt,
} from "./smapi"; } from "./smapi";
import { LinkCodes, InMemoryLinkCodes } from "./link_codes"; import { LinkCodes, InMemoryLinkCodes } from "./link_codes";
import { MusicService, AuthFailure, AuthSuccess } from "./music_library"; import { MusicService, AuthFailure, AuthSuccess } from "./music_service";
import bindSmapiSoapServiceToExpress from "./smapi"; import bindSmapiSoapServiceToExpress from "./smapi";
import { APITokens, InMemoryAPITokens } from "./api_tokens"; import { APITokens, InMemoryAPITokens } from "./api_tokens";
import logger from "./logger"; import logger from "./logger";
@@ -31,8 +31,9 @@ import { pipe } from "fp-ts/lib/function";
import { URLBuilder } from "./url_builder"; import { URLBuilder } from "./url_builder";
import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n"; import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
import { Icon, ICONS, festivals, features } from "./icon"; import { Icon, ICONS, festivals, features } from "./icon";
import _ from "underscore"; import _, { shuffle } from "underscore";
import morgan from "morgan"; import morgan from "morgan";
import { takeWithRepeats } from "./utils";
import { parse } from "./burn"; import { parse } from "./burn";
import { axiosImageFetcher, ImageFetcher } from "./subsonic"; import { axiosImageFetcher, ImageFetcher } from "./subsonic";
import { import {
@@ -498,18 +499,16 @@ function server(
} }
}); });
app.get("/icon/:type_text/size/:size", (req, res) => { app.get("/icon/:type/size/:size", (req, res) => {
const match = (req.params["type_text"] || "")!.match("^([A-Za-z0-9]+)(?:\:([A-Za-z0-9]+))?$") const type = req.params["type"]!;
if (!match)
return res.status(400).send();
const type = match[1]!
const text = match[2]
const size = req.params["size"]!; const size = req.params["size"]!;
if (!Object.keys(ICONS).includes(type)) { if (!Object.keys(ICONS).includes(type)) {
return res.status(404).send(); 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(); return res.status(400).send();
} else { } else {
let icon = (ICONS as any)[type]! as Icon; let icon = (ICONS as any)[type]! as Icon;
@@ -530,8 +529,8 @@ function server(
icon icon
.apply( .apply(
features({ features({
viewPortIncreasePercent: 80,
...serverOpts.iconColors, ...serverOpts.iconColors,
text: text
}) })
) )
.apply(festivals(clock)) .apply(festivals(clock))
@@ -559,11 +558,23 @@ function server(
}); });
}); });
app.get("/art/:burn/size/:size", (req, res) => { const GRAVITY_9 = [
"north",
"northeast",
"east",
"southeast",
"south",
"southwest",
"west",
"northwest",
"centre",
];
app.get("/art/:burns/size/:size", (req, res) => {
const serviceToken = apiTokens.authTokenFor( const serviceToken = apiTokens.authTokenFor(
req.query[BONOB_ACCESS_TOKEN_HEADER] as string req.query[BONOB_ACCESS_TOKEN_HEADER] as string
); );
const urn = parse(req.params["burn"]!); const urns = req.params["burns"]!.split("&").map(parse);
const size = Number.parseInt(req.params["size"]!); const size = Number.parseInt(req.params["size"]!);
if (!serviceToken) { if (!serviceToken) {
@@ -574,24 +585,55 @@ function server(
return musicService return musicService
.login(serviceToken) .login(serviceToken)
.then((musicLibrary) => { .then((musicLibrary) =>
if (urn.system == "external") { Promise.all(
return serverOpts.externalImageResolver(urn.resource); urns.map((it) => {
if (it.system == "external") {
return serverOpts.externalImageResolver(it.resource);
} else { } else {
return musicLibrary.coverArt(urn, size); return musicLibrary.coverArt(it, size);
} }
}) })
.then((coverArt) => { )
if(coverArt) { )
.then((coverArts) => coverArts.filter((it) => it))
.then(shuffle)
.then((coverArts) => {
if (coverArts.length == 1) {
const coverArt = coverArts[0]!;
res.status(200); res.status(200);
res.setHeader("content-type", coverArt.contentType); res.setHeader("content-type", coverArt.contentType);
return res.send(coverArt.data); 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 { } else {
return res.status(404).send(); return res.status(404).send();
} }
}) })
.catch((e: Error) => { .catch((e: Error) => {
logger.error(`Failed fetching image ${urn}/size/${size}`, { logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, {
cause: e, cause: e,
}); });
return res.status(500).send(); return res.status(500).send();

184
src/smapi.ts
View File

@@ -10,24 +10,23 @@ import logger from "./logger";
import { LinkCodes } from "./link_codes"; import { LinkCodes } from "./link_codes";
import { import {
Album,
AlbumQuery, AlbumQuery,
AlbumSummary, AlbumSummary,
ArtistSummary, ArtistSummary,
Genre, Genre,
Year,
MusicService, MusicService,
Playlist, Playlist,
RadioStation,
Rating, Rating,
slice2, slice2,
Track, Track,
} from "./music_library"; } from "./music_service";
import { APITokens } from "./api_tokens"; import { APITokens } from "./api_tokens";
import { Clock } from "./clock"; import { Clock } from "./clock";
import { URLBuilder } from "./url_builder"; import { URLBuilder } from "./url_builder";
import { asLANGs, I8N } from "./i8n"; import { asLANGs, I8N } from "./i8n";
import { ICON, iconForGenre } from "./icon"; import { ICON, iconForGenre } from "./icon";
import _ from "underscore"; import _, { uniq } from "underscore";
import { BUrn, formatForURL } from "./burn"; import { BUrn, formatForURL } from "./burn";
import { import {
isExpiredTokenError, isExpiredTokenError,
@@ -61,7 +60,7 @@ export const SONOS_RECOMMENDED_IMAGE_SIZES = [
const WSDL_FILE = path.resolve( const WSDL_FILE = path.resolve(
__dirname, __dirname,
"Sonoswsdl-1.19.6-20231024.wsdl" "Sonoswsdl-1.19.4-20190411.142401-3.wsdl"
); );
export type Credentials = { export type Credentials = {
@@ -244,25 +243,17 @@ export type Container = {
}; };
const genre = (bonobUrl: URLBuilder, genre: Genre) => ({ const genre = (bonobUrl: URLBuilder, genre: Genre) => ({
itemType: "albumList", itemType: "container",
id: `genre:${genre.id}`, id: `genre:${genre.id}`,
title: genre.name, title: genre.name,
albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(), 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) => ({ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: coverArtURI(bonobUrl, playlist).href(), albumArtURI: playlistAlbumArtURL(bonobUrl, playlist).href(),
canPlay: true, canPlay: true,
attributes: { attributes: {
readOnly: false, readOnly: false,
@@ -271,9 +262,32 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
}, },
}); });
export const coverArtURI = ( export const playlistAlbumArtURL = (
bonobUrl: URLBuilder, bonobUrl: URLBuilder,
{ coverArt }: { coverArt?: BUrn | undefined } playlist: Playlist
) => {
// todo: this should be put into config, or even just removed for the ND music source
if(process.env["BNB_DISABLE_PLAYLIST_ART"]) return iconArtURI(bonobUrl, "music");
const burns: BUrn[] = uniq(
playlist.entries.filter((it) => it.coverArt != undefined),
(it) => it.album.id
).map((it) => it.coverArt!);
if (burns.length == 0) {
return iconArtURI(bonobUrl, "error");
} else {
return bonobUrl.append({
pathname: `/art/${burns
.slice(0, 9)
.map((it) => encodeURIComponent(formatForURL(it)))
.join("&")}/size/180`,
});
}
};
export const defaultAlbumArtURI = (
bonobUrl: URLBuilder,
{ coverArt }: { coverArt: BUrn | undefined }
) => ) =>
pipe( pipe(
coverArt, coverArt,
@@ -286,11 +300,26 @@ export const coverArtURI = (
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl")) O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
); );
export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON, text: string | undefined = undefined) => export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
bonobUrl.append({ bonobUrl.append({
pathname: `/icon/${text == undefined ? icon : `${icon}:${text}`}/size/legacy`, pathname: `/icon/${icon}/size/legacy`,
}); });
export const defaultArtistArtURI = (
bonobUrl: URLBuilder,
artist: ArtistSummary
) =>
pipe(
artist.image,
O.fromNullable,
O.map((it) =>
bonobUrl.append({
pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
})
),
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
);
export const sonosifyMimeType = (mimeType: string) => export const sonosifyMimeType = (mimeType: string) =>
mimeType == "audio/x-flac" ? "audio/flac" : mimeType; mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
@@ -300,7 +329,7 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
artist: album.artistName, artist: album.artistName,
artistId: `artist:${album.artistId}`, artistId: `artist:${album.artistId}`,
title: album.name, title: album.name,
albumArtURI: coverArtURI(bonobUrl, album).href(), albumArtURI: defaultAlbumArtURI(bonobUrl, album).href(),
canPlay: true, canPlay: true,
// defaults // defaults
// canScroll: false, // canScroll: false,
@@ -308,17 +337,10 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
// canAddToFavorites: true // 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) => ({ export const track = (bonobUrl: URLBuilder, track: Track) => ({
itemType: "track", itemType: "track",
id: `track:${track.id}`, id: `track:${track.id}`,
mimeType: sonosifyMimeType(track.encoding.mimeType), mimeType: sonosifyMimeType(track.mimeType),
title: track.name, title: track.name,
trackMetadata: { trackMetadata: {
@@ -326,7 +348,7 @@ export const track = (bonobUrl: URLBuilder, track: Track) => ({
albumId: `album:${track.album.id}`, albumId: `album:${track.album.id}`,
albumArtist: track.artist.name, albumArtist: track.artist.name,
albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined, albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
albumArtURI: coverArtURI(bonobUrl, track).href(), albumArtURI: defaultAlbumArtURI(bonobUrl, track).href(),
artist: track.artist.name, artist: track.artist.name,
artistId: track.artist.id ? `artist:${track.artist.id}` : undefined, artistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
duration: track.duration, duration: track.duration,
@@ -344,7 +366,7 @@ export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
id: `artist:${artist.id}`, id: `artist:${artist.id}`,
artistId: artist.id, artistId: artist.id,
title: artist.name, title: artist.name,
albumArtURI: coverArtURI(bonobUrl, { coverArt: artist.image }).href(), albumArtURI: defaultArtistArtURI(bonobUrl, artist).href(),
}); });
function splitId<T>(id: string) { function splitId<T>(id: string) {
@@ -442,7 +464,9 @@ function bindSmapiSoapServiceToExpress(
}, },
}, },
})), })),
TE.getOrElse(() => T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED)) TE.getOrElse(() =>
T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED)
)
)(); )();
} else { } else {
throw authOrFail.toSmapiFault(); throw authOrFail.toSmapiFault();
@@ -501,14 +525,7 @@ function bindSmapiSoapServiceToExpress(
) => ) =>
login(soapyHeaders?.credentials) login(soapyHeaders?.credentials)
.then(splitId(id)) .then(splitId(id))
.then(({ musicLibrary, credentials, type, typeId }) => { .then(({ credentials, type, typeId }) => ({
switch (type) {
case "internetRadioStation":
return musicLibrary.radioStation(typeId).then((it) => ({
getMediaURIResult: it.url,
}));
case "track":
return {
getMediaURIResult: bonobUrl getMediaURIResult: bonobUrl
.append({ .append({
pathname: `/stream/${type}/${typeId}`, pathname: `/stream/${type}/${typeId}`,
@@ -528,11 +545,7 @@ function bindSmapiSoapServiceToExpress(
}, },
}, },
], ],
}; })),
default:
throw `Unsupported type:${type}`;
}
}),
getMediaMetadata: async ( getMediaMetadata: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
@@ -540,20 +553,11 @@ function bindSmapiSoapServiceToExpress(
) => ) =>
login(soapyHeaders?.credentials) login(soapyHeaders?.credentials)
.then(splitId(id)) .then(splitId(id))
.then(async ({ musicLibrary, apiKey, type, typeId }) => { .then(async ({ musicLibrary, apiKey, typeId }) =>
switch (type) { musicLibrary.track(typeId!).then((it) => ({
case "internetRadioStation":
return musicLibrary.radioStation(typeId).then((it) => ({
getMediaMetadataResult: internetRadioStation(it),
}));
case "track":
return musicLibrary.track(typeId!).then((it) => ({
getMediaMetadataResult: track(urlWithToken(apiKey), it), getMediaMetadataResult: track(urlWithToken(apiKey), it),
})); }))
default: ),
throw `Unsupported type:${type}`;
}
}),
search: async ( search: async (
{ id, term }: { id: string; term: string }, { id, term }: { id: string; term: string },
_, _,
@@ -611,7 +615,7 @@ function bindSmapiSoapServiceToExpress(
switch (type) { switch (type) {
case "artist": case "artist":
return musicLibrary.artist(typeId).then((artist) => { return musicLibrary.artist(typeId).then((artist) => {
const [page, total] = slice2<AlbumSummary>(paging)( const [page, total] = slice2<Album>(paging)(
artist.albums artist.albums
); );
return { return {
@@ -748,12 +752,6 @@ function bindSmapiSoapServiceToExpress(
albumArtURI: iconArtURI(bonobUrl, "genres").href(), albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container", itemType: "container",
}, },
{
id: "years",
title: lang("years"),
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{ {
id: "recentlyAdded", id: "recentlyAdded",
title: lang("recentlyAdded"), title: lang("recentlyAdded"),
@@ -781,12 +779,6 @@ function bindSmapiSoapServiceToExpress(
).href(), ).href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: lang("internetRadio"),
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
], ],
}); });
case "search": case "search":
@@ -831,13 +823,6 @@ function bindSmapiSoapServiceToExpress(
genre: typeId, genre: typeId,
...paging, ...paging,
}); });
case "year":
return albums({
type: "byYear",
fromYear: typeId,
toYear: typeId,
...paging,
});
case "randomAlbums": case "randomAlbums":
return albums({ return albums({
type: "random", type: "random",
@@ -868,32 +853,6 @@ function bindSmapiSoapServiceToExpress(
type: "mostPlayed", type: "mostPlayed",
...paging, ...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": case "genres":
return musicLibrary return musicLibrary
.genres() .genres()
@@ -913,15 +872,13 @@ function bindSmapiSoapServiceToExpress(
.then((it) => .then((it) =>
Promise.all( Promise.all(
it.map((playlist) => { it.map((playlist) => {
// todo: whats this odd copy all about, can we just delete it?
return { return {
id: playlist.id, id: playlist.id,
name: playlist.name, name: playlist.name,
coverArt: playlist.coverArt, entries: []
// todo: are these every important?
entries: [],
}; };
}) }
)
) )
) )
.then(slice2(paging)) .then(slice2(paging))
@@ -953,15 +910,15 @@ function bindSmapiSoapServiceToExpress(
.artist(typeId!) .artist(typeId!)
.then((artist) => artist.albums) .then((artist) => artist.albums)
.then(slice2(paging)) .then(slice2(paging))
.then(([page, total]) => .then(([page, total]) => {
getMetadataResult({ return getMetadataResult({
mediaCollection: page.map((it) => mediaCollection: page.map((it) =>
album(urlWithToken(apiKey), it) album(urlWithToken(apiKey), it)
), ),
index: paging._index, index: paging._index,
total, total,
}) });
); });
case "relatedArtists": case "relatedArtists":
return musicLibrary return musicLibrary
.artist(typeId!) .artist(typeId!)
@@ -981,8 +938,7 @@ function bindSmapiSoapServiceToExpress(
}); });
case "album": case "album":
return musicLibrary return musicLibrary
.album(typeId!) .tracks(typeId!)
.then(it => it.tracks)
.then(slice2(paging)) .then(slice2(paging))
.then(([page, total]) => { .then(([page, total]) => {
return getMetadataResult({ return getMetadataResult({

2
src/sonos.ts
View File

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

631
src/subsonic.ts
View File

@@ -5,18 +5,22 @@ import { pipe } from "fp-ts/lib/function";
import { Md5 } from "ts-md5"; import { Md5 } from "ts-md5";
import { import {
Credentials, Credentials,
MusicService,
Album, Album,
Result,
slice2,
AlbumQuery, AlbumQuery,
ArtistQuery,
MusicLibrary,
AlbumSummary, AlbumSummary,
Genre, Genre,
Track, Track,
CoverArt, CoverArt,
Rating,
AlbumQueryType, AlbumQueryType,
Encoding, Artist,
albumToAlbumSummary, AuthFailure,
TrackSummary, } from "./music_service";
AuthFailure
} from "./music_library";
import sharp from "sharp"; import sharp from "sharp";
import _ from "underscore"; import _ from "underscore";
import fse from "fs-extra"; import fse from "fs-extra";
@@ -25,8 +29,9 @@ import path from "path";
import axios, { AxiosRequestConfig } from "axios"; import axios, { AxiosRequestConfig } from "axios";
import randomstring from "randomstring"; import randomstring from "randomstring";
import { b64Encode, b64Decode } from "./b64"; import { b64Encode, b64Decode } from "./b64";
import { BUrn } from "./burn"; import logger from "./logger";
import { album, artist } from "./smapi"; import { assertSystem, BUrn } from "./burn";
import { artist } from "./smapi";
import { URLBuilder } from "./url_builder"; import { URLBuilder } from "./url_builder";
export const BROWSER_HEADERS = { export const BROWSER_HEADERS = {
@@ -101,7 +106,7 @@ type genre = {
value: string; value: string;
}; };
export type GetGenresResponse = SubsonicResponse & { type GetGenresResponse = SubsonicResponse & {
genres: { genres: {
genre: genre[]; genre: genre[];
}; };
@@ -157,74 +162,48 @@ export type song = {
duration: number | undefined; duration: number | undefined;
bitRate: number | undefined; bitRate: number | undefined;
suffix: string | undefined; suffix: string | undefined;
contentType: string; contentType: string | undefined;
transcodedContentType: string | undefined;
type: string | undefined; type: string | undefined;
userRating: number | undefined; userRating: number | undefined;
// todo: this field shouldnt be on song?
starred: string | undefined; starred: string | undefined;
}; };
export type GetAlbumResponse = { type GetAlbumResponse = {
album: album & { album: album & {
song: song[]; song: song[];
}; };
}; };
export type GetPlaylistResponse = { type playlist = {
// todo: isnt the type here a composite? playlistSummary && { entry: song[]; } id: string;
name: string;
};
type GetPlaylistResponse = {
playlist: { playlist: {
id: string; id: string;
name: string; name: string;
entry: song[]; entry: song[];
// todo: this is an ND specific field?
coverArt: string | undefined;
}; };
}; };
export type GetPlaylistsResponse = { type GetPlaylistsResponse = {
playlists: { playlists: { playlist: playlist[] };
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;
}[]
};
}; };
export type GetSimilarSongsResponse = { type GetSimilarSongsResponse = {
similarSongs2: { song: song[] }; similarSongs2: { song: song[] };
}; };
export type GetTopSongsResponse = { type GetTopSongsResponse = {
topSongs: { song: song[] }; topSongs: { song: song[] };
}; };
export type GetInternetRadioStationsResponse = { type GetSongResponse = {
internetRadioStations: {
internetRadioStation: {
id: string;
name: string;
streamUrl: string;
homePageUrl?: string;
}[];
};
};
export type GetSongResponse = {
song: song; song: song;
}; };
export type GetStarredResponse = { type GetStarredResponse = {
starred2: { starred2: {
song: song[]; song: song[];
album: album[]; album: album[];
@@ -238,7 +217,7 @@ export type PingResponse = {
serverVersion: string; serverVersion: string;
}; };
export type Search3Response = SubsonicResponse & { type Search3Response = SubsonicResponse & {
searchResult3: { searchResult3: {
artist: artist[]; artist: artist[];
album: album[]; album: album[];
@@ -252,12 +231,12 @@ export function isError(
return (subsonicResponse as SubsonicError).error !== undefined; return (subsonicResponse as SubsonicError).error !== undefined;
} }
export type IdName = { type IdName = {
id: string; id: string;
name: string; name: string;
}; };
export const coverArtURN = (coverArt: string | undefined): BUrn | undefined => const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
pipe( pipe(
coverArt, coverArt,
O.fromNullable, O.fromNullable,
@@ -291,25 +270,15 @@ export const artistImageURN = (
} }
}; };
export const asTrackSummary = ( export const asTrack = (album: Album, song: song): Track => ({
song: song,
customPlayers: CustomPlayers
): TrackSummary => ({
id: song.id, id: song.id,
name: song.title, name: song.title,
encoding: pipe( mimeType: song.contentType!,
customPlayers.encodingFor({ mimeType: song.contentType }),
O.getOrElse(() => ({
player: DEFAULT_CLIENT_APPLICATION,
mimeType: song.transcodedContentType
? song.transcodedContentType
: song.contentType,
}))
),
duration: song.duration || 0, duration: song.duration || 0,
number: song.track || 0, number: song.track || 0,
genre: maybeAsGenre(song.genre), genre: maybeAsGenre(song.genre),
coverArt: coverArtURN(song.coverArt), coverArt: coverArtURN(song.coverArt),
album,
artist: { artist: {
id: song.artistId, id: song.artistId,
name: song.artist ? song.artist : "?", name: song.artist ? song.artist : "?",
@@ -326,16 +295,7 @@ export const asTrackSummary = (
}, },
}); });
export const asTrack = ( const asAlbum = (album: album): Album => ({
album: AlbumSummary,
song: song,
customPlayers: CustomPlayers
): Track => ({
...asTrackSummary(song, customPlayers),
album: album,
});
export const asAlbumSummary = (album: album): AlbumSummary => ({
id: album.id, id: album.id,
name: album.name, name: album.name,
year: album.year, year: album.year,
@@ -350,9 +310,7 @@ export const asGenre = (genreName: string) => ({
name: genreName, name: genreName,
}); });
export const maybeAsGenre = ( const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
genreName: string | undefined
): Genre | undefined =>
pipe( pipe(
genreName, genreName,
O.fromNullable, O.fromNullable,
@@ -360,58 +318,19 @@ export const maybeAsGenre = (
O.getOrElseW(() => undefined) O.getOrElseW(() => undefined)
); );
export const asYear = (year: string) => ({ export type StreamClientApplication = (track: Track) => string;
year: year,
});
export interface CustomPlayers { const DEFAULT_CLIENT_APPLICATION = "bonob";
encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>; 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 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) => { export const asURLSearchParams = (q: any) => {
const urlSearchParams = new URLSearchParams(); const urlSearchParams = new URLSearchParams();
Object.keys(q).forEach((k) => { Object.keys(q).forEach((k) => {
@@ -425,7 +344,7 @@ export const asURLSearchParams = (q: any) => {
export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>; export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
export const cachingImageFetcher = export const cachingImageFetcher =
(cacheDir: string, delegate: ImageFetcher, makeSharp = sharp) => (cacheDir: string, delegate: ImageFetcher) =>
async (url: string): Promise<CoverArt | undefined> => { async (url: string): Promise<CoverArt | undefined> => {
const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`); const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
return fse return fse
@@ -434,7 +353,7 @@ export const cachingImageFetcher =
.catch(() => .catch(() =>
delegate(url).then((image) => { delegate(url).then((image) => {
if (image) { if (image) {
return makeSharp(image.data) return sharp(image.data)
.png() .png()
.toBuffer() .toBuffer()
.then((png) => { .then((png) => {
@@ -465,7 +384,6 @@ const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
alphabeticalByArtist: "alphabeticalByArtist", alphabeticalByArtist: "alphabeticalByArtist",
alphabeticalByName: "alphabeticalByName", alphabeticalByName: "alphabeticalByName",
byGenre: "byGenre", byGenre: "byGenre",
byYear: "byYear",
random: "random", random: "random",
recentlyPlayed: "recent", recentlyPlayed: "recent",
mostPlayed: "frequent", mostPlayed: "frequent",
@@ -484,26 +402,32 @@ type SubsonicCredentials = Credentials & {
export const asToken = (credentials: SubsonicCredentials) => export const asToken = (credentials: SubsonicCredentials) =>
b64Encode(JSON.stringify(credentials)); b64Encode(JSON.stringify(credentials));
export const parseToken = (token: string): SubsonicCredentials => export const parseToken = (token: string): SubsonicCredentials =>
JSON.parse(b64Decode(token)); JSON.parse(b64Decode(token));
export class Subsonic { interface SubsonicMusicLibrary extends MusicLibrary {
flavour(): string;
bearerToken(
credentials: Credentials
): TE.TaskEither<Error, string | undefined>;
}
export class Subsonic implements MusicService {
url: URLBuilder; url: URLBuilder;
customPlayers: CustomPlayers; streamClientApplication: StreamClientApplication;
externalImageFetcher: ImageFetcher; externalImageFetcher: ImageFetcher;
constructor( constructor(
url: URLBuilder, url: URLBuilder,
customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS, streamClientApplication: StreamClientApplication = DEFAULT,
externalImageFetcher: ImageFetcher = axiosImageFetcher externalImageFetcher: ImageFetcher = axiosImageFetcher
) { ) {
this.url = url; this.url = url;
this.customPlayers = customPlayers; this.streamClientApplication = streamClientApplication;
this.externalImageFetcher = externalImageFetcher; this.externalImageFetcher = externalImageFetcher;
} }
private get = async ( get = async (
{ username, password }: Credentials, { username, password }: Credentials,
path: string, path: string,
q: {} = {}, q: {} = {},
@@ -532,9 +456,7 @@ export class Subsonic {
} else return response; } else return response;
}); });
// todo: should I put a catch in here and force a subsonic fail status? getJSON = async <T>(
// or there is a catch above, that then throws, perhaps can go in there?
private getJSON = async <T>(
{ username, password }: Credentials, { username, password }: Credentials,
path: string, path: string,
q: {} = {} q: {} = {}
@@ -547,16 +469,40 @@ export class Subsonic {
else return json as unknown as T; else return json as unknown as T;
}); });
ping = (credentials: Credentials): TE.TaskEither<AuthFailure, { authenticated: Boolean, type: string}> => generateToken = (credentials: Credentials) =>
pipe(
TE.tryCatch( TE.tryCatch(
() => this.getJSON<PingResponse>(credentials, "/rest/ping.view") () =>
.then(it => ({ this.getJSON<PingResponse>(
authenticated: it.status == "ok", _.pick(credentials, "username", "password"),
type: it.type "/rest/ping.view"
})), ),
(e) => new AuthFailure(e as string) (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));
getArtists = ( getArtists = (
credentials: Credentials credentials: Credentials
@@ -575,7 +521,6 @@ export class Subsonic {
})) }))
); );
// todo: should be getArtistInfo2?
getArtistInfo = ( getArtistInfo = (
credentials: Credentials, credentials: Credentials,
id: string id: string
@@ -599,42 +544,29 @@ export class Subsonic {
m: it.mediumImageUrl, m: it.mediumImageUrl,
l: it.largeImageUrl, l: it.largeImageUrl,
}, },
//todo: this does seem to be in OpenSubsonic?? it is also singular
similarArtist: (it.similarArtist || []).map((artist) => ({ similarArtist: (it.similarArtist || []).map((artist) => ({
id: `${artist.id}`, id: `${artist.id}`,
name: artist.name, name: artist.name,
// todo: whats this inLibrary used for? it probably should be filtered on??
inLibrary: artistIsInLibrary(artist.id), inLibrary: artistIsInLibrary(artist.id),
image: artistImageURN({ image: artistImageURN({
artistId: artist.id, artistId: artist.id,
artistImageURL: artist.artistImageUrl, artistImageURL: artist.artistImageUrl,
}), }),
})), })),
}) }));
);
getAlbum = (credentials: Credentials, id: string): Promise<Album> => getAlbum = (credentials: Credentials, id: string): Promise<Album> =>
this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id }) this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id })
.then((it) => it.album) .then((it) => it.album)
.then((album) => { .then((album) => ({
const x: AlbumSummary = {
id: album.id, id: album.id,
name: album.name, name: album.name,
year: album.year, year: album.year,
genre: maybeAsGenre(album.genre), genre: maybeAsGenre(album.genre),
artistId: album.artistId, artistId: album.artistId,
artistName: album.artist, artistName: album.artist,
coverArt: coverArtURN(album.coverArt) 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 = ( getArtist = (
credentials: Credentials, credentials: Credentials,
@@ -653,6 +585,26 @@ export class Subsonic {
albums: this.toAlbumSummary(it.album || []), 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) => getCoverArt = (credentials: Credentials, id: string, size?: number) =>
this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, { this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, {
headers: { "User-Agent": "bonob" }, headers: { "User-Agent": "bonob" },
@@ -666,7 +618,7 @@ export class Subsonic {
.then((it) => it.song) .then((it) => it.song)
.then((song) => .then((song) =>
this.getAlbum(credentials, song.albumId!).then((album) => this.getAlbum(credentials, song.albumId!).then((album) =>
asTrack(albumToAlbumSummary(album), song, this.customPlayers) asTrack(album, song)
) )
); );
@@ -706,8 +658,6 @@ export class Subsonic {
this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", { this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
type: AlbumQueryTypeToSubsonicType[q.type], type: AlbumQueryTypeToSubsonicType[q.type],
...(q.genre ? { genre: b64Decode(q.genre) } : {}), ...(q.genre ? { genre: b64Decode(q.genre) } : {}),
...(q.fromYear ? { fromYear: q.fromYear } : {}),
...(q.toYear ? { toYear: q.toYear } : {}),
size: 500, size: 500,
offset: q._index, offset: q._index,
}) })
@@ -718,50 +668,111 @@ export class Subsonic {
total: albums.length == 500 ? total : q._index + albums.length, total: albums.length == 500 ? total : q._index + albums.length,
})); }));
getGenres = (credentials: Credentials) => // getStarred2 = (credentials: Credentials): Promise<{ albums: Album[] }> =>
this.getJSON<GetGenresResponse>(credentials, "/rest/getGenres").then((it) => // this.getJSON<GetStarredResponse>(credentials, "/rest/getStarred2")
// .then((it) => it.starred2)
// .then((it) => ({
// albums: it.album.map(asAlbum),
// }));
login = async (token: string) => this.libraryFor(parseToken(token));
private libraryFor = (
credentials: Credentials & { type: string }
): Promise<SubsonicMusicLibrary> => {
const subsonic = this;
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,
})),
})),
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( pipe(
it.genres.genre || [], it.genres.genre || [],
A.filter((it) => it.albumCount > 0), A.filter((it) => it.albumCount > 0),
A.map((it) => it.value), A.map((it) => it.value),
A.sort(ordString), A.sort(ordString),
A.map(maybeAsGenre), A.map((it) => ({ id: b64Encode(it), name: it }))
A.filter((it) => it != undefined) )
),
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,
}
) )
); );
}
private st4r = (credentials: Credentials, action: string, { id } : { id: string }) => if (track.rating.stars != rating.stars) {
this.getJSON<SubsonicResponse>(credentials, `/rest/${action}`, { id }).then(it => thingsToUpdate.push(
it.status == "ok" subsonic.getJSON(credentials, `/rest/setRating`, {
id: trackId,
rating: rating.stars,
})
); );
}
star = (credentials: Credentials, ids : { id: string }) => return Promise.all(thingsToUpdate);
this.st4r(credentials, "star", ids)
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"); .then(() => true)
.catch(() => false),
scrobble = (credentials: Credentials, id: string, submission: boolean) => stream: async ({
this.getJSON<SubsonicResponse>(credentials, `/rest/scrobble`, { trackId,
id, range,
submission, }: {
}) trackId: string;
.then(it => it.status == "ok") range: string | undefined;
}) =>
stream = (credentials: Credentials, id: string, c: string, range: string | undefined) => subsonic.getTrack(credentials, trackId).then((track) =>
this.get( subsonic
.get(
credentials, credentials,
`/rest/stream`, `/rest/stream`,
{ {
id, id: trackId,
c, c: this.streamClientApplication(track),
}, },
{ {
headers: pipe( headers: pipe(
@@ -778,36 +789,91 @@ export class Subsonic {
responseType: "stream", responseType: "stream",
} }
) )
.then((stream) => ({ .then((res) => ({
status: stream.status, status: res.status,
headers: { headers: {
"content-type": stream.headers["content-type"], "content-type": res.headers["content-type"],
"content-length": stream.headers["content-length"], "content-length": res.headers["content-length"],
"content-range": stream.headers["content-range"], "content-range": res.headers["content-range"],
"accept-ranges": stream.headers["accept-ranges"], "accept-ranges": res.headers["accept-ranges"],
}, },
stream: stream.data, stream: res.data,
}));
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),
})) }))
),
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"),
}))
.catch((e) => {
logger.error(
`Failed getting coverArt for urn:'${coverArtURN}': ${e}`
); );
return undefined;
playlist = (credentials: Credentials, id: string) => }),
this.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", { 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, id,
}) })
.then(({ playlist }) => { .then((it) => it.playlist)
.then((playlist) => {
let trackNumber = 1; let trackNumber = 1;
return { return {
id: playlist.id, id: playlist.id,
name: playlist.name, name: playlist.name,
coverArt: coverArtURN(playlist.coverArt),
entries: (playlist.entry || []).map((entry) => ({ entries: (playlist.entry || []).map((entry) => ({
...asTrack( ...asTrack(
{ {
@@ -819,75 +885,96 @@ export class Subsonic {
artistId: entry.artistId, artistId: entry.artistId,
coverArt: coverArtURN(entry.coverArt), coverArt: coverArtURN(entry.coverArt),
}, },
entry, entry
this.customPlayers
), ),
number: trackNumber++, number: trackNumber++,
})), })),
}; };
}); }),
createPlaylist: async (name: string) =>
createPlayList = (credentials: Credentials, name: string) => subsonic
this.getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", { .getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
name, name,
}) })
.then(({ playlist }) => ({ .then((it) => it.playlist)
id: playlist.id, .then((it) => ({ id: it.id, name: it.name })),
name: playlist.name, deletePlaylist: async (id: string) =>
coverArt: coverArtURN(playlist.coverArt), subsonic
})); .getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
deletePlayList = (credentials: Credentials, id: string) =>
this.getJSON<SubsonicResponse>(credentials, "/rest/deletePlaylist", {
id, id,
}) })
.then(it => it.status == "ok"); .then((_) => true),
addToPlaylist: async (playlistId: string, trackId: string) =>
updatePlaylist = ( subsonic
credentials: Credentials, .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
playlistId: string,
changes : Partial<{ songIdToAdd: string | undefined, songIndexToRemove: number[] | undefined }> = {}
) =>
this.getJSON<SubsonicResponse>(credentials, "/rest/updatePlaylist", {
playlistId, playlistId,
...changes songIdToAdd: trackId,
}) })
.then(it => it.status == "ok"); .then((_) => true),
removeFromPlaylist: async (playlistId: string, indicies: number[]) =>
getSimilarSongs2 = (credentials: Credentials, id: string) => subsonic
this.getJSON<GetSimilarSongsResponse>( .getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", {
playlistId,
songIndexToRemove: indicies,
})
.then((_) => true),
similarSongs: async (id: string) =>
subsonic
.getJSON<GetSimilarSongsResponse>(
credentials, credentials,
"/rest/getSimilarSongs2", "/rest/getSimilarSongs2",
//todo: remove this hard coded 50?
{ id, count: 50 } { id, count: 50 }
) )
.then((it) => .then((it) => it.similarSongs2.song || [])
(it.similarSongs2.song || []).map(it => asTrackSummary(it, this.customPlayers)) .then((songs) =>
); Promise.all(
songs.map((song) =>
getTopSongs = (credentials: Credentials, artist: string) => subsonic
this.getJSON<GetTopSongsResponse>( .getAlbum(credentials, song.albumId!)
credentials, .then((album) => asTrack(album, song))
"/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) => topSongs: async (artistId: string) =>
stations.map((it) => ({ subsonic.getArtist(credentials, artistId).then(({ name }) =>
id: it.id, subsonic
name: it.name, .getJSON<GetTopSongsResponse>(credentials, "/rest/getTopSongs", {
url: it.streamUrl, artist: name,
homePage: it.homePageUrl, count: 50,
})) })
); .then((it) => it.topSongs.song || [])
.then((songs) =>
Promise.all(
songs.map((song) =>
subsonic
.getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song))
)
)
)
),
}; };
if (credentials.type == "navidrome") {
// todo: there does not seem to be a test for this??
return Promise.resolve({
...genericSubsonic,
flavour: () => "navidrome",
bearerToken: (credentials: Credentials) =>
pipe(
TE.tryCatch(
() =>
axios.post(
this.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)
),
});
} else {
return Promise.resolve(genericSubsonic);
}
};
}

320
src/subsonic_music_library.ts
View File

@@ -1,320 +0,0 @@
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;
};
}

27
src/utils.ts
View File

@@ -1,5 +1,3 @@
import { DOMParser, XMLSerializer, Node } from '@xmldom/xmldom';
export function takeWithRepeats<T>(things:T[], count: number) { export function takeWithRepeats<T>(things:T[], count: number) {
const result = []; const result = [];
for(let i = 0; i < count; i++) { for(let i = 0; i < count; i++) {
@@ -7,28 +5,3 @@ export function takeWithRepeats<T>(things:T[], count: number) {
} }
return result; 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);
}

91
tests/builders.ts
View File

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

12
tests/encryption.test.ts
View File

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

87
tests/icon.test.ts
View File

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

88
tests/in_memory_music_service.test.ts
View File

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

15
tests/in_memory_music_service.ts
View File

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

2
tests/music_library.test.ts → tests/music_service.test.ts
View File

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

2
tests/scenarios.test.ts
View File

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

346
tests/server.test.ts
View File

@@ -2,9 +2,11 @@ import { v4 as uuid } from "uuid";
import dayjs from "dayjs"; import dayjs from "dayjs";
import request from "supertest"; import request from "supertest";
import Image from "image-js"; import Image from "image-js";
import fs from "fs";
import { either as E, taskEither as TE } from "fp-ts"; import { either as E, taskEither as TE } from "fp-ts";
import path from "path";
import { AuthFailure, MusicService } from "../src/music_library"; import { AuthFailure, MusicService } from "../src/music_service";
import makeServer, { import makeServer, {
BONOB_ACCESS_TOKEN_HEADER, BONOB_ACCESS_TOKEN_HEADER,
RangeBytesFromFilter, RangeBytesFromFilter,
@@ -1321,6 +1323,279 @@ 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", () => { describe("when there is an error", () => {
it("should return a 500", async () => { it("should return a 500", async () => {
musicService.login.mockResolvedValue(musicLibrary); musicService.login.mockResolvedValue(musicLibrary);
@@ -1366,25 +1641,11 @@ describe("server", () => {
"..%2F..%2Ffoo", "..%2F..%2Ffoo",
"%2Fetc%2Fpasswd", "%2Fetc%2Fpasswd",
".%2Fbob.js", ".%2Fbob.js",
"%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", "1",
"%23%24",
"notAValidIcon", "notAValidIcon",
"notAValidIcon:withSomeText"
].forEach((type) => { ].forEach((type) => {
describe(`trying to retrieve an icon with name ${type}`, () => { describe(`trying to retrieve an icon with name ${type}`, () => {
it(`should fail`, async () => { it(`should fail`, async () => {
@@ -1412,20 +1673,6 @@ 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", () => { describe("fetching", () => {
[ [
"artists", "artists",
@@ -1555,41 +1802,6 @@ 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>`
);
});
});
});
}); });
}); });
}); });

661
tests/smapi.test.ts
View File

File diff suppressed because it is too large Load Diff

5317
tests/subsonic.test.ts
View File

File diff suppressed because it is too large Load Diff

3950
tests/subsonic_music_library.test.ts
View File

File diff suppressed because it is too large Load Diff

4
web/icons/navidrome-radio.svg
View File

@@ -1,4 +0,0 @@
<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>
Side by Side

Before

Width:  |  Height:  |  Size: 293 B

3
web/icons/yy.svg
View File

@@ -1,3 +0,0 @@
<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>
Side by Side

Before

Width:  |  Height:  |  Size: 189 B

3
web/icons/yyyy.svg
View File

@@ -1,3 +0,0 @@
<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>
Side by Side

Before

Width:  |  Height:  |  Size: 190 B

4771
yarn.lock Normal file
View File

File diff suppressed because it is too large Load Diff