Compare commits

..

1 Commits

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

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-11-11 10:51:37 +00:00
26 changed files with 153683 additions and 9167 deletions

View File

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

View File

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

View File

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

1
.npmrc
View File

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

1
.nvmrc Normal file
View File

@@ -0,0 +1 @@
16.6.2

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

File diff suppressed because one or more lines are too long

3
.yarnrc.yml Normal file
View File

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

View File

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

View File

@@ -9,20 +9,19 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
## Features
- Integrates with Subsonic API clones (Navidrome, Gonic)
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums
- Artist & Album Art
- View Related Artists via Artist -> '...' -> Menu -> Related Arists
- Now playing & Track Scrobbling
- Search by Album, Artist, Track
- Playlist editing through sonos app.
- Marking of songs as favourites and with ratings through the sonos app.
- Localization (only en-US, da-DK, nl-NL & fr-FR supported currently, require translations for other languages). [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
- Localization (only en-US, da-DK & nl-NL supported currently, require translations for other languages). [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/)
- Auto discovery of sonos devices
- Discovery of sonos devices using seed IP address
- Auto registration with sonos on start
- Multiple registrations within a single household.
- Transcoding within subsonic clone
- Custom players by mime type, allowing custom transcoding rules for different file types
- Transcoding support for flacs using a specific player for the flac mimeType bonob/sonos
## Running
@@ -40,8 +39,8 @@ 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
master | Laster build from master, probably works, however is currently under test in
vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release
### Full sonos device auto-discovery and auto-registration using docker --network host
@@ -164,6 +163,7 @@ BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos
BNB_SECRET | bonob | secret used for encrypting credentials
BNB_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_DISABLE_PLAYLIST_ART | undefined | Disables playlist art generation, ie. when there are many playlists and art generation takes too long
BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
BNB_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.
@@ -171,7 +171,7 @@ BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommit
BNB_SONOS_SERVICE_NAME | bonob | service name for sonos
BNB_SONOS_SERVICE_ID | 246 | service id for sonos
BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone
BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac". <p>However; <p>if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs. <p>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.
BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache.
BNB_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
@@ -218,22 +218,19 @@ Afterwards the Sonos app displays a dropdown underneath the service, allowing to
- Implement the MusicService/MusicLibrary interface
- Startup bonob with your new implementation.
## Transcoding
## A note on transcoding
### Transcode everything
tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track. However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/). When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
### Audio file type specific transcoding
### Audio File type specific transcoding options within Subsonic
Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
In some situations you may wish to have different 'Players' within 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 some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
In this case you could set;
```bash
# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
```
@@ -249,16 +246,7 @@ ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
```
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
### Changing Icon colors
```bash
-e BNB_ICON_FOREGROUND_COLOR=white \
@@ -288,7 +276,6 @@ And then configure the 'bonob+audio/mpeg' player in your subsonic server.
![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true)
## Credits
- Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho

7662
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -6,33 +6,33 @@
"author": "simojenki <simojenki@users.noreply.github.com>",
"license": "GPL-3.0-only",
"dependencies": {
"@svrooij/sonos": "^2.6.0-beta.7",
"@types/express": "^4.17.21",
"@types/fs-extra": "^11.0.4",
"@types/jsonwebtoken": "^9.0.5",
"@types/jws": "^3.2.9",
"@types/morgan": "^1.9.9",
"@types/node": "^20.11.5",
"@types/randomstring": "^1.1.11",
"@types/underscore": "^1.11.15",
"@types/uuid": "^9.0.7",
"@types/xmldom": "0.1.34",
"axios": "^1.6.5",
"@svrooij/sonos": "^2.5.0",
"@types/express": "^4.17.19",
"@types/fs-extra": "^11.0.2",
"@types/jsonwebtoken": "^9.0.3",
"@types/jws": "^3.2.6",
"@types/morgan": "^1.9.6",
"@types/node": "^16.11.7",
"@types/randomstring": "^1.1.9",
"@types/underscore": "^1.11.11",
"@types/uuid": "^9.0.5",
"@types/xmldom": "0.1.32",
"axios": "^1.6.0",
"dayjs": "^1.11.10",
"eta": "^2.2.0",
"eta": "^2.0.1",
"express": "^4.18.2",
"fp-ts": "^2.16.2",
"fs-extra": "^11.2.0",
"fp-ts": "^2.16.1",
"fs-extra": "^11.1.1",
"jsonwebtoken": "^9.0.2",
"jws": "^4.0.0",
"libxmljs2": "^0.33.0",
"libxmljs2": "^0.32.0",
"morgan": "^1.10.0",
"node-html-parser": "^6.1.12",
"node-html-parser": "^6.1.10",
"randomstring": "^1.3.0",
"sharp": "^0.33.2",
"sharp": "^0.32.6",
"soap": "^1.0.0",
"ts-md5": "^1.3.1",
"typescript": "^5.3.3",
"typescript": "^5.2.2",
"underscore": "^1.13.6",
"urn-lib": "^2.0.0",
"uuid": "^9.0.1",
@@ -40,36 +40,32 @@
"xmldom-ts": "^0.3.1"
},
"devDependencies": {
"@types/chai": "^4.3.11",
"@types/jest": "^29.5.11",
"@types/mocha": "^10.0.6",
"@types/supertest": "^6.0.2",
"@types/tmp": "^0.2.6",
"chai": "^5.0.0",
"@types/chai": "^4.3.7",
"@types/jest": "^29.5.5",
"@types/mocha": "^10.0.2",
"@types/supertest": "^2.0.14",
"@types/tmp": "^0.2.4",
"chai": "^4.3.10",
"get-port": "^7.0.0",
"image-js": "^0.35.5",
"image-js": "^0.35.4",
"jest": "^29.7.0",
"nodemon": "^3.0.3",
"supertest": "^6.3.4",
"nodemon": "^3.0.1",
"supertest": "^6.3.3",
"tmp": "^0.2.1",
"ts-jest": "^29.1.2",
"ts-jest": "^29.1.1",
"ts-mockito": "^2.6.1",
"ts-node": "^10.9.2",
"ts-node": "^10.9.1",
"xmldom-ts": "^0.3.1",
"xpath-ts": "^1.3.13"
},
"overrides": {
"axios-ntlm": "npm:dry-uninstall",
"axios": "$axios"
},
"scripts": {
"clean": "rm -Rf build node_modules",
"build": "tsc",
"dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"dev": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"devr": "BNB_DISABLE_PLAYLIST_ART=true BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
"register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
"test": "jest",
"testw": "jest --watch",
"gitinfo": "git describe --tags > .gitinfo"
}
},
"packageManager": "yarn@1.22.19"
}

View File

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

View File

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

View File

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

View File

@@ -46,24 +46,15 @@ export type Genre = {
id: string;
}
export type Year = {
year: string;
}
export type Rating = {
love: boolean;
stars: number;
}
export type Encoding = {
player: string,
mimeType: string
}
export type Track = {
id: string;
name: string;
encoding: Encoding,
mimeType: string;
duration: number;
number: number | undefined;
genre: Genre | undefined;
@@ -73,13 +64,6 @@ export type Track = {
rating: Rating;
};
export type RadioStation = {
id: string,
name: string,
url: string,
homePage?: string
}
export type Paging = {
_index: number;
_count: number;
@@ -104,13 +88,11 @@ export const asResult = <T>([results, total]: [T[], number]) => ({
export type ArtistQuery = Paging;
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'byYear' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
export type AlbumQuery = Paging & {
type: AlbumQueryType;
genre?: string;
fromYear?: string;
toYear?: string;
};
export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
@@ -131,8 +113,7 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
id: it.id,
name: it.name,
coverArt: it.coverArt
name: it.name
})
export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
@@ -150,8 +131,7 @@ export type CoverArt = {
export type PlaylistSummary = {
id: string,
name: string,
coverArt?: BUrn | undefined
name: string
}
export type Playlist = PlaylistSummary & {
@@ -179,7 +159,6 @@ export interface MusicLibrary {
tracks(albumId: string): Promise<Track[]>;
track(trackId: string): Promise<Track>;
genres(): Promise<Genre[]>;
years(): Promise<Year[]>;
stream({
trackId,
range,
@@ -202,6 +181,4 @@ export interface MusicLibrary {
removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
similarSongs(id: string): Promise<Track[]>;
topSongs(artistId: string): Promise<Track[]>;
radioStation(id: string): Promise<RadioStation>
radioStations(): Promise<RadioStation[]>
}

View File

@@ -31,8 +31,9 @@ import { pipe } from "fp-ts/lib/function";
import { URLBuilder } from "./url_builder";
import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
import { Icon, ICONS, festivals, features } from "./icon";
import _ from "underscore";
import _, { shuffle } from "underscore";
import morgan from "morgan";
import { takeWithRepeats } from "./utils";
import { parse } from "./burn";
import { axiosImageFetcher, ImageFetcher } from "./subsonic";
import {
@@ -557,11 +558,23 @@ function server(
});
});
app.get("/art/:burn/size/:size", (req, res) => {
const GRAVITY_9 = [
"north",
"northeast",
"east",
"southeast",
"south",
"southwest",
"west",
"northwest",
"centre",
];
app.get("/art/:burns/size/:size", (req, res) => {
const serviceToken = apiTokens.authTokenFor(
req.query[BONOB_ACCESS_TOKEN_HEADER] as string
);
const urn = parse(req.params["burn"]!);
const urns = req.params["burns"]!.split("&").map(parse);
const size = Number.parseInt(req.params["size"]!);
if (!serviceToken) {
@@ -572,24 +585,55 @@ function server(
return musicService
.login(serviceToken)
.then((musicLibrary) => {
if (urn.system == "external") {
return serverOpts.externalImageResolver(urn.resource);
} else {
return musicLibrary.coverArt(urn, size);
}
})
.then((coverArt) => {
if(coverArt) {
.then((musicLibrary) =>
Promise.all(
urns.map((it) => {
if (it.system == "external") {
return serverOpts.externalImageResolver(it.resource);
} else {
return musicLibrary.coverArt(it, size);
}
})
)
)
.then((coverArts) => coverArts.filter((it) => it))
.then(shuffle)
.then((coverArts) => {
if (coverArts.length == 1) {
const coverArt = coverArts[0]!;
res.status(200);
res.setHeader("content-type", coverArt.contentType);
return res.send(coverArt.data);
} else if (coverArts.length > 1) {
const gravity = [...GRAVITY_9];
return sharp({
create: {
width: size * 3,
height: size * 3,
channels: 3,
background: { r: 255, g: 255, b: 255 },
},
})
.composite(
takeWithRepeats(coverArts, 9).map((art) => ({
input: art?.data,
gravity: gravity.pop(),
}))
)
.png()
.toBuffer()
.then((image) => sharp(image).resize(size).png().toBuffer())
.then((image) => {
res.status(200);
res.setHeader("content-type", "image/png");
return res.send(image);
});
} else {
return res.status(404).send();
}
})
})
.catch((e: Error) => {
logger.error(`Failed fetching image ${urn}/size/${size}`, {
logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, {
cause: e,
});
return res.status(500).send();

View File

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

View File

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

View File

@@ -20,8 +20,6 @@ import {
AlbumQueryType,
Artist,
AuthFailure,
PlaylistSummary,
Encoding,
} from "./music_service";
import sharp from "sharp";
import _ from "underscore";
@@ -164,8 +162,7 @@ export type song = {
duration: number | undefined;
bitRate: number | undefined;
suffix: string | undefined;
contentType: string;
transcodedContentType: string | undefined;
contentType: string | undefined;
type: string | undefined;
userRating: number | undefined;
starred: string | undefined;
@@ -180,15 +177,12 @@ type GetAlbumResponse = {
type playlist = {
id: string;
name: string;
coverArt: string | undefined;
};
type GetPlaylistResponse = {
// todo: isnt the type here a composite? playlistSummary && { entry: song[]; }
playlist: {
id: string;
name: string;
coverArt: string | undefined;
entry: song[];
};
};
@@ -205,15 +199,6 @@ type GetTopSongsResponse = {
topSongs: { song: song[] };
};
type GetInternetRadioStationsResponse = {
internetRadioStations: { internetRadioStation: {
id: string,
name: string,
streamUrl: string,
homePageUrl?: string }[]
}
}
type GetSongResponse = {
song: song;
};
@@ -285,16 +270,10 @@ export const artistImageURN = (
}
};
export const asTrack = (album: Album, song: song, customPlayers: CustomPlayers): Track => ({
export const asTrack = (album: Album, song: song): Track => ({
id: song.id,
name: song.title,
encoding: pipe(
customPlayers.encodingFor({ mimeType: song.contentType }),
O.getOrElse(() => ({
player: DEFAULT_CLIENT_APPLICATION,
mimeType: song.transcodedContentType ? song.transcodedContentType : song.contentType
}))
),
mimeType: song.contentType!,
duration: song.duration || 0,
number: song.track || 0,
genre: maybeAsGenre(song.genre),
@@ -326,13 +305,6 @@ const asAlbum = (album: album): Album => ({
coverArt: coverArtURN(album.coverArt),
});
// coverArtURN
const asPlayListSummary = (playlist: playlist): PlaylistSummary => ({
id: playlist.id,
name: playlist.name,
coverArt: coverArtURN(playlist.coverArt),
});
export const asGenre = (genreName: string) => ({
id: b64Encode(genreName),
name: genreName,
@@ -346,57 +318,19 @@ const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
O.getOrElseW(() => undefined)
);
export const asYear = (year: string) => ({
year: year,
});
export interface CustomPlayers {
encodingFor({ mimeType }: { mimeType: string }): O.Option<Encoding>
}
export type CustomClient = {
mimeType: string;
transcodedMimeType: string;
};
export class TranscodingCustomPlayers implements CustomPlayers {
transcodings: Map<string, string>;
constructor(transcodings: Map<string, string>) {
this.transcodings = transcodings;
}
static from(config: string): TranscodingCustomPlayers {
const parts: [string, string][] = config
.split(",")
.map((it) => it.split(">"))
.map((pair) => {
if (pair.length == 1) return [pair[0]!, pair[0]!];
else if (pair.length == 2) return [pair[0]!, pair[1]!];
else throw new Error(`Invalid configuration item ${config}`);
});
return new TranscodingCustomPlayers(new Map(parts));
}
encodingFor = ({ mimeType }: { mimeType: string }): O.Option<Encoding> => pipe(
this.transcodings.get(mimeType),
O.fromNullable,
O.map(transcodedMimeType => ({
player:`${DEFAULT_CLIENT_APPLICATION}+${mimeType}`,
mimeType: transcodedMimeType
}))
)
}
export const NO_CUSTOM_PLAYERS: CustomPlayers = {
encodingFor(_) {
return O.none
},
}
export type StreamClientApplication = (track: Track) => string;
const DEFAULT_CLIENT_APPLICATION = "bonob";
const USER_AGENT = "bonob";
export const DEFAULT: StreamClientApplication = (_: Track) =>
DEFAULT_CLIENT_APPLICATION;
export function appendMimeTypeToClientFor(mimeTypes: string[]) {
return (track: Track) =>
mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
}
export const asURLSearchParams = (q: any) => {
const urlSearchParams = new URLSearchParams();
Object.keys(q).forEach((k) => {
@@ -411,28 +345,28 @@ export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
export const cachingImageFetcher =
(cacheDir: string, delegate: ImageFetcher) =>
async (url: string): Promise<CoverArt | undefined> => {
const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
return fse
.readFile(filename)
.then((data) => ({ contentType: "image/png", data }))
.catch(() =>
delegate(url).then((image) => {
if (image) {
return sharp(image.data)
.png()
.toBuffer()
.then((png) => {
return fse
.writeFile(filename, png)
.then(() => ({ contentType: "image/png", data: png }));
});
} else {
return undefined;
}
})
);
};
async (url: string): Promise<CoverArt | undefined> => {
const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
return fse
.readFile(filename)
.then((data) => ({ contentType: "image/png", data }))
.catch(() =>
delegate(url).then((image) => {
if (image) {
return sharp(image.data)
.png()
.toBuffer()
.then((png) => {
return fse
.writeFile(filename, png)
.then(() => ({ contentType: "image/png", data: png }));
});
} else {
return undefined;
}
})
);
};
export const axiosImageFetcher = (url: string): Promise<CoverArt | undefined> =>
axios
@@ -450,7 +384,6 @@ const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
alphabeticalByArtist: "alphabeticalByArtist",
alphabeticalByName: "alphabeticalByName",
byGenre: "byGenre",
byYear: "byYear",
random: "random",
recentlyPlayed: "recent",
mostPlayed: "frequent",
@@ -481,16 +414,16 @@ interface SubsonicMusicLibrary extends MusicLibrary {
export class Subsonic implements MusicService {
url: URLBuilder;
customPlayers: CustomPlayers;
streamClientApplication: StreamClientApplication;
externalImageFetcher: ImageFetcher;
constructor(
url: URLBuilder,
customPlayers: CustomPlayers = NO_CUSTOM_PLAYERS,
streamClientApplication: StreamClientApplication = DEFAULT,
externalImageFetcher: ImageFetcher = axiosImageFetcher
) {
this.url = url;
this.customPlayers = customPlayers;
this.streamClientApplication = streamClientApplication;
this.externalImageFetcher = externalImageFetcher;
}
@@ -685,7 +618,7 @@ export class Subsonic implements MusicService {
.then((it) => it.song)
.then((song) =>
this.getAlbum(credentials, song.albumId!).then((album) =>
asTrack(album, song, this.customPlayers)
asTrack(album, song)
)
);
@@ -725,8 +658,6 @@ export class Subsonic implements MusicService {
this.getJSON<GetAlbumListResponse>(credentials, "/rest/getAlbumList2", {
type: AlbumQueryTypeToSubsonicType[q.type],
...(q.genre ? { genre: b64Decode(q.genre) } : {}),
...(q.fromYear ? { fromYear: q.fromYear} : {}),
...(q.toYear ? { toYear: q.toYear} : {}),
size: 500,
offset: q._index,
})
@@ -790,7 +721,7 @@ export class Subsonic implements MusicService {
})
.then((it) => it.album)
.then((album) =>
(album.song || []).map((song) => asTrack(asAlbum(album), song, this.customPlayers))
(album.song || []).map((song) => asTrack(asAlbum(album), song))
),
track: (trackId: string) => subsonic.getTrack(credentials, trackId),
rate: (trackId: string, rating: Rating) =>
@@ -841,7 +772,7 @@ export class Subsonic implements MusicService {
`/rest/stream`,
{
id: trackId,
c: track.encoding.player,
c: this.streamClientApplication(track),
},
{
headers: pipe(
@@ -858,15 +789,15 @@ export class Subsonic implements MusicService {
responseType: "stream",
}
)
.then((stream) => ({
status: stream.status,
.then((res) => ({
status: res.status,
headers: {
"content-type": stream.headers["content-type"],
"content-length": stream.headers["content-length"],
"content-range": stream.headers["content-range"],
"accept-ranges": stream.headers["accept-ranges"],
"content-type": res.headers["content-type"],
"content-length": res.headers["content-length"],
"content-range": res.headers["content-range"],
"accept-ranges": res.headers["accept-ranges"],
},
stream: stream.data,
stream: res.data,
}))
),
coverArt: async (coverArtURN: BUrn, size?: number) =>
@@ -929,7 +860,9 @@ export class Subsonic implements MusicService {
subsonic
.getJSON<GetPlaylistsResponse>(credentials, "/rest/getPlaylists")
.then((it) => it.playlists.playlist || [])
.then((playlists) => playlists.map(asPlayListSummary)),
.then((playlists) =>
playlists.map((it) => ({ id: it.id, name: it.name }))
),
playlist: async (id: string) =>
subsonic
.getJSON<GetPlaylistResponse>(credentials, "/rest/getPlaylist", {
@@ -941,7 +874,6 @@ export class Subsonic implements MusicService {
return {
id: playlist.id,
name: playlist.name,
coverArt: coverArtURN(playlist.coverArt),
entries: (playlist.entry || []).map((entry) => ({
...asTrack(
{
@@ -953,8 +885,7 @@ export class Subsonic implements MusicService {
artistId: entry.artistId,
coverArt: coverArtURN(entry.coverArt),
},
entry,
this.customPlayers
entry
),
number: trackNumber++,
})),
@@ -966,12 +897,7 @@ export class Subsonic implements MusicService {
name,
})
.then((it) => it.playlist)
// todo: why is this line so similar to other playlist lines??
.then((it) => ({
id: it.id,
name: it.name,
coverArt: coverArtURN(it.coverArt),
})),
.then((it) => ({ id: it.id, name: it.name })),
deletePlaylist: async (id: string) =>
subsonic
.getJSON<GetPlaylistResponse>(credentials, "/rest/deletePlaylist", {
@@ -1005,7 +931,7 @@ export class Subsonic implements MusicService {
songs.map((song) =>
subsonic
.getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song, this.customPlayers))
.then((album) => asTrack(album, song))
)
)
),
@@ -1022,46 +948,11 @@ export class Subsonic implements MusicService {
songs.map((song) =>
subsonic
.getAlbum(credentials, song.albumId!)
.then((album) => asTrack(album, song, this.customPlayers))
.then((album) => asTrack(album, song))
)
)
)
),
radioStations: async () => subsonic
.getJSON<GetInternetRadioStationsResponse>(
credentials,
"/rest/getInternetRadioStations"
)
.then((it) => it.internetRadioStations.internetRadioStation || [])
.then((stations) => stations.map((it) => ({
id: it.id,
name: it.name,
url: it.streamUrl,
homePage: it.homePageUrl
}))),
radioStation: async (id: string) => genericSubsonic
.radioStations()
.then(it =>
it.find(station => station.id === id)!
),
years: async () => {
const q: AlbumQuery = {
_index: 0,
_count: 100000, // FIXME: better than this ?
type: "alphabeticalByArtist",
};
const years = subsonic.getAlbumList2(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;
}
};
if (credentials.type == "navidrome") {
@@ -1074,7 +965,7 @@ export class Subsonic implements MusicService {
TE.tryCatch(
() =>
axios.post(
this.url.append({ pathname: "/auth/login" }).href(),
this.url.append({ pathname: '/auth/login' }).href(),
_.pick(credentials, "username", "password")
),
() => new AuthFailure("Failed to get bearerToken")

View File

@@ -14,7 +14,6 @@ import {
Playlist,
SimilarArtist,
AlbumSummary,
RadioStation,
} from "../src/music_service";
import { b64Encode } from "../src/b64";
@@ -166,12 +165,6 @@ export const SAMPLE_GENRES = [
];
export const randomGenre = () => SAMPLE_GENRES[randomInt(SAMPLE_GENRES.length)];
export const aYear = (year: string) => ({ id: year, year });
export const Y2024 = aYear("2024");
export const Y2023 = aYear("2023");
export const Y1969 = aYear("1969");
export function aTrack(fields: Partial<Track> = {}): Track {
const id = uuid();
const artist = anArtist();
@@ -180,10 +173,7 @@ export function aTrack(fields: Partial<Track> = {}): Track {
return {
id,
name: `Track ${id}`,
encoding: {
player: "bonob",
mimeType: `audio/mp3-${id}`
},
mimeType: `audio/mp3-${id}`,
duration: randomInt(500),
number: randomInt(100),
genre,
@@ -211,17 +201,6 @@ export function anAlbum(fields: Partial<Album> = {}): Album {
};
};
export function aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
const id = uuid()
const name = `Station-${id}`;
return {
id,
name,
url: `http://example.com/${name}`,
...fields
}
}
export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary {
const id = uuid();
return {

View File

@@ -161,9 +161,6 @@ export class InMemoryMusicService implements MusicService {
Promise.reject("Unsupported operation"),
similarSongs: async (_: string) => Promise.resolve([]),
topSongs: async (_: string) => Promise.resolve([]),
radioStations: async () => Promise.resolve([]),
radioStation: async (_: string) => Promise.reject("Unsupported operation"),
years: async () => Promise.resolve([]),
});
}

View File

@@ -2,7 +2,9 @@ import { v4 as uuid } from "uuid";
import dayjs from "dayjs";
import request from "supertest";
import Image from "image-js";
import fs from "fs";
import { either as E, taskEither as TE } from "fp-ts";
import path from "path";
import { AuthFailure, MusicService } from "../src/music_service";
import makeServer, {
@@ -1321,6 +1323,279 @@ describe("server", () => {
});
});
describe("fetching multiple images as a collage", () => {
const png = fs.readFileSync(
path.join(
__dirname,
"..",
"docs",
"images",
"chartreuseFuchsia.png"
)
);
describe("fetching a collage of 4 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"art:1",
"art:2",
"art:3",
"art:4",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 200);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(200);
expect(image.height).toEqual(200);
});
});
describe("fetching a collage of 4, however only 1 is available", () => {
it("should return the single image", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
contentType: "image/some-mime-type",
})
);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual(
"image/some-mime-type"
);
});
});
describe("fetching a collage of 4 and all are missing", () => {
it("should return a 404", async () => {
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
describe("fetching a collage of 9 when all are available", () => {
it("should return the image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"coverArt:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 9 when only 2 are available", () => {
it("should still return an image and a 200", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((urn) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(urn, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("fetching a collage of 11", () => {
it("should still return an image and a 200, though will only display 9", async () => {
const urns = [
"artist:1",
"artist:2",
"artist:3",
"artist:4",
"artist:5",
"artist:6",
"artist:7",
"artist:8",
"artist:9",
"artist:10",
"artist:11",
].map(resource => ({ system:"subsonic", resource }));
musicService.login.mockResolvedValue(musicLibrary);
urns.forEach((_) => {
musicLibrary.coverArt.mockResolvedValueOnce(
coverArtResponse({
data: png,
})
);
});
const res = await request(server)
.get(
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
"&"
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(200);
expect(res.header["content-type"]).toEqual("image/png");
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
urns.forEach((it) => {
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
});
const image = await Image.load(res.body);
expect(image.width).toEqual(180);
expect(image.height).toEqual(180);
});
});
describe("when the image is not available", () => {
it("should return a 404", async () => {
const coverArtURN = { system:"subsonic", resource:"art:404"};
musicService.login.mockResolvedValue(musicLibrary);
musicLibrary.coverArt.mockResolvedValue(undefined);
const res = await request(server)
.get(
`/art/${encodeURIComponent(formatForURL(coverArtURN))}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
)
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
expect(res.status).toEqual(404);
});
});
});
describe("when there is an error", () => {
it("should return a 500", async () => {
musicService.login.mockResolvedValue(musicLibrary);

View File

@@ -18,13 +18,14 @@ import {
track,
artist,
album,
coverArtURI,
defaultAlbumArtURI,
defaultArtistArtURI,
searchResult,
iconArtURI,
playlistAlbumArtURL,
sonosifyMimeType,
ratingAsInt,
ratingFromInt,
internetRadioStation
} from "../src/smapi";
import { keys as i8nKeys } from "../src/i8n";
@@ -39,11 +40,8 @@ import {
ROCK,
TRIP_HOP,
PUNK,
Y2024,
Y2023,
Y1969,
aPlaylist,
aRadioStation,
anAlbumSummary,
} from "./builders";
import { InMemoryMusicService } from "./in_memory_music_service";
import supersoap from "./supersoap";
@@ -58,6 +56,7 @@ import dayjs from "dayjs";
import url, { URLBuilder } from "../src/url_builder";
import { iconForGenre } from "../src/icon";
import { formatForURL } from "../src/burn";
import { range } from "underscore";
import { FixedClock } from "../src/clock";
import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth";
@@ -357,10 +356,7 @@ describe("track", () => {
const someTrack = aTrack({
id: uuid(),
// audio/x-flac should be mapped to audio/flac
encoding: {
player: "something",
mimeType: "audio/x-flac"
},
mimeType: "audio/x-flac",
name: "great song",
duration: randomInt(1000),
number: randomInt(100),
@@ -415,10 +411,7 @@ describe("track", () => {
const someTrack = aTrack({
id: uuid(),
// audio/x-flac should be mapped to audio/flac
encoding: {
player: "something",
mimeType: "audio/x-flac"
},
mimeType: "audio/x-flac",
name: "great song",
duration: randomInt(1000),
number: randomInt(100),
@@ -478,7 +471,7 @@ describe("album", () => {
itemType: "album",
id: `album:${someAlbum.id}`,
title: someAlbum.name,
albumArtURI: coverArtURI(bonobUrl, someAlbum).href(),
albumArtURI: defaultAlbumArtURI(bonobUrl, someAlbum).href(),
canPlay: true,
artist: someAlbum.artistName,
artistId: `artist:${someAlbum.artistId}`,
@@ -486,18 +479,6 @@ describe("album", () => {
});
});
describe("internetRadioStation", () => {
it("should map to a sonos internet stream", () => {
const station = aRadioStation()
expect(internetRadioStation(station)).toEqual({
itemType: "stream",
id: `internetRadioStation:${station.id}`,
title: station.name,
mimeType: "audio/mpeg"
})
});
});
describe("sonosifyMimeType", () => {
describe("when is audio/x-flac", () => {
it("should be mapped to audio/flac", () => {
@@ -514,8 +495,299 @@ describe("sonosifyMimeType", () => {
});
});
describe("playlistAlbumArtURL", () => {
const coverArt1 = { system: "subsonic", resource: "1" };
const coverArt2 = { system: "subsonic", resource: "2" };
const coverArt3 = { system: "subsonic", resource: "3" };
const coverArt4 = { system: "subsonic", resource: "4" };
const coverArt5 = { system: "subsonic", resource: "5" };
describe("coverArtURI", () => {
describe("when the playlist has no coverArt ids", () => {
it("should return question mark icon", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({ coverArt: undefined }),
aTrack({ coverArt: undefined }),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/icon/error/size/legacy?search=yes`
);
});
});
describe("when the playlist has external ids", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const externalArt1 = {
system: "external",
resource: "http://example.com/image1.jpg",
};
const externalArt2 = {
system: "external",
resource: "http://example.com/image2.jpg",
};
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: externalArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: externalArt2,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
it("should format the url with encrypted urn", () => {
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(externalArt1)
)}&${encodeURIComponent(
formatForURL(externalArt2)
)}/size/180?search=yes`
);
});
describe("when BNB_NO_PLAYLIST_ART is set", () => {
const OLD_ENV = process.env;
beforeEach(() => {
process.env = { ...OLD_ENV };
process.env["BNB_DISABLE_PLAYLIST_ART"] = "true";
});
afterEach(() => {
process.env = OLD_ENV;
});
it("should return an icon", () => {
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/icon/music/size/legacy?search=yes`
);
});
});
});
describe("when the playlist has 4 tracks from 2 different albums, including some tracks that are missing coverArt urns", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 2 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 3 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album3" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt4)
)}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 4 different albums", () => {
it("should return them on the url to the image", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album3" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album4" }),
}),
aTrack({
coverArt: coverArt5,
album: anAlbumSummary({ id: "album1" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt3)
)}&${encodeURIComponent(formatForURL(coverArt4))}/size/180?search=yes`
);
});
});
describe("when the playlist has at least 9 distinct albumIds", () => {
it("should return the first 9 of the ids on the url", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: { system: "subsonic", resource: "1" },
album: anAlbumSummary({ id: "1" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "2" },
album: anAlbumSummary({ id: "2" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "3" },
album: anAlbumSummary({ id: "3" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "4" },
album: anAlbumSummary({ id: "4" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "5" },
album: anAlbumSummary({ id: "5" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "6" },
album: anAlbumSummary({ id: "6" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "7" },
album: anAlbumSummary({ id: "7" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "8" },
album: anAlbumSummary({ id: "8" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "9" },
album: anAlbumSummary({ id: "9" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "10" },
album: anAlbumSummary({ id: "10" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "11" },
album: anAlbumSummary({ id: "11" }),
}),
],
});
const burns = range(1, 10)
.map((i) =>
encodeURIComponent(
formatForURL({ system: "subsonic", resource: `${i}` })
)
)
.join("&");
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${burns}/size/180?search=yes`
);
});
});
});
describe("defaultAlbumArtURI", () => {
const bonobUrl = new URLBuilder(
"http://bonob.example.com:8080/context?search=yes"
);
@@ -525,7 +797,7 @@ describe("coverArtURI", () => {
it("should use it", () => {
const coverArt = { system: "subsonic", resource: "12345" };
expect(
coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt)
@@ -541,7 +813,7 @@ describe("coverArtURI", () => {
resource: "http://example.com/someimage.jpg",
};
expect(
coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt)
@@ -554,7 +826,7 @@ describe("coverArtURI", () => {
describe("when there is no album coverArt", () => {
it("should return a vinly icon image", () => {
expect(
coverArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
).toEqual(
"http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes"
);
@@ -562,6 +834,50 @@ describe("coverArtURI", () => {
});
});
describe("defaultArtistArtURI", () => {
describe("when the artist has no image", () => {
it("should return an icon", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const artist = anArtist({ image: undefined });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/icon/vinyl/size/legacy?s=123`
);
});
});
describe("when the resource is subsonic", () => {
it("should use the resource", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const image = { system: "subsonic", resource: "art:1234" };
const artist = anArtist({ image });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/art/${encodeURIComponent(
formatForURL(image)
)}/size/180?s=123`
);
});
});
describe("when the resource is external", () => {
it("should encrypt the resource", () => {
const bonobUrl = url("http://localhost:1234/something?s=123");
const image = {
system: "external",
resource: "http://example.com/something.jpg",
};
const artist = anArtist({ image });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual(
`http://localhost:1234/something/art/${encodeURIComponent(
formatForURL(image)
)}/size/180?s=123`
);
});
});
});
describe("wsdl api", () => {
const musicService = {
generateToken: jest.fn(),
@@ -578,8 +894,6 @@ describe("wsdl api", () => {
artists: jest.fn(),
artist: jest.fn(),
genres: jest.fn(),
years: jest.fn(),
year: jest.fn(),
playlists: jest.fn(),
playlist: jest.fn(),
album: jest.fn(),
@@ -596,8 +910,6 @@ describe("wsdl api", () => {
scrobble: jest.fn(),
nowPlaying: jest.fn(),
rate: jest.fn(),
radioStation: jest.fn(),
radioStations: jest.fn(),
};
const apiTokens = {
mint: jest.fn(),
@@ -1158,12 +1470,6 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container",
},
{
id: "years",
title: "Years",
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{
id: "recentlyAdded",
title: "Recently added",
@@ -1185,12 +1491,6 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList",
},
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
];
expect(root[0]).toEqual(
getMetadataResult({
@@ -1258,12 +1558,6 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container",
},
{
id: "years",
title: "Jaren",
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{
id: "recentlyAdded",
title: "Onlangs toegevoegd",
@@ -1285,12 +1579,6 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList",
},
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
];
expect(root[0]).toEqual(
getMetadataResult({
@@ -1341,7 +1629,7 @@ describe("wsdl api", () => {
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: expectedGenres.map((genre) => ({
itemType: "albumList",
itemType: "container",
id: `genre:${genre.id}`,
title: genre.name,
albumArtURI: iconArtURI(
@@ -1366,7 +1654,7 @@ describe("wsdl api", () => {
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: [PUNK, ROCK].map((genre) => ({
itemType: "albumList",
itemType: "container",
id: `genre:${genre.id}`,
title: genre.name,
albumArtURI: iconArtURI(
@@ -1382,64 +1670,6 @@ describe("wsdl api", () => {
});
});
describe("asking for a year", () => {
const expectedYears = [Y1969, Y2023, Y2024];
beforeEach(() => {
musicLibrary.years.mockResolvedValue(expectedYears);
});
describe("asking for all years", () => {
it("should return a collection of years", async () => {
const result = await ws.getMetadataAsync({
id: `years`,
index: 0,
count: 100,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: expectedYears.map((year) => ({
itemType: "albumList",
id: `year:${year.id}`,
title: year.year,
albumArtURI: iconArtURI(
bonobUrl,
"music",
).href(),
})),
index: 0,
total: expectedYears.length,
})
);
});
});
describe("asking for a page of years", () => {
it("should return just that page", async () => {
const result = await ws.getMetadataAsync({
id: `years`,
index: 1,
count: 2,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: [Y2023, Y2024].map((year) => ({
itemType: "albumList",
id: `year:${year.id}`,
title: year.year,
albumArtURI: iconArtURI(
bonobUrl,
"music"
).href(),
})),
index: 1,
total: expectedYears.length,
})
);
});
});
});
describe("asking for playlists", () => {
const playlist1 = aPlaylist({ id: "1", name: "pl1", entries: []});
const playlist2 = aPlaylist({ id: "2", name: "pl2", entries: []});
@@ -1471,7 +1701,7 @@ describe("wsdl api", () => {
itemType: "playlist",
id: `playlist:${playlist.id}`,
title: playlist.name,
albumArtURI: coverArtURI(
albumArtURI: playlistAlbumArtURL(
bonobUrlWithAccessToken,
playlist
).href(),
@@ -1503,7 +1733,7 @@ describe("wsdl api", () => {
itemType: "playlist",
id: `playlist:${playlist.id}`,
title: playlist.name,
albumArtURI: coverArtURI(
albumArtURI: playlistAlbumArtURL(
bonobUrlWithAccessToken,
playlist
).href(),
@@ -1547,7 +1777,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -1584,7 +1814,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -1636,9 +1866,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`,
artistId: it.id,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultArtistArtURI(
bonobUrlWithAccessToken,
{ coverArt: it.image }
it
).href(),
})),
index: 0,
@@ -1681,9 +1911,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`,
artistId: it.id,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultArtistArtURI(
bonobUrlWithAccessToken,
{ coverArt: it.image }
it
).href(),
})),
index: 1,
@@ -1742,9 +1972,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`,
artistId: it.id,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultArtistArtURI(
bonobUrlWithAccessToken,
{ coverArt: it.image }
it
).href(),
})),
index: 0,
@@ -1771,9 +2001,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`,
artistId: it.id,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultArtistArtURI(
bonobUrlWithAccessToken,
{ coverArt: it.image }
it
).href(),
})
),
@@ -1888,7 +2118,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -1936,7 +2166,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -1984,7 +2214,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2032,7 +2262,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2080,7 +2310,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2128,7 +2358,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2174,7 +2404,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2220,7 +2450,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2264,7 +2494,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2311,7 +2541,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${it.id}`,
title: it.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
it
).href(),
@@ -2478,71 +2708,6 @@ describe("wsdl api", () => {
});
});
});
describe("asking for internet radio stations", () => {
const station1 = aRadioStation();
const station2 = aRadioStation();
const station3 = aRadioStation();
const station4 = aRadioStation();
const stations = [station1, station2, station3, station4];
beforeEach(() => {
musicLibrary.radioStations.mockResolvedValue(stations);
});
describe("when they all fit on the page", () => {
it("should return them all", async () => {
const paging = {
index: 0,
count: 100,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: stations.map((it) =>
internetRadioStation(it)
),
index: 0,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
describe("asking for a single page of stations", () => {
const pageOfStations = [station3, station4];
it("should return only that page", async () => {
const paging = {
index: 2,
count: 2,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: pageOfStations.map((it) =>
internetRadioStation(it)
),
index: paging.index,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
});
});
});
@@ -2753,7 +2918,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`,
itemType: "track",
title: track.name,
mimeType: track.encoding.mimeType,
mimeType: track.mimeType,
trackMetadata: {
artistId: `artist:${track.artist.id}`,
artist: track.artist.name,
@@ -2764,7 +2929,7 @@ describe("wsdl api", () => {
genre: track.genre?.name,
genreId: track.genre?.id,
duration: track.duration,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
track
).href(),
@@ -2801,7 +2966,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`,
itemType: "track",
title: track.name,
mimeType: track.encoding.mimeType,
mimeType: track.mimeType,
trackMetadata: {
artistId: `artist:${track.artist.id}`,
artist: track.artist.name,
@@ -2812,7 +2977,7 @@ describe("wsdl api", () => {
genre: track.genre?.name,
genreId: track.genre?.id,
duration: track.duration,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
track
).href(),
@@ -2855,7 +3020,7 @@ describe("wsdl api", () => {
itemType: "album",
id: `album:${album.id}`,
title: album.name,
albumArtURI: coverArtURI(
albumArtURI: defaultAlbumArtURI(
bonobUrlWithAccessToken,
album
).href(),
@@ -2920,27 +3085,6 @@ describe("wsdl api", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
});
});
describe("asking for a URI to stream a radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return the radio stations uri", async () => {
const root = await ws.getMediaURIAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaURIResult: someStation.url,
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
});
});
@@ -2952,6 +3096,7 @@ describe("wsdl api", () => {
describe("when valid credentials are provided", () => {
let ws: Client;
const someTrack = aTrack();
beforeEach(async () => {
ws = await createClientAsync(`${service.uri}?wsdl`, {
@@ -2959,15 +3104,10 @@ describe("wsdl api", () => {
httpClient: supersoap(server),
});
setupAuthenticatedRequest(ws);
musicLibrary.track.mockResolvedValue(someTrack);
});
describe("asking for media metadata for a track", () => {
const someTrack = aTrack();
beforeEach(async () => {
musicLibrary.track.mockResolvedValue(someTrack);
});
it("should return it with auth header", async () => {
const root = await ws.getMediaMetadataAsync({
id: `track:${someTrack.id}`,
@@ -2986,27 +3126,6 @@ describe("wsdl api", () => {
expect(musicLibrary.track).toHaveBeenCalledWith(someTrack.id);
});
});
describe("asking for media metadata for an internet radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return it with no auth header", async () => {
const root = await ws.getMediaMetadataAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaMetadataResult: internetRadioStation(someStation),
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(apiTokens.mint).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
});
});

File diff suppressed because it is too large Load Diff

View File

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

Before

Width:  |  Height:  |  Size: 293 B

4771
yarn.lock Normal file

File diff suppressed because it is too large Load Diff