Compare commits

...

19 Commits

Author SHA1 Message Date
Simon J
0d86b536aa text adjust 2024-03-30 20:24:47 +11:00
Simon J
e6a291be40 bob.svg 2024-03-30 20:21:27 +11:00
Simon J
e7f5f5871e Ability to play radio stations from subsonic api (#199) 2024-02-26 05:51:30 +11:00
Simon J
eb3124b705 README updates (#197) 2024-02-08 15:49:35 +11:00
Simon J
4b7be66385 Upgrade @svrooij/sonos to ^2.6.0-beta.7 (#195) 2024-02-08 12:36:36 +11:00
Simon J
212f6e34dc Update README.md (#196) 2024-02-08 12:36:26 +11:00
Simon J
9b9a348b20 Fix issue where transcoded files would not play, provide support for custom clients to transcode (#194) 2024-02-07 16:21:28 +11:00
Simon J
6bf89b87e2 Feature/no more sharp (#193)
* Playlist icons working as rendered by ND

* remove duplication in cover art image url creation

* Remove unused ability to create collages of images
2024-02-05 17:22:27 +11:00
Simon J
66c248fe44 Use transcodedContentType when available to indicate to sonos device the transcoded mimeType #191 (#192) 2024-02-02 19:43:53 +11:00
Daniel Hammer
1a251400ec Update README.md (#189) 2024-01-25 08:48:14 +11:00
Simon J
0c9513bec9 Rollback version of fast-xml-parser used by @svrooij/sonos as newest version causes error (#188) 2024-01-24 20:40:25 +11:00
Simon J
b7beb4c610 - Upgrade to node v20 (#187) 2024-01-24 12:25:48 +11:00
Simon J
5ce2e4efb7 Bump libs (#179) 2023-10-11 17:19:24 +11:00
Simon J
8ef9ca80b6 Fix issue #177 (#178) 2023-10-11 12:45:27 +11:00
Simon J
a5689c3d4b Feature/move close stream (#176)
* Move stream destroy closer to where stream is retrieved

* Change BNB_SUBSONIC_URL to be of type URLBuilder to better handle URL construction rather than string concat, should addresse #169
2023-10-10 11:25:55 +11:00
dependabot[bot]
b8caf90e06 Bump semver from 5.7.1 to 5.7.2 (#165)
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-10 10:59:57 +11:00
dependabot[bot]
9b01f07484 Bump get-func-name from 2.0.0 to 2.0.2 (#173)
Bumps [get-func-name](https://github.com/chaijs/get-func-name) from 2.0.0 to 2.0.2.
- [Release notes](https://github.com/chaijs/get-func-name/releases)
- [Commits](https://github.com/chaijs/get-func-name/commits/v2.0.2)

---
updated-dependencies:
- dependency-name: get-func-name
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-10 10:59:46 +11:00
Simon J
fb5f8e81ec Ensure streams and destroyed on end of /stream request to see if addressess TCP leak issue (#175) 2023-10-09 16:19:00 +11:00
Simon J
9786d9f1dd Support for fr-FR LANG (#172) 2023-09-14 16:38:56 +10:00
32 changed files with 9273 additions and 153608 deletions

View File

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

View File

@@ -10,10 +10,19 @@
"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:1": { "ghcr.io/devcontainers/features/docker-in-docker:2": {
"version": "latest", "version": "latest",
"moby": true "moby": true
} }
},
"customizations": {
"vscode": {
"extensions": [
"esbenp.prettier-vscode",
"redhat.vscode-xml"
]
}
} }
} }

View File

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

1
.gitignore vendored
View File

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

1
.npmrc Normal file
View File

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

1
.nvmrc
View File

@@ -1 +0,0 @@
16.6.2

File diff suppressed because one or more lines are too long

View File

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

View File

@@ -1,4 +1,4 @@
FROM node:16-bullseye-slim as build FROM node:20-bullseye-slim as build
WORKDIR /bonob WORKDIR /bonob
@@ -9,12 +9,11 @@ COPY typings ./typings
COPY web ./web COPY web ./web
COPY tests ./tests COPY tests ./tests
COPY jest.config.js . COPY jest.config.js .
COPY package.json .
COPY register.js . COPY register.js .
COPY .npmrc .
COPY tsconfig.json . COPY tsconfig.json .
COPY yarn.lock . COPY package.json .
COPY .yarnrc.yml . COPY package-lock.json .
COPY .yarn/releases ./.yarn/releases
ENV JEST_TIMEOUT=60000 ENV JEST_TIMEOUT=60000
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
@@ -29,24 +28,15 @@ RUN apt-get update && \
g++ && \ g++ && \
apt-get clean && \ apt-get clean && \
rm -rf /var/lib/apt/lists/* && \ rm -rf /var/lib/apt/lists/* && \
yarn config set network-timeout 600000 -g && \ npm install && \
yarn install \ npm test && \
--prefer-offline \ npm run gitinfo && \
--frozen-lockfile \ npm run build && \
--non-interactive \
--production=false && \
yarn test --no-cache && \
yarn gitinfo && \
yarn build && \
rm -Rf node_modules && \ rm -Rf node_modules && \
NODE_ENV=production yarn install \ NODE_ENV=production npm install --omit=dev
--prefer-offline \
--pure-lockfile \
--non-interactive \
--production=true
FROM node:16-bullseye-slim FROM node:20-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" \
@@ -62,7 +52,7 @@ EXPOSE $BNB_PORT
WORKDIR /bonob WORKDIR /bonob
COPY package.json . COPY package.json .
COPY yarn.lock . COPY package-lock.json .
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
@@ -75,7 +65,7 @@ RUN apt-get update && \
apt-get -y install --no-install-recommends \ apt-get -y install --no-install-recommends \
libvips \ libvips \
tzdata \ tzdata \
wget && \ wget && \
apt-get clean && \ apt-get clean && \
rm -rf /var/lib/apt/lists/* rm -rf /var/lib/apt/lists/*

View File

@@ -16,12 +16,13 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
- 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 supported currently, require translations for other languages). [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/) - Localization (only en-US, da-DK & nl-NL supported currently, require translations for other languages). [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
- Auto discovery of sonos devices - 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 support for flacs using a specific player for the flac mimeType bonob/sonos - Transcoding within subsonic clone
- Custom players by mime type, allowing custom transcoding rules for different file types
## Running ## Running
@@ -39,8 +40,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 | Laster build from master, probably works, however is currently under test in master | Lastest build from master, probably works, however is currently under test
vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release vX.Y.Z | Fixed release versions from tags, for those that want to pin to a specific release
### Full sonos device auto-discovery and auto-registration using docker --network host ### Full sonos device auto-discovery and auto-registration using docker --network host
@@ -163,7 +164,6 @@ 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. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs. BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac". <p>However; <p>if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs. <p>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache. BNB_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,19 +218,22 @@ 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.
## A note on transcoding ## Transcoding
tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track. However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below). ### Transcode everything
Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/). When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track. The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
### Audio File type specific transcoding options within Subsonic ### Audio file type specific transcoding
In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/) Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
In this case you could set; 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"
``` ```
@@ -246,7 +249,16 @@ 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 -
``` ```
### Changing Icon colors Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;
```bash
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
```
And then configure the 'bonob+audio/mpeg' player in your subsonic server.
## Changing Icon colors
```bash ```bash
-e BNB_ICON_FOREGROUND_COLOR=white \ -e BNB_ICON_FOREGROUND_COLOR=white \
@@ -276,6 +288,7 @@ ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|240
![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

7662
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -6,67 +6,70 @@
"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.5.0", "@svrooij/sonos": "^2.6.0-beta.7",
"@types/express": "^4.17.17", "@types/express": "^4.17.21",
"@types/fs-extra": "^11.0.1", "@types/fs-extra": "^11.0.4",
"@types/jsonwebtoken": "^9.0.1", "@types/jsonwebtoken": "^9.0.5",
"@types/jws": "^3.2.5", "@types/jws": "^3.2.9",
"@types/morgan": "^1.9.4", "@types/morgan": "^1.9.9",
"@types/node": "^16.11.7", "@types/node": "^20.11.5",
"@types/randomstring": "^1.1.8", "@types/randomstring": "^1.1.11",
"@types/sharp": "^0.31.1", "@types/underscore": "^1.11.15",
"@types/underscore": "^1.11.4", "@types/uuid": "^9.0.7",
"@types/uuid": "^9.0.1", "@types/xmldom": "0.1.34",
"@types/xmldom": "0.1.31", "axios": "^1.6.5",
"axios": "^1.3.4", "dayjs": "^1.11.10",
"dayjs": "^1.11.7", "eta": "^2.2.0",
"eta": "^2.0.1",
"express": "^4.18.2", "express": "^4.18.2",
"fp-ts": "^2.13.1", "fp-ts": "^2.16.2",
"fs-extra": "^11.1.0", "fs-extra": "^11.2.0",
"jsonwebtoken": "^9.0.0", "jsonwebtoken": "^9.0.2",
"jws": "^4.0.0", "jws": "^4.0.0",
"libxmljs2": "^0.31.0", "libxmljs2": "^0.33.0",
"morgan": "^1.10.0", "morgan": "^1.10.0",
"node-html-parser": "^6.1.5", "node-html-parser": "^6.1.12",
"randomstring": "^1.2.3", "randomstring": "^1.3.0",
"sharp": "^0.31.3", "sharp": "^0.33.2",
"soap": "^1.0.0", "soap": "^1.0.0",
"ts-md5": "^1.3.1", "ts-md5": "^1.3.1",
"typescript": "^4.9.5", "typescript": "^5.3.3",
"underscore": "^1.13.6", "underscore": "^1.13.6",
"urn-lib": "^2.0.0", "urn-lib": "^2.0.0",
"uuid": "^9.0.0", "uuid": "^9.0.1",
"winston": "^3.8.2", "winston": "^3.11.0",
"xmldom-ts": "^0.3.1" "xmldom-ts": "^0.3.1"
}, },
"devDependencies": { "devDependencies": {
"@types/chai": "^4.3.4", "@types/chai": "^4.3.11",
"@types/jest": "^29.4.0", "@types/jest": "^29.5.11",
"@types/mocha": "^10.0.1", "@types/mocha": "^10.0.6",
"@types/supertest": "^2.0.12", "@types/supertest": "^6.0.2",
"@types/tmp": "^0.2.3", "@types/tmp": "^0.2.6",
"chai": "^4.3.7", "chai": "^5.0.0",
"get-port": "^6.1.2", "get-port": "^7.0.0",
"image-js": "^0.35.3", "image-js": "^0.35.5",
"jest": "^29.4.3", "jest": "^29.7.0",
"nodemon": "^2.0.21", "nodemon": "^3.0.3",
"supertest": "^6.3.3", "supertest": "^6.3.4",
"tmp": "^0.2.1", "tmp": "^0.2.1",
"ts-jest": "^29.0.5", "ts-jest": "^29.1.2",
"ts-mockito": "^2.6.1", "ts-mockito": "^2.6.1",
"ts-node": "^10.9.1", "ts-node": "^10.9.2",
"xmldom-ts": "^0.3.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_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_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts", "dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"devr": "BNB_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", "devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"register-dev": "ts-node ./src/register.ts http://${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"
} }

View File

@@ -4,11 +4,11 @@ import server from "./server";
import logger from "./logger"; import logger from "./logger";
import { import {
appendMimeTypeToClientFor,
axiosImageFetcher, axiosImageFetcher,
cachingImageFetcher, cachingImageFetcher,
DEFAULT,
Subsonic, Subsonic,
TranscodingCustomPlayers,
NO_CUSTOM_PLAYERS
} from "./subsonic"; } from "./subsonic";
import { InMemoryAPITokens, sha256 } from "./api_tokens"; import { InMemoryAPITokens, sha256 } from "./api_tokens";
import { InMemoryLinkCodes } from "./link_codes"; import { InMemoryLinkCodes } from "./link_codes";
@@ -32,9 +32,9 @@ const bonob = bonobService(
const sonosSystem = sonos(config.sonos.discovery); const sonosSystem = sonos(config.sonos.discovery);
const streamUserAgent = config.subsonic.customClientsFor const customPlayers = config.subsonic.customClientsFor
? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(",")) ? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
: DEFAULT; : NO_CUSTOM_PLAYERS;
const artistImageFetcher = config.subsonic.artistImageCache const artistImageFetcher = config.subsonic.artistImageCache
? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher) ? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
@@ -42,7 +42,7 @@ const artistImageFetcher = config.subsonic.artistImageCache
const subsonic = new Subsonic( const subsonic = new Subsonic(
config.subsonic.url, config.subsonic.url,
streamUserAgent, customPlayers,
artistImageFetcher artistImageFetcher
); );

View File

@@ -98,7 +98,7 @@ export default function () {
sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }), sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
}, },
subsonic: { subsonic: {
url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!, url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }), customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"), artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
}, },

View File

@@ -4,11 +4,12 @@ import { option as O } from "fp-ts";
import _ from "underscore"; import _ from "underscore";
export type LANG = "en-US" | "da-DK" | "de-DE" | "es-ES" | "fr-FR" | "it-IT" | "ja-JP" | "nb-NO" | "nl-NL" | "pt-BR" | "sv-SE" | "zh-CN" export type LANG = "en-US" | "da-DK" | "de-DE" | "es-ES" | "fr-FR" | "it-IT" | "ja-JP" | "nb-NO" | "nl-NL" | "pt-BR" | "sv-SE" | "zh-CN"
export type SUPPORTED_LANG = "en-US" | "da-DK" | "nl-NL"; export type SUPPORTED_LANG = "en-US" | "da-DK" | "fr-FR" | "nl-NL";
export type KEY = export type KEY =
| "AppLinkMessage" | "AppLinkMessage"
| "artists" | "artists"
| "albums" | "albums"
| "internetRadio"
| "playlists" | "playlists"
| "genres" | "genres"
| "random" | "random"
@@ -51,6 +52,7 @@ 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",
@@ -92,6 +94,7 @@ 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",
@@ -129,10 +132,53 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
LOVE: "Synes godt om", LOVE: "Synes godt om",
LOVE_SUCCESS: "Syntes godt om" LOVE_SUCCESS: "Syntes godt om"
}, },
"fr-FR": {
AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
artists: "Artistes",
albums: "Albums",
internetRadio: "Radio Internet",
tracks: "Pistes",
playlists: "Playlists",
genres: "Genres",
random: "Aléatoire",
topRated: "Les mieux notés",
recentlyAdded: "Récemment ajouté",
recentlyPlayed: "Récemment joué",
mostPlayed: "Les plus joué",
success: "Succès",
failure: "Échec",
expectedConfig: "Configuration attendue",
existingServiceConfig: "La configuration de service existe",
noExistingServiceRegistration: "Aucun enregistrement de service existant",
register: "Inscription",
removeRegistration: "Supprimer l'inscription",
devices: "Appareils",
services: "Services",
login: "Se connecter",
logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
username: "Nom d'utilisateur",
password: "Mot de passe",
successfullyRegistered: "Connecté avec succès",
registrationFailed: "Échec de la connexion !",
successfullyRemovedRegistration: "Inscription supprimée avec succès",
failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
invalidLinkCode: "Code non valide !",
loginSuccessful: "Connexion réussie !",
loginFailed: "La connexion a échoué !",
noSonosDevices: "Aucun appareil Sonos",
favourites: "Favoris",
STAR: "Suivre",
UNSTAR: "Ne plus suivre",
STAR_SUCCESS: "Piste suivie",
UNSTAR_SUCCESS: "Piste non suivie",
LOVE: "Aimer",
LOVE_SUCCESS: "Pistes aimée"
},
"nl-NL": { "nl-NL": {
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",

View File

@@ -163,6 +163,7 @@ export const HOLI_COLORS = [
export type ICON = export type ICON =
| "artists" | "artists"
| "albums" | "albums"
| "radio"
| "playlists" | "playlists"
| "genres" | "genres"
| "random" | "random"
@@ -240,6 +241,7 @@ const iconFrom = (name: string) =>
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: iconFrom("blank.svg"),
playlists: iconFrom("navidrome-playlists.svg"), playlists: iconFrom("navidrome-playlists.svg"),
genres: iconFrom("Theatre-Mask-111172.svg"), genres: iconFrom("Theatre-Mask-111172.svg"),

View File

@@ -51,10 +51,15 @@ export type Rating = {
stars: number; stars: number;
} }
export type Encoding = {
player: string,
mimeType: string
}
export type Track = { export type Track = {
id: string; id: string;
name: string; name: string;
mimeType: string; encoding: Encoding,
duration: number; duration: number;
number: number | undefined; number: number | undefined;
genre: Genre | undefined; genre: Genre | undefined;
@@ -64,6 +69,13 @@ export type Track = {
rating: Rating; rating: Rating;
}; };
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;
@@ -113,7 +125,8 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
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";
@@ -131,7 +144,8 @@ 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 & {
@@ -181,4 +195,6 @@ export interface MusicLibrary {
removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean> removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
similarSongs(id: string): Promise<Track[]>; similarSongs(id: string): Promise<Track[]>;
topSongs(artistId: string): Promise<Track[]>; topSongs(artistId: string): Promise<Track[]>;
radioStation(id: string): Promise<RadioStation>
radioStations(): Promise<RadioStation[]>
} }

View File

@@ -31,9 +31,8 @@ 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 _, { shuffle } from "underscore"; import _ 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 {
@@ -307,13 +306,13 @@ function server(
return `<Match propname="rating" value="${value}"> return `<Match propname="rating" value="${value}">
<Ratings> <Ratings>
<Rating Id="${ratingAsInt( <Rating Id="${ratingAsInt(
nextLove nextLove
)}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE"> )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
<Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" /> <Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" />
</Rating> </Rating>
<Rating Id="${-ratingAsInt( <Rating Id="${-ratingAsInt(
nextStar nextStar
)}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR"> )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
<Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" /> <Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" />
</Rating> </Rating>
</Ratings> </Ratings>
@@ -327,9 +326,9 @@ function server(
<Match> <Match>
<imageSizeMap> <imageSizeMap>
${SONOS_RECOMMENDED_IMAGE_SIZES.map( ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
(size) => (size) =>
`<sizeEntry size="${size}" substitution="/size/${size}"/>` `<sizeEntry size="${size}" substitution="/size/${size}"/>`
).join("")} ).join("")}
</imageSizeMap> </imageSizeMap>
</Match> </Match>
</PresentationMap> </PresentationMap>
@@ -338,9 +337,9 @@ function server(
<browseIconSizeMap> <browseIconSizeMap>
<sizeEntry size="0" substitution="/size/legacy"/> <sizeEntry size="0" substitution="/size/legacy"/>
${SONOS_RECOMMENDED_IMAGE_SIZES.map( ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
(size) => (size) =>
`<sizeEntry size="${size}" substitution="/size/${size}"/>` `<sizeEntry size="${size}" substitution="/size/${size}"/>`
).join("")} ).join("")}
</browseIconSizeMap> </browseIconSizeMap>
</Match> </Match>
</PresentationMap> </PresentationMap>
@@ -406,13 +405,17 @@ function server(
trackId: id, trackId: id,
range: req.headers["range"] || undefined, range: req.headers["range"] || undefined,
}) })
.then((stream) => {
res.on('close', () => {
stream.stream.destroy()
});
return stream;
})
.then((stream) => ({ musicLibrary: it, stream })) .then((stream) => ({ musicLibrary: it, stream }))
) )
.then(({ musicLibrary, stream }) => { .then(({ musicLibrary, stream }) => {
logger.debug( logger.debug(
`${trace} bnb<- stream response from music service for ${id}, status=${ `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
stream.status
}, headers=(${JSON.stringify(stream.headers)})`
); );
const sonosisfyContentType = (contentType: string) => const sonosisfyContentType = (contentType: string) =>
@@ -436,9 +439,7 @@ function server(
nowPlaying: boolean; nowPlaying: boolean;
}) => { }) => {
logger.debug( logger.debug(
`${trace} bnb-> ${ `${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
req.path
}, status=${status}, headers=${JSON.stringify(headers)}`
); );
(nowPlaying (nowPlaying
? musicLibrary.nowPlaying(id) ? musicLibrary.nowPlaying(id)
@@ -450,8 +451,8 @@ function server(
.forEach(([header, value]) => { .forEach(([header, value]) => {
res.setHeader(header, value!); res.setHeader(header, value!);
}); });
if (sendStream) stream.stream.pipe(filter).pipe(res); if (sendStream) stream.stream.pipe(filter).pipe(res)
else res.send(); else res.send()
}); });
}; };
@@ -513,15 +514,15 @@ function server(
const spec = const spec =
size == "legacy" size == "legacy"
? { ? {
mimeType: "image/png", mimeType: "image/png",
responseFormatter: (svg: string): Promise<Buffer | string> => responseFormatter: (svg: string): Promise<Buffer | string> =>
sharp(Buffer.from(svg)).resize(80).png().toBuffer(), sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
} }
: { : {
mimeType: "image/svg+xml", mimeType: "image/svg+xml",
responseFormatter: (svg: string): Promise<Buffer | string> => responseFormatter: (svg: string): Promise<Buffer | string> =>
Promise.resolve(svg), Promise.resolve(svg),
}; };
return Promise.resolve( return Promise.resolve(
icon icon
@@ -556,23 +557,11 @@ function server(
}); });
}); });
const GRAVITY_9 = [ app.get("/art/:burn/size/:size", (req, res) => {
"north",
"northeast",
"east",
"southeast",
"south",
"southwest",
"west",
"northwest",
"centre",
];
app.get("/art/:burns/size/:size", (req, res) => {
const serviceToken = apiTokens.authTokenFor( const serviceToken = apiTokens.authTokenFor(
req.query[BONOB_ACCESS_TOKEN_HEADER] as string req.query[BONOB_ACCESS_TOKEN_HEADER] as string
); );
const urns = req.params["burns"]!.split("&").map(parse); const urn = parse(req.params["burn"]!);
const size = Number.parseInt(req.params["size"]!); const size = Number.parseInt(req.params["size"]!);
if (!serviceToken) { if (!serviceToken) {
@@ -583,55 +572,24 @@ function server(
return musicService return musicService
.login(serviceToken) .login(serviceToken)
.then((musicLibrary) => .then((musicLibrary) => {
Promise.all( if (urn.system == "external") {
urns.map((it) => { return serverOpts.externalImageResolver(urn.resource);
if (it.system == "external") { } else {
return serverOpts.externalImageResolver(it.resource); return musicLibrary.coverArt(urn, size);
} else { }
return musicLibrary.coverArt(it, size); })
} .then((coverArt) => {
}) if(coverArt) {
)
)
.then((coverArts) => coverArts.filter((it) => it))
.then(shuffle)
.then((coverArts) => {
if (coverArts.length == 1) {
const coverArt = coverArts[0]!;
res.status(200); res.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 ${urns.join("&")}/size/${size}`, { logger.error(`Failed fetching image ${urn}/size/${size}`, {
cause: e, cause: e,
}); });
return res.status(500).send(); return res.status(500).send();

View File

@@ -17,6 +17,7 @@ import {
Genre, Genre,
MusicService, MusicService,
Playlist, Playlist,
RadioStation,
Rating, Rating,
slice2, slice2,
Track, Track,
@@ -26,7 +27,7 @@ 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 _, { uniq } from "underscore"; import _ from "underscore";
import { BUrn, formatForURL } from "./burn"; import { BUrn, formatForURL } from "./burn";
import { import {
isExpiredTokenError, isExpiredTokenError,
@@ -253,7 +254,7 @@ 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: playlistAlbumArtURL(bonobUrl, playlist).href(), albumArtURI: coverArtURI(bonobUrl, playlist).href(),
canPlay: true, canPlay: true,
attributes: { attributes: {
readOnly: false, readOnly: false,
@@ -262,32 +263,9 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
}, },
}); });
export const playlistAlbumArtURL = ( export const coverArtURI = (
bonobUrl: URLBuilder, bonobUrl: URLBuilder,
playlist: Playlist { coverArt }: { coverArt?: BUrn | undefined }
) => {
// 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,
@@ -305,21 +283,6 @@ export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
pathname: `/icon/${icon}/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;
@@ -329,7 +292,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: defaultAlbumArtURI(bonobUrl, album).href(), albumArtURI: coverArtURI(bonobUrl, album).href(),
canPlay: true, canPlay: true,
// defaults // defaults
// canScroll: false, // canScroll: false,
@@ -337,10 +300,17 @@ 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.mimeType), mimeType: sonosifyMimeType(track.encoding.mimeType),
title: track.name, title: track.name,
trackMetadata: { trackMetadata: {
@@ -348,7 +318,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: defaultAlbumArtURI(bonobUrl, track).href(), albumArtURI: coverArtURI(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,
@@ -366,7 +336,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: defaultArtistArtURI(bonobUrl, artist).href(), albumArtURI: coverArtURI(bonobUrl, { coverArt: artist.image }).href(),
}); });
function splitId<T>(id: string) { function splitId<T>(id: string) {
@@ -464,9 +434,7 @@ function bindSmapiSoapServiceToExpress(
}, },
}, },
})), })),
TE.getOrElse(() => TE.getOrElse(() => T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED))
T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED)
)
)(); )();
} else { } else {
throw authOrFail.toSmapiFault(); throw authOrFail.toSmapiFault();
@@ -525,27 +493,38 @@ function bindSmapiSoapServiceToExpress(
) => ) =>
login(soapyHeaders?.credentials) login(soapyHeaders?.credentials)
.then(splitId(id)) .then(splitId(id))
.then(({ credentials, type, typeId }) => ({ .then(({ musicLibrary, credentials, type, typeId }) => {
getMediaURIResult: bonobUrl switch (type) {
.append({ case "internetRadioStation":
pathname: `/stream/${type}/${typeId}`, return musicLibrary.radioStation(typeId).then((it) => ({
}) getMediaURIResult: it.url,
.href(), }));
httpHeaders: [ case "track":
{ return {
httpHeader: { getMediaURIResult: bonobUrl
header: "bnbt", .append({
value: credentials.loginToken.token, pathname: `/stream/${type}/${typeId}`,
}, })
}, .href(),
{ httpHeaders: [
httpHeader: { {
header: "bnbk", httpHeader: {
value: credentials.loginToken.key, header: "bnbt",
}, value: credentials.loginToken.token,
}, },
], },
})), {
httpHeader: {
header: "bnbk",
value: credentials.loginToken.key,
},
},
],
};
default:
throw `Unsupported type:${type}`;
}
}),
getMediaMetadata: async ( getMediaMetadata: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
@@ -553,11 +532,20 @@ function bindSmapiSoapServiceToExpress(
) => ) =>
login(soapyHeaders?.credentials) login(soapyHeaders?.credentials)
.then(splitId(id)) .then(splitId(id))
.then(async ({ musicLibrary, apiKey, typeId }) => .then(async ({ musicLibrary, apiKey, type, typeId }) => {
musicLibrary.track(typeId!).then((it) => ({ switch (type) {
getMediaMetadataResult: track(urlWithToken(apiKey), 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),
}));
default:
throw `Unsupported type:${type}`;
}
}),
search: async ( search: async (
{ id, term }: { id: string; term: string }, { id, term }: { id: string; term: string },
_, _,
@@ -779,6 +767,12 @@ function bindSmapiSoapServiceToExpress(
).href(), ).href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: lang("internetRadio"),
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
], ],
}); });
case "search": case "search":
@@ -853,6 +847,19 @@ 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 "genres": case "genres":
return musicLibrary return musicLibrary
.genres() .genres()
@@ -872,13 +879,15 @@ 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,
entries: [] coverArt: playlist.coverArt,
// todo: are these every important?
entries: [],
}; };
} })
)
) )
) )
.then(slice2(paging)) .then(slice2(paging))
@@ -910,15 +919,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]) =>
return getMetadataResult({ 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!)

View File

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

View File

@@ -20,6 +20,8 @@ import {
AlbumQueryType, AlbumQueryType,
Artist, Artist,
AuthFailure, AuthFailure,
PlaylistSummary,
Encoding,
} from "./music_service"; } from "./music_service";
import sharp from "sharp"; import sharp from "sharp";
import _ from "underscore"; import _ from "underscore";
@@ -32,6 +34,7 @@ import { b64Encode, b64Decode } from "./b64";
import logger from "./logger"; import logger from "./logger";
import { assertSystem, BUrn } from "./burn"; import { assertSystem, BUrn } from "./burn";
import { artist } from "./smapi"; import { artist } from "./smapi";
import { URLBuilder } from "./url_builder";
export const BROWSER_HEADERS = { export const BROWSER_HEADERS = {
accept: accept:
@@ -161,7 +164,8 @@ export type song = {
duration: number | undefined; duration: number | undefined;
bitRate: number | undefined; bitRate: number | undefined;
suffix: string | undefined; suffix: string | undefined;
contentType: string | undefined; contentType: string;
transcodedContentType: string | undefined;
type: string | undefined; type: string | undefined;
userRating: number | undefined; userRating: number | undefined;
starred: string | undefined; starred: string | undefined;
@@ -176,12 +180,15 @@ type GetAlbumResponse = {
type playlist = { type playlist = {
id: string; id: string;
name: string; name: string;
coverArt: string | undefined;
}; };
type GetPlaylistResponse = { type GetPlaylistResponse = {
// todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
playlist: { playlist: {
id: string; id: string;
name: string; name: string;
coverArt: string | undefined;
entry: song[]; entry: song[];
}; };
}; };
@@ -198,6 +205,15 @@ type GetTopSongsResponse = {
topSongs: { song: song[] }; topSongs: { song: song[] };
}; };
type GetInternetRadioStationsResponse = {
internetRadioStations: { internetRadioStation: {
id: string,
name: string,
streamUrl: string,
homePageUrl?: string }[]
}
}
type GetSongResponse = { type GetSongResponse = {
song: song; song: song;
}; };
@@ -269,10 +285,16 @@ export const artistImageURN = (
} }
}; };
export const asTrack = (album: Album, song: song): Track => ({ export const asTrack = (album: Album, song: song, customPlayers: CustomPlayers): Track => ({
id: song.id, id: song.id,
name: song.title, name: song.title,
mimeType: song.contentType!, encoding: pipe(
customPlayers.encodingFor({ mimeType: song.contentType }),
O.getOrElse(() => ({
player: DEFAULT_CLIENT_APPLICATION,
mimeType: song.transcodedContentType ? song.transcodedContentType : song.contentType
}))
),
duration: song.duration || 0, duration: song.duration || 0,
number: song.track || 0, number: song.track || 0,
genre: maybeAsGenre(song.genre), genre: maybeAsGenre(song.genre),
@@ -304,6 +326,13 @@ const asAlbum = (album: album): Album => ({
coverArt: coverArtURN(album.coverArt), coverArt: coverArtURN(album.coverArt),
}); });
// coverArtURN
const asPlayListSummary = (playlist: playlist): PlaylistSummary => ({
id: playlist.id,
name: playlist.name,
coverArt: coverArtURN(playlist.coverArt),
});
export const asGenre = (genreName: string) => ({ export const asGenre = (genreName: string) => ({
id: b64Encode(genreName), id: b64Encode(genreName),
name: genreName, name: genreName,
@@ -317,19 +346,53 @@ const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
O.getOrElseW(() => undefined) O.getOrElseW(() => undefined)
); );
export type StreamClientApplication = (track: Track) => string; export interface CustomPlayers {
encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>
}
export type CustomClient = {
mimeType: string;
transcodedMimeType: string;
};
export class TranscodingCustomPlayers implements CustomPlayers {
transcodings: Map<string, string>;
constructor(transcodings: Map<string, string>) {
this.transcodings = transcodings;
}
static from(config: string): TranscodingCustomPlayers {
const parts: [string, string][] = config
.split(",")
.map((it) => it.split(">"))
.map((pair) => {
if (pair.length == 1) return [pair[0]!, pair[0]!];
else if (pair.length == 2) return [pair[0]!, pair[1]!];
else throw new Error(`Invalid configuration item ${config}`);
});
return new TranscodingCustomPlayers(new Map(parts));
}
encodingFor = ({ mimeType }: { mimeType: string }): O.Option<Encoding> => pipe(
this.transcodings.get(mimeType),
O.fromNullable,
O.map(transcodedMimeType => ({
player:`${DEFAULT_CLIENT_APPLICATION}+${mimeType}`,
mimeType: transcodedMimeType
}))
)
}
export const NO_CUSTOM_PLAYERS: CustomPlayers = {
encodingFor(_) {
return O.none
},
}
const DEFAULT_CLIENT_APPLICATION = "bonob"; const DEFAULT_CLIENT_APPLICATION = "bonob";
const USER_AGENT = "bonob"; const USER_AGENT = "bonob";
export const DEFAULT: StreamClientApplication = (_: Track) =>
DEFAULT_CLIENT_APPLICATION;
export function appendMimeTypeToClientFor(mimeTypes: string[]) {
return (track: Track) =>
mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
}
export const asURLSearchParams = (q: any) => { export const asURLSearchParams = (q: any) => {
const urlSearchParams = new URLSearchParams(); const urlSearchParams = new URLSearchParams();
Object.keys(q).forEach((k) => { Object.keys(q).forEach((k) => {
@@ -412,17 +475,17 @@ interface SubsonicMusicLibrary extends MusicLibrary {
} }
export class Subsonic implements MusicService { export class Subsonic implements MusicService {
url: string; url: URLBuilder;
streamClientApplication: StreamClientApplication; customPlayers: CustomPlayers;
externalImageFetcher: ImageFetcher; externalImageFetcher: ImageFetcher;
constructor( constructor(
url: string, url: URLBuilder,
streamClientApplication: StreamClientApplication = DEFAULT, customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS,
externalImageFetcher: ImageFetcher = axiosImageFetcher externalImageFetcher: ImageFetcher = axiosImageFetcher
) { ) {
this.url = url; this.url = url;
this.streamClientApplication = streamClientApplication; this.customPlayers = customPlayers;
this.externalImageFetcher = externalImageFetcher; this.externalImageFetcher = externalImageFetcher;
} }
@@ -433,7 +496,7 @@ export class Subsonic implements MusicService {
config: AxiosRequestConfig | undefined = {} config: AxiosRequestConfig | undefined = {}
) => ) =>
axios axios
.get(`${this.url}${path}`, { .get(this.url.append({ pathname: path }).href(), {
params: asURLSearchParams({ params: asURLSearchParams({
u: username, u: username,
v: "1.16.1", v: "1.16.1",
@@ -617,7 +680,7 @@ export class Subsonic implements MusicService {
.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(album, song) asTrack(album, song, this.customPlayers)
) )
); );
@@ -720,7 +783,7 @@ export class Subsonic implements MusicService {
}) })
.then((it) => it.album) .then((it) => it.album)
.then((album) => .then((album) =>
(album.song || []).map((song) => asTrack(asAlbum(album), song)) (album.song || []).map((song) => asTrack(asAlbum(album), song, this.customPlayers))
), ),
track: (trackId: string) => subsonic.getTrack(credentials, trackId), track: (trackId: string) => subsonic.getTrack(credentials, trackId),
rate: (trackId: string, rating: Rating) => rate: (trackId: string, rating: Rating) =>
@@ -771,7 +834,7 @@ export class Subsonic implements MusicService {
`/rest/stream`, `/rest/stream`,
{ {
id: trackId, id: trackId,
c: this.streamClientApplication(track), c: track.encoding.player,
}, },
{ {
headers: pipe( headers: pipe(
@@ -788,15 +851,15 @@ export class Subsonic implements MusicService {
responseType: "stream", responseType: "stream",
} }
) )
.then((res) => ({ .then((stream) => ({
status: res.status, status: stream.status,
headers: { headers: {
"content-type": res.headers["content-type"], "content-type": stream.headers["content-type"],
"content-length": res.headers["content-length"], "content-length": stream.headers["content-length"],
"content-range": res.headers["content-range"], "content-range": stream.headers["content-range"],
"accept-ranges": res.headers["accept-ranges"], "accept-ranges": stream.headers["accept-ranges"],
}, },
stream: res.data, stream: stream.data,
})) }))
), ),
coverArt: async (coverArtURN: BUrn, size?: number) => coverArt: async (coverArtURN: BUrn, size?: number) =>
@@ -859,9 +922,7 @@ export class Subsonic implements MusicService {
subsonic subsonic
.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists") .getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
.then((it) => it.playlists.playlist || []) .then((it) => it.playlists.playlist || [])
.then((playlists) => .then((playlists) => playlists.map(asPlayListSummary)),
playlists.map((it) => ({ id: it.id, name: it.name }))
),
playlist: async (id: string) => playlist: async (id: string) =>
subsonic subsonic
.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", { .getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
@@ -873,6 +934,7 @@ export class Subsonic implements MusicService {
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(
{ {
@@ -884,7 +946,8 @@ export class Subsonic implements MusicService {
artistId: entry.artistId, artistId: entry.artistId,
coverArt: coverArtURN(entry.coverArt), coverArt: coverArtURN(entry.coverArt),
}, },
entry entry,
this.customPlayers
), ),
number: trackNumber++, number: trackNumber++,
})), })),
@@ -896,7 +959,12 @@ export class Subsonic implements MusicService {
name, name,
}) })
.then((it) => it.playlist) .then((it) => it.playlist)
.then((it) => ({ id: it.id, name: it.name })), // todo: why is this line so similar to other playlist lines??
.then((it) => ({
id: it.id,
name: it.name,
coverArt: coverArtURN(it.coverArt),
})),
deletePlaylist: async (id: string) => deletePlaylist: async (id: string) =>
subsonic subsonic
.getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", { .getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
@@ -930,7 +998,7 @@ export class Subsonic implements MusicService {
songs.map((song) => songs.map((song) =>
subsonic subsonic
.getAlbum(credentials, song.albumId!) .getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song)) .then((album) => asTrack(album, song, this.customPlayers))
) )
) )
), ),
@@ -947,14 +1015,33 @@ export class Subsonic implements MusicService {
songs.map((song) => songs.map((song) =>
subsonic subsonic
.getAlbum(credentials, song.albumId!) .getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song)) .then((album) => asTrack(album, song, this.customPlayers))
) )
) )
) )
), ),
radioStations: async () => subsonic
.getJSON<GetInternetRadioStationsResponse>(
credentials,
"/rest/getInternetRadioStations"
)
.then((it) => it.internetRadioStations.internetRadioStation || [])
.then((stations) => stations.map((it) => ({
id: it.id,
name: it.name,
url: it.streamUrl,
homePage: it.homePageUrl
}))),
radioStation: async (id: string) => genericSubsonic
.radioStations()
.then(it =>
it.find(station => station.id === id)!
),
}; };
if (credentials.type == "navidrome") { if (credentials.type == "navidrome") {
// todo: there does not seem to be a test for this??
return Promise.resolve({ return Promise.resolve({
...genericSubsonic, ...genericSubsonic,
flavour: () => "navidrome", flavour: () => "navidrome",
@@ -963,7 +1050,7 @@ export class Subsonic implements MusicService {
TE.tryCatch( TE.tryCatch(
() => () =>
axios.post( axios.post(
`${this.url}/auth/login`, this.url.append({ pathname: "/auth/login" }).href(),
_.pick(credentials, "username", "password") _.pick(credentials, "username", "password")
), ),
() => new AuthFailure("Failed to get bearerToken") () => new AuthFailure("Failed to get bearerToken")

View File

@@ -14,6 +14,7 @@ import {
Playlist, Playlist,
SimilarArtist, SimilarArtist,
AlbumSummary, AlbumSummary,
RadioStation,
} from "../src/music_service"; } from "../src/music_service";
import { b64Encode } from "../src/b64"; import { b64Encode } from "../src/b64";
@@ -173,7 +174,10 @@ export function aTrack(fields: Partial<Track> = {}): Track {
return { return {
id, id,
name: `Track ${id}`, name: `Track ${id}`,
mimeType: `audio/mp3-${id}`, encoding: {
player: "bonob",
mimeType: `audio/mp3-${id}`
},
duration: randomInt(500), duration: randomInt(500),
number: randomInt(100), number: randomInt(100),
genre, genre,
@@ -201,6 +205,17 @@ export function anAlbum(fields: Partial<Album> = {}): Album {
}; };
}; };
export function aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
const id = uuid()
const name = `Station-${id}`;
return {
id,
name,
url: `http://example.com/${name}`,
...fields
}
}
export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary { export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary {
const id = uuid(); const id = uuid();
return { return {

View File

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

View File

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

View File

@@ -161,6 +161,8 @@ 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"),
}); });
} }

View File

@@ -2,9 +2,7 @@ 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_service"; import { AuthFailure, MusicService } from "../src/music_service";
import makeServer, { import makeServer, {
@@ -755,15 +753,22 @@ describe("server", () => {
const trackId = `t-${uuid()}`; const trackId = `t-${uuid()}`;
const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` }; const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` };
const streamContent = (content: string) => ({ const streamContent = (content: string) => {
pipe: (_: Transform) => { const self = {
return { destroyed: false,
pipe: (res: Response) => { pipe: (_: Transform) => {
res.send(content); return {
}, pipe: (res: Response) => {
}; res.send(content);
}, }
}); };
},
destroy: () => {
self.destroyed = true;
}
};
return self;
};
describe("HEAD requests", () => { describe("HEAD requests", () => {
describe("when there is no Bearer token", () => { describe("when there is no Bearer token", () => {
@@ -829,6 +834,8 @@ describe("server", () => {
); );
expect(res.headers["content-length"]).toEqual("123"); expect(res.headers["content-length"]).toEqual("123");
expect(res.body).toEqual({}); expect(res.body).toEqual({});
expect(trackStream.stream.destroyed).toBe(true);
}); });
}); });
@@ -854,6 +861,8 @@ describe("server", () => {
expect(res.status).toEqual(404); expect(res.status).toEqual(404);
expect(res.body).toEqual({}); expect(res.body).toEqual({});
expect(trackStream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -916,6 +925,8 @@ describe("server", () => {
expect(musicLibrary.nowPlaying).not.toHaveBeenCalled(); expect(musicLibrary.nowPlaying).not.toHaveBeenCalled();
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -959,6 +970,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1000,6 +1013,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1040,6 +1055,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1083,6 +1100,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -1131,6 +1150,8 @@ describe("server", () => {
trackId, trackId,
range: requestedRange, range: requestedRange,
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1178,6 +1199,8 @@ describe("server", () => {
trackId, trackId,
range: "4000-5000", range: "4000-5000",
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -1298,279 +1321,6 @@ describe("server", () => {
}); });
}); });
describe("fetching multiple images as a collage", () => {
const png = fs.readFileSync(
path.join(
__dirname,
"..",
"docs",
"images",
"chartreuseFuchsia.png"
)
);
describe("fetching a collage of 4 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"art:1",
"art:2",
"art:3",
"art:4",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 200);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(200);
expect(image.height).toEqual(200);
});
});
describe("fetching a collage of 4, however only 1 is available", () => {
it("should return the single image", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
contentType: "image/some-mime-type",
})
);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual(
"image/some-mime-type"
);
});
});
describe("fetching a collage of 4 and all are missing", () => {
it("should return a 404", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
describe("fetching a collage of 9 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"coverArt:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 9 when only 2 are available", () => {
it("should still return an image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((urn) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(urn, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 11", () => {
it("should still return an image and a 200, though will only display 9", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
"artist:10",
"artist:11",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("when the image is not available", () => {
it("should return a 404", async () => {
const coverArtURN = { system:"subsonic", resource:"art:404"};
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValue(undefined);
const res = await request(server)
.get(
`/art/${encodeURIComponent(formatForURL(coverArtURN))}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
});
describe("when there is an error", () => { 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);

View File

@@ -18,14 +18,13 @@ import {
track, track,
artist, artist,
album, album,
defaultAlbumArtURI, coverArtURI,
defaultArtistArtURI,
searchResult, searchResult,
iconArtURI, iconArtURI,
playlistAlbumArtURL,
sonosifyMimeType, sonosifyMimeType,
ratingAsInt, ratingAsInt,
ratingFromInt, ratingFromInt,
internetRadioStation
} from "../src/smapi"; } from "../src/smapi";
import { keys as i8nKeys } from "../src/i8n"; import { keys as i8nKeys } from "../src/i8n";
@@ -41,7 +40,7 @@ import {
TRIP_HOP, TRIP_HOP,
PUNK, PUNK,
aPlaylist, aPlaylist,
anAlbumSummary, aRadioStation,
} from "./builders"; } from "./builders";
import { InMemoryMusicService } from "./in_memory_music_service"; import { InMemoryMusicService } from "./in_memory_music_service";
import supersoap from "./supersoap"; import supersoap from "./supersoap";
@@ -56,7 +55,6 @@ import dayjs from "dayjs";
import url, { URLBuilder } from "../src/url_builder"; import url, { URLBuilder } from "../src/url_builder";
import { iconForGenre } from "../src/icon"; import { iconForGenre } from "../src/icon";
import { formatForURL } from "../src/burn"; import { formatForURL } from "../src/burn";
import { range } from "underscore";
import { FixedClock } from "../src/clock"; import { FixedClock } from "../src/clock";
import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth"; import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth";
@@ -135,8 +133,8 @@ describe("service config", () => {
"Sonos koppelen aan music land" "Sonos koppelen aan music land"
); );
// no fr-FR translation, so use en-US // no pt-BR translation, so use en-US
expect(sonosString("AppLinkMessage", "fr-FR")).toEqual( expect(sonosString("AppLinkMessage", "pt-BR")).toEqual(
"Linking sonos with music land" "Linking sonos with music land"
); );
}); });
@@ -356,7 +354,10 @@ describe("track", () => {
const someTrack = aTrack({ const someTrack = aTrack({
id: uuid(), id: uuid(),
// audio/x-flac should be mapped to audio/flac // audio/x-flac should be mapped to audio/flac
mimeType: "audio/x-flac", encoding: {
player: "something",
mimeType: "audio/x-flac"
},
name: "great song", name: "great song",
duration: randomInt(1000), duration: randomInt(1000),
number: randomInt(100), number: randomInt(100),
@@ -411,7 +412,10 @@ describe("track", () => {
const someTrack = aTrack({ const someTrack = aTrack({
id: uuid(), id: uuid(),
// audio/x-flac should be mapped to audio/flac // audio/x-flac should be mapped to audio/flac
mimeType: "audio/x-flac", encoding: {
player: "something",
mimeType: "audio/x-flac"
},
name: "great song", name: "great song",
duration: randomInt(1000), duration: randomInt(1000),
number: randomInt(100), number: randomInt(100),
@@ -471,7 +475,7 @@ describe("album", () => {
itemType: "album", itemType: "album",
id: `album:${someAlbum.id}`, id: `album:${someAlbum.id}`,
title: someAlbum.name, title: someAlbum.name,
albumArtURI: defaultAlbumArtURI(bonobUrl, someAlbum).href(), albumArtURI: coverArtURI(bonobUrl, someAlbum).href(),
canPlay: true, canPlay: true,
artist: someAlbum.artistName, artist: someAlbum.artistName,
artistId: `artist:${someAlbum.artistId}`, artistId: `artist:${someAlbum.artistId}`,
@@ -479,6 +483,18 @@ describe("album", () => {
}); });
}); });
describe("internetRadioStation", () => {
it("should map to a sonos internet stream", () => {
const station = aRadioStation()
expect(internetRadioStation(station)).toEqual({
itemType: "stream",
id: `internetRadioStation:${station.id}`,
title: station.name,
mimeType: "audio/mpeg"
})
});
});
describe("sonosifyMimeType", () => { describe("sonosifyMimeType", () => {
describe("when is audio/x-flac", () => { describe("when is audio/x-flac", () => {
it("should be mapped to audio/flac", () => { it("should be mapped to audio/flac", () => {
@@ -495,299 +511,8 @@ describe("sonosifyMimeType", () => {
}); });
}); });
describe("playlistAlbumArtURL", () => {
const coverArt1 = { system: "subsonic", resource: "1" };
const coverArt2 = { system: "subsonic", resource: "2" };
const coverArt3 = { system: "subsonic", resource: "3" };
const coverArt4 = { system: "subsonic", resource: "4" };
const coverArt5 = { system: "subsonic", resource: "5" };
describe("when the playlist has no coverArt ids", () => { describe("coverArtURI", () => {
it("should return question mark icon", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({ coverArt: undefined }),
aTrack({ coverArt: undefined }),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/icon/error/size/legacy?search=yes`
);
});
});
describe("when the playlist has external ids", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const externalArt1 = {
system: "external",
resource: "http://example.com/image1.jpg",
};
const externalArt2 = {
system: "external",
resource: "http://example.com/image2.jpg",
};
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: externalArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: externalArt2,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
it("should format the url with encrypted urn", () => {
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(externalArt1)
)}&${encodeURIComponent(
formatForURL(externalArt2)
)}/size/180?search=yes`
);
});
describe("when BNB_NO_PLAYLIST_ART is set", () => {
const OLD_ENV = process.env;
beforeEach(() => {
process.env = { ...OLD_ENV };
process.env["BNB_DISABLE_PLAYLIST_ART"] = "true";
});
afterEach(() => {
process.env = OLD_ENV;
});
it("should return an icon", () => {
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/icon/music/size/legacy?search=yes`
);
});
});
});
describe("when the playlist has 4 tracks from 2 different albums, including some tracks that are missing coverArt urns", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 2 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 3 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album3" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt4)
)}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 4 different albums", () => {
it("should return them on the url to the image", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album3" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album4" }),
}),
aTrack({
coverArt: coverArt5,
album: anAlbumSummary({ id: "album1" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt3)
)}&${encodeURIComponent(formatForURL(coverArt4))}/size/180?search=yes`
);
});
});
describe("when the playlist has at least 9 distinct albumIds", () => {
it("should return the first 9 of the ids on the url", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: { system: "subsonic", resource: "1" },
album: anAlbumSummary({ id: "1" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "2" },
album: anAlbumSummary({ id: "2" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "3" },
album: anAlbumSummary({ id: "3" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "4" },
album: anAlbumSummary({ id: "4" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "5" },
album: anAlbumSummary({ id: "5" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "6" },
album: anAlbumSummary({ id: "6" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "7" },
album: anAlbumSummary({ id: "7" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "8" },
album: anAlbumSummary({ id: "8" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "9" },
album: anAlbumSummary({ id: "9" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "10" },
album: anAlbumSummary({ id: "10" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "11" },
album: anAlbumSummary({ id: "11" }),
}),
],
});
const burns = range(1, 10)
.map((i) =>
encodeURIComponent(
formatForURL({ system: "subsonic", resource: `${i}` })
)
)
.join("&");
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${burns}/size/180?search=yes`
);
});
});
});
describe("defaultAlbumArtURI", () => {
const bonobUrl = new URLBuilder( const bonobUrl = new URLBuilder(
"http://bonob.example.com:8080/context?search=yes" "http://bonob.example.com:8080/context?search=yes"
); );
@@ -797,7 +522,7 @@ describe("defaultAlbumArtURI", () => {
it("should use it", () => { it("should use it", () => {
const coverArt = { system: "subsonic", resource: "12345" }; const coverArt = { system: "subsonic", resource: "12345" };
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href() coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual( ).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent( `http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt) formatForURL(coverArt)
@@ -813,7 +538,7 @@ describe("defaultAlbumArtURI", () => {
resource: "http://example.com/someimage.jpg", resource: "http://example.com/someimage.jpg",
}; };
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href() coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual( ).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent( `http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt) formatForURL(coverArt)
@@ -826,7 +551,7 @@ describe("defaultAlbumArtURI", () => {
describe("when there is no album coverArt", () => { describe("when there is no album coverArt", () => {
it("should return a vinly icon image", () => { it("should return a vinly icon image", () => {
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href() coverArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
).toEqual( ).toEqual(
"http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes" "http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes"
); );
@@ -834,50 +559,6 @@ describe("defaultAlbumArtURI", () => {
}); });
}); });
describe("defaultArtistArtURI", () => {
describe("when the artist has no image", () => {
it("should return an icon", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const artist = anArtist({ image: undefined });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/icon/vinyl/size/legacy?s=123`
);
});
});
describe("when the resource is subsonic", () => {
it("should use the resource", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const image = { system: "subsonic", resource: "art:1234" };
const artist = anArtist({ image });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/art/${encodeURIComponent(
formatForURL(image)
)}/size/180?s=123`
);
});
});
describe("when the resource is external", () => {
it("should encrypt the resource", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const image = {
system: "external",
resource: "http://example.com/something.jpg",
};
const artist = anArtist({ image });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/art/${encodeURIComponent(
formatForURL(image)
)}/size/180?s=123`
);
});
});
});
describe("wsdl api", () => { describe("wsdl api", () => {
const musicService = { const musicService = {
generateToken: jest.fn(), generateToken: jest.fn(),
@@ -910,6 +591,8 @@ describe("wsdl api", () => {
scrobble: jest.fn(), scrobble: jest.fn(),
nowPlaying: jest.fn(), nowPlaying: jest.fn(),
rate: jest.fn(), rate: jest.fn(),
radioStation: jest.fn(),
radioStations: jest.fn(),
}; };
const apiTokens = { const apiTokens = {
mint: jest.fn(), mint: jest.fn(),
@@ -1491,6 +1174,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(), albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
]; ];
expect(root[0]).toEqual( expect(root[0]).toEqual(
getMetadataResult({ getMetadataResult({
@@ -1579,6 +1268,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(), albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
]; ];
expect(root[0]).toEqual( expect(root[0]).toEqual(
getMetadataResult({ getMetadataResult({
@@ -1701,7 +1396,7 @@ describe("wsdl api", () => {
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: playlistAlbumArtURL( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
playlist playlist
).href(), ).href(),
@@ -1733,7 +1428,7 @@ describe("wsdl api", () => {
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: playlistAlbumArtURL( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
playlist playlist
).href(), ).href(),
@@ -1777,7 +1472,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -1814,7 +1509,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -1866,9 +1561,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 0, index: 0,
@@ -1911,9 +1606,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 1, index: 1,
@@ -1972,9 +1667,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 0, index: 0,
@@ -2001,9 +1696,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
}) })
), ),
@@ -2118,7 +1813,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2166,7 +1861,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2214,7 +1909,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2262,7 +1957,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2310,7 +2005,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2358,7 +2053,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2404,7 +2099,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2450,7 +2145,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2494,7 +2189,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2541,7 +2236,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2708,6 +2403,71 @@ describe("wsdl api", () => {
}); });
}); });
}); });
describe("asking for internet radio stations", () => {
const station1 = aRadioStation();
const station2 = aRadioStation();
const station3 = aRadioStation();
const station4 = aRadioStation();
const stations = [station1, station2, station3, station4];
beforeEach(() => {
musicLibrary.radioStations.mockResolvedValue(stations);
});
describe("when they all fit on the page", () => {
it("should return them all", async () => {
const paging = {
index: 0,
count: 100,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: stations.map((it) =>
internetRadioStation(it)
),
index: 0,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
describe("asking for a single page of stations", () => {
const pageOfStations = [station3, station4];
it("should return only that page", async () => {
const paging = {
index: 2,
count: 2,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: pageOfStations.map((it) =>
internetRadioStation(it)
),
index: paging.index,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
});
}); });
}); });
@@ -2918,7 +2678,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`, id: `track:${track.id}`,
itemType: "track", itemType: "track",
title: track.name, title: track.name,
mimeType: track.mimeType, mimeType: track.encoding.mimeType,
trackMetadata: { trackMetadata: {
artistId: `artist:${track.artist.id}`, artistId: `artist:${track.artist.id}`,
artist: track.artist.name, artist: track.artist.name,
@@ -2929,7 +2689,7 @@ describe("wsdl api", () => {
genre: track.genre?.name, genre: track.genre?.name,
genreId: track.genre?.id, genreId: track.genre?.id,
duration: track.duration, duration: track.duration,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
track track
).href(), ).href(),
@@ -2966,7 +2726,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`, id: `track:${track.id}`,
itemType: "track", itemType: "track",
title: track.name, title: track.name,
mimeType: track.mimeType, mimeType: track.encoding.mimeType,
trackMetadata: { trackMetadata: {
artistId: `artist:${track.artist.id}`, artistId: `artist:${track.artist.id}`,
artist: track.artist.name, artist: track.artist.name,
@@ -2977,7 +2737,7 @@ describe("wsdl api", () => {
genre: track.genre?.name, genre: track.genre?.name,
genreId: track.genre?.id, genreId: track.genre?.id,
duration: track.duration, duration: track.duration,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
track track
).href(), ).href(),
@@ -3020,7 +2780,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${album.id}`, id: `album:${album.id}`,
title: album.name, title: album.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
album album
).href(), ).href(),
@@ -3085,6 +2845,27 @@ describe("wsdl api", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
}); });
}); });
describe("asking for a URI to stream a radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return the radio stations uri", async () => {
const root = await ws.getMediaURIAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaURIResult: someStation.url,
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
}); });
}); });
@@ -3096,7 +2877,6 @@ describe("wsdl api", () => {
describe("when valid credentials are provided", () => { describe("when valid credentials are provided", () => {
let ws: Client; let ws: Client;
const someTrack = aTrack();
beforeEach(async () => { beforeEach(async () => {
ws = await createClientAsync(`${service.uri}?wsdl`, { ws = await createClientAsync(`${service.uri}?wsdl`, {
@@ -3104,10 +2884,15 @@ describe("wsdl api", () => {
httpClient: supersoap(server), httpClient: supersoap(server),
}); });
setupAuthenticatedRequest(ws); setupAuthenticatedRequest(ws);
musicLibrary.track.mockResolvedValue(someTrack);
}); });
describe("asking for media metadata for a track", () => { describe("asking for media metadata for a track", () => {
const someTrack = aTrack();
beforeEach(async () => {
musicLibrary.track.mockResolvedValue(someTrack);
});
it("should return it with auth header", async () => { it("should return it with auth header", async () => {
const root = await ws.getMediaMetadataAsync({ const root = await ws.getMediaMetadataAsync({
id: `track:${someTrack.id}`, id: `track:${someTrack.id}`,
@@ -3126,6 +2911,27 @@ describe("wsdl api", () => {
expect(musicLibrary.track).toHaveBeenCalledWith(someTrack.id); expect(musicLibrary.track).toHaveBeenCalledWith(someTrack.id);
}); });
}); });
describe("asking for media metadata for an internet radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return it with no auth header", async () => {
const root = await ws.getMediaMetadataAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaMetadataResult: internetRadioStation(someStation),
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(apiTokens.mint).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
}); });
}); });

File diff suppressed because it is too large Load Diff

View File

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

8
web/icons/bob.svg Normal file
View File

@@ -0,0 +1,8 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
<style>
.txt {
font: bold 13px helvetica;
}
</style>
<text y="20%" class="txt" textLength="80%" lengthAdjust="spacingAndGlyphs">80s</text>
</svg>

After

Width:  |  Height:  |  Size: 226 B

View File

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

After

Width:  |  Height:  |  Size: 293 B

4553
yarn.lock

File diff suppressed because it is too large Load Diff