Compare commits

...

80 Commits

Author SHA1 Message Date
simon
6897397c28 Move artists tests 2025-02-23 03:07:15 +00:00
simon
3a14b62de4 msg 2025-02-22 04:34:55 +00:00
simon
9e5df22701 Artist tests moved around 2025-02-22 04:29:04 +00:00
simojenki
e29d5c5d24 getJSON private 2025-02-17 07:01:34 +00:00
simojenki
b97590dd36 more 2025-02-17 05:47:19 +00:00
simojenki
b0dc11abcb move stream 2025-02-17 00:38:43 +00:00
simon
5009732da2 move scrobble into subsonic 2025-02-15 22:56:22 +00:00
simojenki
ddde55d02b move some code 2025-02-15 11:34:59 +00:00
simojenki
0602e1f077 Remove tracks function, replace with just getting album 2025-02-15 06:48:23 +00:00
simojenki
7eeedff040 bump node, fix app 2025-02-15 06:22:38 +00:00
simojenki
0451c3a931 tests passing 2025-02-15 06:12:29 +00:00
simojenki
cc0dc3704d Move getGenres onto subsonic 2025-02-10 20:49:22 +00:00
simon
dabb7d0f12 bob 2025-02-10 19:35:42 +00:00
simon
a38ca831df Move subsonic music service/library into own file 2025-02-08 02:59:38 +00:00
Simon J
2961b651d9 Icons for years (#220) 2025-02-07 11:52:59 +11:00
Simon J
d8d532e35f bump node to v22 (#218) 2025-02-04 20:14:46 +11:00
Simon J
a581100d29 Removed libxmljs2 (#219) 2025-02-04 19:56:45 +11:00
Simon J
6bc4c79f02 pull subsonic out into proper class (#217) 2025-02-04 06:28:45 +11:00
Simon J
dd52c5706b Update sonos wsdl (#215) 2025-02-01 15:03:37 +11:00
Simon J
996582ce93 bump libs (#211) 2024-11-30 21:30:30 +11:00
Jonathan Virga
0488f398c1 Add years menu (#202) 2024-04-23 10:06:18 +10: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
dhalem
a9d88bd9eb No longer fetch entities for playlists when getting the list. (#161) 2023-04-27 19:34:59 +10:00
Simon J
f6fc7ab920 Ability to disable album art for playlists (#159) 2023-04-22 10:54:38 +10:00
simojenki
8111041551 Additional documentation around where to pull image from 2023-03-18 08:47:16 +11:00
simojenki
df2ef9b152 Add some labels to docker image 2023-03-17 10:37:42 +11:00
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs
33473cd387 ci: Push image to GHCR (#153)
* ci: Push image to GHCR

* ci: Update build actions
2023-03-17 10:26:43 +11:00
Simon J
7f743aaa7e Change some messages from info to debug, route all soap info to debug (#151) 2023-03-13 08:47:32 +11:00
simojenki
d4bed77c54 Set default log level to info 2023-03-12 07:52:43 +00:00
Simon J
29531a6e01 Ability to configure log level, default to 'warn' (#150) 2023-03-12 13:52:38 +11:00
Simon J
e78b6c4fbc Ability to configure whether to log http requests (#149) 2023-03-12 09:21:49 +11:00
Simon J
2941f6f595 Add wget to image 2023-03-09 06:55:58 +11:00
Daniel Hammer
2c48d08b0e Expanded BNB_SUBSONIC_ARTIST_IMAGE_CACHE description to reflect maintainer insights. (#146)
@see https://github.com/simojenki/bonob/issues/138#issuecomment-1455001557

Co-authored-by: Daniel Hammer <daniel.hammer+oss@gmail.com>
2023-03-08 16:16:03 +11:00
Daniel Hammer
de48ee0fca Added initial da-DK i18n. (#140) 2023-03-06 18:40:08 +11:00
Simon J
cefdf5e2d5 Switch to node:16-bullsys-slim images to reduce final image size (#144) 2023-03-06 18:39:40 +11:00
Daniel Hammer
f86a78b338 Added initial documentation for multiple registrations. (#141)
@see https://github.com/simojenki/bonob/issues/139

Co-authored-by: Daniel Hammer <daniel.hammer+oss@gmail.com>
2023-03-06 10:41:55 +11:00
dependabot[bot]
4d23885d7c Bump @xmldom/xmldom from 0.7.6 to 0.7.9 (#143)
Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.6 to 0.7.9.
- [Release notes](https://github.com/xmldom/xmldom/releases)
- [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
- [Commits](https://github.com/xmldom/xmldom/compare/0.7.6...0.7.9)

---
updated-dependencies:
- dependency-name: "@xmldom/xmldom"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:41:19 +11:00
dependabot[bot]
8c80c00089 Bump qs from 6.10.1 to 6.11.0 (#142)
Bumps [qs](https://github.com/ljharb/qs) from 6.10.1 to 6.11.0.
- [Release notes](https://github.com/ljharb/qs/releases)
- [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ljharb/qs/compare/v6.10.1...v6.11.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:41:08 +11:00
dependabot[bot]
ebf385e918 Bump http-cache-semantics from 4.1.0 to 4.1.1 (#133)
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/kornelski/http-cache-semantics/releases)
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:52 +11:00
dependabot[bot]
a20fdcbc5f Bump eta from 1.12.3 to 2.0.0 (#131)
Bumps [eta](https://github.com/eta-dev/eta) from 1.12.3 to 2.0.0.
- [Release notes](https://github.com/eta-dev/eta/releases)
- [Commits](https://github.com/eta-dev/eta/compare/v1.12.3...v2.0.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:40 +11:00
dependabot[bot]
f763dbd8b9 Bump cookiejar from 2.1.2 to 2.1.4 (#130)
Bumps [cookiejar](https://github.com/bmeck/node-cookiejar) from 2.1.2 to 2.1.4.
- [Release notes](https://github.com/bmeck/node-cookiejar/releases)
- [Commits](https://github.com/bmeck/node-cookiejar/commits)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-06 10:40:25 +11:00
dependabot[bot]
2d3e5dc635 Bump json5 from 2.2.0 to 2.2.3 (#126) 2023-03-06 08:10:21 +11:00
dependabot[bot]
6091308266 Bump jsonwebtoken from 8.5.1 to 9.0.0 (#125) 2023-03-06 08:10:14 +11:00
dependabot[bot]
fed6e9663d Bump express from 4.17.1 to 4.17.3 (#124) 2023-03-06 08:10:01 +11:00
dependabot[bot]
03b5b04c73 Bump minimatch from 3.0.4 to 3.1.2 (#120) 2023-03-06 07:54:15 +11:00
simojenki
4a529b46e1 Fix incorrect boolean usage with docker-compose, had to quote the "true" 2022-11-14 00:34:04 +00:00
simojenki
5c9fbede7a Add devcontainer for building bonob 2022-11-14 00:33:35 +00:00
dependabot[bot]
94e25e03ea Bump follow-redirects from 1.14.3 to 1.15.2 (#119)
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.3 to 1.15.2.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.3...v1.15.2)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:27 +11:00
dependabot[bot]
d9c3a3edcb Bump jpeg-js from 0.4.3 to 0.4.4 (#118)
Bumps [jpeg-js](https://github.com/eugeneware/jpeg-js) from 0.4.3 to 0.4.4.
- [Release notes](https://github.com/eugeneware/jpeg-js/releases)
- [Commits](https://github.com/eugeneware/jpeg-js/compare/v0.4.3...v0.4.4)

---
updated-dependencies:
- dependency-name: jpeg-js
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:17 +11:00
dependabot[bot]
f22b094d83 Bump minimist from 1.2.5 to 1.2.7 (#117)
Bumps [minimist](https://github.com/minimistjs/minimist) from 1.2.5 to 1.2.7.
- [Release notes](https://github.com/minimistjs/minimist/releases)
- [Changelog](https://github.com/minimistjs/minimist/blob/main/CHANGELOG.md)
- [Commits](https://github.com/minimistjs/minimist/compare/v1.2.5...v1.2.7)

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

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:34:06 +11:00
dependabot[bot]
4ae71675e8 Bump async from 3.2.0 to 3.2.4 (#116)
Bumps [async](https://github.com/caolan/async) from 3.2.0 to 3.2.4.
- [Release notes](https://github.com/caolan/async/releases)
- [Changelog](https://github.com/caolan/async/blob/master/CHANGELOG.md)
- [Commits](https://github.com/caolan/async/compare/v3.2.0...v3.2.4)

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

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-20 19:33:53 +11:00
simojenki
84866dfd60 Trying to make server tests more stable 2022-10-20 16:35:18 +11:00
simojenki
719fd998b1 Set jest timeout globally for all tests as tests break in GH actions due to timeout 2022-10-20 13:29:37 +11:00
dependabot[bot]
91995678a4 Bump tar from 6.1.8 to 6.1.11 (#115) 2022-10-18 09:06:15 +11:00
dependabot[bot]
67d6c4a730 Bump node-fetch from 2.6.1 to 2.6.7 (#114) 2022-10-18 09:05:58 +11:00
dependabot[bot]
3df4f4daa7 Bump nth-check from 2.0.0 to 2.1.1 (#113) 2022-10-18 09:05:19 +11:00
dependabot[bot]
bd63408ec3 Bump tmpl from 1.0.4 to 1.0.5 (#112) 2022-10-18 09:04:50 +11:00
dependabot[bot]
da5491b474 Bump sharp from 0.29.1 to 0.30.5 (#106) 2022-10-18 09:04:27 +11:00
dependabot[bot]
bbd676b5b8 Bump @xmldom/xmldom from 0.7.4 to 0.7.6 (#111)
Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.4 to 0.7.6.
- [Release notes](https://github.com/xmldom/xmldom/releases)
- [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
- [Commits](https://github.com/xmldom/xmldom/compare/0.7.4...0.7.6)

---
updated-dependencies:
- dependency-name: "@xmldom/xmldom"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-10-18 08:03:05 +11:00
simojenki
d01c747c96 handling SIGTERM 2022-07-30 17:28:30 +10:00
Laurent le Beau-Martin
192f65a56b Improve ffmpeg command to transcode flac (#99)
* Improve ffmpeg command to transcode flac

The command previously suggested forced the output sample rate to 48 kHz, even if the input was lower, at 44.1 kHz. 
This new command lets `ffmpeg` select the appropriate output sample rate to minimize conversion. 
Documentation: https://www.ffmpeg.org/ffmpeg-filters.html#aformat-1

* Update transcoding command

- Support more sample rates and bit depths.
- Add note about S1
2022-03-10 15:06:56 +11:00
Simon J
9b3df4ce1a Support for using boolean values when using yaml docker-compose files rather than strings for booleans (#98) 2022-02-28 22:07:17 +11:00
Simon J
df9a6d4663 Improve date handling (#94) 2022-02-02 13:26:01 +11:00
simojenki
d0c80b2f20 Add linux/arm64 to platforms supported 2021-12-30 09:30:49 +11:00
49 changed files with 14995 additions and 14417 deletions

16
.devcontainer/Dockerfile Normal file
View File

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

View File

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

6
.dockerignore Normal file
View File

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

View File

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

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-berry.cjs

View File

@@ -1,4 +1,4 @@
FROM node:16-bullseye as build FROM node:23-bullseye-slim AS build
WORKDIR /bonob WORKDIR /bonob
@@ -9,14 +9,13 @@ 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=30000 ENV JEST_TIMEOUT=60000
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update && \ RUN apt-get update && \
@@ -29,13 +28,20 @@ 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 install --immutable && \ npm install && \
yarn gitinfo && \ npm test && \
yarn test --no-cache && \ npm run gitinfo && \
yarn build npm run build && \
rm -Rf node_modules && \
NODE_ENV=production npm install --omit=dev
FROM node:16-bullseye FROM node:23-bullseye-slim
LABEL maintainer="simojenki" \
org.opencontainers.image.source="https://github.com/simojenki/bonob" \
org.opencontainers.image.description="bonob SONOS SMAPI implementation" \
org.opencontainers.image.licenses="GPLv3"
ENV BNB_PORT=4534 ENV BNB_PORT=4534
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
@@ -46,17 +52,20 @@ 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
COPY --from=build /bonob/.gitinfo ./ COPY --from=build /bonob/.gitinfo ./
COPY web ./web COPY web ./web
COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl
RUN apt-get update && \ RUN apt-get update && \
apt-get -y upgrade && \ apt-get -y upgrade && \
apt-get -y install --no-install-recommends libvips tzdata && \ apt-get -y install --no-install-recommends \
libvips \
tzdata \
wget && \
apt-get clean && \ apt-get clean && \
rm -rf /var/lib/apt/lists/* rm -rf /var/lib/apt/lists/*

View File

@@ -9,23 +9,40 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
## Features ## Features
- Integrates with Subsonic API clones (Navidrome, Gonic) - Integrates with Subsonic API clones (Navidrome, Gonic)
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums - Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
- Artist & Album Art - Artist & Album Art
- View Related Artists via Artist -> '...' -> Menu -> Related Arists - View Related Artists via Artist -> '...' -> Menu -> Related Arists
- Now playing & Track Scrobbling - Now playing & Track Scrobbling
- Search by Album, Artist, Track - Search by Album, Artist, Track
- Playlist editing through sonos app. - Playlist editing through sonos app.
- Marking of songs as favourites and with ratings through the sonos app. - Marking of songs as favourites and with ratings through the sonos app.
- Localization (only en-US & nl-NL supported currently, require translations for other languages). [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/) - Localization (only en-US, da-DK, nl-NL & fr-FR supported currently, require translations for other languages). [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
- Auto discovery of sonos devices - 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
bonob is distributed via docker and can be run in a number of ways bonob is packaged as an OCI image to both the docker hub registry and github registry.
ie.
```bash
docker pull docker.io/simojenki/bonob
```
or
```bash
docker pull ghcr.io/simojenki/bonob
```
tag | description
--- | ---
latest | Latest release, intended to be stable
master | Lastest build from master, probably works, however is currently under test
vX.Y.Z | Fixed release versions from tags, for those that want to pin to a specific release
### Full sonos device auto-discovery and auto-registration using docker --network host ### Full sonos device auto-discovery and auto-registration using docker --network host
@@ -126,8 +143,8 @@ services:
# ip address of your machine running bonob # ip address of your machine running bonob
BNB_URL: http://192.168.1.111:4534 BNB_URL: http://192.168.1.111:4534
BNB_SECRET: changeme BNB_SECRET: changeme
BNB_SONOS_AUTO_REGISTER: true BNB_SONOS_AUTO_REGISTER: "true"
BNB_SONOS_DEVICE_DISCOVERY: true BNB_SONOS_DEVICE_DISCOVERY: "true"
BNB_SONOS_SERVICE_ID: 246 BNB_SONOS_SERVICE_ID: 246
# ip address of one of your sonos devices # ip address of one of your sonos devices
BNB_SONOS_SEED_HOST: 192.168.1.121 BNB_SONOS_SEED_HOST: 192.168.1.121
@@ -146,14 +163,16 @@ BNB_PORT | 4534 | Default http port for bonob to listen on
BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.** BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.**
BNB_SECRET | bonob | secret used for encrypting credentials BNB_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_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.
BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery
BNB_SONOS_SERVICE_NAME | bonob | service name for sonos BNB_SONOS_SERVICE_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 as are sourced externally. ie. Navidrome provides spotify URLs BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache.
BNB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s BNB_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
BNB_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html) BNB_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
@@ -188,34 +207,58 @@ Generally speaking you will not need to do this very often. However on occassio
Service should now be registered and everything should work as expected. Service should now be registered and everything should work as expected.
## Multiple registrations within a single household.
It's possible to register multiple Subsonic clone users for the bonob service in Sonos.
Basically this consist of repeating the Sonos app ["Add a service"](#initialising-service-within-sonos-app) steps for each additional user.
Afterwards the Sonos app displays a dropdown underneath the service, allowing to switch between users.
## Implementing a different music source other than a subsonic clone ## Implementing a different music source other than a subsonic clone
- 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"
``` ```
This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'. You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a sonos supported format, ie [Using something like this](https://stackoverflow.com/questions/41420391/ffmpeg-flac-24-bit-96khz-to-16-bit-48khz); This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'. You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a sonos supported format, ie [Using something like this](https://stackoverflow.com/questions/41420391/ffmpeg-flac-24-bit-96khz-to-16-bit-48khz) or [this](https://stackoverflow.com/questions/52119489/ffmpeg-limit-audio-sample-rate):
```bash ```bash
ffmpeg -i %s -af aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=48000 -f flac - ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
``` ```
### Changing Icon colors **Note for Sonos S1:** [24-bit depth is only supported by Sonos S2](https://support.sonos.com/s/article/79?language=en_US), so if your system is still on Sonos S1, transcoding should convert all FLACs to 16-bit:
```bash
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
```
Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;
```bash
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
```
And then configure the 'bonob+audio/mpeg' player in your subsonic server.
## Changing Icon colors
```bash ```bash
-e BNB_ICON_FOREGROUND_COLOR=white \ -e BNB_ICON_FOREGROUND_COLOR=white \
@@ -245,6 +288,7 @@ ffmpeg -i %s -af aresample=resampler=soxr:out_sample_fmt=s16:out_sample_rate=480
![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true) ![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

View File

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

7472
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -6,64 +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.4.0", "@svrooij/sonos": "^2.6.0-beta.11",
"@types/express": "^4.17.13", "@types/express": "^4.17.21",
"@types/fs-extra": "^9.0.13", "@types/fs-extra": "^11.0.4",
"@types/jsonwebtoken": "^8.5.5", "@types/jsonwebtoken": "^9.0.7",
"@types/jws": "^3.2.4", "@types/jws": "^3.2.10",
"@types/morgan": "^1.9.3", "@types/morgan": "^1.9.9",
"@types/node": "^16.7.13", "@types/node": "^20.11.5",
"@types/randomstring": "^1.1.8", "@types/randomstring": "^1.3.0",
"@types/sharp": "^0.28.6", "@types/underscore": "^1.13.0",
"@types/underscore": "^1.11.3", "@types/uuid": "^10.0.0",
"@types/uuid": "^8.3.1", "@types/xmldom": "^0.1.34",
"axios": "^0.21.4", "@xmldom/xmldom": "^0.9.7",
"dayjs": "^1.10.6", "axios": "^1.7.8",
"eta": "^1.12.3", "dayjs": "^1.11.13",
"express": "^4.17.1", "eta": "^2.2.0",
"fp-ts": "^2.11.1", "express": "^4.18.3",
"fs-extra": "^10.0.0", "fp-ts": "^2.16.9",
"jsonwebtoken": "^8.5.1", "fs-extra": "^11.2.0",
"jsonwebtoken": "^9.0.2",
"jws": "^4.0.0", "jws": "^4.0.0",
"libxmljs2": "^0.28.0",
"morgan": "^1.10.0", "morgan": "^1.10.0",
"node-html-parser": "^4.1.4", "node-html-parser": "^6.1.13",
"randomstring": "^1.2.1", "randomstring": "^1.3.0",
"sharp": "^0.29.1", "sharp": "^0.33.5",
"soap": "^0.42.0", "soap": "^1.1.6",
"ts-md5": "^1.2.9", "ts-md5": "^1.3.1",
"typescript": "^4.4.2", "typescript": "^5.7.2",
"underscore": "^1.13.1", "underscore": "^1.13.7",
"urn-lib": "^2.0.0", "urn-lib": "^2.0.0",
"uuid": "^8.3.2", "uuid": "^11.0.3",
"winston": "^3.3.3" "winston": "^3.17.0",
"xmldom-ts": "^0.3.1",
"xpath": "^0.0.34"
}, },
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.21", "@types/chai": "^5.0.1",
"@types/jest": "^27.0.1", "@types/jest": "^29.5.14",
"@types/mocha": "^9.0.0", "@types/mocha": "^10.0.10",
"@types/supertest": "^2.0.11", "@types/supertest": "^6.0.2",
"@types/tmp": "^0.2.1", "@types/tmp": "^0.2.6",
"chai": "^4.3.4", "chai": "^5.1.2",
"get-port": "^5.1.1", "get-port": "^7.1.0",
"image-js": "^0.33.0", "image-js": "^0.35.6",
"jest": "^27.1.0", "jest": "^29.7.0",
"nodemon": "^2.0.12", "nodemon": "^3.1.7",
"supertest": "^6.1.6", "supertest": "^7.0.0",
"tmp": "^0.2.1", "tmp": "^0.2.3",
"ts-jest": "^27.0.5", "ts-jest": "^29.2.5",
"ts-mockito": "^2.6.1", "ts-mockito": "^2.6.1",
"ts-node": "^10.2.1", "ts-node": "^10.9.2",
"xmldom-ts": "^0.3.1",
"xpath-ts": "^1.3.13" "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_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true nodemon -V ./src/app.ts", "dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"devr": "BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true nodemon -V ./src/app.ts", "devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_ICON_FOREGROUND_COLOR=deeppink BNB_ICON_BACKGROUND_COLOR=darkslategray BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"register-dev": "ts-node ./src/register.ts http://$(hostname):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"
} }
} }

View File

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

View File

@@ -4,17 +4,18 @@ import server from "./server";
import logger from "./logger"; import logger from "./logger";
import { import {
appendMimeTypeToClientFor,
axiosImageFetcher, axiosImageFetcher,
cachingImageFetcher, cachingImageFetcher,
DEFAULT, TranscodingCustomPlayers,
Subsonic, NO_CUSTOM_PLAYERS,
Subsonic
} from "./subsonic"; } from "./subsonic";
import { SubsonicMusicService} from "./subsonic_music_library";
import { InMemoryAPITokens, sha256 } from "./api_tokens"; import { InMemoryAPITokens, sha256 } from "./api_tokens";
import { InMemoryLinkCodes } from "./link_codes"; import { InMemoryLinkCodes } from "./link_codes";
import readConfig from "./config"; import readConfig from "./config";
import sonos, { bonobService } from "./sonos"; import sonos, { bonobService } from "./sonos";
import { MusicService } from "./music_service"; import { MusicService } from "./music_library";
import { SystemClock } from "./clock"; import { SystemClock } from "./clock";
import { JWTSmapiLoginTokens } from "./smapi_auth"; import { JWTSmapiLoginTokens } from "./smapi_auth";
@@ -32,18 +33,21 @@ 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)
: axiosImageFetcher; : axiosImageFetcher;
const subsonic = new Subsonic( const subsonic = new SubsonicMusicService(
new Subsonic(
config.subsonic.url, config.subsonic.url,
streamUserAgent, customPlayers,
artistImageFetcher artistImageFetcher
),
customPlayers
); );
const featureFlagAwareMusicService: MusicService = { const featureFlagAwareMusicService: MusicService = {
@@ -88,14 +92,14 @@ const app = server(
clock, clock,
iconColors: config.icons, iconColors: config.icons,
applyContextPath: true, applyContextPath: true,
logRequests: true, logRequests: config.logRequests,
version, version,
smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout), smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout),
externalImageResolver: artistImageFetcher externalImageResolver: artistImageFetcher
} }
); );
app.listen(config.port, () => { const expressServer = app.listen(config.port, () => {
logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`); logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`);
}); });
@@ -113,6 +117,15 @@ if (config.sonos.autoRegister) {
logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`); logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`);
}); });
}); });
} };
process.on('SIGTERM', () => {
logger.info('SIGTERM signal received: closing HTTP server');
expressServer.close(() => {
logger.info('HTTP server closed');
});
process.exit(0);
});
export default app; export default app;

View File

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

View File

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

View File

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

View File

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

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" | "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"
@@ -39,6 +40,7 @@ export type KEY =
| "loginFailed" | "loginFailed"
| "noSonosDevices" | "noSonosDevices"
| "favourites" | "favourites"
| "years"
| "LOVE" | "LOVE"
| "LOVE_SUCCESS" | "LOVE_SUCCESS"
| "STAR" | "STAR"
@@ -51,6 +53,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",
@@ -81,6 +84,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Login failed!", loginFailed: "Login failed!",
noSonosDevices: "No sonos devices", noSonosDevices: "No sonos devices",
favourites: "Favourites", favourites: "Favourites",
years: "Years",
STAR: "Star", STAR: "Star",
UNSTAR: "Un-star", UNSTAR: "Un-star",
STAR_SUCCESS: "Track starred", STAR_SUCCESS: "Track starred",
@@ -88,10 +92,97 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
LOVE: "Love", LOVE: "Love",
LOVE_SUCCESS: "Track loved" LOVE_SUCCESS: "Track loved"
}, },
"da-DK": {
AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
artists: "Kunstnere",
albums: "Album",
internetRadio: "Internet Radio",
tracks: "Numre",
playlists: "Afspilningslister",
genres: "Genre",
random: "Tilfældig",
topRated: "Højst vurderet",
recentlyAdded: "Senest tilføjet",
recentlyPlayed: "Senest afspillet",
mostPlayed: "Flest afspilninger",
success: "Succes",
failure: "Fejl",
expectedConfig: "Forventet konfiguration",
existingServiceConfig: "Eksisterende tjeneste konfiguration",
noExistingServiceRegistration: "Ingen eksisterende tjeneste registrering",
register: "Registrer",
removeRegistration: "Fjern registrering",
devices: "Enheder",
services: "Tjenester",
login: "Log på",
logInToBonob: "Log på $BNB_SONOS_SERVICE_NAME",
username: "Brugernavn",
password: "Adgangskode",
successfullyRegistered: "Registreret med succes",
registrationFailed: "Registrering fejlede!",
successfullyRemovedRegistration: "Registrering fjernet med succes",
failedToRemoveRegistration: "FJernelse af registrering fejlede!",
invalidLinkCode: "Ugyldig linkCode!",
loginSuccessful: "Log på succes!",
loginFailed: "Log på fejlede!",
noSonosDevices: "Ingen Sonos enheder",
favourites: "Favoritter",
years: "Flere år",
STAR: "Tilføj stjerne",
UNSTAR: "Fjern stjerne",
STAR_SUCCESS: "Stjerne tilføjet",
UNSTAR_SUCCESS: "Stjerne fjernet",
LOVE: "Synes godt om",
LOVE_SUCCESS: "Syntes godt om"
},
"fr-FR": {
AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
artists: "Artistes",
albums: "Albums",
internetRadio: "Radio Internet",
tracks: "Pistes",
playlists: "Playlists",
genres: "Genres",
random: "Aléatoire",
topRated: "Les mieux notés",
recentlyAdded: "Récemment ajouté",
recentlyPlayed: "Récemment joué",
mostPlayed: "Les plus joué",
success: "Succès",
failure: "Échec",
expectedConfig: "Configuration attendue",
existingServiceConfig: "La configuration de service existe",
noExistingServiceRegistration: "Aucun enregistrement de service existant",
register: "Inscription",
removeRegistration: "Supprimer l'inscription",
devices: "Appareils",
services: "Services",
login: "Se connecter",
logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
username: "Nom d'utilisateur",
password: "Mot de passe",
successfullyRegistered: "Connecté avec succès",
registrationFailed: "Échec de la connexion !",
successfullyRemovedRegistration: "Inscription supprimée avec succès",
failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
invalidLinkCode: "Code non valide !",
loginSuccessful: "Connexion réussie !",
loginFailed: "La connexion a échoué !",
noSonosDevices: "Aucun appareil Sonos",
favourites: "Favoris",
years: "Années",
STAR: "Suivre",
UNSTAR: "Ne plus suivre",
STAR_SUCCESS: "Piste suivie",
UNSTAR_SUCCESS: "Piste non suivie",
LOVE: "Aimer",
LOVE_SUCCESS: "Pistes aimée"
},
"nl-NL": { "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",
@@ -122,6 +213,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Inloggen mislukt!", loginFailed: "Inloggen mislukt!",
noSonosDevices: "Geen Sonos-apparaten", noSonosDevices: "Geen Sonos-apparaten",
favourites: "Favorieten", favourites: "Favorieten",
years: "Jaren",
STAR: "Ster ", STAR: "Ster ",
UNSTAR: "Een ster", UNSTAR: "Een ster",
STAR_SUCCESS: "Nummer met ster", STAR_SUCCESS: "Nummer met ster",

View File

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

View File

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

View File

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

View File

@@ -22,7 +22,7 @@ import {
ratingAsInt, ratingAsInt,
} from "./smapi"; } from "./smapi";
import { LinkCodes, InMemoryLinkCodes } from "./link_codes"; import { LinkCodes, InMemoryLinkCodes } from "./link_codes";
import { MusicService, AuthFailure, AuthSuccess } from "./music_service"; import { MusicService, AuthFailure, AuthSuccess } from "./music_library";
import bindSmapiSoapServiceToExpress from "./smapi"; import bindSmapiSoapServiceToExpress from "./smapi";
import { APITokens, InMemoryAPITokens } from "./api_tokens"; import { APITokens, InMemoryAPITokens } from "./api_tokens";
import logger from "./logger"; import logger from "./logger";
@@ -31,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 {
@@ -374,7 +373,7 @@ function server(
const id = req.params["id"]!; const id = req.params["id"]!;
const trace = uuid(); const trace = uuid();
logger.info( logger.debug(
`${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify( `${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify(
req.query req.query
)}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}` )}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}`
@@ -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.info( logger.debug(
`${trace} bnb<- stream response from music service for ${id}, status=${ `${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
stream.status
}, headers=(${JSON.stringify(stream.headers)})`
); );
const sonosisfyContentType = (contentType: string) => const sonosisfyContentType = (contentType: string) =>
@@ -435,10 +438,8 @@ function server(
sendStream: boolean; sendStream: boolean;
nowPlaying: boolean; nowPlaying: boolean;
}) => { }) => {
logger.info( logger.debug(
`${trace} bnb-> ${ `${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
req.path
}, status=${status}, headers=${JSON.stringify(headers)}`
); );
(nowPlaying (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()
}); });
}; };
@@ -497,16 +498,18 @@ function server(
} }
}); });
app.get("/icon/:type/size/:size", (req, res) => { app.get("/icon/:type_text/size/:size", (req, res) => {
const type = req.params["type"]!; const match = (req.params["type_text"] || "")!.match("^([A-Za-z0-9]+)(?:\:([A-Za-z0-9]+))?$")
if (!match)
return res.status(400).send();
const type = match[1]!
const text = match[2]
const size = req.params["size"]!; const size = req.params["size"]!;
if (!Object.keys(ICONS).includes(type)) { if (!Object.keys(ICONS).includes(type)) {
return res.status(404).send(); return res.status(404).send();
} else if ( } else if (size != "legacy" && !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)) {
size != "legacy" &&
!SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)
) {
return res.status(400).send(); return res.status(400).send();
} else { } else {
let icon = (ICONS as any)[type]! as Icon; let icon = (ICONS as any)[type]! as Icon;
@@ -527,8 +530,8 @@ function server(
icon icon
.apply( .apply(
features({ features({
viewPortIncreasePercent: 80,
...serverOpts.iconColors, ...serverOpts.iconColors,
text: text
}) })
) )
.apply(festivals(clock)) .apply(festivals(clock))
@@ -556,23 +559,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 +574,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") {
return serverOpts.externalImageResolver(it.resource);
} else { } else {
return musicLibrary.coverArt(it, size); return musicLibrary.coverArt(urn, 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

@@ -10,23 +10,24 @@ import logger from "./logger";
import { LinkCodes } from "./link_codes"; import { LinkCodes } from "./link_codes";
import { import {
Album,
AlbumQuery, AlbumQuery,
AlbumSummary, AlbumSummary,
ArtistSummary, ArtistSummary,
Genre, Genre,
Year,
MusicService, MusicService,
Playlist, Playlist,
RadioStation,
Rating, Rating,
slice2, slice2,
Track, Track,
} from "./music_service"; } from "./music_library";
import { APITokens } from "./api_tokens"; import { APITokens } from "./api_tokens";
import { Clock } from "./clock"; import { Clock } from "./clock";
import { URLBuilder } from "./url_builder"; import { URLBuilder } from "./url_builder";
import { asLANGs, I8N } from "./i8n"; import { asLANGs, I8N } from "./i8n";
import { ICON, iconForGenre } from "./icon"; import { ICON, iconForGenre } from "./icon";
import _, { uniq } from "underscore"; import _ from "underscore";
import { BUrn, formatForURL } from "./burn"; import { BUrn, formatForURL } from "./burn";
import { import {
isExpiredTokenError, isExpiredTokenError,
@@ -60,7 +61,7 @@ export const SONOS_RECOMMENDED_IMAGE_SIZES = [
const WSDL_FILE = path.resolve( const WSDL_FILE = path.resolve(
__dirname, __dirname,
"Sonoswsdl-1.19.4-20190411.142401-3.wsdl" "Sonoswsdl-1.19.6-20231024.wsdl"
); );
export type Credentials = { export type Credentials = {
@@ -243,17 +244,25 @@ export type Container = {
}; };
const genre = (bonobUrl: URLBuilder, genre: Genre) => ({ const genre = (bonobUrl: URLBuilder, genre: Genre) => ({
itemType: "container", itemType: "albumList",
id: `genre:${genre.id}`, id: `genre:${genre.id}`,
title: genre.name, title: genre.name,
albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(), albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(),
}); });
const yyyy = (bonobUrl: URLBuilder, year: Year) => ({
itemType: "albumList",
id: `year:${year.year}`,
title: year.year,
// todo: maybe year.year should be nullable?
albumArtURI: year.year !== "?" ? iconArtURI(bonobUrl, "yyyy", year.year).href() : iconArtURI(bonobUrl, "music").href(),
});
const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: playlistAlbumArtURL(bonobUrl, playlist).href(), albumArtURI: coverArtURI(bonobUrl, playlist).href(),
canPlay: true, canPlay: true,
attributes: { attributes: {
readOnly: false, readOnly: false,
@@ -262,29 +271,9 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
}, },
}); });
export const playlistAlbumArtURL = ( export const coverArtURI = (
bonobUrl: URLBuilder, bonobUrl: URLBuilder,
playlist: Playlist { coverArt }: { coverArt?: BUrn | undefined }
) => {
const burns: BUrn[] = uniq(
playlist.entries.filter((it) => it.coverArt != undefined),
(it) => it.album.id
).map((it) => it.coverArt!);
if (burns.length == 0) {
return iconArtURI(bonobUrl, "error");
} else {
return bonobUrl.append({
pathname: `/art/${burns
.slice(0, 9)
.map((it) => encodeURIComponent(formatForURL(it)))
.join("&")}/size/180`,
});
}
};
export const defaultAlbumArtURI = (
bonobUrl: URLBuilder,
{ coverArt }: { coverArt: BUrn | undefined }
) => ) =>
pipe( pipe(
coverArt, coverArt,
@@ -297,26 +286,11 @@ export const defaultAlbumArtURI = (
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl")) O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
); );
export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) => export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON, text: string | undefined = undefined) =>
bonobUrl.append({ bonobUrl.append({
pathname: `/icon/${icon}/size/legacy`, pathname: `/icon/${text == undefined ? icon : `${icon}:${text}`}/size/legacy`,
}); });
export const defaultArtistArtURI = (
bonobUrl: URLBuilder,
artist: ArtistSummary
) =>
pipe(
artist.image,
O.fromNullable,
O.map((it) =>
bonobUrl.append({
pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
})
),
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
);
export const sonosifyMimeType = (mimeType: string) => export const sonosifyMimeType = (mimeType: string) =>
mimeType == "audio/x-flac" ? "audio/flac" : mimeType; mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
@@ -326,7 +300,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,
@@ -334,10 +308,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: {
@@ -345,7 +326,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,
@@ -363,7 +344,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) {
@@ -461,9 +442,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();
@@ -522,7 +501,14 @@ function bindSmapiSoapServiceToExpress(
) => ) =>
login(soapyHeaders?.credentials) login(soapyHeaders?.credentials)
.then(splitId(id)) .then(splitId(id))
.then(({ credentials, type, typeId }) => ({ .then(({ musicLibrary, credentials, type, typeId }) => {
switch (type) {
case "internetRadioStation":
return musicLibrary.radioStation(typeId).then((it) => ({
getMediaURIResult: it.url,
}));
case "track":
return {
getMediaURIResult: bonobUrl getMediaURIResult: bonobUrl
.append({ .append({
pathname: `/stream/${type}/${typeId}`, pathname: `/stream/${type}/${typeId}`,
@@ -542,7 +528,11 @@ function bindSmapiSoapServiceToExpress(
}, },
}, },
], ],
})), };
default:
throw `Unsupported type:${type}`;
}
}),
getMediaMetadata: async ( getMediaMetadata: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
@@ -550,11 +540,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) {
case "internetRadioStation":
return musicLibrary.radioStation(typeId).then((it) => ({
getMediaMetadataResult: internetRadioStation(it),
}));
case "track":
return musicLibrary.track(typeId!).then((it) => ({
getMediaMetadataResult: track(urlWithToken(apiKey), it), getMediaMetadataResult: track(urlWithToken(apiKey), it),
})) }));
), default:
throw `Unsupported type:${type}`;
}
}),
search: async ( search: async (
{ id, term }: { id: string; term: string }, { id, term }: { id: string; term: string },
_, _,
@@ -612,7 +611,7 @@ function bindSmapiSoapServiceToExpress(
switch (type) { switch (type) {
case "artist": case "artist":
return musicLibrary.artist(typeId).then((artist) => { return musicLibrary.artist(typeId).then((artist) => {
const [page, total] = slice2<Album>(paging)( const [page, total] = slice2<AlbumSummary>(paging)(
artist.albums artist.albums
); );
return { return {
@@ -749,6 +748,12 @@ function bindSmapiSoapServiceToExpress(
albumArtURI: iconArtURI(bonobUrl, "genres").href(), albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container", itemType: "container",
}, },
{
id: "years",
title: lang("years"),
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{ {
id: "recentlyAdded", id: "recentlyAdded",
title: lang("recentlyAdded"), title: lang("recentlyAdded"),
@@ -776,6 +781,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":
@@ -820,6 +831,13 @@ function bindSmapiSoapServiceToExpress(
genre: typeId, genre: typeId,
...paging, ...paging,
}); });
case "year":
return albums({
type: "byYear",
fromYear: typeId,
toYear: typeId,
...paging,
});
case "randomAlbums": case "randomAlbums":
return albums({ return albums({
type: "random", type: "random",
@@ -850,6 +868,32 @@ function bindSmapiSoapServiceToExpress(
type: "mostPlayed", type: "mostPlayed",
...paging, ...paging,
}); });
case "internetRadio":
return musicLibrary
.radioStations()
.then(slice2(paging))
.then(([page, total]) =>
getMetadataResult({
mediaMetadata: page.map((it) =>
internetRadioStation(it)
),
index: paging._index,
total,
})
);
case "years":
return musicLibrary
.years()
.then(slice2(paging))
.then(([page, total]) =>
getMetadataResult({
mediaCollection: page.map((it) =>
yyyy(bonobUrl, it)
),
index: paging._index,
total,
})
);
case "genres": case "genres":
return musicLibrary return musicLibrary
.genres() .genres()
@@ -868,9 +912,16 @@ function bindSmapiSoapServiceToExpress(
.playlists() .playlists()
.then((it) => .then((it) =>
Promise.all( Promise.all(
it.map((playlist) => it.map((playlist) => {
musicLibrary.playlist(playlist.id) // todo: whats this odd copy all about, can we just delete it?
) return {
id: playlist.id,
name: playlist.name,
coverArt: playlist.coverArt,
// todo: are these every important?
entries: [],
};
})
) )
) )
.then(slice2(paging)) .then(slice2(paging))
@@ -902,15 +953,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!)
@@ -930,7 +981,8 @@ function bindSmapiSoapServiceToExpress(
}); });
case "album": case "album":
return musicLibrary return musicLibrary
.tracks(typeId!) .album(typeId!)
.then(it => it.tracks)
.then(slice2(paging)) .then(slice2(paging))
.then(([page, total]) => { .then(([page, total]) => {
return getMetadataResult({ return getMetadataResult({
@@ -1066,8 +1118,9 @@ function bindSmapiSoapServiceToExpress(
soapyService.log = (type, data) => { soapyService.log = (type, data) => {
switch (type) { switch (type) {
// routing all soap info messages to debug so less noisy
case "info": case "info":
logger.info({ level: "info", data }); logger.debug({ level: "info", data });
break; break;
case "warn": case "warn":
logger.warn({ level: "warn", data }); logger.warn({ level: "warn", data });

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

@@ -2,25 +2,21 @@ import { option as O, taskEither as TE } from "fp-ts";
import * as A from "fp-ts/Array"; import * as A from "fp-ts/Array";
import { ordString } from "fp-ts/lib/Ord"; import { ordString } from "fp-ts/lib/Ord";
import { pipe } from "fp-ts/lib/function"; import { pipe } from "fp-ts/lib/function";
import { Md5 } from "ts-md5/dist/md5"; import { Md5 } from "ts-md5";
import { import {
Credentials, Credentials,
MusicService,
Album, Album,
Result,
slice2,
AlbumQuery, AlbumQuery,
ArtistQuery,
MusicLibrary,
AlbumSummary, AlbumSummary,
Genre, Genre,
Track, Track,
CoverArt, CoverArt,
Rating,
AlbumQueryType, AlbumQueryType,
Artist, Encoding,
AuthFailure, albumToAlbumSummary,
} from "./music_service"; TrackSummary,
AuthFailure
} from "./music_library";
import sharp from "sharp"; import sharp from "sharp";
import _ from "underscore"; import _ from "underscore";
import fse from "fs-extra"; import fse from "fs-extra";
@@ -29,9 +25,9 @@ import path from "path";
import axios, { AxiosRequestConfig } from "axios"; import axios, { AxiosRequestConfig } from "axios";
import randomstring from "randomstring"; import randomstring from "randomstring";
import { b64Encode, b64Decode } from "./b64"; import { b64Encode, b64Decode } from "./b64";
import logger from "./logger"; import { BUrn } from "./burn";
import { assertSystem, BUrn } from "./burn"; import { album, artist } from "./smapi";
import { artist } from "./smapi"; import { URLBuilder } from "./url_builder";
export const BROWSER_HEADERS = { export const BROWSER_HEADERS = {
accept: accept:
@@ -105,7 +101,7 @@ type genre = {
value: string; value: string;
}; };
type GetGenresResponse = SubsonicResponse & { export type GetGenresResponse = SubsonicResponse & {
genres: { genres: {
genre: genre[]; genre: genre[];
}; };
@@ -161,48 +157,74 @@ 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;
// todo: this field shouldnt be on song?
starred: string | undefined; starred: string | undefined;
}; };
type GetAlbumResponse = { export type GetAlbumResponse = {
album: album & { album: album & {
song: song[]; song: song[];
}; };
}; };
type playlist = { export type GetPlaylistResponse = {
id: string; // todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
name: string;
};
type GetPlaylistResponse = {
playlist: { playlist: {
id: string; id: string;
name: string; name: string;
entry: song[]; entry: song[];
// todo: this is an ND specific field?
coverArt: string | undefined;
}; };
}; };
type GetPlaylistsResponse = { export type GetPlaylistsResponse = {
playlists: { playlist: playlist[] }; playlists: {
playlist: {
id: string;
name: string;
//owner: string,
//public: boolean,
//created: string,
//changed: string,
//songCount: int,
//duration: int,
// todo: this is an ND specific field.
coverArt: string | undefined;
}[]
};
}; };
type GetSimilarSongsResponse = { export type GetSimilarSongsResponse = {
similarSongs2: { song: song[] }; similarSongs2: { song: song[] };
}; };
type GetTopSongsResponse = { export type GetTopSongsResponse = {
topSongs: { song: song[] }; topSongs: { song: song[] };
}; };
type GetSongResponse = { export type GetInternetRadioStationsResponse = {
internetRadioStations: {
internetRadioStation: {
id: string;
name: string;
streamUrl: string;
homePageUrl?: string;
}[];
};
};
export type GetSongResponse = {
song: song; song: song;
}; };
type GetStarredResponse = { export type GetStarredResponse = {
starred2: { starred2: {
song: song[]; song: song[];
album: album[]; album: album[];
@@ -216,7 +238,7 @@ export type PingResponse = {
serverVersion: string; serverVersion: string;
}; };
type Search3Response = SubsonicResponse & { export type Search3Response = SubsonicResponse & {
searchResult3: { searchResult3: {
artist: artist[]; artist: artist[];
album: album[]; album: album[];
@@ -230,12 +252,12 @@ export function isError(
return (subsonicResponse as SubsonicError).error !== undefined; return (subsonicResponse as SubsonicError).error !== undefined;
} }
type IdName = { export type IdName = {
id: string; id: string;
name: string; name: string;
}; };
const coverArtURN = (coverArt: string | undefined): BUrn | undefined => export const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
pipe( pipe(
coverArt, coverArt,
O.fromNullable, O.fromNullable,
@@ -269,15 +291,25 @@ export const artistImageURN = (
} }
}; };
export const asTrack = (album: Album, song: song): Track => ({ export const asTrackSummary = (
song: song,
customPlayers: CustomPlayers
): TrackSummary => ({
id: song.id, 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),
coverArt: coverArtURN(song.coverArt), coverArt: coverArtURN(song.coverArt),
album,
artist: { artist: {
id: song.artistId, id: song.artistId,
name: song.artist ? song.artist : "?", name: song.artist ? song.artist : "?",
@@ -294,7 +326,16 @@ export const asTrack = (album: Album, song: song): Track => ({
}, },
}); });
const asAlbum = (album: album): Album => ({ export const asTrack = (
album: AlbumSummary,
song: song,
customPlayers: CustomPlayers
): Track => ({
...asTrackSummary(song, customPlayers),
album: album,
});
export const asAlbumSummary = (album: album): AlbumSummary => ({
id: album.id, id: album.id,
name: album.name, name: album.name,
year: album.year, year: album.year,
@@ -309,7 +350,9 @@ export const asGenre = (genreName: string) => ({
name: genreName, name: genreName,
}); });
const maybeAsGenre = (genreName: string | undefined): Genre | undefined => export const maybeAsGenre = (
genreName: string | undefined
): Genre | undefined =>
pipe( pipe(
genreName, genreName,
O.fromNullable, O.fromNullable,
@@ -317,19 +360,58 @@ const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
O.getOrElseW(() => undefined) O.getOrElseW(() => undefined)
); );
export type StreamClientApplication = (track: Track) => string; export const asYear = (year: string) => ({
year: year,
});
const DEFAULT_CLIENT_APPLICATION = "bonob"; export interface CustomPlayers {
const USER_AGENT = "bonob"; encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>;
export const DEFAULT: StreamClientApplication = (_: Track) =>
DEFAULT_CLIENT_APPLICATION;
export function appendMimeTypeToClientFor(mimeTypes: string[]) {
return (track: Track) =>
mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
} }
export type CustomClient = {
mimeType: string;
transcodedMimeType: string;
};
export class TranscodingCustomPlayers implements CustomPlayers {
transcodings: Map<string, string>;
constructor(transcodings: Map<string, string>) {
this.transcodings = transcodings;
}
static from(config: string): TranscodingCustomPlayers {
const parts: [string, string][] = config
.split(",")
.map((it) => it.split(">"))
.map((pair) => {
if (pair.length == 1) return [pair[0]!, pair[0]!];
else if (pair.length == 2) return [pair[0]!, pair[1]!];
else throw new Error(`Invalid configuration item ${config}`);
});
return new TranscodingCustomPlayers(new Map(parts));
}
encodingFor = ({ mimeType }: { mimeType: string }): O.Option<Encoding> =>
pipe(
this.transcodings.get(mimeType),
O.fromNullable,
O.map((transcodedMimeType) => ({
player: `${DEFAULT_CLIENT_APPLICATION}+${mimeType}`,
mimeType: transcodedMimeType,
}))
);
}
export const NO_CUSTOM_PLAYERS: CustomPlayers = {
encodingFor(_) {
return O.none;
},
};
export const DEFAULT_CLIENT_APPLICATION = "bonob";
export const USER_AGENT = "bonob";
export const asURLSearchParams = (q: any) => { export const asURLSearchParams = (q: any) => {
const urlSearchParams = new URLSearchParams(); const urlSearchParams = new URLSearchParams();
Object.keys(q).forEach((k) => { Object.keys(q).forEach((k) => {
@@ -343,7 +425,7 @@ export const asURLSearchParams = (q: any) => {
export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>; export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
export const cachingImageFetcher = export const cachingImageFetcher =
(cacheDir: string, delegate: ImageFetcher) => (cacheDir: string, delegate: ImageFetcher, makeSharp = sharp) =>
async (url: string): Promise<CoverArt | undefined> => { async (url: string): Promise<CoverArt | undefined> => {
const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`); const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
return fse return fse
@@ -352,7 +434,7 @@ export const cachingImageFetcher =
.catch(() => .catch(() =>
delegate(url).then((image) => { delegate(url).then((image) => {
if (image) { if (image) {
return sharp(image.data) return makeSharp(image.data)
.png() .png()
.toBuffer() .toBuffer()
.then((png) => { .then((png) => {
@@ -383,6 +465,7 @@ const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
alphabeticalByArtist: "alphabeticalByArtist", alphabeticalByArtist: "alphabeticalByArtist",
alphabeticalByName: "alphabeticalByName", alphabeticalByName: "alphabeticalByName",
byGenre: "byGenre", byGenre: "byGenre",
byYear: "byYear",
random: "random", random: "random",
recentlyPlayed: "recent", recentlyPlayed: "recent",
mostPlayed: "frequent", mostPlayed: "frequent",
@@ -401,39 +484,33 @@ type SubsonicCredentials = Credentials & {
export const asToken = (credentials: SubsonicCredentials) => export const asToken = (credentials: SubsonicCredentials) =>
b64Encode(JSON.stringify(credentials)); b64Encode(JSON.stringify(credentials));
export const parseToken = (token: string): SubsonicCredentials => export const parseToken = (token: string): SubsonicCredentials =>
JSON.parse(b64Decode(token)); JSON.parse(b64Decode(token));
interface SubsonicMusicLibrary extends MusicLibrary { export class Subsonic {
flavour(): string; url: URLBuilder;
bearerToken( customPlayers: CustomPlayers;
credentials: Credentials
): TE.TaskEither<Error, string | undefined>;
}
export class Subsonic implements MusicService {
url: string;
streamClientApplication: StreamClientApplication;
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;
} }
get = async ( private get = async (
{ username, password }: Credentials, { username, password }: Credentials,
path: string, path: string,
q: {} = {}, q: {} = {},
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",
@@ -455,7 +532,9 @@ export class Subsonic implements MusicService {
} else return response; } else return response;
}); });
getJSON = async <T>( // todo: should I put a catch in here and force a subsonic fail status?
// or there is a catch above, that then throws, perhaps can go in there?
private getJSON = async <T>(
{ username, password }: Credentials, { username, password }: Credentials,
path: string, path: string,
q: {} = {} q: {} = {}
@@ -468,40 +547,16 @@ export class Subsonic implements MusicService {
else return json as unknown as T; else return json as unknown as T;
}); });
generateToken = (credentials: Credentials) => ping = (credentials: Credentials): TE.TaskEither<AuthFailure, { authenticated: Boolean, type: string}> =>
pipe(
TE.tryCatch( TE.tryCatch(
() => () => this.getJSON<PingResponse>(credentials, "/rest/ping.view")
this.getJSON<PingResponse>( .then(it => ({
_.pick(credentials, "username", "password"), authenticated: it.status == "ok",
"/rest/ping.view" type: it.type
), })),
(e) => new AuthFailure(e as string) (e) => new AuthFailure(e as string)
),
TE.chain(({ type }) =>
pipe(
TE.tryCatch(
() => this.libraryFor({ ...credentials, type }),
() => new AuthFailure("Failed to get library")
),
TE.map((library) => ({ type, library }))
) )
),
TE.chain(({ library, type }) =>
pipe(
library.bearerToken(credentials),
TE.map((bearer) => ({ bearer, type }))
)
),
TE.map(({ bearer, type }) => ({
serviceToken: asToken({ ...credentials, bearer, type }),
userId: credentials.username,
nickname: credentials.username,
}))
);
refreshToken = (serviceToken: string) =>
this.generateToken(parseToken(serviceToken));
getArtists = ( getArtists = (
credentials: Credentials credentials: Credentials
@@ -520,6 +575,7 @@ export class Subsonic implements MusicService {
})) }))
); );
// todo: should be getArtistInfo2?
getArtistInfo = ( getArtistInfo = (
credentials: Credentials, credentials: Credentials,
id: string id: string
@@ -543,29 +599,42 @@ export class Subsonic implements MusicService {
m: it.mediumImageUrl, m: it.mediumImageUrl,
l: it.largeImageUrl, l: it.largeImageUrl,
}, },
//todo: this does seem to be in OpenSubsonic?? it is also singular
similarArtist: (it.similarArtist || []).map((artist) => ({ similarArtist: (it.similarArtist || []).map((artist) => ({
id: `${artist.id}`, id: `${artist.id}`,
name: artist.name, name: artist.name,
// todo: whats this inLibrary used for? it probably should be filtered on??
inLibrary: artistIsInLibrary(artist.id), inLibrary: artistIsInLibrary(artist.id),
image: artistImageURN({ image: artistImageURN({
artistId: artist.id, artistId: artist.id,
artistImageURL: artist.artistImageUrl, artistImageURL: artist.artistImageUrl,
}), }),
})), })),
})); })
);
getAlbum = (credentials: Credentials, id: string): Promise<Album> => getAlbum = (credentials: Credentials, id: string): Promise<Album> =>
this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id }) this.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", { id })
.then((it) => it.album) .then((it) => it.album)
.then((album) => ({ .then((album) => {
const x: AlbumSummary = {
id: album.id, id: album.id,
name: album.name, name: album.name,
year: album.year, year: album.year,
genre: maybeAsGenre(album.genre), genre: maybeAsGenre(album.genre),
artistId: album.artistId, artistId: album.artistId,
artistName: album.artist, artistName: album.artist,
coverArt: coverArtURN(album.coverArt), coverArt: coverArtURN(album.coverArt)
})); }
return { summary: x, songs: album.song }
}).then(({ summary, songs }) => {
const x: AlbumSummary = summary
const y: Track[] = songs.map((it) => asTrack(summary, it, this.customPlayers))
return {
...x,
tracks: y
};
});
getArtist = ( getArtist = (
credentials: Credentials, credentials: Credentials,
@@ -584,26 +653,6 @@ export class Subsonic implements MusicService {
albums: this.toAlbumSummary(it.album || []), albums: this.toAlbumSummary(it.album || []),
})); }));
getArtistWithInfo = (credentials: Credentials, id: string) =>
Promise.all([
this.getArtist(credentials, id),
this.getArtistInfo(credentials, id),
]).then(([artist, artistInfo]) => ({
id: artist.id,
name: artist.name,
image: artistImageURN({
artistId: artist.id,
artistImageURL: [
artist.artistImageUrl,
artistInfo.images.l,
artistInfo.images.m,
artistInfo.images.s,
].find(isValidImage),
}),
albums: artist.albums,
similarArtists: artistInfo.similarArtist,
}));
getCoverArt = (credentials: Credentials, id: string, size?: number) => getCoverArt = (credentials: Credentials, id: string, size?: number) =>
this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, { this.get(credentials, "/rest/getCoverArt", size ? { id, size } : { id }, {
headers: { "User-Agent": "bonob" }, headers: { "User-Agent": "bonob" },
@@ -617,7 +666,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(albumToAlbumSummary(album), song, this.customPlayers)
) )
); );
@@ -657,6 +706,8 @@ export class Subsonic implements MusicService {
this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", { this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
type: AlbumQueryTypeToSubsonicType[q.type], type: AlbumQueryTypeToSubsonicType[q.type],
...(q.genre ? { genre: b64Decode(q.genre) } : {}), ...(q.genre ? { genre: b64Decode(q.genre) } : {}),
...(q.fromYear ? { fromYear: q.fromYear } : {}),
...(q.toYear ? { toYear: q.toYear } : {}),
size: 500, size: 500,
offset: q._index, offset: q._index,
}) })
@@ -667,111 +718,50 @@ export class Subsonic implements MusicService {
total: albums.length == 500 ? total : q._index + albums.length, total: albums.length == 500 ? total : q._index + albums.length,
})); }));
// getStarred2 = (credentials: Credentials): Promise<{ albums: Album[] }> => getGenres = (credentials: Credentials) =>
// this.getJSON<GetStarredResponse>(credentials, "/rest/getStarred2") this.getJSON<GetGenresResponse>(credentials, "/rest/getGenres").then((it) =>
// .then((it) => it.starred2)
// .then((it) => ({
// albums: it.album.map(asAlbum),
// }));
login = async (token: string) => this.libraryFor(parseToken(token));
private libraryFor = (
credentials: Credentials & { type: string }
): Promise<SubsonicMusicLibrary> => {
const subsonic = this;
const genericSubsonic: SubsonicMusicLibrary = {
flavour: () => "subsonic",
bearerToken: (_: Credentials) => TE.right(undefined),
artists: (q: ArtistQuery): Promise<Result<ArtistSummary>> =>
subsonic
.getArtists(credentials)
.then(slice2(q))
.then(([page, total]) => ({
total,
results: page.map((it) => ({
id: it.id,
name: it.name,
image: it.image,
})),
})),
artist: async (id: string): Promise<Artist> =>
subsonic.getArtistWithInfo(credentials, id),
albums: async (q: AlbumQuery): Promise<Result<AlbumSummary>> =>
subsonic.getAlbumList2(credentials, q),
album: (id: string): Promise<Album> => subsonic.getAlbum(credentials, id),
genres: () =>
subsonic
.getJSON<GetGenresResponse>(credentials, "/rest/getGenres")
.then((it) =>
pipe( pipe(
it.genres.genre || [], it.genres.genre || [],
A.filter((it) => it.albumCount > 0), A.filter((it) => it.albumCount > 0),
A.map((it) => it.value), A.map((it) => it.value),
A.sort(ordString), A.sort(ordString),
A.map((it) => ({ id: b64Encode(it), name: it })) A.map(maybeAsGenre),
) A.filter((it) => it != undefined)
),
tracks: (albumId: string) =>
subsonic
.getJSON<GetAlbumResponse>(credentials, "/rest/getAlbum", {
id: albumId,
})
.then((it) => it.album)
.then((album) =>
(album.song || []).map((song) => asTrack(asAlbum(album), song))
),
track: (trackId: string) => subsonic.getTrack(credentials, trackId),
rate: (trackId: string, rating: Rating) =>
Promise.resolve(true)
.then(() => {
if (rating.stars >= 0 && rating.stars <= 5) {
return subsonic.getTrack(credentials, trackId);
} else {
throw `Invalid rating.stars value of ${rating.stars}`;
}
})
.then((track) => {
const thingsToUpdate = [];
if (track.rating.love != rating.love) {
thingsToUpdate.push(
subsonic.getJSON(
credentials,
`/rest/${rating.love ? "star" : "unstar"}`,
{
id: trackId,
}
) )
); );
}
if (track.rating.stars != rating.stars) { private st4r = (credentials: Credentials, action: string, { id } : { id: string }) =>
thingsToUpdate.push( this.getJSON<SubsonicResponse>(credentials, `/rest/${action}`, { id }).then(it =>
subsonic.getJSON(credentials, `/rest/setRating`, { it.status == "ok"
id: trackId,
rating: rating.stars,
})
); );
}
return Promise.all(thingsToUpdate); star = (credentials: Credentials, ids : { id: string }) =>
this.st4r(credentials, "star", ids)
unstar = (credentials: Credentials, ids : { id: string }) =>
this.st4r(credentials, "unstar", ids)
setRating = (credentials: Credentials, id: string, rating: number) =>
this.getJSON<SubsonicResponse>(credentials, `/rest/setRating`, {
id,
rating,
}) })
.then(() => true) .then(it => it.status == "ok");
.catch(() => false),
stream: async ({ scrobble = (credentials: Credentials, id: string, submission: boolean) =>
trackId, this.getJSON<SubsonicResponse>(credentials, `/rest/scrobble`, {
range, id,
}: { submission,
trackId: string; })
range: string | undefined; .then(it => it.status == "ok")
}) =>
subsonic.getTrack(credentials, trackId).then((track) => stream = (credentials: Credentials, id: string, c: string, range: string | undefined) =>
subsonic this.get(
.get(
credentials, credentials,
`/rest/stream`, `/rest/stream`,
{ {
id: trackId, id,
c: this.streamClientApplication(track), c,
}, },
{ {
headers: pipe( headers: pipe(
@@ -788,91 +778,36 @@ 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,
}));
playlists = (credentials: Credentials) =>
this.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
.then(({ playlists }) => (playlists.playlist || []).map( it => ({
id: it.id,
name: it.name,
coverArt: coverArtURN(it.coverArt),
})) }))
),
coverArt: async (coverArtURN: BUrn, size?: number) =>
Promise.resolve(coverArtURN)
.then((it) => assertSystem(it, "subsonic"))
.then((it) => it.resource.split(":")[1]!)
.then((it) => subsonic.getCoverArt(credentials, it, size))
.then((res) => ({
contentType: res.headers["content-type"],
data: Buffer.from(res.data, "binary"),
}))
.catch((e) => {
logger.error(
`Failed getting coverArt for urn:'${coverArtURN}': ${e}`
); );
return undefined;
}), playlist = (credentials: Credentials, id: string) =>
scrobble: async (id: string) => this.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
subsonic
.getJSON(credentials, `/rest/scrobble`, {
id,
submission: true,
})
.then((_) => true)
.catch(() => false),
nowPlaying: async (id: string) =>
subsonic
.getJSON(credentials, `/rest/scrobble`, {
id,
submission: false,
})
.then((_) => true)
.catch(() => false),
searchArtists: async (query: string) =>
subsonic
.search3(credentials, { query, artistCount: 20 })
.then(({ artists }) =>
artists.map((artist) => ({
id: artist.id,
name: artist.name,
image: artistImageURN({
artistId: artist.id,
artistImageURL: artist.artistImageUrl,
}),
}))
),
searchAlbums: async (query: string) =>
subsonic
.search3(credentials, { query, albumCount: 20 })
.then(({ albums }) => subsonic.toAlbumSummary(albums)),
searchTracks: async (query: string) =>
subsonic
.search3(credentials, { query, songCount: 20 })
.then(({ songs }) =>
Promise.all(
songs.map((it) => subsonic.getTrack(credentials, it.id))
)
),
playlists: async () =>
subsonic
.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
.then((it) => it.playlists.playlist || [])
.then((playlists) =>
playlists.map((it) => ({ id: it.id, name: it.name }))
),
playlist: async (id: string) =>
subsonic
.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
id, id,
}) })
.then((it) => it.playlist) .then(({ playlist }) => {
.then((playlist) => {
let trackNumber = 1; let trackNumber = 1;
return { return {
id: playlist.id, id: playlist.id,
name: playlist.name, name: playlist.name,
coverArt: coverArtURN(playlist.coverArt),
entries: (playlist.entry || []).map((entry) => ({ entries: (playlist.entry || []).map((entry) => ({
...asTrack( ...asTrack(
{ {
@@ -884,95 +819,75 @@ 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++,
})), })),
}; };
}), });
createPlaylist: async (name: string) =>
subsonic createPlayList = (credentials: Credentials, name: string) =>
.getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", { this.getJSON<GetPlaylistResponse>(credentials, "/rest/createPlaylist", {
name, name,
}) })
.then((it) => it.playlist) .then(({ playlist }) => ({
.then((it) => ({ id: it.id, name: it.name })), id: playlist.id,
deletePlaylist: async (id: string) => name: playlist.name,
subsonic coverArt: coverArtURN(playlist.coverArt),
.getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", { }));
deletePlayList = (credentials: Credentials, id: string) =>
this.getJSON<SubsonicResponse>(credentials, "/rest/deletePlaylist", {
id, id,
}) })
.then((_) => true), .then(it => it.status == "ok");
addToPlaylist: async (playlistId: string, trackId: string) =>
subsonic updatePlaylist = (
.getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", { credentials: Credentials,
playlistId: string,
changes : Partial<{ songIdToAdd: string | undefined, songIndexToRemove: number[] | undefined }> = {}
) =>
this.getJSON<SubsonicResponse>(credentials, "/rest/updatePlaylist", {
playlistId, playlistId,
songIdToAdd: trackId, ...changes
}) })
.then((_) => true), .then(it => it.status == "ok");
removeFromPlaylist: async (playlistId: string, indicies: number[]) =>
subsonic getSimilarSongs2 = (credentials: Credentials, id: string) =>
.getJSON<GetPlaylistResponse>(credentials, "/rest/updatePlaylist", { this.getJSON<GetSimilarSongsResponse>(
playlistId,
songIndexToRemove: indicies,
})
.then((_) => true),
similarSongs: async (id: string) =>
subsonic
.getJSON<GetSimilarSongsResponse>(
credentials, credentials,
"/rest/getSimilarSongs2", "/rest/getSimilarSongs2",
//todo: remove this hard coded 50?
{ id, count: 50 } { id, count: 50 }
) )
.then((it) => it.similarSongs2.song || []) .then((it) =>
.then((songs) => (it.similarSongs2.song || []).map(it => asTrackSummary(it, this.customPlayers))
Promise.all( );
songs.map((song) =>
subsonic
.getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song))
)
)
),
topSongs: async (artistId: string) =>
subsonic.getArtist(credentials, artistId).then(({ name }) =>
subsonic
.getJSON<GetTopSongsResponse>(credentials, "/rest/getTopSongs", {
artist: name,
count: 50,
})
.then((it) => it.topSongs.song || [])
.then((songs) =>
Promise.all(
songs.map((song) =>
subsonic
.getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song))
)
)
)
),
};
if (credentials.type == "navidrome") { getTopSongs = (credentials: Credentials, artist: string) =>
return Promise.resolve({ this.getJSON<GetTopSongsResponse>(
...genericSubsonic, credentials,
flavour: () => "navidrome", "/rest/getTopSongs",
bearerToken: (credentials: Credentials) => //todo: remove this hard coded 50?
pipe( { artist, count: 50 }
TE.tryCatch( )
() => .then((it) =>
axios.post( (it.topSongs.song || []).map(it => asTrackSummary(it, this.customPlayers))
`${this.url}/auth/login`, );
_.pick(credentials, "username", "password")
), getInternetRadioStations = (credentials: Credentials) =>
() => new AuthFailure("Failed to get bearerToken") this.getJSON<GetInternetRadioStationsResponse>(
), credentials,
TE.map((it) => it.data.token as string | undefined) "/rest/getInternetRadioStations"
), )
}); .then((it) => it.internetRadioStations.internetRadioStation || [])
} else { .then((stations) =>
return Promise.resolve(genericSubsonic); stations.map((it) => ({
} id: it.id,
}; name: it.name,
} url: it.streamUrl,
homePage: it.homePageUrl,
}))
);
};

View File

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

View File

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

View File

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

View File

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

View File

@@ -96,43 +96,36 @@ describe("config", () => {
propertyGetter: (config: any) => any propertyGetter: (config: any) => any
) { ) {
describe(name, () => { describe(name, () => {
function expecting({ it.each([
value, [expectedDefault, ""],
expected, [expectedDefault, undefined],
}: { [true, "true"],
value: string; [false, "false"],
expected: boolean; [false, "foo"],
}) { ])("should be %s when env var is '%s'", (expected, value) => {
describe(`when value is '${value}'`, () => {
it(`should be ${expected}`, () => {
process.env[envVar] = value; process.env[envVar] = value;
expect(propertyGetter(config())).toEqual(expected); expect(propertyGetter(config())).toEqual(expected);
}); })
});
}
expecting({ value: "", expected: expectedDefault });
expecting({ value: "true", expected: true });
expecting({ value: "false", expected: false });
expecting({ value: "foo", expected: false });
}); });
} }
describe("bonobUrl", () => { describe("bonobUrl", () => {
["BNB_URL", "BONOB_URL", "BONOB_WEB_ADDRESS"].forEach((key) => { describe.each([
describe(`when ${key} is specified`, () => { "BNB_URL",
"BONOB_URL",
"BONOB_WEB_ADDRESS"
])("when %s is specified", (k) => {
it("should be used", () => { it("should be used", () => {
const url = "http://bonob1.example.com:8877/"; const url = "http://bonob1.example.com:8877/";
process.env["BNB_URL"] = ""; process.env["BNB_URL"] = "";
process.env["BONOB_URL"] = ""; process.env["BONOB_URL"] = "";
process.env["BONOB_WEB_ADDRESS"] = ""; process.env["BONOB_WEB_ADDRESS"] = "";
process.env[key] = url; process.env[k] = url;
expect(config().bonobUrl.href()).toEqual(url); expect(config().bonobUrl.href()).toEqual(url);
}); });
}); });
});
describe("when none of BNB_URL, BONOB_URL, BONOB_WEB_ADDRESS are specified", () => { describe("when none of BNB_URL, BONOB_URL, BONOB_WEB_ADDRESS are specified", () => {
describe("when BONOB_PORT is not specified", () => { describe("when BONOB_PORT is not specified", () => {
@@ -165,8 +158,10 @@ describe("config", () => {
describe("icons", () => { describe("icons", () => {
describe("foregroundColor", () => { describe("foregroundColor", () => {
["BNB_ICON_FOREGROUND_COLOR", "BONOB_ICON_FOREGROUND_COLOR"].forEach( describe.each([
(k) => { "BNB_ICON_FOREGROUND_COLOR",
"BONOB_ICON_FOREGROUND_COLOR",
])("%s", (k) => {
describe(`when ${k} is not specified`, () => { describe(`when ${k} is not specified`, () => {
it(`should default to undefined`, () => { it(`should default to undefined`, () => {
expect(config().icons.foregroundColor).toEqual(undefined); expect(config().icons.foregroundColor).toEqual(undefined);
@@ -202,13 +197,14 @@ describe("config", () => {
); );
}); });
}); });
} });
);
}); });
describe("backgroundColor", () => { describe("backgroundColor", () => {
["BNB_ICON_BACKGROUND_COLOR", "BONOB_ICON_BACKGROUND_COLOR"].forEach( describe.each([
(k) => { "BNB_ICON_BACKGROUND_COLOR",
"BONOB_ICON_BACKGROUND_COLOR",
])("%s", (k) => {
describe(`when ${k} is not specified`, () => { describe(`when ${k} is not specified`, () => {
it(`should default to undefined`, () => { it(`should default to undefined`, () => {
expect(config().icons.backgroundColor).toEqual(undefined); expect(config().icons.backgroundColor).toEqual(undefined);
@@ -244,8 +240,7 @@ describe("config", () => {
); );
}); });
}); });
} });
);
}); });
}); });
@@ -254,9 +249,12 @@ describe("config", () => {
expect(config().secret).toEqual("bonob"); expect(config().secret).toEqual("bonob");
}); });
["BNB_SECRET", "BONOB_SECRET"].forEach((key) => { describe.each([
it(`should be overridable using ${key}`, () => { "BNB_SECRET",
process.env[key] = "new secret"; "BONOB_SECRET"
])("%s", (k) => {
it(`should be overridable using ${k}`, () => {
process.env[k] = "new secret";
expect(config().secret).toEqual("new secret"); expect(config().secret).toEqual("new secret");
}); });
}); });
@@ -271,7 +269,16 @@ describe("config", () => {
process.env["BNB_AUTH_TIMEOUT"] = "33s"; process.env["BNB_AUTH_TIMEOUT"] = "33s";
expect(config().authTimeout).toEqual("33s"); expect(config().authTimeout).toEqual("33s");
}); });
}); });
describe("logRequests", () => {
describeBooleanConfigValue(
"logRequests",
"BNB_SERVER_LOG_REQUESTS",
false,
(config) => config.logRequests
);
});
describe("sonos", () => { describe("sonos", () => {
describe("serviceName", () => { describe("serviceName", () => {
@@ -279,91 +286,122 @@ describe("config", () => {
expect(config().sonos.serviceName).toEqual("bonob"); expect(config().sonos.serviceName).toEqual("bonob");
}); });
["BNB_SONOS_SERVICE_NAME", "BONOB_SONOS_SERVICE_NAME"].forEach((k) => { describe.each([
"BNB_SONOS_SERVICE_NAME",
"BONOB_SONOS_SERVICE_NAME"
])(
"%s",
(k) => {
it("should be overridable", () => { it("should be overridable", () => {
process.env[k] = "foobar1000"; process.env[k] = "foobar1000";
expect(config().sonos.serviceName).toEqual("foobar1000"); expect(config().sonos.serviceName).toEqual("foobar1000");
}); });
}); }
);
}); });
["BNB_SONOS_DEVICE_DISCOVERY", "BONOB_SONOS_DEVICE_DISCOVERY"].forEach( describe.each([
(k) => { "BNB_SONOS_DEVICE_DISCOVERY",
"BONOB_SONOS_DEVICE_DISCOVERY",
])("%s", (k) => {
describeBooleanConfigValue( describeBooleanConfigValue(
"deviceDiscovery", "deviceDiscovery",
k, k,
true, true,
(config) => config.sonos.discovery.enabled (config) => config.sonos.discovery.enabled
); );
} });
);
describe("seedHost", () => { describe("seedHost", () => {
it("should default to undefined", () => { it("should default to undefined", () => {
expect(config().sonos.discovery.seedHost).toBeUndefined(); expect(config().sonos.discovery.seedHost).toBeUndefined();
}); });
["BNB_SONOS_SEED_HOST", "BONOB_SONOS_SEED_HOST"].forEach((k) => { describe.each([
"BNB_SONOS_SEED_HOST",
"BONOB_SONOS_SEED_HOST"
])(
"%s",
(k) => {
it("should be overridable", () => { it("should be overridable", () => {
process.env[k] = "123.456.789.0"; process.env[k] = "123.456.789.0";
expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0"); expect(config().sonos.discovery.seedHost).toEqual("123.456.789.0");
}); });
}); }
);
}); });
["BNB_SONOS_AUTO_REGISTER", "BONOB_SONOS_AUTO_REGISTER"].forEach((k) => { describe.each([
"BNB_SONOS_AUTO_REGISTER",
"BONOB_SONOS_AUTO_REGISTER"
])(
"%s",
(k) => {
describeBooleanConfigValue( describeBooleanConfigValue(
"autoRegister", "autoRegister",
k, k,
false, false,
(config) => config.sonos.autoRegister (config) => config.sonos.autoRegister
); );
}); }
);
describe("sid", () => { describe("sid", () => {
it("should default to 246", () => { it("should default to 246", () => {
expect(config().sonos.sid).toEqual(246); expect(config().sonos.sid).toEqual(246);
}); });
["BNB_SONOS_SERVICE_ID", "BONOB_SONOS_SERVICE_ID"].forEach((k) => { describe.each([
"BNB_SONOS_SERVICE_ID",
"BONOB_SONOS_SERVICE_ID"
])(
"%s",
(k) => {
it("should be overridable", () => { it("should be overridable", () => {
process.env[k] = "786"; process.env[k] = "786";
expect(config().sonos.sid).toEqual(786); expect(config().sonos.sid).toEqual(786);
}); });
}); }
);
}); });
}); });
describe("subsonic", () => { describe("subsonic", () => {
describe("url", () => { describe("url", () => {
["BNB_SUBSONIC_URL", "BONOB_SUBSONIC_URL", "BONOB_NAVIDROME_URL"].forEach( describe.each([
(k) => { "BNB_SUBSONIC_URL",
"BONOB_SUBSONIC_URL",
"BONOB_NAVIDROME_URL",
])("%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( expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
`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( expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
`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);
});
}); });
}); });
}
);
}); });
describe("customClientsFor", () => { describe("customClientsFor", () => {
@@ -371,11 +409,11 @@ describe("config", () => {
expect(config().subsonic.customClientsFor).toBeUndefined(); expect(config().subsonic.customClientsFor).toBeUndefined();
}); });
[ describe.each([
"BNB_SUBSONIC_CUSTOM_CLIENTS", "BNB_SUBSONIC_CUSTOM_CLIENTS",
"BONOB_SUBSONIC_CUSTOM_CLIENTS", "BONOB_SUBSONIC_CUSTOM_CLIENTS",
"BONOB_NAVIDROME_CUSTOM_CLIENTS", "BONOB_NAVIDROME_CUSTOM_CLIENTS",
].forEach((k) => { ])("%s", (k) => {
it(`should be overridable for ${k}`, () => { it(`should be overridable for ${k}`, () => {
process.env[k] = "whoop/whoop"; process.env[k] = "whoop/whoop";
expect(config().subsonic.customClientsFor).toEqual("whoop/whoop"); expect(config().subsonic.customClientsFor).toEqual("whoop/whoop");
@@ -395,7 +433,10 @@ describe("config", () => {
}); });
}); });
["BNB_SCROBBLE_TRACKS", "BONOB_SCROBBLE_TRACKS"].forEach((k) => { describe.each([
"BNB_SCROBBLE_TRACKS",
"BONOB_SCROBBLE_TRACKS"
])("%s", (k) => {
describeBooleanConfigValue( describeBooleanConfigValue(
"scrobbleTracks", "scrobbleTracks",
k, k,
@@ -404,12 +445,18 @@ describe("config", () => {
); );
}); });
["BNB_REPORT_NOW_PLAYING", "BONOB_REPORT_NOW_PLAYING"].forEach((k) => { describe.each([
"BNB_REPORT_NOW_PLAYING",
"BONOB_REPORT_NOW_PLAYING"
])(
"%s",
(k) => {
describeBooleanConfigValue( describeBooleanConfigValue(
"reportNowPlaying", "reportNowPlaying",
k, k,
true, true,
(config) => config.reportNowPlaying (config) => config.reportNowPlaying
); );
}); }
);
}); });

View File

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

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", "nl-NL"]); expect(langs()).toEqual(["en-US", "da-DK", "fr-FR", "nl-NL"]);
}); });
}); });

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -2,11 +2,9 @@ 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_library";
import makeServer, { import makeServer, {
BONOB_ACCESS_TOKEN_HEADER, BONOB_ACCESS_TOKEN_HEADER,
RangeBytesFromFilter, RangeBytesFromFilter,
@@ -167,15 +165,13 @@ describe("RangeBytesFromFilter", () => {
describe("server", () => { describe("server", () => {
jest.setTimeout(Number.parseInt(process.env["JEST_TIMEOUT"] || "2000"));
beforeEach(() => { beforeEach(() => {
jest.clearAllMocks(); jest.clearAllMocks();
jest.resetAllMocks(); jest.resetAllMocks();
}); });
const bonobUrlWithNoContextPath = url("http://bonob.localhost:1234"); const bonobUrlWithNoContextPath = url("http://localhost:1234");
const bonobUrlWithContextPath = url("http://bonob.localhost:1234/aContext"); const bonobUrlWithContextPath = url("http://localhost:1234/aContext");
const langName = randomLang(); const langName = randomLang();
const acceptLanguage = `le-ET,${langName};q=0.9,en;q=0.8`; const acceptLanguage = `le-ET,${langName};q=0.9,en;q=0.8`;
@@ -757,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) => {
const self = {
destroyed: false,
pipe: (_: Transform) => { pipe: (_: Transform) => {
return { return {
pipe: (res: Response) => { pipe: (res: Response) => {
res.send(content); 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", () => {
@@ -831,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);
}); });
}); });
@@ -856,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);
}); });
}); });
}); });
@@ -918,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);
}); });
}); });
@@ -961,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);
}); });
}); });
@@ -1002,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);
}); });
}); });
@@ -1042,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);
}); });
}); });
@@ -1085,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);
}); });
}); });
}); });
@@ -1133,6 +1150,8 @@ describe("server", () => {
trackId, trackId,
range: requestedRange, range: requestedRange,
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1180,6 +1199,8 @@ describe("server", () => {
trackId, trackId,
range: "4000-5000", range: "4000-5000",
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -1300,279 +1321,6 @@ describe("server", () => {
}); });
}); });
describe("fetching multiple images as a collage", () => {
const png = fs.readFileSync(
path.join(
__dirname,
"..",
"docs",
"images",
"chartreuseFuchsia.png"
)
);
describe("fetching a collage of 4 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"art:1",
"art:2",
"art:3",
"art:4",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 200);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(200);
expect(image.height).toEqual(200);
});
});
describe("fetching a collage of 4, however only 1 is available", () => {
it("should return the single image", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
contentType: "image/some-mime-type",
})
);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual(
"image/some-mime-type"
);
});
});
describe("fetching a collage of 4 and all are missing", () => {
it("should return a 404", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
describe("fetching a collage of 9 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"coverArt:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 9 when only 2 are available", () => {
it("should still return an image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((urn) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(urn, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 11", () => {
it("should still return an image and a 200, though will only display 9", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
"artist:10",
"artist:11",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("when the image is not available", () => {
it("should return a 404", async () => {
const coverArtURN = { system:"subsonic", resource:"art:404"};
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValue(undefined);
const res = await request(server)
.get(
`/art/${encodeURIComponent(formatForURL(coverArtURN))}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
});
describe("when there is an error", () => { 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);
@@ -1618,11 +1366,25 @@ describe("server", () => {
"..%2F..%2Ffoo", "..%2F..%2Ffoo",
"%2Fetc%2Fpasswd", "%2Fetc%2Fpasswd",
".%2Fbob.js", ".%2Fbob.js",
".",
"..",
"1",
"%23%24", "%23%24",
].forEach((type) => {
describe(`trying to retrieve an icon with name ${type}`, () => {
it(`should fail`, async () => {
const response = await request(server()).get(
`/icon/${type}/size/legacy`
);
expect(response.status).toEqual(400);
});
});
});
});
describe("missing icons", () => {
[
"1",
"notAValidIcon", "notAValidIcon",
"notAValidIcon:withSomeText"
].forEach((type) => { ].forEach((type) => {
describe(`trying to retrieve an icon with name ${type}`, () => { describe(`trying to retrieve an icon with name ${type}`, () => {
it(`should fail`, async () => { it(`should fail`, async () => {
@@ -1650,6 +1412,20 @@ describe("server", () => {
}); });
}); });
describe("invalid text", () => {
["..", "foobar.123", "_dog_", "{ whoop }"].forEach((text) => {
describe(`trying to retrieve an icon with text ${text}`, () => {
it(`should fail`, async () => {
const response = await request(server()).get(
`/icon/yyyy:${text}/size/60`
);
expect(response.status).toEqual(400);
});
});
});
});
describe("fetching", () => { describe("fetching", () => {
[ [
"artists", "artists",
@@ -1779,6 +1555,41 @@ describe("server", () => {
}); });
}); });
}); });
describe("specifing some text", () => {
const text = "somethingWicked"
describe(`legacy icon`, () => {
it("should return the png image", async () => {
const response = await request(server()).get(
`/icon/yyyy:${text}/size/legacy`
);
expect(response.status).toEqual(200);
expect(response.header["content-type"]).toEqual("image/png");
const image = await Image.load(response.body);
expect(image.width).toEqual(80);
expect(image.height).toEqual(80);
});
});
describe("svg icon", () => {
it(`should return an svg image with the text replaced`, async () => {
const response = await request(server()).get(
`/icon/yyyy:${text}/size/60`
);
expect(response.status).toEqual(200);
expect(response.header["content-type"]).toEqual(
"image/svg+xml; charset=utf-8"
);
const svg = Buffer.from(response.body).toString();
expect(svg).toContain(
`>${text}</text>`
);
});
});
});
}); });
}); });
}); });

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

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

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

3
web/icons/yy.svg Normal file
View File

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

After

Width:  |  Height:  |  Size: 189 B

3
web/icons/yyyy.svg Normal file
View File

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

After

Width:  |  Height:  |  Size: 190 B

7612
yarn.lock

File diff suppressed because it is too large Load Diff